diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.md b/README.md index 6bfed53..516fb34 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # qvm Trivial management of 64 bit virtual machines with qemu. + +# What this script will do +It can handle: +- Virtual hard disk creation, backup and deletion. +- Basic network management: two ports are exposed to the host + machine (but you can add as many as you want). One of these + two ports is SSH (so admin gets simpler). +- Shared directory between host and guest. +- Last, but not least, running the virtual machine with all + these options. + +# Setup information +- You need a 64 bit machine. +- Modify `configvmrc` based on your needs. + Variables are self-explanatory and I have kept mine + as an example. + +``` +# pacman -S qemu +$ . ./configvmrc +$ mkdir -p "$shared_data_path" +``` + +- On your guest machine add the following in `/etc/fstab`: +``` +host_share /home/vm/shared 9p trans=virtio,version=9p2000.L 0 0 +``` +This will enable the shared directory automatically (no mount commands of any +sort). + +# License +CC0. diff --git a/configvmrc b/configvmrc new file mode 100644 index 0000000..9b09339 --- /dev/null +++ b/configvmrc @@ -0,0 +1,30 @@ +# qvm - Trivial management of 64 bit virtual machines with qemu. +# +# Written in 2016 by Franco Masotti/frnmst +# +# To the extent possible under law, the author(s) have dedicated all +# copyright and related and neighboring rights to this software to the public +# domain worldwide. This software is distributed without any warranty. +# +# You should have received a copy of the CC0 Public Domain Dedication along +# with this software. If not, see +# . + +img_name="antergos.iso" + +vhd_size="16G" +vhd_type="qcow2" +vhd_name=""$img_name"."$vhd_type"" +vm_memory="4G" + +# Shared port. +host_port="5555" +# vm port. +guest_port="3050" +# Shared port. +ssh_host_port="2222" +# vm port. +ssh_guest_port="22" + +shared_data_path="/home/parabola/dev/unife/intern/qemu/shared_host_guest" +mount_tag="host_share" diff --git a/qvm b/qvm new file mode 100755 index 0000000..7f796f0 --- /dev/null +++ b/qvm @@ -0,0 +1,72 @@ +#!/usr/bin/env sh + +# qvm - Trivial management of 64 bit virtual machines with qemu. +# +# Written in 2016 by Franco Masotti/frnmst +# +# To the extent possible under law, the author(s) have dedicated all +# copyright and related and neighboring rights to this software to the public +# domain worldwide. This software is distributed without any warranty. +# +# You should have received a copy of the CC0 Public Domain Dedication along +# with this software. If not, see +# . + +. ./configvmrc + +input="$1" +if [ -z "$input" ] || [ "$input" = "-h" ]; then + cat <<-EOF +Usage: qvm [OPTION] +Trivial management of 64 bit virtual machines with qemu. + +Options: + -b backup vhd + -c create new vhd + -d delete vhd backup + -h print this help + -i install img on vhd + -r run vm + +Only a single option is accepted. +Before running any virtual machine you must create a backup first. + +CC0 +Written in 2016 by Franco Masotti/frnmst +EOF + exit 1 +fi + +{ + +[ "$input" = "-b" ] \ +&& qemu-img create -f "$vhd_type" \ +-b "$vhd_name" \ +"$vhd_name".mod + +[ "$input" = "-d" ] \ +&& rm "$vhd_name".mod + +[ "$input" = "-c" ] \ +&& qemu-img create -f "$vhd_type" "$vhd_name" "$vhd_size" + +[ "$input" = "-i" ] \ +&& qemu-system-x86_64 -m "$vm_memory" \ +-enable-kvm -cdrom "$img_name" \ +-boot order=d "$vhd_name" + +[ "$input" = "-r" ] \ +&& [ -f "$vhd_name".mod ] \ +&& qemu-system-x86_64 \ +-m "$vm_memory" \ +-enable-kvm \ +-device e1000,netdev=user.0 \ +-netdev user,\ +id=user.0,hostfwd=tcp::"$host_port"-:"$guest_port",\ +hostfwd=tcp::"$ssh_host_port"-:"$ssh_guest_port" \ +-virtfs local,path="$shared_data_path",\ +security_model=none,mount_tag="$mount_tag" \ +"$vhd_name".mod \ +|| { printf "Make a backup first.\n"; exit 1; } + +} &