diff --git a/doc-test.conf b/doc-test.conf index e56540bc34..9b5f382f61 100644 --- a/doc-test.conf +++ b/doc-test.conf @@ -5,6 +5,7 @@ repo_name = openstack-manuals release_path = draft url_exception = https://build.opensuse.org/package/show?package=python-pip&project=Cloud:OpenStack:Master +url_exception = https://packer.io # These files are not in DocBook format: file_exception = emc-vmax.xml diff --git a/doc/image-guide/ch_creating_images_automatically.xml b/doc/image-guide/ch_creating_images_automatically.xml index b708193e21..1dc9091d30 100644 --- a/doc/image-guide/ch_creating_images_automatically.xml +++ b/doc/image-guide/ch_creating_images_automatically.xml @@ -41,7 +41,7 @@ # yum install oz As of this writing, there are no Oz packages for Ubuntu, - so you will need to either install from source or build your + so you will need to either install from the source or build your own .deb file. A full treatment of Oz is beyond the scope of this document, but @@ -97,13 +97,12 @@ echo -n > /lib/udev/rules.d/75-persistent-net-generator.rules epel-release, cloud-utils, and cloud-init packages, as specified in the packages section of the file. - After Oz does the initial OS install using the kickstart file, it - updates the image's install packages with yum - update. It also removes any reference to the eth0 + After Oz completes the initial OS install using the kickstart file, + it customizes the image with an update. It also removes any reference to the eth0 device that libvirt creates while Oz does the customizing, as specified in the command section of the XML file. - To run this, do, as root: + To run this: # oz-install -d3 -u centos64.tdl -x centos64-libvirt.xml @@ -164,7 +163,7 @@ echo -n > /lib/udev/rules.d/75-persistent-net-generator.rules
Packer - + Packer is a tool for creating machine images for multiple platforms from a single source configuration. diff --git a/doc/image-guide/ch_creating_images_manually.xml b/doc/image-guide/ch_creating_images_manually.xml index d5bb938c9b..bfb39b6caf 100644 --- a/doc/image-guide/ch_creating_images_manually.xml +++ b/doc/image-guide/ch_creating_images_manually.xml @@ -17,8 +17,8 @@ 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. + Fusion or VirtualBox), you can use that instead and just + convert the file to raw once you are 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 @@ -58,7 +58,7 @@ default active yes 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 + embedded VNC client 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 diff --git a/doc/image-guide/ch_introduction.xml b/doc/image-guide/ch_introduction.xml index 22f2209c1a..30b176fdb7 100644 --- a/doc/image-guide/ch_introduction.xml +++ b/doc/image-guide/ch_introduction.xml @@ -13,8 +13,7 @@ What is a virtual machine image? A virtual machine image is a single file which contains a virtual disk that has a bootable operating system installed on it. - Virtual machine images come in different formats, some of which are described below. In a - later chapter, we'll describe how to convert between formats. + Virtual machine images come in different formats, some of which are described below. Raw @@ -35,10 +34,10 @@ copy-on-write version 2) format is commonly used with the KVM hypervisor. It has some additional features over the raw format, such as: - Using sparse representation, so the image size is smaller + Using sparse representation, so the image size is smaller. - Support for snapshots + Support for snapshots. Because qcow2 is sparse, qcow2 images are typically smaller than raw images. Smaller images mean faster uploads, so it's often faster to convert a raw image to qcow2 for uploading instead of uploading the raw file directly. diff --git a/doc/image-guide/ch_modifying_images.xml b/doc/image-guide/ch_modifying_images.xml index dc5506b50b..cd1c09cea8 100644 --- a/doc/image-guide/ch_modifying_images.xml +++ b/doc/image-guide/ch_modifying_images.xml @@ -178,19 +178,19 @@ Type: 'help' for help on commands virt-sparsify for making an image - sparse + sparse. virt-p2v for converting a physical - machine to an image that runs on KVM + machine to an image that runs on KVM. virt-v2v for converting Xen and - VMware images to KVM images + VMware images to KVM images. @@ -213,7 +213,7 @@ Type: 'help' for help on commands Resize an image - Here's a simple of example of how to use + Here is an example of how to use virt-resize to resize an image. Assume we have a 16 GB Windows image in qcow2 format that we want to resize to 50 GB. First, we use @@ -275,7 +275,7 @@ disk, carefully check that the resized disk boots and works correctly. 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 + using LVM to manage its partitions, use the losetup command to find an unused loop device. # losetup -f @@ -310,7 +310,7 @@ brw-rw---- 1 root disk 43, 51 2012-03-05 15:32 /dev/mapper/loop0p3Mount 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: + partitions to the host. # losetup -f /dev/loop0 # losetup /dev/loop0 rhel62.img diff --git a/doc/image-guide/ch_obtaining_images.xml b/doc/image-guide/ch_obtaining_images.xml index 7352c238ba..84e53e8f74 100644 --- a/doc/image-guide/ch_obtaining_images.xml +++ b/doc/image-guide/ch_obtaining_images.xml @@ -11,7 +11,7 @@
CentOS images The CentOS project maintains official images for direct - download: + download. @@ -36,7 +36,7 @@ If your deployment uses QEMU or KVM, we recommend using the images in qcow2 format. The most recent 64-bit qcow2 image as of this writing is cirros-0.3.3-x86_64-disk.img + >cirros-0.3.3-x86_64-disk.img. In a CirrOS image, the login account is cirros. The password is cubswin:) @@ -66,7 +66,7 @@ Red Hat maintains official Red Hat Enterprise Linux cloud images. A valid Red Hat Enterprise Linux subscription is required - to download these images: + to download these images. diff --git a/doc/image-guide/ch_openstack_images.xml b/doc/image-guide/ch_openstack_images.xml index 331c59f885..e92255fa07 100644 --- a/doc/image-guide/ch_openstack_images.xml +++ b/doc/image-guide/ch_openstack_images.xml @@ -12,7 +12,7 @@ For a Linux-based image to have full functionality in an OpenStack Compute cloud, there are a few requirements. For - some of these, you can fulfill the requirement by installing + some of these, you can fulfill the requirements by installing the cloud-init package. Read @@ -106,11 +106,11 @@ The partition table for the image describes - the original size of the image + the original size of the image. The file system for the image fills the - original size of the image + original size of the image. Then, during the boot process, you must: @@ -248,7 +248,7 @@ instance to come up as an interface other than eth0. This is because your image has a record of the MAC address of the network interface card when it was first installed, - and this MAC address is different each time that the + and this MAC address is different each time the instance boots. You should alter the following files: @@ -256,18 +256,18 @@ Replace /etc/udev/rules.d/70-persistent-net.rules with an empty file (contains network persistence - rules, including MAC address) + rules, including MAC address). Replace /lib/udev/rules.d/75-persistent-net-generator.rules with an empty file (this generates the file - above) + above). Remove the HWADDR line from /etc/sysconfig/network-scripts/ifcfg-eth0 - on Fedora-based images + on Fedora-based images. @@ -386,7 +386,7 @@ done (cloud-init) In addition to the ssh public key, an image might need additional information from OpenStack, such as Provide user data to instances, that the user submitted when requesting the image. For example, you might want to set the host name of the instance when it is booted. @@ -394,7 +394,7 @@ done user data content as a script on boot. You can access this information through the metadata service or referring to Store metadata on the configuration drive. As the OpenStack metadata service is compatible with version 2009-04-04 of the Amazon EC2 metadata service, consult the Amazon EC2 diff --git a/doc/image-guide/figures/virt-manager-new.png b/doc/image-guide/figures/virt-manager-new.png index 929d8aee59..95c5203111 100644 Binary files a/doc/image-guide/figures/virt-manager-new.png and b/doc/image-guide/figures/virt-manager-new.png differ diff --git a/doc/image-guide/section_centos-example.xml b/doc/image-guide/section_centos-example.xml index 75d874616b..f14e4d363e 100644 --- a/doc/image-guide/section_centos-example.xml +++ b/doc/image-guide/section_centos-example.xml @@ -93,7 +93,7 @@ - Depending on the version of CentOS, the net installer requires that the user specify + Depending on the version of CentOS, the net installer requires the user to specify either a URL or the web site and a CentOS directory that corresponds to one of the CentOS mirrors. If the installer asks for a single URL, a valid URL might be http://mirror.umd.edu/centos/6/os/x86_64. @@ -150,7 +150,7 @@ Detach the CD-ROM and reboot - After the install completes, the Congratulations, your CentOS installation + When the installation has completed, the Congratulations, your CentOS installation is complete screen appears. diff --git a/doc/image-guide/section_freebsd-example.xml b/doc/image-guide/section_freebsd-example.xml index 250bcccdea..822cf29b9e 100644 --- a/doc/image-guide/section_freebsd-example.xml +++ b/doc/image-guide/section_freebsd-example.xml @@ -247,9 +247,9 @@ https://raw.github.com/pellaeon/bsd-cloudinit-installer/master/installer.sh Run the installer: # sh ./installer.sh - The installer installs necessary prerequisites and - downloads and installs the latest - bsd-cloudinit. + Issue this command to download and install the latest + bsd-cloudinit package, and install the + necessary prerequisites. Install sudo and configure the diff --git a/doc/image-guide/section_glance_image-formats.xml b/doc/image-guide/section_glance_image-formats.xml index d5f5bfd333..57408aabc4 100644 --- a/doc/image-guide/section_glance_image-formats.xml +++ b/doc/image-guide/section_glance_image-formats.xml @@ -18,46 +18,46 @@ following values: - raw. An unstructured disk + raw: An unstructured disk image format; if you have a file without an - extension it is possibly a raw format + extension it is possibly a raw format. - vhd. The VHD disk format, a + vhd: The VHD disk format, a common disk format used by virtual machine monitors from VMware, Xen, Microsoft, VirtualBox, - and others + and others. - vmdk. Common disk format + vmdk: Common disk format supported by many common virtual machine - monitors + monitors. - vdi. Supported by VirtualBox + vdi: Supported by VirtualBox virtual machine monitor and the QEMU - emulator + emulator. - iso. An archive format for + iso: An archive format for the data contents of an optical disc, such as CD-ROM. - qcow2. Supported by the QEMU + qcow2: Supported by the QEMU emulator that can expand dynamically and supports - Copy on Write + Copy on Write. - aki. An Amazon kernel + aki: An Amazon kernel image. - ari. An Amazon ramdisk + ari: An Amazon ramdisk image. - ami. An Amazon machine + ami: An Amazon machine image.