openstack/openstack-manuals
Code Issues Proposed changes

Grammar/phrasal mistakes: OS Virtual Machine Image Guide

Browse Source 
* Grammar mistakes corrected.
* Not all corrections in the bug were made as it changed the meaning
and/or were grammatically incorrect themselves.
* Fix incorrect links

Change-Id: I3ded1c9c65df64e71b64545d45b3cbdb678444fe
Closes-bug: #1387850
This commit is contained in:
Alexandra Settle 2015-05-18 11:33:25 +10:00 committed by Andreas Jaeger
parent 183459747b
commit 9baec75cdb
11 changed files with 49 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc-test.conf
View File

@ -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

11
doc/image-guide/ch_creating_images_automatically.xml
View File

@ -41,7 +41,7 @@
<screen><prompt>#</prompt> <userinput>yum install oz</userinput></screen>
<note><para>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.</para>
</note>
<para>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
<literal>epel-release</literal>, <literal>cloud-utils</literal>,
and <literal>cloud-init</literal> packages, as specified in the
<literal>packages</literal> section of the file.</para>
<para>After Oz does the initial OS install using the kickstart file, it
updates the image's install packages with <command>yum
update</command>. It also removes any reference to the eth0
<para>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 <literal>command</literal> section of the XML
file.</para>
<para>To run this, do, as root:</para>
<para>To run this:</para>
<screen><prompt>#</prompt> <userinput>oz-install -d3 -u centos64.tdl -x centos64-libvirt.xml</userinput></screen>
<itemizedlist>
<listitem>
@ -164,7 +163,7 @@ echo -n > /lib/udev/rules.d/75-persistent-net-generator.rules
</section>
<section xml:id="packer">
<title>Packer</title>
<para><link xlink:href="http://www.packer.io/">
<para><link xlink:href="https://packer.io">
Packer</link> is a tool for creating machine images for multiple platforms
from a single source configuration.
</para>

6
doc/image-guide/ch_creating_images_manually.xml
View File

@ -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.</para>
Fusion or VirtualBox), you can use that instead and just
convert the file to raw once you are done.</para>
<para>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</computeroutput></screen>
which is installable as the
<literal>virt-manager</literal> 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.</para>
<para>If you are building the image on a headless server, and
you have an X server on your local machine, you can launch

7
doc/image-guide/ch_introduction.xml
View File

@ -13,8 +13,7 @@
<para>What is a virtual machine image?</para>
<para>A virtual machine image is a single file which contains a virtual disk that has a
bootable operating system installed on it.</para>
<para>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.</para>
<para>Virtual machine images come in different formats, some of which are described below.</para>
<variablelist>
<varlistentry>
<term>Raw</term>
@ -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:<itemizedlist>
<listitem>
<para>Using sparse representation, so the image size is smaller</para>
<para>Using sparse representation, so the image size is smaller.</para>
</listitem>
<listitem>
<para>Support for snapshots</para>
<para>Support for snapshots.</para>
</listitem>
</itemizedlist></para>
<para>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.</para>

12
doc/image-guide/ch_modifying_images.xml
View File

@ -178,19 +178,19 @@ Type: 'help' for help on commands
<para><link
xlink:href="http://libguestfs.org/virt-sparsify.1.html"
>virt-sparsify</link> for making an image
sparse</para>
sparse.</para>
</listitem>
<listitem>
<para><link
xlink:href="http://libguestfs.org/virt-v2v/"
>virt-p2v</link> for converting a physical
machine to an image that runs on KVM</para>
machine to an image that runs on KVM.</para>
</listitem>
<listitem>
<para><link
xlink:href="http://libguestfs.org/virt-v2v/"
>virt-v2v</link> for converting Xen and
VMware images to KVM images</para>
VMware images to KVM images.</para>
</listitem>
</itemizedlist></para>
<simplesect>
@ -213,7 +213,7 @@ Type: 'help' for help on commands
</simplesect>
<simplesect>
<title>Resize an image</title>
<para>Here's a simple of example of how to use
<para>Here is an example of how to use
<command>virt-resize</command> to resize an image.
Assume we have a 16&nbsp;GB Windows image in qcow2 format
that we want to resize to 50&nbsp;GB. First, we use
@ -275,7 +275,7 @@ disk, carefully check that the resized disk boots and works correctly.
<simplesect>
<title>Mount a raw image (without LVM)</title>
<para>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
<command>losetup</command> command to find an
unused loop device.
<screen><prompt>#</prompt> <userinput>losetup -f</userinput>
@ -310,7 +310,7 @@ brw-rw---- 1 root disk 43, 51 2012-03-05 15:32 /dev/mapper/loop0p3</computeroutp
<title>Mount a raw image (with LVM)</title>
<para>If your partitions are managed with LVM, use losetup
and kpartx as in the previous example to expose the
partitions to the host:</para>
partitions to the host.</para>
<screen><prompt>#</prompt> <userinput>losetup -f</userinput>
<computeroutput>/dev/loop0</computeroutput>
<prompt>#</prompt> <userinput>losetup /dev/loop0 rhel62.img</userinput>

6
doc/image-guide/ch_obtaining_images.xml
View File

@ -11,7 +11,7 @@
<section xml:id="centos-images">
<title>CentOS images</title>
<para>The CentOS project maintains official images for direct
download:</para>
download.</para>
<itemizedlist>
<listitem>
<para>
@ -36,7 +36,7 @@
<para>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 <link
xlink:href="http://download.cirros-cloud.net/0.3.3/cirros-0.3.3-x86_64-disk.img"
>cirros-0.3.3-x86_64-disk.img</link>
>cirros-0.3.3-x86_64-disk.img</link>.
<note>
<para>In a CirrOS image, the login account is <literal>cirros</literal>. The
password is <literal>cubswin:)</literal></para>
@ -66,7 +66,7 @@
<para>
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.
</para>
<itemizedlist>
<listitem>

18
doc/image-guide/ch_openstack_images.xml
View File

@ -12,7 +12,7 @@
<?dbhtml stop-chunking?>
<para>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 <link
xlink:href="https://cloudinit.readthedocs.org/en/latest/"
><package>cloud-init</package></link> package. Read
@ -106,11 +106,11 @@
<itemizedlist>
<listitem>
<para>The partition table for the image describes
the original size of the image</para>
the original size of the image.</para>
</listitem>
<listitem>
<para>The file system for the image fills the
original size of the image</para>
original size of the image.</para>
</listitem>
</itemizedlist>
<para>Then, during the boot process, you must:</para>
@ -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:</para>
<itemizedlist>
@ -256,18 +256,18 @@
<para>Replace
<filename>/etc/udev/rules.d/70-persistent-net.rules</filename>
with an empty file (contains network persistence
rules, including MAC address)</para>
rules, including MAC address).</para>
</listitem>
<listitem>
<para>Replace
<filename>/lib/udev/rules.d/75-persistent-net-generator.rules</filename>
with an empty file (this generates the file
above)</para>
above).</para>
</listitem>
<listitem>
<para>Remove the HWADDR line from
<filename>/etc/sysconfig/network-scripts/ifcfg-eth0</filename>
on Fedora-based images</para>
on Fedora-based images.</para>
</listitem>
</itemizedlist>
<note>
@ -386,7 +386,7 @@ done</programlisting>
(cloud-init)</title>
<para>In addition to the ssh public key, an image might need
additional information from OpenStack, such as <link
xlink:href="http://docs.openstack.org/user-guide/enduser/cli_provide_user_data_to_instances.html"
xlink:href="http://docs.openstack.org/user-guide/cli_provide_user_data_to_instances.html"
>Provide user data to instances</link>, 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</programlisting>
user data content as a script on boot.</para>
<para>You can access this information through the metadata
service or referring to <link
xlink:href="http://docs.openstack.org/user-guide/enduser/cli_config_drive.html"
xlink:href="http://docs.openstack.org/user-guide/cli_config_drive.html"
>Store metadata on the configuration drive</link>. As the OpenStack metadata
service is compatible with version 2009-04-04 of the
Amazon EC2 metadata service, consult the Amazon EC2

BIN
doc/image-guide/figures/virt-manager-new.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 30 KiB

4
doc/image-guide/section_centos-example.xml
View File

@ -93,7 +93,7 @@
<imagedata fileref="figures/install-method.png" format="PNG" contentwidth="6in"/>
</imageobject>
</mediaobject>
<para>Depending on the version of CentOS, the net installer requires that the user specify
<para>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
<literal>http://mirror.umd.edu/centos/6/os/x86_64</literal>.</para>
@ -150,7 +150,7 @@
</simplesect>
<simplesect>
<title>Detach the CD-ROM and reboot</title>
<para>After the install completes, the <guilabel>Congratulations, your CentOS installation
<para>When the installation has completed, the <guilabel>Congratulations, your CentOS installation
is complete</guilabel> screen appears.</para>
<mediaobject>
<imageobject>

6
doc/image-guide/section_freebsd-example.xml
View File

@ -247,9 +247,9 @@ https://raw.github.com/pellaeon/bsd-cloudinit-installer/master/installer.sh</use
<step>
<para>Run the installer:</para>
<screen><prompt>#</prompt> <userinput>sh ./installer.sh</userinput></screen>
<para>The installer installs necessary prerequisites and
downloads and installs the latest
<package>bsd-cloudinit</package>.</para>
<para>Issue this command to download and install the latest
<package>bsd-cloudinit</package> package, and install the
necessary prerequisites.</para>
</step>
<step>
<para>Install <package>sudo</package> and configure the

28
doc/image-guide/section_glance_image-formats.xml
View File

@ -18,46 +18,46 @@
following values:</para>
<itemizedlist>
<listitem>
<para><literal>raw</literal>. An unstructured disk
<para><literal>raw</literal>: An unstructured disk
image format; if you have a file without an
extension it is possibly a raw format</para>
extension it is possibly a raw format.</para>
</listitem>
<listitem>
<para><literal>vhd</literal>. The VHD disk format, a
<para><literal>vhd</literal>: The VHD disk format, a
common disk format used by virtual machine
monitors from VMware, Xen, Microsoft, VirtualBox,
and others</para>
and others.</para>
</listitem>
<listitem>
<para><literal>vmdk</literal>. Common disk format
<para><literal>vmdk</literal>: Common disk format
supported by many common virtual machine
monitors</para>
monitors.</para>
</listitem>
<listitem>
<para><literal>vdi</literal>. Supported by VirtualBox
<para><literal>vdi</literal>: Supported by VirtualBox
virtual machine monitor and the QEMU
emulator</para>
emulator.</para>
</listitem>
<listitem>
<para><literal>iso</literal>. An archive format for
<para><literal>iso</literal>: An archive format for
the data contents of an optical disc, such as
CD-ROM.</para>
</listitem>
<listitem>
<para><literal>qcow2</literal>. Supported by the QEMU
<para><literal>qcow2</literal>: Supported by the QEMU
emulator that can expand dynamically and supports
Copy on Write</para>
Copy on Write.</para>
</listitem>
<listitem>
<para><literal>aki</literal>. An Amazon kernel
<para><literal>aki</literal>: An Amazon kernel
image.</para>
</listitem>
<listitem>
<para><literal>ari</literal>. An Amazon ramdisk
<para><literal>ari</literal>: An Amazon ramdisk
image.</para>
</listitem>
<listitem>
<para><literal>ami</literal>. An Amazon machine
<para><literal>ami</literal>: An Amazon machine
image.</para>
</listitem>
</itemizedlist>