openstack-manuals/doc/image-guide/section_glance-image-metadata.xml
Don Domingo 3e1100a70a Applied conventions for "e.g."
As per convention, we should avoid using "e.g." (we should use "for
example" instead). Found and replaced them accordingly; didn't touch
instances that looked copy-pasted from stdout.

Change-Id: I45aae1a30b872f916744a6a33f6888abe8cf6eb0
Partial-Bug: #1217503
2014-01-20 19:59:27 +01:00

716 lines
37 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="image-metadata">
<title>Image metadata</title>
<?dbhtml stop-chunking?>
<para>You can associate metadata with an image using the <literal>--property
<replaceable>key</replaceable>=<replaceable>value</replaceable></literal>
argument to <command>glance image-create</command> or <command>glance
image-update</command>. For
example:</para>
<screen><prompt>$</prompt> <userinput>glance image-update <replaceable>img-uuid</replaceable> --property architecture=arm --property hypervisor_type=qemu</userinput></screen>
<para>If the following properties are set on an image, and the ImagePropertiesFilter scheduler
filter is enabled (which it is by default), then the scheduler will only consider
compute hosts that satisfy these properties:</para>
<variablelist xml:id="image-metadata-properties">
<varlistentry>
<term>architecture</term>
<listitem>
<para>The CPU architecture that must be supported by
the hypervisor. For example,
<literal>x86_64</literal>, <literal>arm</literal>, or <literal>ppc64</literal>. Run
<command>uname -m</command> to get the architecture of a
machine. We strongly recommend using the architecture data vocabulary
defined by the <link xlink:href="http://libosinfo.org">libosinfo project</link>
for this purpose. Recognized values for this field are:
<variablelist xml:id="image-architecture" spacing="compact">
<varlistentry>
<term><literal>alpha</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/DEC_Alpha"
>DEC 64-bit RISC</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>armv7l</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/ARM_architecture"
>ARM Cortex-A7 MPCore</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>cris</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/ETRAX_CRIS"
>Ethernet, Token Ring, AXis - Code Reduced Instruction Set</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>i686</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/X86"
>Intel sixth-generation x86</link>
(P6 micro architecture)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ia64</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/Itanium"
>Itanium</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>lm32</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/Milkymist"
>Lattice Micro32</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>m68k</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/Motorola_68000_family"
>Motorola 68000</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>microblaze</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/MicroBlaze"
>Xilinx 32-bit FPGA (Big Endian)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>microblazeel</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/MicroBlaze"
>Xilinx 32-bit FPGA (Little Endian)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>mips</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/MIPS_architecture"
>MIPS 32-bit RISC (Big Endian)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>mipsel</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/MIPS_architecture"
>MIPS 32-bit RISC (Little Endian)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>mips64</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/MIPS_architecture"
>MIPS 64-bit RISC (Big Endian)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>mips64el</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/MIPS_architecture"
>MIPS 64-bit RISC (Little Endian)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>openrisc</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/OpenRISC#QEMU_support"
>OpenCores RISC</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>parisc</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/PA-RISC"
>HP Precision Architecture RISC</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>parisc64</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/PA-RISC"
>HP Precision Architecture 64-bit RISC</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ppc</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/PowerPC"
>PowerPC 32-bit</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ppc64</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/PowerPC"
>PowerPC 64-bit</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ppcemb</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/PowerPC"
>PowerPC (Embedded 32-bit)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>s390</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/S390"
>IBM Enterprise Systems Architecture/390</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>s390x</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/S390x"
>S/390 64-bit</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>sh4</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/SuperH"
>SuperH SH-4 (Little Endian)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>sh4eb</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/SuperH"
>SuperH SH-4 (Big Endian)</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>sparc</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/Sparc"
>Scalable Processor Architecture, 32-bit</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>sparc64</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/Sparc"
>Scalable Processor Architecture, 64-bit</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>unicore32</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/Unicore"
>Microprocessor Research and Development Center
RISC Unicore32</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>x86_64</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/X86"
>64-bit extension of IA-32</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>xtensa</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/Xtensa#Processor_Cores"
>Tensilica Xtensa configurable microprocessor core</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>xtensaeb</literal></term>
<listitem>
<para>
<link xlink:href="http://en.wikipedia.org/wiki/Xtensa#Processor_Cores"
>Tensilica Xtensa configurable microprocessor core
(Big Endian)</link>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>hypervisor_type</term>
<listitem>
<para>The hypervisor type. Allowed values include: <literal>xen</literal>,
<literal>qemu</literal>, <literal>kvm</literal>,
<literal>lxc</literal>, <literal>uml</literal>,
<literal>vmware</literal>, <literal>hyperv</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>vm_mode</term>
<listitem>
<para>The virtual machine mode. This represents the host/guest ABI
(application binary interface) used for the virtual machine. Allowed
values are:<variablelist>
<varlistentry>
<term><literal>hvm</literal></term>
<listitem>
<para>Fully virtualized. This is the mode used by QEMU and
KVM.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>xen</literal></term>
<listitem>
<para>Xen 3.0 paravirtualized.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>uml</literal></term>
<listitem>
<para>User Mode Linux paravirtualized.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>exe</literal></term>
<listitem>
<para>Executables in containers. This is the mode used by
LXC.</para>
</listitem>
</varlistentry>
</variablelist></para>
</listitem>
</varlistentry>
</variablelist><para>The following metadata properties are specific to the XenAPI driver:</para><variablelist>
<varlistentry>
<term>auto_disk_config</term>
<listitem>
<para>A boolean option. If true, the root partition on the disk will be
automatically resized before the instance boots. This value is only
taken into account by the Compute service when using a Xen-based
hypervisor with the XenAPI driver. The Compute service will only attempt
to resize if there is a single partition on the image, and only if the
partition is in ext3 or ext4 format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>os_type</term>
<listitem>
<para>The operating system installed on the image. For
example,
<literal>linux</literal> or <literal>windows</literal>. The XenAPI
driver contains logic that will take different actions depending on the
value of the os_type parameter of the image. For example, for images
where <literal>os_type=windows</literal>, it creates a FAT32-based
swap partition instead of a Linux swap partition, and it limits the
injected host name to less than 16 characters.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The following metadata properties are specific to
the libvirt API driver:
<variablelist>
<varlistentry>
<term>hw_video_model</term>
<listitem>
<para>The video image driver used. Allowed
values include: <literal>vga</literal>,
<literal>cirrus</literal>,
<literal>vmvga</literal>, <literal>xen</literal>
and <literal>qxl</literal>.</para>
</listitem>
</varlistentry>
</variablelist></para>
<para>The following metadata properties are specific to the VMware API driver:</para>
<variablelist>
<varlistentry>
<term>vmware_adaptertype</term>
<listitem>
<para>Indicates the virtual SCSI or IDE controller used by the hypervisor.
Allowed values: <literal>lsiLogic</literal>,
<literal>busLogic</literal>, <literal>ide</literal></para>
</listitem>
</varlistentry>
<varlistentry>
<term>vmware_ostype</term>
<listitem>
<para>A VMware GuestID which describes the operating system installed in the
image. This will be passed to the hypervisor when creating a virtual
machine. See <link xlink:href="http://www.thinkvirt.com/?q=node/181"
>thinkvirt.com</link> for a list of valid values. If this is not
specified, it will default to <literal>otherGuest</literal>.</para>
</listitem>
</varlistentry>
</variablelist><variablelist>
<varlistentry>
<term>vmware_image_version</term>
<listitem>
<para>Currently unused, set it to <literal>1</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>To assist end-users in utilizing images, you may wish to put additional
common metadata on Glance images. By community agreement, the following metadata
keys may be used across Glance installations for the purposes described, as follows.</para>
<variablelist>
<varlistentry>
<term>instance_uuid</term>
<listitem>
<para>
For snapshot images, this is the UUID of the server used to create this image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>kernel_id</term>
<listitem>
<para>
The ID of image stored in Glance that should be used as the kernel when
booting an AMI-style image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ramdisk_id</term>
<listitem>
<para>
The ID of image stored in Glance that should be used as the ramdisk when
booting an AMI-style image.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>os_version</term>
<listitem>
<para>
The operating system version as specified by the distributor.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>os_distro</term>
<listitem>
<para>
The value of this property is the common name of the operating system
distribution in all-lowercase. For this purpose, we use the same data
vocabulary as the <link xlink:href="http://libosinfo.org"
>libosinfo project</link>. Following are the recognized values for
this property. In the interest of interoperability, please use only
a recognized value for this field. The deprecated values are listed
to assist you in searching for the recognized value. Allowed values
are:
<variablelist>
<varlistentry>
<term><literal>arch</literal></term>
<listitem>
<para>
This is: Arch Linux
</para>
<para>
Do not use:
<literal>archlinux</literal>, or
<literal>org.archlinux</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>centos</literal></term>
<listitem>
<para>
This is: Community Enterprise Operating System
</para>
<para>
Do not use:
<literal>org.centos</literal>, or
<literal>CentOS</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>debian</literal></term>
<listitem>
<para>
This is: Debian
</para>
<para>
Do not use:
<literal>Debian</literal>, or
<literal>org.debian</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>fedora</literal></term>
<listitem>
<para>
This is: Fedora
</para>
<para>
Do not use:
<literal>Fedora</literal>,
<literal>org.fedora</literal>, or
<literal>org.fedoraproject</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>freebsd</literal></term>
<listitem>
<para>
This is: FreeBSD
</para>
<para>
Do not use:
<literal>org.freebsd</literal>,
<literal>freeBSD</literal>, or
<literal>FreeBSD</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>gentoo</literal></term>
<listitem>
<para>
This is: Gentoo Linux
</para>
<para>
Do not use:
<literal>Gentoo</literal>, or
<literal>org.gentoo</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>mandrake</literal></term>
<listitem>
<para>
This is: Mandrakelinux (MandrakeSoft)
</para>
<para>
Do not use:
<literal>mandrakelinux</literal>, or
<literal>MandrakeLinux</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>mandriva</literal></term>
<listitem>
<para>
This is: Mandriva Linux
</para>
<para>
Do not use:
<literal>mandrivalinux</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>mes</literal></term>
<listitem>
<para>
This is: Mandriva Enterprise Server
</para>
<para>
Do not use:
<literal>mandrivaent</literal>, or
<literal>mandrivaES</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>msdos</literal></term>
<listitem>
<para>
This is: Microsoft Disc Operating System
</para>
<para>
Do not use:
<literal>ms-dos</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>netbsd</literal></term>
<listitem>
<para>
This is: NetBSD
</para>
<para>
Do not use:
<literal>NetBSD</literal>, or
<literal>org.netbsd</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>netware</literal></term>
<listitem>
<para>
This is: Novell NetWare
</para>
<para>
Do not use:
<literal>novell</literal>, or
<literal>NetWare</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>openbsd</literal></term>
<listitem>
<para>
This is: OpenBSD
</para>
<para>
Do not use:
<literal>OpenBSD</literal>, or
<literal>org.openbsd</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>opensolaris</literal></term>
<listitem>
<para>
Do not use:
<literal>OpenSolaris</literal>,or
<literal>org.opensolaris</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>opensuse</literal></term>
<listitem>
<para>
This is: openSUSE
</para>
<para>
Do not use:
<literal>suse</literal>,
<literal>SuSE</literal>, or
<literal>org.opensuse</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>rhel</literal></term>
<listitem>
<para>
This is: Red Hat Enterprise Linux
</para>
<para>
Do not use:
<literal>redhat</literal>,
<literal>RedHat</literal>, or
<literal>com.redhat</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>sled</literal></term>
<listitem>
<para>
This is: SUSE Linux Enterprise Desktop
</para>
<para>
Do not use:
<literal>com.suse</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ubuntu</literal></term>
<listitem>
<para>
This is: Ubuntu
</para>
<para>
Do not use:
<literal>Ubuntu</literal>,
<literal>com.ubuntu</literal>,
<literal>org.ubuntu</literal>, or
<literal>canonical</literal>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>windows</literal></term>
<listitem>
<para>
This is: Microsoft Windows
</para>
<para>
Do not use:
<literal>com.microsoft.server</literal>, or
<literal>windoze</literal>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</section>