diff --git a/doc/image-guide/ch_creating_images_manually.xml b/doc/image-guide/ch_creating_images_manually.xml index 0a6a22c970..3e0ae3a0ab 100644 --- a/doc/image-guide/ch_creating_images_manually.xml +++ b/doc/image-guide/ch_creating_images_manually.xml @@ -1,88 +1,118 @@ - - Creating images manually - - Creating a new image is a step done outside of your OpenStack installation. - You create the new image manually on your own system and then upload the image to your - cloud. - - To create a new image, you will need the installation CD or DVD ISO file for the guest - operating system. You'll also need access to a virtualization tool. You can use KVM for - this. Or, if you have a GUI desktop virtualization tool (such as, VMWare Fusion and VirtualBox), - you can use that instead and just convert the file to raw once you're done. - When you create a new virtual machine image, you will need to connect to the graphical - console of the hypervisor, which acts as the virtual machine's display and allows you to - interact with the guest operating system's installer using your keyboard and mouse. KVM can - expose the graphical console using the VNC (Virtual - Network Computing) protocol or the newer SPICE protocol. We'll use the VNC protocol here, since you're more likely to be - able to find a VNC client that works on your local desktop. + + Create images manually + Creating a new image is a step done outside of your + OpenStack installation. You create the new image manually on + your own system and then upload the image to your + cloud. + To create a new image, you will need the installation CD or + DVD ISO file for the guest operating system. You'll also need + access to a virtualization tool. You can use KVM for this. Or, + if you have a GUI desktop virtualization tool (such as, VMWare + Fusion and VirtualBox), you can use that instead and just + convert the file to raw once you're done. + When you create a new virtual machine image, you will need + to connect to the graphical console of the hypervisor, which + acts as the virtual machine's display and allows you to + interact with the guest operating system's installer using + your keyboard and mouse. KVM can expose the graphical console + using the VNC (Virtual Network Computing) protocol or the + newer SPICE + protocol. We'll use the VNC protocol here, since you're more + likely to be able to find a VNC client that works on your + local desktop.
- Ensuring the libvirt default network is running - Before starting a virtual machine with libvirt, verify that the libvirt "default" - network has been started. This network must be active for your virtual machine to be - able to connect out to the network. Starting this network will create a Linux bridge - (usually called virbr0), iptables rules, and a dnsmasq process that - will serve as a DHCP server. - To verify that the libvirt "default" network is enabled, use the virsh - net-list command and verify that the "default" network is - active:# virsh net-list + Verify the libvirt default network is running + Before starting a virtual machine with libvirt, verify + that the libvirt "default" network has been started. This + network must be active for your virtual machine to be able + to connect out to the network. Starting this network will + create a Linux bridge (usually called + virbr0), iptables rules, and a + dnsmasq process that will serve as a DHCP server. + To verify that the libvirt "default" network is enabled, + use the virsh net-list command and + verify that the "default" network is active: + # virsh net-list Name State Autostart ----------------------------------------- default active yes - - If the network is not active, start it by - doing:# virsh net-start default - + If the network is not active, start it by doing: + # virsh net-start default
- Using the virt-manager X11 GUI - If you plan to create a virtual machine image on a machine that can run X11 applications, - the simplest way to do so is to use the virt-manager GUI, which is - installable as the virt-manager package on both Fedora-based and - Debian-based systems. This GUI has an embedded VNC client in it that will let you view and - interact with the guest's graphical console. - If you are building the image on a headless server, and you have an X server on your - local machine, you can launch virt-manager  using ssh X11 forwarding to - access the GUI. Since virt-manager interacts directly with libvirt, you typically need to be - root to access it. If you can ssh directly in as root (or with a user that has permissions - to interact with libvirt), - do:$ ssh -X root@server virt-manager - If the account you use to ssh into your server does not have permissions to run libvirt, - but has sudo privileges, do:$ ssh -X root@server + Use the virt-manager X11 GUI + If you plan to create a virtual machine image on a + machine that can run X11 applications, the simplest way to + do so is to use the virt-manager GUI, + which is installable as the + virt-manager package on both + Fedora-based and Debian-based systems. This GUI has an + embedded VNC client in it that will let you view and + interact with the guest's graphical console. + If you are building the image on a headless server, and + you have an X server on your local machine, you can launch + virt-manager  using ssh X11 + forwarding to access the GUI. Since virt-manager interacts + directly with libvirt, you typically need to be root to + access it. If you can ssh directly in as root (or with a + user that has permissions to interact with libvirt), + do:$ ssh -X root@server virt-manager + If the account you use to ssh into your server does not + have permissions to run libvirt, but has sudo privileges, do:$ ssh -X root@server $ sudo virt-manager - The -X flag passed to ssh will enable X11 forwarding over ssh. - If this does not work, try replacing it with the -Y flag. - - Click the "New" button at the top-left and step through the instructions. + The -X flag passed to ssh + will enable X11 forwarding over ssh. If this does + not work, try replacing it with the + -Y flag. + + Click the "New" button at the top-left and step through + the instructions. - + - You will be shown a series of dialog boxes that will allow you to specify - information about the virtual machine. + You will be shown a series of dialog boxes + that will allow you to specify information about the + virtual machine.
- Using virt-install and connecting using a local VNC client - If you do not with to use virt-manager (e.g., you don't want to install the - dependencies on your server, you don't have an X server running locally, the X11 - forwarding over SSH isn't working), you can use the virt-install tool - to boot the virtual machine through libvirt and connect to the graphical console from a - VNC client installed on your local machine. - Since VNC is a standard protocol, there are multiple clients available that implement - the VNC spec, including Use virt-install and connect by using a local VNC + client + If you do not with to use virt-manager (for example, you + do not want to install the dependencies on your server, + you don't have an X server running locally, the X11 + forwarding over SSH isn't working), you can use the + virt-install tool to boot the + virtual machine through libvirt and connect to the + graphical console from a VNC client installed on your + local machine. + Because VNC is a standard protocol, there are multiple + clients available that implement the VNC spec, including + TigerVNC (multiple platforms), TightVNC (multiple platforms), RealVNC (multiple platforms), Chicken (Mac OS X), - Krde (KDE), and Vinagre (GNOME). - The following example shows how to use the qemu-img command to create an empty - image file virt-install command to start up a virtual machine using - that image file. As root: - # qemu-img create -f qcow2 /data/centos-6.4.qcow2 10G + >TigerVNC (multiple platforms), TightVNC + (multiple platforms), RealVNC + (multiple platforms), Chicken (Mac OS X), Krde + (KDE), and Vinagre (GNOME). + The following example shows how to use the + qemu-img command to create an empty + image file virt-install command to + start up a virtual machine using that image file. As + root: + # qemu-img create -f qcow2 /data/centos-6.4.qcow2 10G # virt-install --virt-type kvm --name centos-6.4 --ram 1024 \ --cdrom=/data/CentOS-6.4-x86_64-netinstall.iso \ --disk path=/data/centos-6.4.qcow2,size=10,format=qcow2 \ @@ -94,32 +124,45 @@ Starting install... Creating domain... | 0 B 00:00 Domain installation still in progress. You can reconnect to the console to complete the installation process. - This uses the KVM hypervisor to start up a virtual machine with the libvirt name of - centos-6.4 with 1024MB of RAM, with a virtual CD-ROM drive - associated with the /data/CentOS-6.4-x86_64-netinstall.iso file, - and a local hard disk which is stored in the host at - /data/centos-6.4.qcow2 that is 10GB in size in qcow2 format. It - configures networking to use libvirt's default network. There is a VNC server that is - listening on all interfaces, and libvirt will not attempt to launch a VNC client - automatically nor try to display the text console (--no-autoconsole). - Finally, libvirt will attempt to optimize the configuration for a Linux guest running a - RHEL 6.x distribution. - When using the libvirt default network, libvirt will - connect the virtual machine's interface to a bridge called - virbr0. There is a dnsmasq process managed by libvirt - that will hand out an IP address on the 192.168.122.0/24 subnet, and libvirt has - iptables rules for doing NAT for IP addresses on this subnet. + This uses the KVM hypervisor to start up a virtual + machine with the libvirt name of + centos-6.4 with 1024MB of RAM, with + a virtual CD-ROM drive associated with the + /data/CentOS-6.4-x86_64-netinstall.iso + file, and a local hard disk which is stored in the host at + /data/centos-6.4.qcow2 that is + 10GB in size in qcow2 format. It configures networking to + use libvirt's default network. There is a VNC server that + is listening on all interfaces, and libvirt will not + attempt to launch a VNC client automatically nor try to + display the text console + (--no-autoconsole). Finally, + libvirt will attempt to optimize the configuration for a + Linux guest running a RHEL 6.x distribution. + When using the libvirt + default network, libvirt + will connect the virtual machine's interface to a + bridge called virbr0. There is + a dnsmasq process managed by libvirt that will + hand out an IP address on the 192.168.122.0/24 + subnet, and libvirt has iptables rules for doing + NAT for IP addresses on this subnet. - Run the virt-install --os-variant list command to see a range of allowed + Run the virt-install --os-variant + list command to see a range of allowed --os-variant options. - Use the virsh vncdisplay vm-name command - to get the VNC port - number.# virsh vncdisplay centos-6.4 + Use the virsh vncdisplay + vm-name + command to get the VNC port number. + # virsh vncdisplay centos-6.4 :1 - In the example above, the guest centos-6.4 uses VNC display - :1, which corresponds to tcp port 5901. You - should be able to connect to a VNC client running on your local machine to display :1 on - the remote machine and step through the installation process. + In the example above, the guest + centos-6.4 uses VNC display + :1, which corresponds to tcp port + 5901. You should be able to connect + to a VNC client running on your local machine to display + :1 on the remote machine and step through the installation + process.
diff --git a/doc/image-guide/ch_modifying_images.xml b/doc/image-guide/ch_modifying_images.xml index b478950f61..bb3f3f12fe 100644 --- a/doc/image-guide/ch_modifying_images.xml +++ b/doc/image-guide/ch_modifying_images.xml @@ -1,7 +1,7 @@ - Modifying images + Modify images Once you have obtained a virtual machine image, you may want to make some changes to it before uploading it to the OpenStack Image service. Here we describe several tools available @@ -82,7 +82,7 @@ Type: 'help' for help on commands command:><fs> exit - Going further with guestfish + Go further with guestfish There is an enormous amount of functionality in guestfish and a full treatment is beyond the scope of this document. Instead, we recommend that you read the guestfs-recipes @@ -209,7 +209,7 @@ disk, carefully check that the resized disk boots and works correctly. OS by Daniel Berrangé for more details. - Mounting a raw image (without LVM) + Mount a raw image (without LVM) If you have a raw virtual machine image that is not using LVM to manage its partitions. First, use the losetup command to find an unused loop device. @@ -239,7 +239,7 @@ brw-rw---- 1 root disk 43, 51 2012-03-05 15:32 /dev/mapper/loop0p3# losetup -d /dev/loop0 - Mounting a raw image (with LVM) + Mount a raw image (with LVM) If your partitions are managed with LVM, use losetup and kpartx as in the previous example to expose the partitions to the host:# losetup -f @@ -261,7 +261,7 @@ brw-rw---- 1 root disk 43, 51 2012-03-05 15:32 /dev/mapper/loop0p3# losetup -d /dev/loop0 - Mounting a qcow2 image (without LVM) + Mount a qcow2 image (without LVM) You need the nbd (network block device) kernel module loaded to mount qcow2 images. This will load it with support for 16 block devices, which is fine for our purposes. As @@ -290,7 +290,7 @@ brw-rw---- 1 root disk 43, 51 2012-03-05 15:32 /dev/nbd0p3# qemu-nbd -d /dev/g nbd0 - Mounting a qcow2 image (with LVM) + Mount a qcow2 image (with LVM) If the image partitions are managed with LVM, after you use qemu-nbd and partprobe, you must use vgscan and vgchange -ay in order to expose diff --git a/doc/image-guide/ch_obtaining_images.xml b/doc/image-guide/ch_obtaining_images.xml index eb52f10d3a..78edcd9266 100644 --- a/doc/image-guide/ch_obtaining_images.xml +++ b/doc/image-guide/ch_obtaining_images.xml @@ -3,7 +3,7 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="ch_obtaining_images"> - Obtaining images + Get images The simplest way to obtain a virtual machine image that works with OpenStack is to download one that someone else has already created. @@ -93,7 +93,7 @@ >rackerjoe/oz-image-build on Github.
- Microsoft Windows Images + Microsoft Windows images Cloudbase Solutions hosts an OpenStack Windows Server 2012 Standard Evaluation image that runs on Hyper-V, KVM, and XenServer/XCP. diff --git a/doc/image-guide/ch_openstack_images.xml b/doc/image-guide/ch_openstack_images.xml index 95a497788e..acd7521b4e 100644 --- a/doc/image-guide/ch_openstack_images.xml +++ b/doc/image-guide/ch_openstack_images.xml @@ -215,7 +215,7 @@ configured to download the ssh public key from the OpenStack metadata service or config drive, at boot time. - Using cloud-init to fetch the public key + Use cloud-init to fetch the public key The cloud-init package will automatically fetch the public key from the metadata server and place the key in an account. The account varies by distribution. On Ubuntu-based virtual machines, the account is called "ubuntu". On Fedora-based @@ -229,7 +229,7 @@ line:user: admin - Writing a custom script to fetch the public key + Write a custom script to fetch the public key If you are unable or unwilling to install cloud-init inside the guest, you can write a custom script to fetch the public and add it to a user account. To fetch the ssh public key and add it to the root account, edit the @@ -318,7 +318,7 @@ done that the image boots a kernel that has been compiled with Xen support.
- Managing the image cache + Manage the image cache Use options in nova.conf to control whether, and for how long, unused base images are stored in /var/lib/nova/instances/_base/. If you have configured live migration of instances, all your compute nodes share one common diff --git a/doc/image-guide/section_centos-example.xml b/doc/image-guide/section_centos-example.xml index 2eedaa2850..9b4e335a88 100644 --- a/doc/image-guide/section_centos-example.xml +++ b/doc/image-guide/section_centos-example.xml @@ -214,7 +214,7 @@ - Using cloud-init to fetch the public key + Use cloud-init to fetch the public key The cloud-init package will automatically fetch the public key from the metadata server and place the key in an account. You can install cloud-init inside the CentOS guest by adding the EPEL @@ -230,7 +230,7 @@ line:user: admin - Writing a script to fetch the public key (if no cloud-init) + Write a script to fetch the public key (if no cloud-init) If you are not able to install the cloud-init package in your image, to fetch the ssh public key and add it to the root account, edit the /etc/rc.local file and add the following lines before the line @@ -290,7 +290,7 @@ kernel ... console=tty0 console=ttyS0,115200n8# /sbin/shutdown -h now - Clean up (e.g., remove MAC address details) + Clean up (remove MAC address details) The operating system records the MAC address of the virtual ethernet card in locations such as /etc/sysconfig/network-scripts/ifcfg-eth0 and /etc/udev/rules.d/70-persistent-net.rules during the instance diff --git a/doc/image-guide/section_glance_image-formats.xml b/doc/image-guide/section_glance_image-formats.xml index de2451535b..630db169c5 100644 --- a/doc/image-guide/section_glance_image-formats.xml +++ b/doc/image-guide/section_glance_image-formats.xml @@ -3,12 +3,12 @@ xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="image-formats"> - Disk and Container Formats for Images + Disk and container formats for images When you add an image to the Image Service, you can specify its disk and container formats.
- Disk Formats + Disk formats The disk format of a virtual machine image is the format of the underlying disk image. Virtual appliance vendors have different formats for laying out the information @@ -62,7 +62,7 @@
- Container Formats + Container formats The container format indicates whether the virtual machine image is in a file format that also contains metadata about the actual virtual machine. diff --git a/doc/image-guide/section_ubuntu-example.xml b/doc/image-guide/section_ubuntu-example.xml index fbaacdd4e1..69886224ba 100644 --- a/doc/image-guide/section_ubuntu-example.xml +++ b/doc/image-guide/section_ubuntu-example.xml @@ -54,7 +54,7 @@ - Selecting a mirror + Select a mirror The default mirror proposed by the installer should be fine. @@ -171,7 +171,7 @@ root:# /sbin/shutdown -h now - Clean up (e.g., remove MAC address details) + Clean up (remove MAC address details) The operating system records the MAC address of the virtual ethernet card in locations such as /etc/udev/rules.d/70-persistent-net.rules during the instance process. However, each time the image boots up, the virtual ethernet card will