openstack/openstack-manuals
Code Issues Proposed changes

removed unnecessary spaces

Browse Source 
'<para> ' --> '<para>'
'. </para>' --> '.</para>'
'<listitem> ' --> '<listitem>'
'. </listitem>' --> '.</listitem>'
'<td> ' --> '<td>'
'. </td>' --> '.</td>'

Change-Id: Ib30729297f0e05cb85d79ba6780a9d0ff1b8daf7
This commit is contained in:
Christian Berendt 2013-08-02 18:00:26 +02:00
parent 06cd588129
commit 421a8d732e
237 changed files with 1811 additions and 1811 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/src/docbkx/basic-install/src/basic-install_architecture.xml
View File

@ -25,14 +25,14 @@
Compute service, such as the API server, the scheduler,
conductor, console authenticator, and VNC service.
Finally, it hosts the API endpoint for the OpenStack
Network service. </para>
Network service.</para>
</listitem>
<listitem>
<para><emphasis role="bold">The Network
Controller</emphasis>. Provides the bulk of the
OpenStack Network services such as DHCP, layer 2
switching, layer 3 routing, floating IPs (which this
guide does not configure), and metadata connectivity. </para>
guide does not configure), and metadata connectivity.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Compute Node</emphasis>. Runs
@ -41,7 +41,7 @@
plugin agent). This server also manages an
OpenStack-compatible hypervisor such as KVM or Xen.
This server hosts the actual virtual machines
(instances). </para>
(instances).</para>
</listitem>
</itemizedlist>
<note><para>OpenStack provides great flexibility with regard to how its
@ -49,7 +49,7 @@
that run on the Network Controller can easily be installed on
the Cloud Controller. As another example, the OpenStack Image
service can be installed on its own server (or many servers to
provide a more highly available service). </para>
provide a more highly available service).</para>
</note>
<para>With regard to cloud networking, a standard OpenStack
Network setup can have up to four distinct physical data
@ -88,7 +88,7 @@
possible to create a subnet for the external
network that uses IP allocation ranges to use only
less than the full range of IP addresses in an IP
block. </para>
block.</para>
</listitem>
</itemizedlist>
</chapter>

2
doc/src/docbkx/basic-install/src/basic-install_compute-common.xml
View File

@ -115,7 +115,7 @@ ONBOOT=yes
<para>Install NTP:
<itemizedlist>
<listitem>
<para>
<para>
<screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install ntp</userinput></screen>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>yum install ntp</userinput></screen>
</para>

2
doc/src/docbkx/basic-install/src/basic-install_controller-common.xml
View File

@ -168,7 +168,7 @@ ONBOOT=yes
<para>Install NTP. NTP ensures that the server has the correct time. This is important because if an OpenStack server's time is
not correct, it is removed from the rest of the cloud.<itemizedlist>
<listitem>
<para>
<para>
<screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install ntp</userinput></screen>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>yum install ntp</userinput></screen>
</para>

2
doc/src/docbkx/basic-install/src/basic-install_controller-keystone.xml
View File

@ -67,7 +67,7 @@ export OS_SERVICE_TOKEN=password</programlisting></para>
<para>Source the credentials into your environment: <screen><userinput>source ~/openrc</userinput></screen></para>
</listitem>
<listitem>
<para> Configure the Bash shell to load these credentials upon each login:
<para>Configure the Bash shell to load these credentials upon each login:
<screen><userinput>echo "source ~/openrc" >> ~/.bashrc</userinput></screen>
</para>
</listitem>

4
doc/src/docbkx/basic-install/src/basic-install_intro.xml
View File

@ -16,7 +16,7 @@
Ringtail) and the most recent LTS (Long Term Support)
version which is 12.04 (Precise Pangolin), via the
Ubuntu Cloud Archive. At this time, there are not
packages available for 12.10. </para>
packages available for 12.10.</para>
</note>
<para>We are going to install a three-node setup with one
controller, one network and one compute node.</para>
@ -26,7 +26,7 @@
options. These options specify the default setting. You only
need to uncomment these lines if you are changing the setting
to a non-default value. Additionally, this guide only shows options that are being
modified from their default value. </para>
modified from their default value.</para>
<para>Finally, please be aware that the use of <literal>password</literal>
as a password throughout this guide is for simplicity and
testing purposes. Please ensure you use proper passwords when

2
doc/src/docbkx/basic-install/src/basic-install_network-common.xml
View File

@ -157,7 +157,7 @@ ONBOOT=yes
<listitem>
<para>Install NTP:<itemizedlist>
<listitem>
<para>
<para>
<screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install ntp</userinput></screen>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>yum install ntp</userinput></screen>
</para>

6
doc/src/docbkx/basic-install/src/basic-install_operate.xml
View File

@ -14,7 +14,7 @@
<para>Create a personal keypair, <filename>default_key</filename>.</para>
<note><para>If you see an Error: Unable to create keypair: Key pair 'default_key' already exists, it may have been created using the command-line method below.</para></note>
</step>
<step><para>Modify the permissions on the keypair file, <filename>default_key</filename>. </para>
<step><para>Modify the permissions on the keypair file, <filename>default_key</filename>.</para>
<screen><prompt>#</prompt> <userinput>chmod 400 default_key</userinput></screen></step>
<step>
<para>Go to "Instances" and click "Launch Instance" for spawning a new
@ -34,7 +34,7 @@
<prompt>#</prompt> <userinput>nova keypair-add --pub_key ~/.ssh/id_rsa.pub default_key</userinput> </screen></para>
<note><para>If you see an Error: Unable to create keypair: Key pair 'default_key' already exists, it may have been created using the Dashboard method above.</para></note>
</step>
<step><para>Modify the permissions on the keypair file, <filename>default_key</filename>. </para>
<step><para>Modify the permissions on the keypair file, <filename>default_key</filename>.</para>
<screen><prompt>#</prompt> <userinput>chmod 400 default_key</userinput></screen></step>
</procedure>
@ -80,7 +80,7 @@
beginning with
<literal>qrouter</literal> and the
other beginning with
<literal>qdhcp</literal>. </para>
<literal>qdhcp</literal>.</para>
</step>
<step>
<para>Run SSH inside the

2
doc/src/docbkx/basic-install/src/bk-basic-install.xml
View File

@ -51,7 +51,7 @@
</legalnotice>
<abstract>
<para>This document is for administrators who install
OpenStack on various Linux distributions. </para>
OpenStack on various Linux distributions.</para>
</abstract>
<revhistory>
<revision>

6
doc/src/docbkx/cli-guide/src/bk-cli-guide.xml
View File

@ -72,7 +72,7 @@
protocol, including methods, URIs, media types, and
response codes. To request OpenStack services, you
must first issue an authentication request to the
OpenStack Identity Service v2.0. </para>
OpenStack Identity Service v2.0.</para>
</abstract>
<revhistory>
<!-- ... continue addding more revisions here as you change this document using the markup shown below... -->
@ -116,11 +116,11 @@
<itemizedlist spacing="compact">
<listitem>
<para>Added front matter to and
reorganized the book. </para>
reorganized the book.</para>
</listitem>
<listitem>
<para>Moved authentication to the
installation chapter. </para>
installation chapter.</para>
</listitem>
<listitem>
<para>Added the cinder client.</para>

2
doc/src/docbkx/cli-guide/src/ch_client_overview.xml
View File

@ -34,7 +34,7 @@ format="SVG" scale="60"/>
<?dbhtml stop-chunking?>
<para>To manage your servers, images, volumes, isolated networks,
and other cloud resources from the command line, install and
use the OpenStack clients. </para>
use the OpenStack clients.</para>
<xi:include href="../../common/cli_overview.xml"/>
<xi:include href="../../common/cli_install.xml"/>
<xi:include href="../../common/section_cli_openrc.xml"/>

4
doc/src/docbkx/cli-guide/src/cli_troubleshooting.xml
View File

@ -5,7 +5,7 @@
xml:id="troubleshooting_cli">
<title>Troubleshooting</title>
<para>The CLI clients are considered to be software in
development. </para>
development.</para>
<itemizedlist>
<listitem>
<para>If you cannot run commands successfully, make sure
@ -27,7 +27,7 @@ OS_TENANT_NAME=coolu</literallayout>
<listitem>
<para>If you change any environment variables,
either log out and back in or source your bash
profile again. </para>
profile again.</para>
</listitem>
<listitem>
<para>To override some environment variable

2
doc/src/docbkx/cli-guide/src/glance_cli_howto.xml
View File

@ -7,7 +7,7 @@
xml:id="glance_client">
<?dbhtml stop-chunking?>
<title>glance command-line client</title>
<para>Learn how to use the glance client to create and manage images. </para>
<para>Learn how to use the glance client to create and manage images.</para>
<xi:include
href="../../common/section_cli_manage_images.xml"/>
<xi:include

10
doc/src/docbkx/cli-guide/src/neutron_cli_howto.xml
View File

@ -22,19 +22,19 @@
<para><emphasis role="bold">Positional
arguments</emphasis>. Mandatory arguments that
must be specified in a specific order. </para>
must be specified in a specific order.</para>
</listitem>
<listitem xml:id="neutron_overview_command_unknown">
<para><emphasis role="bold">Unknown
options</emphasis>. Complement the known
arguments. </para>
arguments.</para>
<para>To define an unknown option, use the
format:</para>
<screen><userinput>--optionname [type=int|bool|dict...][list=true] [optionvalue]*</userinput></screen>
<para>You can specify multiple option values for an
option name. When no option value is specified,
the option defaults to <literal>bool</literal>
with a value of <literal>true</literal>. </para>
with a value of <literal>true</literal>.</para>
<para>The type is python built-in type, such as
<literal>int</literal>,
@ -216,7 +216,7 @@ CSV Formatter:
return. A sample of such URLs is:
<literal>http://localhost:9696/v2.0/networks.json?fields=id&amp;fields=name</literal></para>
<para> Neutron client supports this feature by
<para>Neutron client supports this feature by
<literal>-F</literal> option in known options part
and <literal>--fields</literal> in unknown options
part. For example, <literal>neutron -F id net-list --
@ -239,7 +239,7 @@ CSV Formatter:
options in unknown option part. For example
<literal>neutron net-list -- --name test1
test2</literal>. Only <literal>xx-list</literal>
commands support this feature. </para>
commands support this feature.</para>
</section>
</section>

2
doc/src/docbkx/common/about-dashboard.xml
View File

@ -21,7 +21,7 @@
</listitem>
<listitem>
<para>Verify your installation by going to the URL of the
Apache server you configured. </para>
Apache server you configured.</para>
</listitem>
</orderedlist>
<simplesect>

88
doc/src/docbkx/common/adding-images.xml
View File

@ -5,7 +5,7 @@
xml:id="adding-images">
<title>Adding images with glance image-create</title>
<para>To add a virtual machine image to glance, use the
<command>glance image-create</command> command. </para>
<command>glance image-create</command> command.</para>
<para>To modify image properties, use the <command>glance
image-update</command> command.</para>
<para>The <command>image-create</command> command requires that you
@ -30,7 +30,7 @@
<para>If you set the following properties on an image, and the
ImagePropertiesFilter scheduler filter is enabled, which is the
default, the scheduler only considers compute hosts that satisfy
these properties. </para>
these properties.</para>
<para><parameter>architecture</parameter>: The CPU architecture
that must be supported by the hypervisor, e.g.
@ -332,7 +332,7 @@
<term>vmware_image_version</term>
<listitem>
<para>Currently unused. Set it to
<literal>1</literal>. </para>
<literal>1</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
@ -344,7 +344,7 @@
<term>instance_uuid</term>
<listitem>
<para>For snapshot images, the UUID of the server
used to create this image. </para>
used to create this image.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -352,7 +352,7 @@
<listitem>
<para>The ID of image stored in Glance that should
be used as the kernel when booting an AMI-style
image. </para>
image.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -360,14 +360,14 @@
<listitem>
<para>The ID of image stored in Glance that should
be used as the ramdisk when booting an AMI-style
image. </para>
image.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>os_version</term>
<listitem>
<para>The operating system version as specified by
the distributor. </para>
the distributor.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -387,8 +387,8 @@
<varlistentry>
<term><literal>arch</literal></term>
<listitem>
<para> This is: Arch Linux </para>
<para> Do not use:
<para>This is: Arch Linux </para>
<para>Do not use:
<literal>archlinux</literal>, or
<literal>org.archlinux</literal>
</para>
@ -397,9 +397,9 @@
<varlistentry>
<term><literal>centos</literal></term>
<listitem>
<para> This is: Community Enterprise
<para>This is: Community Enterprise
Operating System </para>
<para> Do not use:
<para>Do not use:
<literal>org.centos</literal>
<literal>CentOS</literal>
</para>
@ -408,8 +408,8 @@
<varlistentry>
<term><literal>debian</literal></term>
<listitem>
<para> This is: Debian </para>
<para> Do not use:
<para>This is: Debian </para>
<para>Do not use:
<literal>Debian</literal>, or
<literal>org.debian</literal>
</para>
@ -418,8 +418,8 @@
<varlistentry>
<term><literal>fedora</literal></term>
<listitem>
<para> This is: Fedora </para>
<para> Do not use:
<para>This is: Fedora </para>
<para>Do not use:
<literal>Fedora</literal>,
<literal>org.fedora</literal>, or
<literal>org.fedoraproject</literal>
@ -429,8 +429,8 @@
<varlistentry>
<term><literal>freebsd</literal></term>
<listitem>
<para> This is: FreeBSD </para>
<para> Do not use:
<para>This is: FreeBSD </para>
<para>Do not use:
<literal>org.freebsd</literal>,
<literal>freeBSD</literal>, or
<literal>FreeBSD</literal>
@ -440,8 +440,8 @@
<varlistentry>
<term><literal>gentoo</literal></term>
<listitem>
<para> This is: Gentoo Linux </para>
<para> Do not use:
<para>This is: Gentoo Linux </para>
<para>Do not use:
<literal>Gentoo</literal>, or
<literal>org.gentoo</literal>
</para>
@ -450,8 +450,8 @@
<varlistentry>
<term><literal>mandrake</literal></term>
<listitem>
<para> This is: Mandrakelinux (MandrakeSoft) </para>
<para> Do not use:
<para>This is: Mandrakelinux (MandrakeSoft) </para>
<para>Do not use:
<literal>mandrakelinux</literal>, or
<literal>MandrakeLinux</literal>
</para>
@ -460,8 +460,8 @@
<varlistentry>
<term><literal>mandriva</literal></term>
<listitem>
<para> This is: Mandriva Linux </para>
<para> Do not use:
<para>This is: Mandriva Linux </para>
<para>Do not use:
<literal>mandrivalinux</literal>
</para>
</listitem>
@ -469,8 +469,8 @@
<varlistentry>
<term><literal>mes</literal></term>
<listitem>
<para> This is: Mandriva Enterprise Server </para>
<para> Do not use:
<para>This is: Mandriva Enterprise Server </para>
<para>Do not use:
<literal>mandrivaent</literal>, or
<literal>mandrivaES</literal>
</para>
@ -479,17 +479,17 @@
<varlistentry>
<term><literal>msdos</literal></term>
<listitem>
<para> This is: Microsoft Disc Operating
<para>This is: Microsoft Disc Operating
System </para>
<para> Do not use: <literal>ms-dos</literal>
<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:
<para>This is: NetBSD </para>
<para>Do not use:
<literal>NetBSD</literal>, or
<literal>org.netbsd</literal>
</para>
@ -498,8 +498,8 @@
<varlistentry>
<term><literal>netware</literal></term>
<listitem>
<para> This is: Novell NetWare </para>
<para> Do not use:
<para>This is: Novell NetWare </para>
<para>Do not use:
<literal>novell</literal>, or
<literal>NetWare</literal>
</para>
@ -508,8 +508,8 @@
<varlistentry>
<term><literal>openbsd</literal></term>
<listitem>
<para> This is: OpenBSD </para>
<para> Do not use:
<para>This is: OpenBSD </para>
<para>Do not use:
<literal>OpenBSD</literal>, or
<literal>org.openbsd</literal>
</para>
@ -518,7 +518,7 @@
<varlistentry>
<term><literal>opensolaris</literal></term>
<listitem>
<para> Do not use:
<para>Do not use:
<literal>OpenSolaris</literal>,or
<literal>org.opensolaris</literal>
</para>
@ -527,8 +527,8 @@
<varlistentry>
<term><literal>opensuse</literal></term>
<listitem>
<para> This is: openSUSE </para>
<para> Do not use: <literal>suse</literal>,
<para>This is: openSUSE </para>
<para>Do not use: <literal>suse</literal>,
<literal>SuSE</literal>, or
<literal>org.opensuse</literal>
</para>
@ -537,8 +537,8 @@
<varlistentry>
<term><literal>rhel</literal></term>
<listitem>
<para> This is: Red Hat Enterprise Linux </para>
<para> Do not use:
<para>This is: Red Hat Enterprise Linux </para>
<para>Do not use:
<literal>redhat</literal>,
<literal>RedHat</literal>, or
<literal>com.redhat</literal>
@ -548,9 +548,9 @@
<varlistentry>
<term><literal>sled</literal></term>
<listitem>
<para> This is: SUSE Linux Enterprise
<para>This is: SUSE Linux Enterprise
Desktop </para>
<para> Do not use:
<para>Do not use:
<literal>com.suse</literal>
</para>
</listitem>
@ -558,8 +558,8 @@
<varlistentry>
<term><literal>ubuntu</literal></term>
<listitem>
<para> This is: Ubuntu </para>
<para> Do not use:
<para>This is: Ubuntu </para>
<para>Do not use:
<literal>Ubuntu</literal>,
<literal>com.ubuntu</literal>,
<literal>org.ubuntu</literal>, or
@ -570,8 +570,8 @@
<varlistentry>
<term><literal>windows</literal></term>
<listitem>
<para> This is: Microsoft Windows </para>
<para> Do not use:
<para>This is: Microsoft Windows </para>
<para>Do not use:
<literal>com.microsoft.server</literal>,
or <literal>windoze</literal>
</para>

48
doc/src/docbkx/common/certificates-for-pki.xml
View File

@ -4,7 +4,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="certificates-for-pki">
<title>Certificates for PKI</title>
<para> PKI stands for Public Key Infrastructure. Tokens are
<para>PKI stands for Public Key Infrastructure. Tokens are
documents, cryptographically signed using the X509 standard.
In order to work correctly token generation requires a
public/private key pair. The public key must be signed in an
@ -15,9 +15,9 @@
generated. The files need to be in the locations specified by
the top level Keystone configuration file as specified in the
above section. Additionally, the private key should only be
readable by the system user that will run Keystone. </para>
readable by the system user that will run Keystone.</para>
<warning>
<para> The certificates can be world readable, but the private
<para>The certificates can be world readable, but the private
key cannot be. The private key should only be readable by
the account that is going to sign tokens. When generating
files with the <command>keystone-mange pki_setup</command>
@ -105,49 +105,49 @@ nouriuiCgFayIqCssK3SVdhOMINiuJtqv0sE-wBDFiEj-Prcudqlz-n+6q7VgV4mwMPszz39-rwp+P5l
SrWY8lF3HrTcJT23sZIleg==</screen></para>
<section xml:id="signing-certificate-issued-by-external-ca">
<title>Signing Certificate Issued by External CA</title>
<para> You may use a signing certificate issued by an external
<para>You may use a signing certificate issued by an external
CA instead of generated by
<command>keystone-manage</command>. However,
certificate issued by external CA must satisfy the
following conditions: </para>
<itemizedlist>
<listitem>
<para> all certificate and key files must be in
<para>all certificate and key files must be in
Privacy Enhanced Mail (PEM) format </para>
</listitem>
<listitem>
<para> private key files must not be protected by a
<para>private key files must not be protected by a
password </para>
</listitem>
</itemizedlist>
<para> When using signing certificate issued by an external
<para>When using signing certificate issued by an external
CA, you do not need to specify
<literal>key_size</literal>,
<literal>valid_days</literal>, and
<literal>ca_password</literal> as they will be
ignored. </para>
<para> The basic workflow for using a signing certificate
ignored.</para>
<para>The basic workflow for using a signing certificate
issued by an external CA involves: </para>
<orderedlist numeration="arabic">
<listitem>
<para> Request Signing Certificate from External CA
<para>Request Signing Certificate from External CA
</para>
</listitem>
<listitem>
<para> Convert certificate and private key to PEM if
<para>Convert certificate and private key to PEM if
needed </para>
</listitem>
<listitem>
<para> Install External Signing Certificate </para>
<para>Install External Signing Certificate </para>
</listitem>
</orderedlist>
</section>
<section xml:id="request-signing-certificate-from-external-ca">
<title>Request Signing Certificate from External CA</title>
<para> One way to request a signing certificate from an
<para>One way to request a signing certificate from an
external CA is to first generate a PKCS #10 Certificate
Request Syntax (CRS) using OpenSSL CLI. </para>
<para> First create a certificate request configuration file
Request Syntax (CRS) using OpenSSL CLI.</para>
<para>First create a certificate request configuration file
(e.g. <literal>cert_req.conf</literal>): </para>
<screen>
[ req ]
@ -167,15 +167,15 @@ organizationalUnitName = Keystone
commonName = Keystone Signing
emailAddress = keystone@openstack.org
</screen>
<para> Then generate a CRS with OpenSSL CLI. <emphasis
<para>Then generate a CRS with OpenSSL CLI. <emphasis
role="strong">Do not encrypt the generated private
key. Must use the -nodes option.</emphasis>
</para>
<para> For example: </para>
<para>For example: </para>
<screen>
openssl req -newkey rsa:1024 -keyout signing_key.pem -keyform PEM -out signing_cert_req.pem -outform PEM -config cert_req.conf -nodes
</screen>
<para> If everything is successfully, you should end up with
<para>If everything is successfully, you should end up with
<literal>signing_cert_req.pem</literal> and
<literal>signing_key.pem</literal>. Send
<literal>signing_cert_req.pem</literal> to your CA to
@ -186,7 +186,7 @@ openssl req -newkey rsa:1024 -keyout signing_key.pem -keyform PEM -out signing_c
</section>
<section xml:id="install-external-signing-certificate">
<title>Install External Signing Certificate</title>
<para> Assuming you have the following already: </para>
<para>Assuming you have the following already: </para>
<itemizedlist>
<listitem>
<para>
@ -204,7 +204,7 @@ openssl req -newkey rsa:1024 -keyout signing_key.pem -keyform PEM -out signing_c
certificate chain in PEM format </para>
</listitem>
</itemizedlist>
<para> Copy the above to your certificate directory. For
<para>Copy the above to your certificate directory. For
example: </para>
<screen>
mkdir -p /etc/keystone/ssl/certs
@ -214,13 +214,13 @@ cp cacert.pem /etc/keystone/ssl/certs/
chmod -R 700 /etc/keystone/ssl/certs
</screen>
<note>
<para> Make sure the certificate directory is only
accessible by root. </para>
<para>Make sure the certificate directory is only
accessible by root.</para>
</note>
<para> If your certificate directory path is different from
<para>If your certificate directory path is different from
the default <literal>/etc/keystone/ssl/certs</literal>,
make sure it is reflected in the
<literal>[signing]</literal> section of the
configuration file. </para>
configuration file.</para>
</section>
</section>

186
doc/src/docbkx/common/ch_identity_mgmt.xml
View File

@ -59,13 +59,13 @@ pipeline = stats_monitoring url_normalize token_auth admin_token_auth xml_body j
<xi:include href="../common/identity-configure.xml"/>
<section xml:id="keystone-logging">
<title>Logging</title>
<para> Logging is configured externally to the rest of Identity,
<para>Logging is configured externally to the rest of Identity,
the file specifying the logging configuration is in the
<literal>[DEFAULT]</literal> section of the
<filename>keystone.conf</filename> file under
<literal>log_config</literal>. If you wish to route all your
logging through syslog, set <literal>use_syslog=true</literal>
option in the <literal>[DEFAULT]</literal> section. </para>
option in the <literal>[DEFAULT]</literal> section.</para>
<para>
A sample logging file is available with the project in the
directory <filename>etc/logging.conf.sample</filename>. Like other
@ -205,10 +205,10 @@ keystone-manage db_sync
<section xml:id="adding-users-tenants-and-roles-with-python-keystoneclient">
<?dbhtml stop-chunking?>
<title>Adding Users, Tenants, and Roles with python-keystoneclient</title>
<para>Only users with admin credentials can administer users, tenants and roles. You can configure the python-keystoneclient with admin credentials through either the authentication token, or the username and password method. </para>
<para>Only users with admin credentials can administer users, tenants and roles. You can configure the python-keystoneclient with admin credentials through either the authentication token, or the username and password method.</para>
<section xml:id="token-auth-method">
<title>Token Auth Method</title>
<para> To use keystone client using token auth, set the following flags:</para>
<para>To use keystone client using token auth, set the following flags:</para>
<itemizedlist>
<listitem>
<para>
@ -220,7 +220,7 @@ keystone-manage db_sync
<listitem>
<para>
<literal>--token SERVICE_TOKEN</literal>. The administrator
service token. </para>
service token.</para>
</listitem>
</itemizedlist>
</section>
@ -229,7 +229,7 @@ keystone-manage db_sync
<itemizedlist>
<listitem>
<para>
<literal>--username OS_USERNAME</literal>. The administrator username. </para>
<literal>--username OS_USERNAME</literal>. The administrator username.</para>
</listitem>
<listitem>
<para>
@ -238,7 +238,7 @@ keystone-manage db_sync
</listitem>
<listitem>
<para>
<literal>--tenant_name OS_TENANT_NAME</literal>. The tenant name. </para>
<literal>--tenant_name OS_TENANT_NAME</literal>. The tenant name.</para>
</listitem>
<listitem>
<para>
@ -261,7 +261,7 @@ keystone-manage db_sync
</listitem>
<listitem>
<para><parameter>--os-identity-api-version</parameter>.
Specifies the Identity Service API version. </para>
Specifies the Identity Service API version.</para>
</listitem></itemizedlist>
<para>For example, the following parameters indicate the use of API
v3:</para> <screen><parameter>--os-url</parameter> <userinput>"http://15.253.57.115:35357/v3"</userinput> <parameter>--os-identity-api-version</parameter> <userinput>3</userinput></screen>
@ -305,19 +305,19 @@ keystone --username=admin --password=secrete --tenant_name=admin tenant-create -
tenant owns virtual machines. In swift, a tenant owns
containers. Users can be associated with more than one tenant.
Each tenant and user pairing can have a role associated with
it. </para>
it.</para>
<section xml:id="tenant-create">
<title><literal>tenant-create</literal></title>
<para> keyword arguments </para>
<para>keyword arguments </para>
<itemizedlist>
<listitem>
<para> name </para>
<para>name </para>
</listitem>
<listitem>
<para> description (optional, defaults to None) </para>
<para>description (optional, defaults to None) </para>
</listitem>
<listitem>
<para> enabled (optional, defaults to True) </para>
<para>enabled (optional, defaults to True) </para>
</listitem>
</itemizedlist>
<para>The following command creates a tenant named
@ -326,39 +326,39 @@ keystone --username=admin --password=secrete --tenant_name=admin tenant-create -
</section>
<section xml:id="tenant-delete">
<title><literal>tenant-delete</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> tenant_id </para>
<para>tenant_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone tenant-delete f2b7b39c860840dfa47d9ee4adffa0b3
</screen>
</section>
<section xml:id="tenant-enable">
<title><literal>tenant-enable</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> tenant_id </para>
<para>tenant_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone tenant-enable f2b7b39c860840dfa47d9ee4adffa0b3
</screen>
</section>
<section xml:id="tenant-disable">
<title><literal>tenant-disable</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> tenant_id </para>
<para>tenant_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone tenant-disable f2b7b39c860840dfa47d9ee4adffa0b3
</screen>
@ -368,25 +368,25 @@ keystone tenant-disable f2b7b39c860840dfa47d9ee4adffa0b3
<title>Users</title>
<section xml:id="user-create">
<title><literal>user-create</literal></title>
<para> keyword arguments: </para>
<para>keyword arguments: </para>
<itemizedlist>
<listitem>
<para> name </para>
<para>name </para>
</listitem>
<listitem>
<para> pass </para>
<para>pass </para>
</listitem>
<listitem>
<para> email </para>
<para>email </para>
</listitem>
<listitem>
<para> default_tenant (optional, defaults to None) </para>
<para>default_tenant (optional, defaults to None) </para>
</listitem>
<listitem>
<para> enabled (optional, defaults to True) </para>
<para>enabled (optional, defaults to True) </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone user-create
--name=admin \
@ -396,88 +396,88 @@ keystone user-create
</section>
<section xml:id="user-delete">
<title><literal>user-delete</literal></title>
<para> keyword arguments: </para>
<para>keyword arguments: </para>
<itemizedlist>
<listitem>
<para> user </para>
<para>user </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone user-delete f2b7b39c860840dfa47d9ee4adffa0b3
</screen>
</section>
<section xml:id="user-list">
<title><literal>user-list</literal></title>
<para> list users in the system, optionally by a specific tenant
<para>list users in the system, optionally by a specific tenant
(identified by tenant_id) </para>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> tenant_id (optional, defaults to None) </para>
<para>tenant_id (optional, defaults to None) </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone user-list
</screen>
</section>
<section xml:id="user-update-email">
<title><literal>user-update --email</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> user_id </para>
<para>user_id </para>
</listitem>
<listitem>
<para> email </para>
<para>email </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone user-update --email 03c84b51574841ba9a0d8db7882ac645 &quot;someone@somewhere.com&quot;
</screen>
</section>
<section xml:id="user-enable">
<title><literal>user-enable</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> user_id </para>
<para>user_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone user-enable 03c84b51574841ba9a0d8db7882ac645
</screen>
</section>
<section xml:id="user-disable">
<title><literal>user-disable</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> user_id </para>
<para>user_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone user-disable 03c84b51574841ba9a0d8db7882ac645
</screen>
</section>
<section xml:id="user-update-password">
<title><literal>user-update --password</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> user_id </para>
<para>user_id </para>
</listitem>
<listitem>
<para> password </para>
<para>password </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone user-update --password 03c84b51574841ba9a0d8db7882ac645 foo
</screen>
@ -487,65 +487,65 @@ keystone user-update --password 03c84b51574841ba9a0d8db7882ac645 foo
<title>Roles</title>
<section xml:id="role-create">
<title><literal>role-create</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> name </para>
<para>name </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone role-create --name=demo
</screen>
</section>
<section xml:id="role-delete">
<title><literal>role-delete</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> role_id </para>
<para>role_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone role-delete 19d1d3344873464d819c45f521ff9890
</screen>
</section>
<section xml:id="role-list">
<title><literal>role-list</literal></title>
<para> example: </para>
<para>example: </para>
<screen>
keystone role-list
</screen>
</section>
<section xml:id="role-get">
<title><literal>role-get</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> role_id </para>
<para>role_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone role-get role=19d1d3344873464d819c45f521ff9890
</screen>
</section>
<section xml:id="add-user-role">
<title><literal>add-user-role</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> role_id </para>
<para>role_id </para>
</listitem>
<listitem>
<para> user_id </para>
<para>user_id </para>
</listitem>
<listitem>
<para> tenant_id </para>
<para>tenant_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone add-user-role \
3a751f78ef4c412b827540b829e2d7dd \
@ -555,19 +555,19 @@ keystone add-user-role \
</section>
<section xml:id="remove-user-role">
<title><literal>remove-user-role</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> role_id </para>
<para>role_id </para>
</listitem>
<listitem>
<para> user_id </para>
<para>user_id </para>
</listitem>
<listitem>
<para> tenant_id </para>
<para>tenant_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone remove-user-role \
19d1d3344873464d819c45f521ff9890 \
@ -580,19 +580,19 @@ keystone remove-user-role \
<title>Services</title>
<section xml:id="service-create">
<title><literal>service-create</literal></title>
<para> keyword arguments </para>
<para>keyword arguments </para>
<itemizedlist>
<listitem>
<para> name </para>
<para>name </para>
</listitem>
<listitem>
<para> type </para>
<para>type </para>
</listitem>
<listitem>
<para> description </para>
<para>description </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone service create \
--name=nova \
@ -602,39 +602,39 @@ keystone service create \
</section>
<section xml:id="service-list">
<title><literal>service-list</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> service_id </para>
<para>service_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone service-list
</screen>
</section>
<section xml:id="service-get">
<title><literal>service-get</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> service_id </para>
<para>service_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone service-get 08741d8ed88242ca88d1f61484a0fe3b
</screen>
</section>
<section xml:id="service-delete">
<title><literal>service-delete</literal></title>
<para> arguments </para>
<para>arguments </para>
<itemizedlist>
<listitem>
<para> service_id </para>
<para>service_id </para>
</listitem>
</itemizedlist>
<para> example: </para>
<para>example: </para>
<screen>
keystone service-delete 08741d8ed88242ca88d1f61484a0fe3b
</screen>
@ -682,11 +682,11 @@ keystone service-delete 08741d8ed88242ca88d1f61484a0fe3b
<para>To ensure services that you add to the catalog know about
the users, tenants, and roles, you must create an admin token
and create service users. These sections walk through those
requirements. </para>
requirements.</para>
<section xml:id="admin-token">
<title>Admin Token</title>
<para> For a default installation of Keystone, before you can
<para>For a default installation of Keystone, before you can
use the REST API, you need to define an authorization token.
This is configured in <filename>keystone.conf</filename> file
under the section <literal>[DEFAULT]</literal>. In the
@ -697,10 +697,10 @@ keystone service-delete 08741d8ed88242ca88d1f61484a0fe3b
[DEFAULT] admin_token = ADMIN
</para>
</blockquote>
<para> This configured token is a &quot;shared secret&quot;
<para>This configured token is a &quot;shared secret&quot;
between keystone and other OpenStack services, and is used
by the client to communicate with the API to create tenants,
users, roles, etc. </para>
users, roles, etc.</para>
</section>
<section xml:id="setting-up-tenants-users-and-roles">
<title>Setting up tenants, users, and roles</title>
@ -790,7 +790,7 @@ keystone user-role-add --tenant_id=[uuid of the service tenant] \
heavily - and this <emphasis role="strong">must</emphasis> be
configured for the OpenStack Dashboard to properly function.
</para>
<para> The endpoints for these services are defined in a
<para>The endpoints for these services are defined in a
template, an example of which is in the project as the file
<literal>etc/default_catalog.templates</literal>. When
keystone uses a template file backend, then changes made to
@ -838,7 +838,7 @@ keystone service-create --name=swift \
</section>
<section xml:id="configuring-nova-to-use-keystone">
<title>Configuring Nova to use Keystone</title>
<para> When configuring Nova, it is important to create a nova user in the service tenant and
<para>When configuring Nova, it is important to create a nova user in the service tenant and
include the nova user's login information in /etc/nova/nova.conf</para>
</section>
<section xml:id="configuring-swift-to-use-keystone">
@ -1215,7 +1215,7 @@ admin_password = keystone123
</section>
<section xml:id="keystone-ssl">
<title>Configuring Keystone SSL support</title>
<para> Keystone may be configured to support 2-way SSL out-of-the-box.
<para>Keystone may be configured to support 2-way SSL out-of-the-box.
The x509 certificates used by Keystone must be obtained
externally and configured for use with Keystone as described in
this section. However, a set of sample certificates is provided
@ -1245,8 +1245,8 @@ admin_password = keystone123
</itemizedlist> Note that you may choose whatever names you want
for these certificates, or combine the public/private keys in
the same file if you wish. These certificates are just provided
as an example. </para>
<para> To enable SSL with client authentication, modify the
as an example.</para>
<para>To enable SSL with client authentication, modify the
<literal>etc/keystone.conf</literal> file accordingly under
the <literal>[ssl]</literal> section. SSL configuration example
using the included sample certificates:

16
doc/src/docbkx/common/ch_image_mgmt.xml
View File

@ -13,7 +13,7 @@
xlink:href="http://docs.openstack.org/cli/quick-start/content/glance_client.html">glance
command-line tool</link>, or the <link
xlink:href="http://docs.openstack.org/developer/python-glanceclient/">Python API</link>
to accomplish the same tasks. </para>
to accomplish the same tasks.</para>
<para>VM images made available through OpenStack Image Service can be stored in a variety of
locations. The OpenStack Image Service supports the following backend stores:</para>
<itemizedlist>
@ -135,14 +135,14 @@
injecting ssh keys into instances before they are booted.
This allows a user to log in to the instances that he or
she creates securely. Generally the first thing that a
user does when using the system is create a keypair. </para>
user does when using the system is create a keypair.</para>
<para>Keypairs provide secure authentication to your
instances. As part of the first boot of a virtual image,
the private key of your keypair is added to
authorized_keys file of the login account. Nova generates
a public and private key pair, and sends the private key
to the user. The public key is stored so that it can be
injected into instances. </para>
injected into instances.</para>
<para>Run (boot) a test instance:</para>
<screen>
<prompt>$</prompt> <userinput>nova boot --image cirros-0.3.0-x86_64 --flavor m1.small --key_name test my-first-server</userinput>
@ -174,7 +174,7 @@
<screen>
<prompt>$</prompt> <userinput>nova list</userinput>
</screen>
<para> The instance will go from BUILD to ACTIVE in a short
<para>The instance will go from BUILD to ACTIVE in a short
time, and you should be able to connect via ssh as
'cirros' user, using the private key you created. If your
ssh keypair fails for some reason, you can also log in
@ -222,11 +222,11 @@
<para>Since the release of the API in its 1.1 version, it is
possible to pause and suspend instances.</para>
<warning>
<para> Pausing and Suspending instances only apply to
<para>Pausing and Suspending instances only apply to
KVM-based hypervisors and XenServer/XCP Hypervisors.
</para>
</warning>
<para> Pause/ Unpause : Stores the content of the VM in memory
<para>Pause/ Unpause : Stores the content of the VM in memory
(RAM).</para>
<para>Suspend/ Resume : Stores the content of the VM on
disk.</para>
@ -245,7 +245,7 @@
</section>
<section xml:id="suspending-instance">
<title>Suspending instance</title>
<para> To suspend an instance :</para>
<para>To suspend an instance :</para>
<screen>nova suspend $server-id </screen>
<para>To resume a suspended instance :</para>
<screen>nova resume $server-id </screen>
@ -411,7 +411,7 @@ Options:
</listitem>
</itemizedlist>
</para>
<para>Load the contents of a local directory into glance. </para>
<para>Load the contents of a local directory into glance.</para>
<para>The <command>dump</command> and
<command>load</command> are useful when
replicating across two glance servers where a direct

8
doc/src/docbkx/common/ch_installdashboard.xml
View File

@ -9,18 +9,18 @@
xlink:href="https://github.com/openstack/horizon/"
>horizon</link>, is a Web interface that allows cloud
administrators and users to manage various OpenStack resources
and services. </para>
and services.</para>
<para>The dashboard enables web-based interactions with the
OpenStack Compute cloud controller through the OpenStack APIs. </para>
OpenStack Compute cloud controller through the OpenStack APIs.</para>
<para>The following instructions show an example deployment
configured with an Apache web server. </para>
configured with an Apache web server.</para>
<para>After you <link linkend="installing-openstack-dashboard"
>install and configure the dashboard</link>, you can
complete the following tasks:</para>
<itemizedlist>
<listitem>
<para>Customize your dashboard. See <xref
linkend="dashboard-custom-brand"/>. </para>
linkend="dashboard-custom-brand"/>.</para>
</listitem>
<listitem>
<para>Set up session storage for the dashboard. See <xref

2
doc/src/docbkx/common/ch_resources.xml
View File

@ -10,7 +10,7 @@
<title>Resources</title>
<para>For the available OpenStack documentation, see <link
xlink:href="http://docs.openstack.org"
>docs.openstack.org</link>. </para>
>docs.openstack.org</link>.</para>
<db:para>For assistance with OpenStack, go to <link xlink:href="ask.openstack.org">ask.openstack.org</link>.</db:para>
<!-- <para>For the Rackspace SDKs, see the <link
xlink:href="http://developer.rackspace.com"

6
doc/src/docbkx/common/cli_help.xml
View File

@ -6,17 +6,17 @@
<title>Get Help for Client Commands</title>
<para>Use the <command>help</command> command to get help for
commands, parameters, and subcommands for any OpenStack
client. </para>
client.</para>
<para>The syntax is:</para>
<para><screen><prompt>$</prompt> &lt;client-name&gt; help</screen></para>
<para>For example, to get help for glance client commands, run the
following command:</para>
<screen><prompt>$</prompt> glance help</screen>
<para>The <command>help</command> command lists the available
commands for the specified client. </para>
commands for the specified client.</para>
<note>
<para>Depending on your credentials, you might not have
permission to use every command. </para>
permission to use every command.</para>
</note>
<para>To get help for a specific command, enter the command name
after the <option>help</option> command, as follows:</para>

16
doc/src/docbkx/common/cli_install.xml
View File

@ -15,7 +15,7 @@
<title>Install the Openstack command-line clients</title>
<?dbhtml stop-chunking?>
<para>To install the clients, install the prerequisite software
and the Python package for each OpenStack client. </para>
and the Python package for each OpenStack client.</para>
<note>
<para>If you already installed the OpenStack client packages
by using the package management tools provided by your
@ -46,7 +46,7 @@
</td>
<td>
<para>Currently, the clients do not
support Python 3. </para>
support Python 3.</para>
</td>
</tr>
<tr>
@ -56,7 +56,7 @@
</td>
<td>
<para>Installed by default on Mac OS
X. </para>
X.</para>
<para>Many Linux distributions provide
packages to make
<command>setuptools</command> easy
@ -109,7 +109,7 @@
<listitem>
<para>RHEL, CentOS, or
Fedora</para>
<para> A packaged version available
<para>A packaged version available
in <link
xlink:href="http://openstack.redhat.com/"
>RDO</link> enables you to use
@ -121,8 +121,8 @@
with the lower case name of the
client to install, such as
<literal>nova</literal>. Repeat
this step for each desired client. </para>
<para> Alternatively install
this step for each desired client.</para>
<para>Alternatively install
<command>pip</command> and use it
to manage client installation:
<screen><prompt>#</prompt> yum install python-pip</screen>
@ -144,8 +144,8 @@
with the lower case name of the
client to install, such as
<literal>nova</literal>. Repeat
this step for each desired client. </para>
<para> Alternatively install
this step for each desired client.</para>
<para>Alternatively install
<command>pip</command> and use it
to manage client installation:
<screen><prompt>#</prompt> zypper install python-pip </screen></para>

8
doc/src/docbkx/common/cli_overview.xml
View File

@ -17,7 +17,7 @@
scripts. Internally, each client command runs cURL commands
that embed API requests. The OpenStack APIs are RESTful APIs
that use the HTTP protocol, including methods, URIs, media
types, and response codes. </para>
types, and response codes.</para>
<para>These open-source Python clients run on Linux or Mac OS X
systems and are easy to learn and use. Each OpenStack service
has its own command-line client. On some client commands, you
@ -28,7 +28,7 @@
xmlns:db="http://docbook.org/ns/docbook">debug</parameter>
parameter to show the underlying API request for the command.
This is a good way to become familiar with the OpenStack API
calls. </para>
calls.</para>
<para>The following command-line clients are available for the
respective services' APIs:</para>
@ -38,7 +38,7 @@
(python-cinderclient)</term>
<listitem>
<para>Client for the Block Storage Service API. Use to
create and manage volumes. </para>
create and manage volumes.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -65,7 +65,7 @@
<listitem>
<para>Client for the Compute API and its extensions.
Use to create and manage images, instances, and
flavors. </para>
flavors.</para>
</listitem>
</varlistentry>

4
doc/src/docbkx/common/colocating-services.xml
View File

@ -9,7 +9,7 @@
different machines, this is not always practical. For example, in small deployments there might be
too few machines available, or a limited number of public IP addresses. Components from different
OpenStack projects are not necessarily engineered to be able to be co-located, however many users
report success with a variety of deployment scenarios. </para>
report success with a variety of deployment scenarios.</para>
<para>
The following is a series of pointers to be used when co-location
of services from different OpenStack projects on the same machine
@ -21,7 +21,7 @@
consider filing a bug.</para></listitem>
<listitem><para>Monitor your systems and ensure they are not overloaded. Some parts of OpenStack use a lot of
CPU time (such as Object Storage Proxy Servers), while others are I/O focused (such as Object
Storage Object Servers). Try to balance these so they complement each other. </para></listitem>
Storage Object Servers). Try to balance these so they complement each other.</para></listitem>
<listitem><para>Beware of security. Different parts of OpenStack assume different security models. For
example, OpenStack Object Storage (Swift) assumes the storage nodes will be on a private
network and does not provide additional security between nodes in the cluster.</para></listitem>

2
doc/src/docbkx/common/compute-options.xml
View File

@ -23,7 +23,7 @@ server=10.3.4.2</programlisting></para>
</simplesect>
<simplesect>
<title>Types of configuration options</title>
<para> Each configuration option has an associated type that indicates what values can be
<para>Each configuration option has an associated type that indicates what values can be
set. The supported option types are as follows:<variablelist>
<varlistentry>
<term>BoolOpt</term>

2
doc/src/docbkx/common/compute-spice-console.xml
View File

@ -12,7 +12,7 @@
streaming and more. SPICE is a new protocol which aims to address
all the limitations in VNC, to provide good remote desktop
support.</para>
<para> SPICE support in OpenStack Compute shares a similar
<para>SPICE support in OpenStack Compute shares a similar
architecture to the VNC implementation. The OpenStack Dashboard
uses a SPICE-HTML5 widget in its console tab, that communicates to
the <literal>nova-spicehtml5proxy</literal> service using

4
doc/src/docbkx/common/config-drive.xml
View File

@ -51,7 +51,7 @@
<programlisting>force_config_drive=true</programlisting></para>
<note><para>As of this writing, there is no mechanism for an administrator to disable use of the config
drive if a user passes the <literal>--config-drive=true</literal> flag to the
<command>nova boot</command> command. </para></note>
<command>nova boot</command> command.</para></note>
</simplesect>
<simplesect>
<title>Accessing the config drive from inside an instance</title>
@ -103,7 +103,7 @@ openstack/latest/user_data</computeroutput></screen>
<title>Guidelines for accessing config drive data</title>
<para>Do not rely on the presence of the EC2 metadata present in the config drive (i.e.,
files under the <filename>ec2</filename> directory), as this content may be removed in a
future release. </para>
future release.</para>
<para>When creating images that access config drive data, if there are multiple directories
under the <filename>openstack</filename> directory, always select the highest API
version by date that your consumer supports. For example, if your guest image can

4
doc/src/docbkx/common/dashboard-configure.xml
View File

@ -8,7 +8,7 @@
<para>You can configure the dashboard for a simple HTTP deployment
or a secured HTTPS deployment. While the standard installation
uses a non-encrypted HTTP channel, you can enable SSL support
for the dashboard. </para>
for the dashboard.</para>
<section xml:id="dashboard-config-http">
<title>Configure the dashboard for HTTP</title>
<procedure>
@ -18,7 +18,7 @@
Service endpoint in the
<filename>/etc/openstack-dashboard/local_settings.py</filename>
file with the <literal>OPENSTACK_HOST</literal>
setting. </para>
setting.</para>
<para>The following example shows this setting: </para>
<programlisting language="python"><?db-font-size 65%?><xi:include parse="text" href="samples/local_settings.py"/></programlisting>
<para>The <literal>HORIZON_CONFIG</literal> dictionary

26
doc/src/docbkx/common/dashboard-install.xml
View File

@ -72,7 +72,7 @@
>/etc/openstack-dashboard/local_settings</filename><filename
os="ubuntu"
>/etc/openstack-dashboard/local_settings.py</filename>
file. </para>
file.</para>
<para>Change the following parameter: <code>TIME_ZONE =
"UTC"</code>
</para>
@ -83,25 +83,25 @@
</step>
<step>
<para>Make sure that the web browser on your local machine supports
HTML5. </para>
<para>Enable cookies and JavaScript. </para>
HTML5.</para>
<para>Enable cookies and JavaScript.</para>
<note>
<para>To use the VNC client with the dashboard, the browser must
support HTML5 Canvas and HTML5 WebSockets. </para>
support HTML5 Canvas and HTML5 WebSockets.</para>
<para>For details about browsers that support noVNC, see <link
xlink:href="https://github.com/kanaka/noVNC/blob/master/README.md"
>https://github.com/kanaka/noVNC/blob/master/README.md</link>,
and <link
xlink:href="https://github.com/kanaka/noVNC/wiki/Browser-support"
>https://github.com/kanaka/noVNC/wiki/Browser-support</link>,
respectively. </para>
respectively.</para>
</note>
</step>
<step>
<para>You can configure the dashboard for a simple HTTP deployment
or a secured HTTPS deployment. While the standard installation
uses a non-encrypted HTTP channel, you can enable SSL support
for the dashboard. </para>
for the dashboard.</para>
<para>To configure the dashboard for HTTP, proceed to <xref
linkend="dashboard-config-http"/>.</para>
<para>To configure the dashboard for HTTPS, proceed to <xref
@ -114,7 +114,7 @@
<para>Specify the host for your OpenStack Identity Service endpoint
in the
<filename>/etc/openstack-dashboard/local_settings.py</filename>
file with the <literal>OPENSTACK_HOST</literal> setting. </para>
file with the <literal>OPENSTACK_HOST</literal> setting.</para>
<para>The following example shows this setting: </para>
<programlisting language="python"><?db-font-size 65%?><xi:include parse="text" href="samples/local_settings.py"/></programlisting>
<para>The <literal>HORIZON_CONFIG</literal> dictionary contains all
@ -131,9 +131,9 @@
</step>
<step>
<para>After you connect to the dashboard through the URL, a login
page appears. </para>
page appears.</para>
<para>Enter the credentials for any user that you created with the
OpenStack Identity Service. </para>
OpenStack Identity Service.</para>
<para>For example, enter <literal>admin</literal> for the user name
and <literal>secrete</literal> for the password.</para>
</step>
@ -157,7 +157,7 @@
<para>Edit
<filename>/etc/apache2/conf.d/openstack-dashboard.conf</filename>.
Change the contents of the file to match the <xref
linkend="conf_after"/>. </para>
linkend="conf_after"/>.</para>
<example xml:id="conf_before">
<title>openstack-dashboard.conf &ndash; before editing</title>
<programlisting><?db-font-size 65%?>WSGIScriptAlias / /usr/share/openstack-dashboard/openstack_dashboard/wsgi/django.wsgi
@ -211,9 +211,9 @@ Allow from all
</step>
<step>
<para>After you connect to the dashboard through the URL, a login
page appears. </para>
page appears.</para>
<para>Enter the credentials for any user that you created with the
OpenStack Identity Service. </para>
OpenStack Identity Service.</para>
<para>For example, enter <literal>admin</literal> for the user name
and <literal>secrete</literal> for the password.</para>
</step>
@ -223,7 +223,7 @@ Allow from all
Dashboard</title>
<para>The size of the window image used for VNC is hard-coded in a
Django HTML template. To alter the hard-coded values, edit the
<filename>_detail_vnc.html</filename> template file. </para>
<filename>_detail_vnc.html</filename> template file.</para>
<step>
<para>Edit
/usr/share/pyshared/horizon/dashboards/nova/instances/templates/instances/_detail_vnc.html.</para>

10
doc/src/docbkx/common/dashboard-system-reqs.xml
View File

@ -9,9 +9,9 @@
<itemizedlist>
<listitem>
<para>OpenStack Compute installation. Enable the Identity
Service for user and project management. </para>
Service for user and project management.</para>
<para>Note the URLs of the Identity Service and Compute
endpoints. </para>
endpoints.</para>
</listitem>
<listitem>
<para>Identity Service user with sudo privileges. Because
@ -29,7 +29,7 @@
Django. These instructions have been tested with
Ubuntu 10.10. The Python version should run on any
system, including Mac OS X. Installation prerequisites
might differ by platform. </para>
might differ by platform.</para>
</listitem>
</itemizedlist>
<para>Then, <link xlink:href="installing-openstack-dashboard"
@ -52,13 +52,13 @@
JavaScript enabled.</para>
<note>
<para>To use the VNC client with the dashboard, the browser
must support HTML5 Canvas and HTML5 WebSockets. </para>
must support HTML5 Canvas and HTML5 WebSockets.</para>
<para>For details about browsers that support noVNC, see <link
xlink:href="https://github.com/kanaka/noVNC/blob/master/README.md"
>https://github.com/kanaka/noVNC/blob/master/README.md</link>,
and <link
xlink:href="https://github.com/kanaka/noVNC/wiki/Browser-support"
>https://github.com/kanaka/noVNC/wiki/Browser-support</link>,
respectively. </para>
respectively.</para>
</note>
</section>

8
doc/src/docbkx/common/dashboard_customizing.xml
View File

@ -7,14 +7,14 @@
<para>Adapted from <link
xlink:href="http://www.prestonlee.com/2012/05/09/how-to-custom-brand-the-openstack-horizon-dashboard/"
>How To Custom Brand The OpenStack “Horizon”
Dashboard</link>. </para>
Dashboard</link>.</para>
<para>You install the OpenStack dashboard through the
<literal>openstack-dashboard</literal> package. You can
customize the dashboard with your own colors, logo, and site
title through a CSS file.</para>
<para>Canonical also provides an
<literal>openstack-dashboard-ubuntu-theme</literal>
package that brands the Python-based Django interface. </para>
package that brands the Python-based Django interface.</para>
<para>The following example shows a customized dashboard with
custom colors, logo, and site title:</para>
<mediaobject>
@ -48,7 +48,7 @@
background. The text <literal>TGen Cloud</literal> in
this example is rendered through
<filename>.png</filename> files of multiple sizes
created with a graphics program. </para>
created with a graphics program.</para>
<para>Use a 200×27 for the logged-in banner graphic, and
365×50 for the login screen graphic.</para>
</step>
@ -71,7 +71,7 @@
<step>
<para>Edit your CSS file to override the Ubuntu
customizations in the <filename>ubuntu.css</filename>
file. </para>
file.</para>
<para>Change the colors and image file names as
appropriate, though the relative directory paths
should be the same. The following example file shows

8
doc/src/docbkx/common/dashboard_sessions.xml
View File

@ -12,9 +12,9 @@
<literal>SESSION_ENGINE</literal> setting in your
<filename os="centos;fedora;rhel">
/etc/openstack-dashboard/local_settings</filename>
<filename os="ubuntu">local_settings.py</filename> file. </para>
<filename os="ubuntu">local_settings.py</filename> file.</para>
<para>The following sections describe the pros and cons of each
option as it pertains to deploying the dashboard. </para>
option as it pertains to deploying the dashboard.</para>
<section xml:id="dashboard-session-local">
<title>Local memory cache</title>
<para>Local memory storage is the quickest and easiest session
@ -75,7 +75,7 @@ CACHES = {
session storages and incur a high overhead under heavy
usage. Proper configuration of your database deployment
can also be a substantial undertaking and is far beyond
the scope of this documentation. </para>
the scope of this documentation.</para>
<procedure>
<title>To initialize and configure the database:</title>
<step>
@ -161,7 +161,7 @@ No fixtures found.</computeroutput></screen>
<para>To mitigate the performance issues of database queries,
you can use the Django cached_db session backend, which
utilizes both your database and caching infrastructure to
perform write-through caching and efficient retrieval. </para>
perform write-through caching and efficient retrieval.</para>
<para>Enable this hybrid setting by configuring both your
database and cache, as discussed previously. Then, set the
following value: </para>

2
doc/src/docbkx/common/fibrechannel.xml
View File

@ -40,7 +40,7 @@
</section>
<section xml:id="fibre-channel-packages">
<title>Installing the Required Packages</title>
<para>Use the following commands to install the system packages. </para>
<para>Use the following commands to install the system packages.</para>
<para>
<itemizedlist>
<listitem>

38
doc/src/docbkx/common/getstart.xml
View File

@ -11,11 +11,11 @@
VARS, SMBs, researchers, and global data centers can all use
OpenStack to deploy private or public clouds. At the heart of our
mission is a pair of basic requirements: Clouds must be simple to
implement and massively scalable. </para>
implement and massively scalable.</para>
<para>If you are new to OpenStack, you undoubtedly have questions
about installation, deployment, and usage. It can seem
overwhelming at first. But do not fear: This guide along with
other OpenStack guides help you ramp up. </para>
other OpenStack guides help you ramp up.</para>
<section xml:id="why-cloud">
<title>Why Cloud?</title>
<para>In data centers, projects might need a large amount of
@ -23,7 +23,7 @@
that power after completing the computation. Cloud computing
provides a service that is available on demand with the
flexibility to spin resources up or down through automation or
with little intervention. </para>
with little intervention.</para>
<para><emphasis role="italic">Cloud computing</emphasis> is often
depicted as a cloud-like shape with a service layer that goes
from user to provider. The cloud contains the services that
@ -91,7 +91,7 @@
supporting a specific community with shared concerns. A hybrid
cloud is a cloud deployment model and can be composed of both
public and private clouds, or may involve both virtual and
physical servers. </para>
physical servers.</para>
<para>What do people do with cloud computing? Cloud computing can
help with large-scale computing needs or can lead consolidation
efforts by virtualizing servers to make more use of existing
@ -116,7 +116,7 @@
operating system. Each of the constituent services work together
to provide a complete Infrastructure as a Service (IaaS). Each
service offers an application programming interface (API) that
facilitates this integration. </para>
facilitates this integration.</para>
<para>Any service can use the API for another service. Also, an
implementer can switch out any service as long as they maintain
the API. These APIs are, for the most part, the same APIs that
@ -201,7 +201,7 @@
usually Nova. Enables users to create their own networks
and attach interfaces to them. OpenStack Networking has
a pluggable architecture to support many popular
networking vendors and technologies. </td>
networking vendors and technologies.</td>
</tr>
<tr>
<td><link
@ -244,10 +244,10 @@
<title>Logical Architecture</title>
<para>As you can imagine, the logical architecture is far more
complicated than the conceptual architecture shown in <xref
linkend="concept_arch"/>. </para>
linkend="concept_arch"/>.</para>
<para>This section describes the relevant aspects of the logical
architecture that administrators need to design, install, and
configure a cloud. These details are not exhaustive. </para>
configure a cloud. These details are not exhaustive.</para>
<para>Modules are organized by the kind of functions they
implement or deliver and are classified by one of the
following types:</para>
@ -349,7 +349,7 @@
privileged users to perform administrative actions). It
also initiates most of the orchestration activities
(such as running an instance) as well as enforces some
policy. </para>
policy.</para>
</listitem>
<listitem>
<para><code>nova-api-metadata</code> accepts metadata
@ -357,7 +357,7 @@
xlink:href="http://docs.openstack.org/trunk/openstack-compute/admin/content/metadata-service.html"
>more details</link>). The nova-api-metadata service
is generally only used when running in multi-host mode
with nova-network installations. </para>
with nova-network installations.</para>
</listitem>
</itemizedlist>
<para>Computing core</para>
@ -389,7 +389,7 @@
scales horizontally but it shouldn’t be deployed on the
same node(s) where <systemitem class="service">nova-compute</systemitem> runs. You can <link
xlink:href="http://russellbryantnet.wordpress.com/2012/11/19/a-new-nova-service-nova-conductor/"
>read more about the new service here</link>. </para>
>read more about the new service here</link>.</para>
</listitem>
</itemizedlist>
<para>Networking for VMs</para>
@ -401,7 +401,7 @@
to manipulate the network (such as setting up bridging
interfaces or changing iptables rules). This
functionality is being migrated to OpenStack Networking,
a separate OpenStack service. </para>
a separate OpenStack service.</para>
</listitem>
<listitem>
<para><code>nova-dhcpbridge</code> (script) This script
@ -409,7 +409,7 @@
database using dnsmasq's dhcp-script facility. This
functionality is also migrated to OpenStack Networking;
a different script is provided when using OpenStack
Networking (code-named Neutron). </para>
Networking (code-named Neutron).</para>
</listitem>
</itemizedlist>
<para>Console Interface</para>
@ -423,7 +423,7 @@
nova-consoleauth service in a cluster configuration.
<link
xlink:href="http://docs.openstack.org/trunk/openstack-compute/admin/content/about-nova-consoleauth.html"
>Read more details</link>. </para>
>Read more details</link>.</para>
</listitem>
<listitem>
<para>The <code>nova-novncproxy</code> (daemon) provides a
@ -440,7 +440,7 @@
<para>The <code>nova-xvpnvncproxy</code> daemon is a proxy
for accessing running instances through a VNC
connection. It supports a Java client specifically
designed for OpenStack. </para>
designed for OpenStack.</para>
</listitem>
<listitem>
<para>The <code>nova-cert</code> daemon manages x509
@ -476,11 +476,11 @@
<listitem>
<para>The <code>nova</code> client enables you to submit
either tenant administrator’s commands or cloud user’s
commands. </para>
commands.</para>
</listitem>
<listitem>
<para>The <code>nova-manage</code> client submits cloud
administrator commands. </para>
administrator commands.</para>
</listitem>
</itemizedlist>
<itemizedlist>
@ -653,7 +653,7 @@
</itemizedlist>
<para>OpenStack Networking interacts mainly with OpenStack
Compute, where it provides networks and connectivity for its
instances. </para>
instances.</para>
</section>
<section xml:id="overview-block-storage-arch">
<title>Block Storage Service API</title>
@ -674,7 +674,7 @@
providers through a driver architecture. Currently,
there are drivers for IBM, SolidFire, NetApp, Nexenta,
Zadara, GlusterFS, linux iSCSI and other storage
providers. </para>
providers.</para>
</listitem>
<listitem>
<para>Much like <code>nova-scheduler</code>, the

42
doc/src/docbkx/common/glossary/glossary-terms.xml
View File

@ -19,7 +19,7 @@
distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See
the License for the specific language governing
permissions and limitations under the License. </para>
permissions and limitations under the License.</para>
</legalnotice>
</info>
@ -474,7 +474,7 @@
<para>A backup schedule can be defined to create
server images at regular intervals (daily and
weekly). Backup schedules are configurable per
server. </para>
server.</para>
</glossdef>
</glossentry>-->
<glossentry>
@ -672,7 +672,7 @@
<glossdef>
<para>Defines resources for a cell, including CPU,
storage, and networking. Can apply to the specific
services within a cell or a whole cell. </para>
services within a cell or a whole cell.</para>
</glossdef>
</glossentry>
<glossentry>
@ -838,7 +838,7 @@
<glossterm>cloud architect</glossterm>
<glossdef>
<para>A person who plans, designs, and oversees the
creation of clouds. </para>
creation of clouds.</para>
</glossdef>
</glossentry>
<glossentry>
@ -980,7 +980,7 @@
<glossdef>
<para>A node that runs the <systemitem class="service">nova-compute</systemitem> daemon, a VM
instance that provides a wide range of services
such as a web services and analytics. </para>
such as a web services and analytics.</para>
</glossdef>
</glossentry>
<glossentry>
@ -1432,7 +1432,7 @@
usa.gov, Harvard.edu, or mail.yahoo.com.</para>
<para>A domain is an entity or container of all
DNS-related information containing one or more
records. </para>
records.</para>
</glossdef>
</glossentry>
<glossentry>
@ -1461,7 +1461,7 @@
master invokes the slave. DNS servers might also
be clustered or replicated such that changes made
to one DNS server are automatically propagated to
other active servers. </para>
other active servers.</para>
</glossdef>
</glossentry>
<glossentry>
@ -2189,7 +2189,7 @@
can also create custom images, or snapshots, from
servers that you have launched. Custom images can
be used for data backups or as "gold" images for
additional servers. </para>
additional servers.</para>
</glossdef>
</glossentry>
<glossentry>
@ -2351,7 +2351,7 @@
<para>Number that is unique to every computer system
on the Internet. Two versions of the Internet
Protocol (IP) are in use for addresses: IPv4 and
IPv6. </para>
IPv6.</para>
</glossdef>
</glossentry>
<glossentry>
@ -2479,7 +2479,7 @@
<glossterm>large object</glossterm>
<glossdef>
<para>An object within swift that is larger than 5
GBs. </para>
GBs.</para>
</glossdef>
</glossentry>
<glossentry>
@ -2540,7 +2540,7 @@
belongs to a cloud account. It is used to
distribute workloads between multiple back-end
systems or services, based on the criteria defined
as part of its configuration. </para>
as part of its configuration.</para>
</glossdef>
</glossentry>
<glossentry>
@ -2959,7 +2959,7 @@
<glossdef>
<para>Opens all objects for an object server and
verifies the MD5 hash, size, and metadata for each
object. </para>
object.</para>
</glossdef>
</glossentry>
<glossentry>
@ -3356,7 +3356,7 @@
other and with the public network. All machines
must have a public and private network interface.
The public network interface is controlled by the
public_interface option. </para>
public_interface option.</para>
</glossdef>
</glossentry>
<!--<glossentry>
@ -3536,7 +3536,7 @@
<glossdef>
<para>Removes all data on the server and replaces it
with the specified image. Server ID and IP
addresses remain the same. </para>
addresses remain the same.</para>
</glossdef>
</glossentry>
<glossentry>
@ -3557,7 +3557,7 @@
exchange (MX) records, which specify the mail
server for a particular domain, and name server
(NS) records, which specify the authoritative name
servers for a domain. </para>
servers for a domain.</para>
</glossdef>
</glossentry>
<glossentry>
@ -3888,7 +3888,7 @@
managing a variety of computer operations.</para>
<para>A server is a VM instance in the compute system.
Flavor and image are requisite elements when
creating a server. </para>
creating a server.</para>
</glossdef>
</glossentry>
<glossentry>
@ -3954,7 +3954,7 @@
<para>A feature of the load balancing service. It
attempts to force subsequent connections to a
service to be redirected to the same node as long
as it is online. </para>
as it is online.</para>
</glossdef>
</glossentry>
<glossentry>
@ -3998,7 +3998,7 @@
server in the group. With the exception of the
first server in a shared IP group, servers must be
launched into shared IP groups. A server may only
be a member of one shared IP group. </para>
be a member of one shared IP group.</para>
</glossdef>
</glossentry>
<!--<glossentry>
@ -4171,7 +4171,7 @@
delegate domains. Subdomains can themselves have
subdomains, so third-level, fourth-level,
fifth-level, and deeper levels of nesting are
possible. </para>
possible.</para>
</glossdef>
</glossentry>
<glossentry>
@ -4230,7 +4230,7 @@
<glossterm>swift proxy server</glossterm>
<glossdef>
<para>Acts as the gatekeeper to swift and is
responsible for authenticating the user. </para>
responsible for authenticating the user.</para>
</glossdef>
</glossentry>
<glossentry>
@ -4796,7 +4796,7 @@
<glossentry>
<glossterm>vSphere</glossterm>
<glossdef>
<para>An OpenStack-supported hypervisor. </para>
<para>An OpenStack-supported hypervisor.</para>
</glossdef>
</glossentry>
<glossentry>

2
doc/src/docbkx/common/glossary/openstack-glossary.xml
View File

@ -11,7 +11,7 @@
<chapter xml:id="glossary">
<title>OpenStack Glossary</title>
<para>Use this glossary to get definitions of OpenStack-related
words and phrases. </para>
words and phrases.</para>
<para>To add to this glossary, fork the
<literal>openstack-manuals</literal> repository on
github.com and update the source files through the

2
doc/src/docbkx/common/host_aggregates.xml
View File

@ -13,7 +13,7 @@ xml:id="host-aggregates">
groups of machines. Each node can have multiple aggregates, each aggregate can have
multiple key-value pairs, and the same key-value pair can be assigned to multiple
aggregate. This information can be used in the scheduler to enable advanced scheduling,
to set up Xen hypervisor resources pools or to define logical groups for migration. </para>
to set up Xen hypervisor resources pools or to define logical groups for migration.</para>
</simplesect>
<simplesect>
<title>Command-line interface</title>

2
doc/src/docbkx/common/hyper-v.xml
View File

@ -26,7 +26,7 @@
<title>Hyper-V Configuration</title>
<para>The following sections discuss how to prepare the Windows Hyper-V node for operation
as an OpenStack Compute node. Unless stated otherwise, any configuration information
should work for both the Windows 2008r2 and 2012 platforms. </para>
should work for both the Windows 2008r2 and 2012 platforms.</para>
<para><emphasis role="bold">Local Storage Considerations</emphasis></para>
<para>The Hyper-V compute node needs to have ample storage for storing the virtual machine
images running on the compute nodes. You may use a single volume for all, or partition

2
doc/src/docbkx/common/identity-configure.xml
View File

@ -14,7 +14,7 @@
various services are included in individual sections (such as
<literal>[sql]</literal> or <literal>[ec2]</literal>).
</para>
<para> The services include: </para>
<para>The services include: </para>
<itemizedlist>
<listitem>
<para>

2
doc/src/docbkx/common/image-formats.xml
View File

@ -81,7 +81,7 @@
</listitem>
<listitem>
<para><literal>ovf</literal>. The OVF container
format. </para>
format.</para>
</listitem>
<listitem>
<para><literal>aki</literal>. An Amazon kernel image.

4
doc/src/docbkx/common/introduction-to-xen.xml
View File

@ -78,7 +78,7 @@
of security isolation between the privileged system
software and the OpenStack software (much of which is
customer-facing). This architecture is described in
more detail later. </para>
more detail later.</para>
<para>There is an ongoing project to split domain 0 into
multiple privileged domains known as <emphasis
role="bold">driver domains</emphasis> and
@ -181,7 +181,7 @@
</listitem>
<listitem>
<para>Public network - floating IPs,
public API endpoints. </para>
public API endpoints.</para>
</listitem>
</itemizedlist></para>
</listitem>

46
doc/src/docbkx/common/keystone-concepts.xml
View File

@ -5,17 +5,17 @@
xml:id="keystone-concepts">
<?dbhtml stop-chunking?>
<title>Identity Service Concepts</title>
<para> The Identity service performs the following functions: </para>
<para>The Identity service performs the following functions: </para>
<itemizedlist spacing="compact">
<listitem>
<para>User management. Tracks users and their permissions. </para>
<para>User management. Tracks users and their permissions.</para>
</listitem>
<listitem>
<para>Service catalog. Provides a catalog of available
services with their API endpoints. </para>
services with their API endpoints.</para>
</listitem>
</itemizedlist>
<para> To understand the Identity Service, you must understand the
<para>To understand the Identity Service, you must understand the
following concepts: </para>
<variablelist>
<varlistentry>
@ -61,7 +61,7 @@
and password or a username and API key. In
response to these credentials, the Identity
Service issues the user an authentication token,
which the user provides in subsequent requests. </para>
which the user provides in subsequent requests.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -71,14 +71,14 @@
resources. Each token has a scope which describes
which resources are accessible with it. A token
may be revoked at anytime and is valid for a
finite duration. </para>
finite duration.</para>
<para>While the Identity Service supports token-based
authentication in this release, the intention is
for it to support additional protocols in the
future. The intent is for it to be an integration
service foremost, and not aspire to be a
full-fledged identity store and management
solution. </para>
solution.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -87,7 +87,7 @@
<para>A container used to group or isolate resources
and/or identity objects. Depending on the service
operator, a tenant may map to a customer, account,
organization, or project. </para>
organization, or project.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -96,7 +96,7 @@
<para>An OpenStack service, such as Compute (Nova),
Object Storage (Swift), or Image Service (Glance).
Provides one or more endpoints through which users
can access resources and perform operations. </para>
can access resources and perform operations.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -107,7 +107,7 @@
an extension for templates, you can create an
endpoint template, which represents the templates
of all the consumable services that are available
across the regions. </para>
across the regions.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -117,13 +117,13 @@
them to perform a specific set of operations. A
role includes a set of rights and privileges. A
user assuming that role inherits those rights and
privileges. </para>
privileges.</para>
<para>In the Identity Service, a token that is issued
to a user includes the list of roles that user can
assume. Services that are being called by that
user determine how they interpret the set of roles
a user has and which operations or resources each
role grants access to. </para>
role grants access to.</para>
</listitem>
</varlistentry>
</variablelist>
@ -143,7 +143,7 @@
</para>
<section xml:id="keystone-user-management">
<title>User management</title>
<para> The main components of Identity user management are: <itemizedlist>
<para>The main components of Identity user management are: <itemizedlist>
<listitem>
<para>Users</para>
</listitem>
@ -173,7 +173,7 @@
use <literal>--project_id</literal> instead of
<literal>--tenant-id</literal> or
<literal>--os-tenant-id</literal> to refer to a
tenant ID. </para>
tenant ID.</para>
</note>
<para>A <emphasis>role</emphasis> captures what operations a
user is permitted to perform in a given tenant. This
@ -183,7 +183,7 @@
<para>It is up to individual services such as the Compute
service and Image service to assign meaning to these
roles. As far as the Identity service is concerned, a
role is simply a name. </para>
role is simply a name.</para>
</note>
<para>The Identity service associates a user with a tenant and
a role. To continue with our previous examples, we may
@ -211,7 +211,7 @@
<para>A user can be assigned different roles in different
tenants: for example, Alice may also have the "admin" role
in the "Cyberdyne" tenant. A user can also be assigned
multiple roles in the same tenant. </para>
multiple roles in the same tenant.</para>
<para>The
<filename>/etc/<replaceable>[SERVICE_CODENAME]</replaceable>/policy.json</filename>
controls what users are allowed to do for a given service.
@ -220,22 +220,22 @@
<filename>/etc/glance/policy.json</filename> specifies
the access policy for the Image service, and
<filename>/etc/keystone/policy.json</filename>
specifies the access policy for the Identity service. </para>
specifies the access policy for the Identity service.</para>
<para>The default <filename>policy.json</filename> files in
the Compute, Identity, and Image service recognize only
the <literal>admin</literal> role: all operations that do
not require the <literal>admin</literal> role will be
accessible by any user that has any role in a tenant. </para>
accessible by any user that has any role in a tenant.</para>
<para>If you wish to restrict users from performing operations
in, say, the Compute service, you need to create a role in
the Identity service and then modify
<filename>/etc/nova/policy.json</filename> so that
this role is required for Compute operations. </para>
this role is required for Compute operations.</para>
<para>For example, this line in
<filename>/etc/nova/policy.json</filename> specifies
that there are no restrictions on which users can create
volumes: if the user has any role in a tenant, they will
be able to create volumes in that tenant. </para>
be able to create volumes in that tenant.</para>
<programlisting language="json">"volume:create": [], </programlisting>
<para>If we wished to restrict creation of volumes to users
who had the <literal>compute-user</literal> role in a
@ -352,7 +352,7 @@
</section>
<section xml:id="keystone-service-mgmt">
<title>Service management</title>
<para> The Identity Service provides the following service
<para>The Identity Service provides the following service
management functions: </para>
<itemizedlist>
<listitem>
@ -366,8 +366,8 @@
corresponds to each service (such as, a user named
<emphasis>nova</emphasis>, for the Compute service)
and a special service tenant, which is called
<emphasis>service</emphasis>. </para>
<emphasis>service</emphasis>.</para>
<para>The commands for creating services and endpoints are
described in a later section. </para>
described in a later section.</para>
</section>
</section>

2
doc/src/docbkx/common/keystone-ssl-config.xml
View File

@ -6,7 +6,7 @@
version="5.0"
xml:id="keystone-ssl-config">
<title>SSL and Keystone Configuration</title>
<para> Keystone may be configured to support 2-way SSL
<para>Keystone may be configured to support 2-way SSL
out-of-the-box. The x509 certificates used by Keystone must be
obtained externally and configured for use with Keystone as
described in this section. However, a set of sample

8
doc/src/docbkx/common/kvm.xml
View File

@ -79,7 +79,7 @@ libvirt_type=kvm</programlisting>
<title>Checking for hardware virtualization support</title>
<para>The processors of your compute host need to support virtualization technology (VT)
(mainly Intel <emphasis role="italic">VT -x</emphasis> or AMD <emphasis role="italic"
>AMD-v</emphasis> technologies) to use KVM. </para>
>AMD-v</emphasis> technologies) to use KVM.</para>
<para>In order to check if your processor has VT support (which has to be enabled in the
BIOS), issue as
root:<screen os="ubuntu">
@ -114,7 +114,7 @@ KVM acceleration can NOT be used</computeroutput></screen></para>
<title>Enabling KVM</title>
<para>KVM requires the <literal>kvm </literal>and either <literal>kvm-intel</literal> or
<literal>kvm-amd</literal> modules to be loaded. This may have been configured
automatically on your distribution when KVM is installed. </para>
automatically on your distribution when KVM is installed.</para>
<para>You can check that they have been loaded using <command>lsmod</command>, as follows,
with expected output for Intel-based
processors:<screen><prompt>$</prompt> <userinput>lsmod | grep kvm</userinput>
@ -212,7 +212,7 @@ libvirt_cpu_model=Nehalem</programlisting>
libvirt will not specify any CPU model at all. It will
leave it up to the hypervisor to choose the default
model. This setting is equivalent to the Compute
service behavior prior to the Folsom release. </para>
service behavior prior to the Folsom release.</para>
</simplesect>
</section>
<section xml:id="kvm-performance">
@ -231,7 +231,7 @@ libvirt_cpu_model=Nehalem</programlisting>
error appears in
<filename>/var/log/nova/nova-compute.log</filename><screen><computeroutput>libvirtError: internal error no supported architecture for os type 'hvm'</computeroutput></screen>
This is a symptom that the KVM kernel modules have not
been loaded. </para>
been loaded.</para>
<para>If you cannot start VMs after installation without
rebooting, it's possible the permissions are not correct.
This can happen if you load the KVM module before you've

2
doc/src/docbkx/common/lxc.xml
View File

@ -15,7 +15,7 @@ xml:id="lxc">
technologies, such as AppArmor, may be used to provide better
isolation between containers, although this is not the case by
default. For all these reasons, the choice of this virtualization
technology is not recommended in production. </para>
technology is not recommended in production.</para>
<para>If your compute hosts do not have hardware support for virtualization, LXC will likely
provide better performance than QEMU. In addition, if your guests need to access to specialized
hardware (e.g., GPUs), this may be easier to achieve with LXC than other hypervisors.</para>

44
doc/src/docbkx/common/moosefs.xml
View File

@ -6,15 +6,15 @@
version="5.0"
xml:id="installing-moosefs-as-backend">
<title>Installing MooseFS as shared storage for the instances directory</title>
<para> In the previous section we presented a convenient way to deploy a shared storage using
NFS. For better transactions performance, you could deploy MooseFS instead. </para>
<para>In the previous section we presented a convenient way to deploy a shared storage using
NFS. For better transactions performance, you could deploy MooseFS instead.</para>
<para>MooseFS (Moose File System) is a shared file system ; it implements the same rough
concepts of shared storage solutions - such as Ceph, Lustre or even GlusterFS. </para>
concepts of shared storage solutions - such as Ceph, Lustre or even GlusterFS.</para>
<para>
<emphasis role="bold">Main concepts </emphasis>
<itemizedlist>
<listitem>
<para> A metadata server (MDS), also called master server, which manages the file
<para>A metadata server (MDS), also called master server, which manages the file
repartition, their access and the namespace.</para>
</listitem>
<listitem>
@ -36,13 +36,13 @@
<para>
<itemizedlist>
<listitem>
<para> Two compute nodes running both MooseFS chunkserver and client services. </para>
<para>Two compute nodes running both MooseFS chunkserver and client services.</para>
</listitem>
<listitem>
<para> One MooseFS master server, running the metadata service. </para>
<para>One MooseFS master server, running the metadata service.</para>
</listitem>
<listitem>
<para> One MooseFS slave server, running the metalogger service. </para>
<para>One MooseFS slave server, running the metalogger service.</para>
</listitem>
</itemizedlist> For that particular walkthrough, we will use the following network schema : </para>
<para>
@ -79,10 +79,10 @@
<section xml:id="installing-moosefs-metadata-metalogger-servers">
<title> Installing the MooseFS metadata and metalogger servers</title>
<para>Both components could be run anywhere , as long as the MooseFS chunkservers can reach
the MooseFS master server. </para>
the MooseFS master server.</para>
<para>In our deployment, both MooseFS master and slave run their services inside a virtual
machine ; you just need to make sure to allocate enough memory to the MooseFS metadata
server, all the metadata being stored in RAM when the service runs. </para>
server, all the metadata being stored in RAM when the service runs.</para>
<para>
<orderedlist>
<listitem>
@ -101,13 +101,13 @@
</listitem>
<listitem>
<para><emphasis role="bold">User and group creation</emphasis></para>
<para> Create the adequate user and group :
<para>Create the adequate user and group :
<screen><prompt>$</prompt> <userinput>groupadd mfs &amp;&amp; useradd -g mfs mfs </userinput></screen>
</para>
</listitem>
<listitem>
<para><emphasis role="bold">Download the sources</emphasis></para>
<para> Go to the <link xlink:href="http://www.moosefs.org/download.html">MooseFS download page</link>
<para>Go to the <link xlink:href="http://www.moosefs.org/download.html">MooseFS download page</link>
and fill the download form in order to obtain your URL for the package.
</para>
<para/>
@ -123,7 +123,7 @@
</listitem>
<listitem>
<para><emphasis role="bold">Create configuration files</emphasis></para>
<para> We will keep the default settings, for tuning performance, you can read the <link
<para>We will keep the default settings, for tuning performance, you can read the <link
xlink:href="http://www.moosefs.org/moosefs-faq.html">MooseFS official FAQ</link>
</para>
<para><screen><prompt>$</prompt> <userinput>cd /etc/moosefs</userinput></screen>
@ -152,7 +152,7 @@
</listitem>
<listitem>
<para><emphasis role="bold">Power up the MooseFS metalogger service</emphasis></para>
<para>
<para>
<screen><prompt>$</prompt> <userinput>/usr/sbin/mfsmetalogger start</userinput></screen>
</para>
</listitem>
@ -162,8 +162,8 @@
</section>
<section xml:id="installing-moosefs-chunk-client-services">
<title>Installing the MooseFS chunk and client services</title>
<para> In the first part, we will install the last version of FUSE, and proceed to the
installation of the MooseFS chunk and client in the second part. </para>
<para>In the first part, we will install the last version of FUSE, and proceed to the
installation of the MooseFS chunk and client in the second part.</para>
<para/>
<para><emphasis role="bold">Installing FUSE</emphasis></para>
<para>
@ -176,7 +176,7 @@
</listitem>
<listitem>
<para><emphasis role="bold">Download the sources and configure them</emphasis></para>
<para> For that setup we will retrieve the last version of fuse to make sure every
<para>For that setup we will retrieve the last version of fuse to make sure every
function will be available :
<screen><prompt>$</prompt> <userinput>wget http://downloads.sourceforge.net/project/fuse/fuse-2.X/2.9.1/fuse-2.9.1.tar.gz &amp;&amp; tar -zxvf fuse-2.9.1.tar.gz &amp;&amp; cd fuse-2.9.1</userinput></screen><screen><prompt>$</prompt> <userinput>./configure &amp;&amp; make &amp;&amp; make install</userinput></screen>
</para>
@ -184,10 +184,10 @@
</orderedlist>
</para>
<para><emphasis role="bold">Installing the MooseFS chunk and client services</emphasis></para>
<para> For installing both services, you can follow the same steps that were presented before
<para>For installing both services, you can follow the same steps that were presented before
(Steps 1 to 4) : <orderedlist>
<listitem>
<para> Hosts entry configuration</para>
<para>Hosts entry configuration</para>
</listitem>
<listitem>
<para>Required packages</para>
@ -209,7 +209,7 @@
</listitem>
<listitem>
<para><emphasis role="bold">Create configuration files</emphasis></para>
<para> The chunk servers configuration is relatively easy to setup. You only need to
<para>The chunk servers configuration is relatively easy to setup. You only need to
create on every server directories that will be used for storing the datas of your
cluster.</para>
<para><screen><prompt>$</prompt> <userinput>cd /etc/moosefs</userinput></screen>
@ -231,7 +231,7 @@
</listitem>
<listitem>
<para><emphasis role="bold">Power up the MooseFS mfschunkserver service</emphasis></para>
<para>
<para>
<screen><prompt>$</prompt> <userinput>/usr/sbin/mfschunkserver start</userinput></screen>
</para>
</listitem>
@ -240,7 +240,7 @@
</section>
<section xml:id="access-to-cluster-storage">
<title>Access to your cluster storage</title>
<para> You can now access your cluster space from the compute node, (both acting as
<para>You can now access your cluster space from the compute node, (both acting as
chunkservers) : <screen><prompt>$</prompt> <userinput>mfsmount /var/lib/nova/instances -H mfsmaster</userinput></screen>
<computeroutput> mfsmaster accepted connection with parameters: read-write,restricted_ip ;
root mapped to root:root </computeroutput>
@ -262,7 +262,7 @@ none on /var/lib/ureadahead/debugfs type debugfs (rw,relatime)
can interact with it the way you would interact with a classical mount, using build-in linux
commands (cp, rm, etc...).
</para>
<para> The MooseFS client has several tools for managing the objects within the cluster (set
<para>The MooseFS client has several tools for managing the objects within the cluster (set
replication goals, etc..). You can see the list of the available tools by running
<screen><prompt>$</prompt> <userinput>mfs &lt;TAB&gt; &lt;TAB&gt;</userinput> </screen><programlisting>
mfsappendchunks mfschunkserver mfsfileinfo mfsgetgoal mfsmount mfsrsetgoal mfssetgoal mfstools

4
doc/src/docbkx/common/nova_cli_access_and_security.xml
View File

@ -7,7 +7,7 @@
<para>Before you launch a virtual machine, you can add security
group rules to enable users to ping and SSH to the instances.
To do so, you either add rules to the default security group
or add a security group with rules. </para>
or add a security group with rules.</para>
<para>A security group is a named collection of network access
rules that you use to limit the types of traffic that have
access to instances. When you launch an instance, you can
@ -19,7 +19,7 @@
you create or modify them.</para>
<para>Keypairs are SSH credentials that are injected into images
when they are launched. For this to work, the image must
contain the <literal>cloud-init</literal> package. </para>
contain the <literal>cloud-init</literal> package.</para>
<!-- <xi:include href="nova_cli_secgroups.xml"/>
<xi:include href="nova_cli_sshkeys.xml"/>
<xi:include href="nova_cli_floatingip.xml"/> -->

28
doc/src/docbkx/common/nova_cli_boot.xml
View File

@ -43,7 +43,7 @@
server that can be launched. For more details and
a list of default flavors available, see Section
1.5, "Managing Flavors," (↑ User Guide for
Administrators ). </para>
Administrators ).</para>
</listitem>
<listitem>
<para><literal>User Data</literal> is a special key in
@ -54,7 +54,7 @@
>cloudinit</link> system is an open source
package from Ubuntu that handles early
initialization of a cloud instance that makes use
of this <literal>user data</literal>. </para>
of this <literal>user data</literal>.</para>
</listitem>
<listitem>
<para>Access and security credentials, which include
@ -74,7 +74,7 @@
use the keypair for multiple instances
that belong to that project. For details,
refer to Section 1.5.1, Creating or
Importing Keys. </para>
Importing Keys.</para>
</listitem>
<listitem>
<para>A <emphasis role="bold">security
@ -125,7 +125,7 @@
| 84 | m1.micro | 128 | 0 | 0 | | 1 | 1.0 | True |
+----+-----------+-----------+------+-----------+------+-------+-------------+-----------+</computeroutput></screen>
<para>Note the ID of the flavor that you want to use
for your instance. </para>
for your instance.</para>
</step>
<step>
<para>List the available images:</para>
@ -142,14 +142,14 @@
<screen><prompt>$</prompt> <userinput>nova image-list | grep 'kernel'</userinput></screen>
<screen><computeroutput>| df430cc2-3406-4061-b635-a51c16e488ac | cirros-0.3.1-x86_64-uec-kernel | ACTIVE | |</computeroutput></screen>
<para>Note the ID of the image that you want to boot
your instance from. </para>
your instance from.</para>
</step>
<step>
<para>List the available security groups:</para>
<note>
<para>If you are an admin user, specify the
<literal>--all-tenants</literal> parameter
to list groups for all tenants. </para>
to list groups for all tenants.</para>
</note>
<screen><prompt>$</prompt> <userinput>nova secgroup-list --all-tenants</userinput></screen>
<screen><computeroutput>+----+---------+-------------+----------------------------------+
@ -160,7 +160,7 @@
+----+---------+-------------+----------------------------------+</computeroutput></screen>
<para>If you have not created any security groups, you
can assign the instance to only the default
security group. </para>
security group.</para>
<para>You can also list rules for a specified security
group:</para>
<screen><prompt>$</prompt> <userinput>nova secgroup-list-rules default</userinput> </screen>
@ -174,7 +174,7 @@
80.</para>
</step>
<step>
<para>List the available keypairs. </para>
<para>List the available keypairs.</para>
<screen><prompt>$</prompt> <userinput>nova keypair-list</userinput></screen>
<screen><computeroutput>+------+-------------+
| Name | Fingerprint |
@ -212,9 +212,9 @@
depending on which parameters you provide.</para>
<para>A status of <literal>BUILD</literal> indicates
that the instance has started, but is not yet
online. </para>
online.</para>
<para>A status of <literal>ACTIVE</literal> indicates
that your server is active. </para>
that your server is active.</para>
<informalexample>
<screen><computeroutput><?db-font-size 70%?>+-------------------------------------+--------------------------------------+
| Property | Value |
@ -250,7 +250,7 @@
<para>Copy the server ID value from the
<literal>id</literal> field in the output. You
use this ID to get details for or delete your
server. </para>
server.</para>
<para>Copy the administrative password value from the
<literal>adminPass</literal> field. You use
this value to log into your server.</para>
@ -281,9 +281,9 @@
<para>This command lists all instances of the project
you belong to, including their ID, their name,
their status, and their private (and if assigned,
their public) IP addresses. </para>
their public) IP addresses.</para>
<para>If the status for the instance is ACTIVE, the
instance is online. </para>
instance is online.</para>
<para>To view the available options for the
<command>nova list</command> command, run the
following command:</para>
@ -293,7 +293,7 @@
<para>If you did not provide a keypair, security
groups, or rules, you can only access the instance
from inside the cloud through VNC. Even pinging
the instance is not possible. </para>
the instance is not possible.</para>
<!-- <para>To change this, proceed to <xref
linkend="cli_configure_instances"/>.</para> -->
</step>

8
doc/src/docbkx/common/nova_cli_evacuate.xml
View File

@ -6,12 +6,12 @@
<title>Evacuate instances</title>
<para>If a cloud compute node fails due to a hardware malfunction
or another reason, you can evacuate instances to make them
available again. </para>
<para>You can choose evacuation parameters for your use case. </para>
available again.</para>
<para>You can choose evacuation parameters for your use case.</para>
<para>To preserve user data on server disk, you must configure
shared storage on the target host. Also, you must validate
that the current VM host is down. Otherwise the evacuation
fails with an error. </para>
fails with an error.</para>
<procedure xml:id="evacuate_shared">
<title>To evacuate your server</title>
<step>
@ -44,7 +44,7 @@
filesystem. To configure your system, see <link
xlink:href="http://docs.openstack.org/trunk/openstack-compute/admin/content/configuring-migrations.html"
>Configure migrations guide</link>. In this
example, the password remains unchanged. </para>
example, the password remains unchanged.</para>
<screen><prompt>$</prompt> <userinput>nova evacuate <replaceable>evacuated_server_name</replaceable> <replaceable>host_b</replaceable> --on-shared-storage</userinput> </screen>
</step>
</procedure>

6
doc/src/docbkx/common/nova_cli_fileinjection.xml
View File

@ -9,10 +9,10 @@
<title>Inject files into instances</title>
<para>You can inject local files into the instance file system when
you launch an instance. </para>
you launch an instance.</para>
<para>Use the <parameter>--file dst-path=src-path</parameter>
parameter on the nova <command>boot</command> command. </para>
<para>You can inject up to five files. </para>
parameter on the nova <command>boot</command> command.</para>
<para>You can inject up to five files.</para>
<para>For example, you might inject the
<filename>special_authorized_keysfile</filename> file into the
instance rather than using the regular ssh key injection.</para>

4
doc/src/docbkx/common/nova_cli_images.xml
View File

@ -37,7 +37,7 @@
<screen><prompt>$</prompt> <userinput>nova image-create myCirrosServer myCirrosImage</userinput></screen>The
command creates a qemu snapshot and automatically
uploads the image to your repository. Only the tenant
that creates the image has access to it. </para>
that creates the image has access to it.</para>
</step>
<step>
<para>Get details for your image to check its
@ -79,7 +79,7 @@
<para>After a while, the image status changes from
<literal>SAVING</literal> to
<literal>ACTIVE</literal>. Only the tenant who
creates the image has access to it. </para>
creates the image has access to it.</para>
</step>
<step>

32
doc/src/docbkx/common/nova_cli_secgroups.xml
View File

@ -11,7 +11,7 @@
<section xml:id="secgroup_add-delete">
<title>Add or delete a security group</title>
<para>Security groups can be added with <command>nova
secgroup-create</command>. </para>
secgroup-create</command>.</para>
<para>The following example shows the creation of the
security group <literal>secure1</literal>. After the
group is created, it can be viewed in the security
@ -51,7 +51,7 @@
</itemizedlist>
<note>
<para>You can add extra rules into the default security group for handling the egress
traffic. Rules are ingress only at this time. </para>
traffic. Rules are ingress only at this time.</para>
</note>
</para>
<para>In the following example, the group
@ -83,16 +83,16 @@
types of traffic. The command requires the following arguments for both TCP and UDP
rules : <itemizedlist>
<listitem>
<para>&lt;secgroup&gt; ID of security group. </para>
<para>&lt;secgroup&gt; ID of security group.</para>
</listitem>
<listitem>
<para>&lt;ip_proto&gt; IP protocol (icmp, tcp, udp). </para>
<para>&lt;ip_proto&gt; IP protocol (icmp, tcp, udp).</para>
</listitem>
<listitem>
<para>&lt;from_port&gt; Port at start of range. </para>
<para>&lt;from_port&gt; Port at start of range.</para>
</listitem>
<listitem>
<para>&lt;to_port&gt; Port at end of range. </para>
<para>&lt;to_port&gt; Port at end of range.</para>
</listitem>
<listitem>
<para>&lt;cidr&gt; CIDR for address range.</para>
@ -101,23 +101,23 @@
<para>For ICMP rules, instead of specifying a begin and end port, you specify the
allowed ICMP code and ICMP type: <itemizedlist>
<listitem>
<para>&lt;secgroup&gt; ID of security group. </para>
<para>&lt;secgroup&gt; ID of security group.</para>
</listitem>
<listitem>
<para>&lt;ip_proto&gt; IP protocol (with icmp specified). </para>
<para>&lt;ip_proto&gt; IP protocol (with icmp specified).</para>
</listitem>
<listitem>
<para>&lt;ICMP_code&gt; The ICMP code. </para>
<para>&lt;ICMP_code&gt; The ICMP code.</para>
</listitem>
<listitem>
<para>&lt;ICMP_type&gt; The ICMP type. </para>
<para>&lt;ICMP_type&gt; The ICMP type.</para>
</listitem>
<listitem>
<para>&lt;cidr&gt; CIDR for the source address range.</para>
</listitem>
</itemizedlist>
<note>
<para> Entering "-1" for both code and type
<para>Entering "-1" for both code and type
indicates that all ICMP codes and types should
be allowed.</para>
</note>
@ -170,19 +170,19 @@
<para>In order to delete a rule, you need to specify the exact same arguments you used
to create it:<itemizedlist>
<listitem>
<para>&lt;secgroup&gt; ID of security group. </para>
<para>&lt;secgroup&gt; ID of security group.</para>
</listitem>
<listitem>
<para>&lt;ip_proto&gt; IP protocol (icmp, tcp, udp). </para>
<para>&lt;ip_proto&gt; IP protocol (icmp, tcp, udp).</para>
</listitem>
<listitem>
<para>&lt;from_port&gt; Port at start of range. </para>
<para>&lt;from_port&gt; Port at start of range.</para>
</listitem>
<listitem>
<para>&lt;to_port&gt; Port at end of range. </para>
<para>&lt;to_port&gt; Port at end of range.</para>
</listitem>
<listitem>
<para>&lt;cidr&gt; CIDR for address range. </para>
<para>&lt;cidr&gt; CIDR for address range.</para>
</listitem>
</itemizedlist><screen>
<prompt>$</prompt> <userinput>nova secgroup-delete-rule default tcp 80 80 0.0.0.0/0</userinput>

4
doc/src/docbkx/common/nova_cli_sshkeys.xml
View File

@ -17,7 +17,7 @@
<prompt>$</prompt> <userinput>nova keypair-add mykey > mykey.pem</userinput></screen>
<para>Save the <filename>mykey.pem</filename> file to a secure
location. It enables root access to any instances with which
the <literal>mykey</literal> key is associated. </para>
the <literal>mykey</literal> key is associated.</para>
</step>
<step>
<title>Import a keypair</title>
@ -28,7 +28,7 @@
<screen>
<prompt>$</prompt> <userinput>nova keypair-add --pub-key mykey.pub mykey</userinput></screen>
<para>You must have the matching private key to access instances
that are associated with this key. </para>
that are associated with this key.</para>
</step>
</procedure>
</section>

6
doc/src/docbkx/common/nova_cli_startstop.xml
View File

@ -13,17 +13,17 @@
<step> <para>To pause a server, run the following command:</para><screen><prompt>$</prompt> <userinput>nova pause</userinput> <replaceable>SERVER</replaceable></screen>
<para>This command stores the state of the VM in
RAM. A paused instance continues to run in a frozen
state. </para>
state.</para>
<para>To un-pause the server, run the following command:</para><screen><prompt>$</prompt> <userinput>nova unpause</userinput> <replaceable>SERVER</replaceable></screen></step>
</procedure></section>
<section xml:id="suspend_resume"><title>Suspend and resume an instance</title> <procedure xml:id="nova_cli_suspend_resume">
<title>To suspend and resume a server</title>
<para>Administrative users might want to suspend an infrequently used
instance or to perform system maintenance. </para>
instance or to perform system maintenance.</para>
<step><para>When you suspend an instance, its VM state is stored on disk,
all memory is written to disk, and the virtual machine is
stopped. Suspending an instance is similar to placing a device
in hibernation; memory and vCPUs become available. </para><para>To initiate a hypervisor-level suspend operation,
in hibernation; memory and vCPUs become available.</para><para>To initiate a hypervisor-level suspend operation,
run the following command:</para><screen><prompt>$</prompt> <userinput>nova suspend</userinput> <replaceable>SERVER</replaceable></screen>
</step>
<step><para>To resume a suspended server:</para>

4
doc/src/docbkx/common/nova_cli_terminate.xml
View File

@ -6,7 +6,7 @@
version="5.0"
xml:id="terminating">
<title>Delete an instance</title>
<para>When you no longer need an instance, you can delete it. </para>
<para>When you no longer need an instance, you can delete it.</para>
<procedure><title>To delete an instance</title><step>
<para>List all instances:</para>
<screen><prompt>$</prompt> <userinput>nova list</userinput></screen>
@ -22,7 +22,7 @@
<literal>newServer</literal> instance, which is in
<literal>ERROR</literal> state:</para>
<screen><prompt>$</prompt> <userinput>nova delete newServer</userinput></screen>
</step><step><para>The command does not notify that your server was deleted. </para>
</step><step><para>The command does not notify that your server was deleted.</para>
<para>Instead, run the <command>nova list</command>
command:</para>
<screen><prompt>$</prompt> <userinput>nova list</userinput></screen>

6
doc/src/docbkx/common/nova_cli_usage_statistics.xml
View File

@ -37,10 +37,10 @@
| devstack-grizzly | 66265572db174a7aa66eba661f58eb9e | 2 | 4096 | 40 |
+------------------+----------------------------------+-----+-----------+---------+</computeroutput></screen>
<para>The <literal>cpu</literal> column shows the sum of
the virtual CPUs for instances running on the host. </para>
the virtual CPUs for instances running on the host.</para>
<para>The <literal>memory_mb</literal> column shows the
sum of the memory (in MB) allocated to the instances
that run on the hosts. </para>
that run on the hosts.</para>
<para>The <literal>disk_gb</literal> column shows the sum
of the root and ephemeral disk sizes (in GB) of the
instances that run on the hosts.</para>
@ -53,7 +53,7 @@
<title>To show instance usage statistics</title>
<step>
<para>Get CPU, memory, I/O, and network statistics for an
instance. </para>
instance.</para>
<para>First, list instances:</para>
<screen><prompt>$</prompt> <userinput>nova list</userinput></screen>
<screen><computeroutput>+--------------------------------------+----------------------+--------+------------+-------------+------------------+

2
doc/src/docbkx/common/nova_cli_userdata.xml
View File

@ -13,7 +13,7 @@
xlink:href="https://help.ubuntu.com/community/CloudInit"
>cloudinit</link> system is an open source package from Ubuntu
that handles early initialization of a cloud instance that makes
use of this <literal>user data</literal>. </para>
use of this <literal>user data</literal>.</para>
<para>This user-data can be put in a file on your local system and
then passed in at instance creation with the flag

4
doc/src/docbkx/common/qemu.xml
View File

@ -52,7 +52,7 @@ libvirt_type=qemu</programlisting></para>
</listitem>
</itemizedlist>
<section xml:id="fixes-rhel-qemu" os="rhel;fedora;centos"><title>Tips and fixes for QEMU on RHEL</title>
<para> If you are testing OpenStack in a virtual machine, you need
<para>If you are testing OpenStack in a virtual machine, you need
to configure nova to use qemu without KVM and hardware
virtualization. The second command relaxes SELinux rules
to allow this mode of operation
@ -61,7 +61,7 @@ libvirt_type=qemu</programlisting></para>
RHEL 6.4. Note nested virtualization will be the much
slower TCG variety, and you should provide lots of memory
to the top level guest, as the OpenStack-created guests
default to 2GM RAM with no overcommit. </para>
default to 2GM RAM with no overcommit.</para>
<note><para>The second command, <command>setsebool</command>, may take a while.</para></note>
<screen><prompt>$</prompt> <userinput>sudo openstack-config --set /etc/nova/nova.conf DEFAULT libvirt_type qemu</userinput>
<prompt>$</prompt> <userinput>sudo setsebool -P virt_use_execmem on</userinput>

10
doc/src/docbkx/common/section_cli_baremetal.xml
View File

@ -16,24 +16,24 @@
</listitem>
<listitem>
<para><command>baremetal-interface-list</command></para>
<para> Lists network interfaces associated with a bare metal
<para>Lists network interfaces associated with a bare metal
node.</para>
</listitem>
<listitem>
<para>
<command>baremetal-interface-remove</command></para>
<para> Removes a network interface from a bare metal
<para>Removes a network interface from a bare metal
node.</para>
</listitem>
<listitem>
<para>
<command>baremetal-node-create</command></para>
<para> Creates a bare metal node.</para>
<para>Creates a bare metal node.</para>
</listitem>
<listitem>
<para>
<command>baremetal-node-delete</command></para>
<para> Removes a bare metal node and any associated
<para>Removes a bare metal node and any associated
interfaces.</para>
</listitem>
<listitem>
@ -42,7 +42,7 @@
</listitem>
<listitem>
<para><command>baremetal-node-show</command></para>
<para> Shows information about a bare metal node.</para>
<para>Shows information about a bare metal node.</para>
</listitem></itemizedlist>
<procedure><title>To manage bare metal nodes</title><step><para>Create a bare metal node.</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-create --pm_address=1.2.3.4 --pm_user=ipmi --pm_password=ipmi $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff</userinput></screen>

36
doc/src/docbkx/common/section_cli_manage_images.xml
View File

@ -7,9 +7,9 @@
<para>During set up of OpenStack cloud, the cloud operator sets
user permissions to manage images.</para>
<para>Image upload and management might be restricted to only
cloud administrators or cloud operators. </para>
cloud administrators or cloud operators.</para>
<para>After you upload an image, it is considered <emphasis
role="italic">golden</emphasis> and you cannot change it. </para>
role="italic">golden</emphasis> and you cannot change it.</para>
<para>You can upload images through the glance client or the Image
Service API. You can also use the nova client to list images,
set and delete image metadata, delete images, and take a
@ -96,12 +96,12 @@
<para>To update an image by name or ID: </para>
<para><screen><prompt>$</prompt> glance image-update IMAGE</screen></para>
<para> To modify image properties, use the following
<para>To modify image properties, use the following
optional arguments:</para>
<itemizedlist>
<listitem>
<para><parameter>--name NAME</parameter>. The
name of the image. </para>
name of the image.</para>
</listitem>
<listitem>
@ -109,36 +109,36 @@
DISK_FORMAT</parameter>. The disk
format of the image. Acceptable formats
are ami, ari, aki, vhd, vmdk, raw, qcow2,
vdi, and iso. </para>
vdi, and iso.</para>
</listitem>
<listitem>
<para><parameter>--container-format
CONTAINER_FORMAT</parameter>. The
container format of the image. Acceptable
formats are ami, ari, aki, bare, and ovf. </para>
formats are ami, ari, aki, bare, and ovf.</para>
</listitem>
<listitem>
<para><parameter>--owner
TENANT_ID</parameter>. The tenant who
should own the image. </para>
should own the image.</para>
</listitem>
<listitem>
<para><parameter>--size SIZE</parameter>. The
size of image data, in bytes. </para>
size of image data, in bytes.</para>
</listitem>
<listitem>
<para><parameter>--min-disk
DISK_GB</parameter>. The minimum size
of disk needed to boot image, in
gigabytes. </para>
gigabytes.</para>
</listitem>
<listitem>
<para><parameter>--min-ram
DISK_RAM</parameter>. The minimum
amount of ram needed to boot image, in
megabytes. </para>
megabytes.</para>
</listitem>
<listitem>
@ -147,7 +147,7 @@
the data for this image resides. For
example, if the image data is stored in
swift, you could specify
<literal>swift://account:key@example.com/container/obj</literal>. </para>
<literal>swift://account:key@example.com/container/obj</literal>.</para>
</listitem>
<listitem>
@ -155,12 +155,12 @@
Local file that contains disk image to be
uploaded during update. Alternatively, you
can pass images to the client through
stdin. </para>
stdin.</para>
</listitem>
<listitem>
<para><parameter>--checksum
CHECKSUM</parameter>. Hash of image
data to use for verification. </para>
data to use for verification.</para>
</listitem>
<listitem>
@ -170,26 +170,26 @@
usage, but indicates that the Glance
server should immediately copy the data
and store it in its configured image
store. </para>
store.</para>
</listitem>
<listitem>
<para><parameter>--is-public
[True|False]</parameter>. Makes an
image accessible to the public. </para>
image accessible to the public.</para>
</listitem>
<listitem>
<para><parameter>--is-protected
[True|False]</parameter>. Prevents an
image from being deleted. </para>
image from being deleted.</para>
</listitem>
<listitem>
<para><parameter>--property
KEY=VALUE</parameter>. Arbitrary
property to associate with image. Can be
used multiple times. </para>
used multiple times.</para>
</listitem>
<listitem>
@ -197,7 +197,7 @@
Deletes all image properties that are not
explicitly set in the update request.
Otherwise, those properties not referenced
are preserved. </para>
are preserved.</para>
</listitem>
<listitem>

10
doc/src/docbkx/common/section_cli_openrc.xml
View File

@ -8,7 +8,7 @@
command-line clients, you must download and source an
environment file, <filename>openrc.sh</filename>. It is
project-specific and contains the credentials used by
OpenStack Compute, Image, and Identity services. </para>
OpenStack Compute, Image, and Identity services.</para>
<para>When you source the file and enter the password, environment
variables are set for that shell. They allow the commands to
communicate to the OpenStack services that run in the
@ -18,7 +18,7 @@
<procedure>
<title>To download the OpenStack RC file</title>
<step>
<para>Log in to the OpenStack dashboard. </para>
<para>Log in to the OpenStack dashboard.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, select the
@ -33,15 +33,15 @@
</step>
<step>
<para>Copy the <filename>openrc.sh</filename> file to the
machine from where you want to run OpenStack commands. </para>
machine from where you want to run OpenStack commands.</para>
<para>For example, copy the file to the machine from where
you want to upload an image with a glance client
command. </para>
command.</para>
</step>
<step>
<para>On any shell from where you want to run OpenStack
commands, source the <filename>openrc.sh</filename>
file for the respective project. </para>
file for the respective project.</para>
<para>In this example, we source the
<filename>demo-openrc.sh</filename> file for the
demo project:</para>

2
doc/src/docbkx/common/section_cli_reboot.xml
View File

@ -6,7 +6,7 @@
<para>You can perform a soft or hard reboot of a running instance. A
soft reboot attempts a graceful shutdown and restart of the
instance. A hard reboot power cycles the instance.</para>
<procedure><title>To reboot a server</title> <step><para>By default, when you reboot a server, it is a soft reboot. </para>
<procedure><title>To reboot a server</title> <step><para>By default, when you reboot a server, it is a soft reboot.</para>
<screen><prompt>$</prompt> <userinput>nova reboot <replaceable>SERVER</replaceable></userinput></screen></step></procedure>
<para>To perform a hard reboot, pass the <parameter>--hard</parameter>
parameter, as follows:</para><screen><prompt>$</prompt> <userinput>nova reboot --hard <replaceable>SERVER</replaceable></userinput></screen></section>

12
doc/src/docbkx/common/section_dashboard_access.xml
View File

@ -18,12 +18,12 @@
overview of the interface.</para>
<!-- <note>
<para>To use the VNC client with the dashboard, the browser
must support HTML5 Canvas and HTML5 WebSockets. </para>
must support HTML5 Canvas and HTML5 WebSockets.</para>
<para>For details about browsers that support noVNC, see <link
xlink:href="https://github.com/kanaka/noVNC/blob/master/README.md"
>noVNC: HTML5 VNC Client</link>, and <link
xlink:href="https://github.com/kanaka/noVNC/wiki/Browser-support"
>Browser support</link>, respectively. </para>
>Browser support</link>, respectively.</para>
</note> -->
<section xml:id="log_in_dashboard">
<title>Log in to the dashboard</title>
@ -39,11 +39,11 @@
<para>The dashboard is available on the node
that has the
<literal>nova-dashboard</literal>
server role. </para>
server role.</para>
</listitem>
<listitem>
<para>The user name and password with which
you can log in to the dashboard. </para>
you can log in to the dashboard.</para>
</listitem>
</itemizedlist>
</step>
@ -67,13 +67,13 @@
that is not considered trustworthy by default.
In this case, verify the certificate. To
proceed anyway, you can add an exception in
the browser to bypass the warning. </para>
the browser to bypass the warning.</para>
</note>
</step>
<step>
<para>On the dashboard log in page, enter your user
name and password and click <guibutton>Sign
In</guibutton>. </para>
In</guibutton>.</para>
</step>
</procedure>
</section>

4
doc/src/docbkx/common/section_dashboard_install.xml
View File

@ -6,7 +6,7 @@
<title>Install the dashboard</title>
<?dbhtml stop-chunking?>
<para>The following instructions show an example dashboard
deployment configured with an Apache web server. </para>
deployment configured with an Apache web server.</para>
<para>To install the OpenStack dashboard, complete the following
high-level steps: </para>
<orderedlist>
@ -36,7 +36,7 @@
following tasks:</para>
<listitem>
<para>To customize your dashboard, see <xref
linkend="dashboard-custom-brand"/>. </para>
linkend="dashboard-custom-brand"/>.</para>
</listitem>
<listitem>
<para>To set up session storage for the dashboard, see

26
doc/src/docbkx/common/section_dashboard_launch_instances_from_image.xml
View File

@ -56,7 +56,7 @@
keypair with an external tool, you can import
it into OpenStack. You can use the keypair for
multiple instances that belong to that
project. </para>
project.</para>
</listitem>
<listitem>
<para>A <emphasis role="bold">security
@ -65,7 +65,7 @@
instances. Security groups hold a set of
firewall policies, known as <emphasis
role="italic">security group
rules</emphasis>. </para>
rules</emphasis>.</para>
</listitem>
</itemizedlist>
</listitem>
@ -84,14 +84,14 @@
<step>
<para>If you are a member of multiple projects, select a
project from the drop-down list at the top of the
<guilabel>Project</guilabel> tab. </para>
<guilabel>Project</guilabel> tab.</para>
</step>
<step>
<para>Click the <guilabel>Images &amp; Snapshot</guilabel>
category. </para>
category.</para>
<para>The dashboard shows the images that have been
uploaded to OpenStack Image Service and are available
for this project. </para>
for this project.</para>
</step>
<step>
<para>Select an image and click
@ -114,24 +114,24 @@
<itemizedlist>
<listitem>
<para>Enter an instance name to assign to the
virtual machine. </para>
virtual machine.</para>
</listitem>
<listitem>
<para>From the <guilabel>Flavor</guilabel>
drop-down list, select the size of the virtual
machine to launch. </para>
machine to launch.</para>
</listitem>
<listitem>
<para>Optionally, select a keypair. </para>
<para>Optionally, select a keypair.</para>
<para>In case an image uses a static root password
or a static key set (neither is recommended),
you do not need to provide a keypair on
starting the instance. </para>
starting the instance.</para>
</listitem>
<listitem>
<para>In <guilabel>Instance Count</guilabel>,
enter the number of virtual machines to launch
from this image. </para>
from this image.</para>
</listitem>
<listitem>
<para>Assign the instance to the default security
@ -142,14 +142,14 @@
<para>If you want to boot from volume, click the
respective entry to expand its options. Set
the options as described in Launching
Instances from a Volume. </para>
Instances from a Volume.</para>
</listitem> -->
</itemizedlist>
</step>
<step>
<para>Click <guibutton>Launch Instance</guibutton>. The
instance is launched on any of the compute nodes in
the cloud. </para>
the cloud.</para>
</step>
</procedure>
<para>After you have launched an instance, switch to the
@ -168,5 +168,5 @@
<para>If you did not provide a keypair on starting and have not
touched security groups or rules so far, by default the
instance can only be accessed from inside the cloud through
VNC at this point. Even pinging the instance is not possible. </para>
VNC at this point. Even pinging the instance is not possible.</para>
</section>

18
doc/src/docbkx/common/section_dashboard_overview.xml
View File

@ -27,15 +27,15 @@
<para>The top-level row shows the user name that you
logged in with. You can also access
<guilabel>Settings</guilabel> or <guibutton>Sign
Out</guibutton> of the Web interface. </para>
Out</guibutton> of the Web interface.</para>
<note>
<para>The visible tabs and functions in the dashboard
depend on the access permissions of the user that
is logged in. They are defined by roles. </para>
is logged in. They are defined by roles.</para>
</note>
<para>If you are logged in as an end user rather than an
admin user, the main screen shows only the
<guilabel>Project</guilabel> tab. </para>
<guilabel>Project</guilabel> tab.</para>
<para>This tab shows details for the projects, or tenants,
of which you are a member.</para>
<para>Select a project from the drop-down list on the
@ -53,7 +53,7 @@
<term><guilabel>Instances</guilabel></term>
<listitem>
<para>Lists instances and volumes created by
users of the project. </para>
users of the project.</para>
<para>From here, you can stop, pause, or
reboot any instances or connect to them
through virtual network computing (VNC).
@ -64,9 +64,9 @@
<term><guilabel>Volumes</guilabel></term>
<listitem>
<para>Lists volumes created by users of the
project. </para>
project.</para>
<para>From here, you can create or delete
volumes. </para>
volumes.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -89,13 +89,13 @@
<para>On the <guilabel>Security
Groups</guilabel> tab, you can list,
create, and delete security groups and
edit rules for security groups. </para>
edit rules for security groups.</para>
<para>On the <guilabel>Keypairs</guilabel>
tab, you can list, create, and import
keypairs, and delete keypairs. </para>
keypairs, and delete keypairs.</para>
<para>On the <guilabel>Floating IPs</guilabel>
tab, you can allocate an IP address to or
release it from a project. </para>
release it from a project.</para>
<para>On the <guilabel>API Access</guilabel>
tab, you can list the API
endpoints.</para>

4
doc/src/docbkx/common/storage-concepts.xml
View File

@ -55,7 +55,7 @@
</tr>
</tbody>
</table>
<para> Other points of note include: <itemizedlist>
<para>Other points of note include: <itemizedlist>
<listitem>
<para><emphasis>OpenStack Object Storage is not used like a
traditional hard drive.</emphasis> Object storage is all
@ -64,7 +64,7 @@
http). This is a good idea as if you don't have to provide
atomic operations (that is, you can rely on eventual
consistency), you can much more easily scale a storage
system and avoid a central point of failure. </para>
system and avoid a central point of failure.</para>
</listitem>
<listitem>
<para><emphasis>The OpenStack Image Service is used to manage

8
doc/src/docbkx/common/support-compute.xml
View File

@ -39,7 +39,7 @@
If it gets started out of order, you may not be able to
create your zip file. Once your CA information is
available, you should be able to go back to nova-manage to
create your zipfile. </para>
create your zipfile.</para>
<para>You may also need to check your proxy settings to see if
they are causing problems with the novarc creation.</para>
<para>Instance errors</para>
@ -79,10 +79,10 @@
<para>Check the file sizes to see if they are reasonable. If
any are missing/zero/very small then <systemitem class="service">nova-compute</systemitem> has
somehow not completed download of the images from
objectstore. </para>
objectstore.</para>
<para>Also check nova-compute.log for exceptions. Sometimes
they don't show up in the console output. </para>
<para> Next, check the /var/log/libvirt/qemu/i-ze0bnh1q.log
they don't show up in the console output.</para>
<para>Next, check the /var/log/libvirt/qemu/i-ze0bnh1q.log
file to see if it exists and has any useful error messages
in it.</para>

6
doc/src/docbkx/common/support-object-storage.xml
View File

@ -6,7 +6,7 @@
<para>For OpenStack Object Storage, everything is logged in /var/log/syslog (or messages on some distros). Several settings enable further customization of logging, such as log_name, log_facility, and log_level, within the object server configuration files.</para>
<section xml:id="handling-drive-failure">
<title>Handling Drive Failure</title>
<para> In the event that a drive has failed, the first step is to make sure the drive is unmounted. This will make it easier for OpenStack Object Storage to work around the failure until it has been resolved. If the drive is going to be replaced immediately, then it is just best to replace the drive, format it, remount it, and let replication fill it up.</para>
<para>In the event that a drive has failed, the first step is to make sure the drive is unmounted. This will make it easier for OpenStack Object Storage to work around the failure until it has been resolved. If the drive is going to be replaced immediately, then it is just best to replace the drive, format it, remount it, and let replication fill it up.</para>
<para>If the drive can’t be replaced immediately, then it is best to leave it unmounted, and remove the drive from the ring. This will allow all the replicas that were on that drive to be replicated elsewhere until the drive is replaced. Once the drive is replaced, it can be re-added to the ring.</para>
<para>Rackspace has seen hints at drive failures by looking at error messages in /var/log/kern.log -
do consider checking this in your monitoring</para>
@ -41,7 +41,7 @@
<section xml:id="recover-ring-builder-file">
<title>Emergency Recovery of Ring Builder Files</title>
<para> You should always keep a backup of Swift ring builder files.
<para>You should always keep a backup of Swift ring builder files.
However, if an emergency occurs, this procedure may assist in returning
your cluster to an operational state.</para>
<para>Using existing Swift tools, there is no way to recover a builder
@ -50,7 +50,7 @@
the one you have lost. The following is what you will need to do.</para>
<warning><title>Warning</title>
<para>This procedure is a last-resort for emergency circumstances - it
requires knowledge of the swift python code and may not succeed. </para></warning>
requires knowledge of the swift python code and may not succeed.</para></warning>
<para>First, load the ring and a new ringbuilder object in a Python REPL:</para>
<programlisting>
>>> from swift.common.ring import RingData, RingBuilder

22
doc/src/docbkx/common/support.xml
View File

@ -22,7 +22,7 @@
question. Be sure you give a clear, concise summary in
the title and provide as much detail as possible in
the description. Paste in your command output or stack
traces, link to screenshots, and so on. </para>
traces, link to screenshots, and so on.</para>
</simplesect>
<simplesect><title>OpenStack mailing lists</title>
<para>Posting your question or scenario to the OpenStack
@ -47,7 +47,7 @@
you are searching for specific information, say about "networking" or "api" for nova, you can
find lots of content using the search feature. More is being added all the time, so be sure to
check back often. You can find the search box in the upper right hand corner of any OpenStack wiki
page. </para></simplesect>
page.</para></simplesect>
<simplesect><title>The Launchpad Bugs area </title>
<para>So you think you've found a bug. That's great! Seriously, it is. The OpenStack community
values your setup and testing efforts and wants your feedback. To log a bug you must
@ -56,36 +56,36 @@
Launchpad Bugs area. It is suggested that you first use the search facility to see
if the bug you found has already been reported (or even better, already fixed). If
it still seems like your bug is new or unreported then it is time to fill out a bug
report. </para>
report.</para>
<para>Some tips: </para>
<itemizedlist><listitem><para>Give a clear, concise summary! </para></listitem>
<listitem><para>Provide as much detail as possible
in the description. Paste in your command output or stack traces, link to
screenshots, etc. </para></listitem>
screenshots, etc.</para></listitem>
<listitem><para>Be sure to include what version of the software you are using.
This is especially critical if you are using a development branch eg. "Grizzly
release" vs git commit bc79c3ecc55929bac585d04a03475b72e06a3208. </para></listitem>
release" vs git commit bc79c3ecc55929bac585d04a03475b72e06a3208.</para></listitem>
<listitem><para>Any deployment specific info is helpful as well, such as Ubuntu
12.04, multi-node install.</para></listitem> </itemizedlist>
<para>The Launchpad Bugs areas are available here - : </para>
<itemizedlist>
<listitem><para> OpenStack Compute: <link
<listitem><para>OpenStack Compute: <link
xlink:href="https://bugs.launchpad.net/nova"
>https://bugs.launchpad.net/nova</link></para></listitem>
<listitem><para> OpenStack Object Storage: <link
<listitem><para>OpenStack Object Storage: <link
xlink:href="https://bugs.launchpad.net/swift"
>https://bugs.launchpad.net/swift</link></para></listitem>
<listitem><para> OpenStack Image Delivery and Registration: <link
<listitem><para>OpenStack Image Delivery and Registration: <link
xlink:href="https://bugs.launchpad.net/glance"
>https://bugs.launchpad.net/glance</link></para></listitem>
<listitem><para> OpenStack Identity: <link
<listitem><para>OpenStack Identity: <link
xlink:href="https://bugs.launchpad.net/keystone"
>https://bugs.launchpad.net/keystone</link></para></listitem>
<listitem><para> OpenStack Dashboard: <link
<listitem><para>OpenStack Dashboard: <link
xlink:href="https://bugs.launchpad.net/horizon"
>https://bugs.launchpad.net/horizon</link></para></listitem>
<listitem><para> OpenStack Network Connectivity: <link
<listitem><para>OpenStack Network Connectivity: <link
xlink:href="https://bugs.launchpad.net/neutron"
>https://bugs.launchpad.net/neutron</link></para></listitem>
</itemizedlist>

4
doc/src/docbkx/common/tables/glance-api.xml
View File

@ -29,11 +29,11 @@
</tr>
<tr>
<td>enable_v1_api=True</td>
<td>(BoolOpt)Deploy the v1 OpenStack Images API. </td>
<td>(BoolOpt)Deploy the v1 OpenStack Images API.</td>
</tr>
<tr>
<td>enable_v2_api=True</td>
<td>(BoolOpt)Deploy the v2 OpenStack Images API. </td>
<td>(BoolOpt)Deploy the v2 OpenStack Images API.</td>
</tr>
<tr>
<td>image_size_cap=1099511627776</td>

102
doc/src/docbkx/common/tables/ldap-keystone-conf.xml
View File

@ -19,28 +19,28 @@
<tr>
<td>
user = dc=Manager,dc=example,dc=com </td>
<td> (StrOpt) User for the LDAP server to use as default. </td>
<td>(StrOpt) User for the LDAP server to use as default.</td>
</tr>
<tr>
<td> password = None </td>
<td> (StrOpt) Password for LDAP server to connect to. </td>
<td>password = None </td>
<td>(StrOpt) Password for LDAP server to connect to.</td>
</tr>
<tr>
<td>
suffix = cn=example,cn=com </td>
<td> (StrOpt) Default suffix for your LDAP server. </td>
<td>(StrOpt) Default suffix for your LDAP server.</td>
</tr>
<tr><td>use_dumb_member = False</td>
<td>(Bool) Indicates whether dumb_member settings are in use.</td></tr>
<tr>
<td>allow_subtree_delete = False
</td>
<td> (Bool) Determine whether to delete LDAP subtrees.</td>
<td>(Bool) Determine whether to delete LDAP subtrees.</td>
</tr>
<tr>
<td>dumb_member = cn=dumb,dc=example,dc=com
</td>
<td>Mockup member as placeholder, for testing purposes. </td>
<td>Mockup member as placeholder, for testing purposes.</td>
</tr><tr>
<td>query_scope = one
</td>
@ -48,48 +48,48 @@
</tr><tr>
<td>user_tree_dn = ou=Users,dc=example,dc=com
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_filter =
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_objectclass = inetOrgPerson
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_id_attribute = cn
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_name_attribute = sn
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_mail_attribute = email
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_pass_attribute = userPassword
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_enabled_attribute = enabled
</td>
<td>Example, userAccountControl. Combines with user_enabled_mask and user_enabled_default settings below to extract the value from an integer
attribute like in Active Directory. </td>
attribute like in Active Directory.</td>
</tr><tr>
<td>user_enabled_mask = 0
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_enabled_default = True
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_attribute_ignore = tenant_id,tenants
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_allow_create = True
</td>
@ -97,16 +97,16 @@
</tr><tr>
<td>user_allow_update = True
</td>
<td> </td>
<td></td>
</tr><tr>
<td>user_allow_delete = True
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>tenant_tree_dn = ou=Groups,dc=example,dc=com
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>tenant_filter =
@ -115,149 +115,149 @@
</tr><tr>
<td>tenant_objectclass = groupOfNames
</td>
<td> </td>
<td></td>
</tr><tr>
<td>tenant_id_attribute = cn
</td>
<td> </td>
<td></td>
</tr><tr>
<td>tenant_member_attribute = member
</td>
<td> </td>
<td></td>
</tr><tr>
<td>tenant_name_attribute = ou
</td>
<td> </td>
<td></td>
</tr><tr>
<td>tenant_desc_attribute = desc
</td>
<td> </td>
<td></td>
</tr><tr>
<td>tenant_enabled_attribute = enabled
</td>
<td> </td>
<td></td>
</tr><tr>
<td>tenant_attribute_ignore =
</td>
<td> </td>
<td></td>
</tr><tr>
<td>tenant_allow_create = True
</td>
<td> </td>
<td></td>
</tr><tr>
<td>tenant_allow_update = True
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>tenant_allow_delete = True
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_tree_dn = ou=Roles,dc=example,dc=com
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_filter =
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_objectclass = organizationalRole
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_id_attribute = cn
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_name_attribute = ou
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_member_attribute = roleOccupant
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_attribute_ignore =
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_allow_create = True
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_allow_update = True
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>role_allow_delete = True
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_tree_dn =
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_filter =
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_objectclass = groupOfNames
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_id_attribute = cn
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_name_attribute = ou
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_member_attribute = member
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_desc_attribute = desc
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_attribute_ignore =
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_allow_create = True
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_allow_update = True
</td>
<td> </td>
<td></td>
</tr>
<tr>
<td>group_allow_delete = True
</td>
<td> </td>
<td></td>
</tr>
</tbody>
</table>

6
doc/src/docbkx/common/trusted-compute-pools.xml
View File

@ -14,10 +14,10 @@
external standalone web-based remote attestation server, cloud providers can ensure that
the compute node is running software with verified measurements, thus they can establish
the foundation for the secure cloud stack. Through the Trusted Computing Pools, cloud
subscribers can request services to be run on verified compute nodes. </para>
subscribers can request services to be run on verified compute nodes.</para>
<para>The remote attestation server performs node verification through the following steps:<orderedlist>
<listitem>
<para> Compute nodes boot with Intel TXT technology enabled.</para>
<para>Compute nodes boot with Intel TXT technology enabled.</para>
</listitem>
<listitem>
<para>The compute node's BIOS, hypervisor and OS are measured.</para>
@ -27,7 +27,7 @@
attestation server.</para>
</listitem>
<listitem>
<para> The attestation server verifies those measurements against good/known
<para>The attestation server verifies those measurements against good/known
database to determine nodes' trustworthiness.</para>
</listitem>
</orderedlist></para>

2
doc/src/docbkx/common/user-data.xml
View File

@ -44,7 +44,7 @@
configured to run a service on boot that retrieves the user data from the metadata
service and take some action based on the contents of the data. The cloud-init package
was designed to do exactly this. In particular, cloud-init is compatible with the
Compute metadata service as well as the Compute config drive. </para>
Compute metadata service as well as the Compute config drive.</para>
<para>Note that cloud-init is not an OpenStack technology. Rather, it is a package that is
designed to support multiple cloud providers, so that the same virtual machine image can
be used in different clouds without modification. Cloud-init is an open source project,

14
doc/src/docbkx/common/using-vnc-console.xml
View File

@ -4,7 +4,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="using-vnc-console">
<title>Using VNC Console</title>
<para> There are several methods to interact with the VNC console,
<para>There are several methods to interact with the VNC console,
using a VNC client directly, a special java client, or through the
web browser. For information about configuring the console,
please refer <link linkend="remote-console-access">refer here</link>.
@ -20,9 +20,9 @@
provided by the nova client: </para>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> <replaceable>[novnc|xvpvnc]</replaceable></userinput></programlisting>
<para>Specify '<literal>novnc</literal>' to get a URL suitable
for pasting into a web browser. </para>
for pasting into a web browser.</para>
<para>Specify '<literal>xvpvnc</literal>' for a URL suitable for
pasting into the Java client. </para>
pasting into the Java client.</para>
<para>To request a web browser URL: </para>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> novnc</userinput></programlisting>
</section>
@ -32,7 +32,7 @@
<title>Access VNC consoles with a Java client</title>
</info>
<para>To enable support for the OpenStack Java VNC client in
compute, run the <literal>nova-xvpvncproxy</literal> service. </para>
compute, run the <literal>nova-xvpvncproxy</literal> service.</para>
<itemizedlist>
<listitem>
<para><literal>xvpvncproxy_port</literal>=<replaceable>[port]</replaceable>
@ -51,7 +51,7 @@
<prompt>$</prompt> <userinput>make</userinput></programlisting>
<para>To create a session, request an access URL by using
<command>python-novaclient</command>. Then, run the client
as follows. </para>
as follows.</para>
<para>To get an access URL: </para>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> xvpvnc</userinput> </programlisting>
<para>To run the client:</para>
@ -63,7 +63,7 @@
<title>Access a VNC console through a web browser</title>
</info>
<para>Retrieving an access_url for a web browser is similar to
the flow for the Java client. </para>
the flow for the Java client.</para>
<para>To get the access URL, run the following command: </para>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> novnc</userinput></programlisting>
@ -71,6 +71,6 @@
<para>Additionally, you can use the OpenStack dashboard, known
as horizon, to access browser-based VNC consoles for
instances. </para>
instances.</para>
</section>
</section>

4
doc/src/docbkx/common/xapi-install-plugins.xml
View File

@ -55,7 +55,7 @@
<prompt>$</prompt> <userinput>./build-rpm.sh</userinput></screen>These
commands leave an <literal>.rpm</literal> file in
the <literal>rpmbuild/RPMS/noarch/</literal>
directory. </para>
directory.</para>
</step>
<step>
<para>Pack the RPM packages to a
@ -73,7 +73,7 @@
<prompt>&gt;</prompt> <userinput>full_path_to_rpmfile</userinput></screen>This
command produces an <literal>.iso</literal> file
in the output directory specified. Copy that file
to the hypervisor. </para>
to the hypervisor.</para>
</step>
<step>
<para>Install the Supplemental Pack. Log

2
doc/src/docbkx/common/xen-install.xml
View File

@ -8,7 +8,7 @@
<link xlink:href="http://docs.vmd.citrix.com/XenServer/6.0.0/1.0/en_gb/installation.html#sys_requirements">
an appropriate server</link>.</para>
<note><para>Xen is a type 1 hypervisor: When your server starts, Xen is the first software that runs. Consequently, you must install XenServer or XCP before you install the operating system on which you want to run OpenStack code. The OpenStack services then run in a virtual machine that you install on top of XenServer.</para></note>
<para> Before you can install your system you must decide if you want
<para>Before you can install your system you must decide if you want
to install Citrix XenServer (either the free edition, or
one of the paid editions) or Xen Cloud Platform from
Xen.org. You can download the software from the following

8
doc/src/docbkx/docbkx-example/src/docbkx/example.xml
View File

@ -30,7 +30,7 @@
</annotation>
</legalnotice>
<abstract>
<para> This document is intended for individuals who whish to produce documentation using Maven and having
<para>This document is intended for individuals who whish to produce documentation using Maven and having
the same "feel" as the documentation that is produced by the mainline OpenStack projects.
</para>
</abstract>
@ -88,7 +88,7 @@
<title>Additional Resources</title>
<itemizedlist spacing="compact">
<listitem>
<para>
<para>
<link xlink:href="http://www.openstack.org">
Openstack - Cloud Software
</link>
@ -124,7 +124,7 @@
<title>Notes and including images</title>
<para>So I want an note and an image in this section ...</para>
<note>
<para>This is an example of a note. </para>
<para>This is an example of a note.</para>
</note>
<para>Here's a sample figure in svg format. The build will convert it to png:</para>
@ -164,7 +164,7 @@
</link>
then follow the link.
</para>
<para> For the <emphasis>pom.xml</emphasis>file that was included in this distribution we will
<para>For the <emphasis>pom.xml</emphasis>file that was included in this distribution we will
parse the individual lines and explaine the meaning.
</para>
<para>

2
doc/src/docbkx/openstack-admin-user/src/ch_overview.xml
View File

@ -17,7 +17,7 @@
command-line clients let you run simple commands to create and
manage resources in a cloud and automate tasks by using
scripts. Each of the core OpenStack projects has its own
command-line client. </para>
command-line client.</para>
<para>You
can modify these examples for your specific use cases.</para>
<para>In addition to these ways of interacting with a cloud, you

14
doc/src/docbkx/openstack-admin-user/src/section_cli_floating_ips.xml
View File

@ -5,27 +5,27 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
<title>Manage IP addresses</title>
<para>Each instance can have a private, or fixed, IP address and a
public, or floating, one. </para>
public, or floating, one.</para>
<para>Private IP addresses are used for communication between
instances, and public ones are used for communication with the
outside world. </para>
outside world.</para>
<para>When you launch an instance, it is automatically assigned a
private IP address that stays the same until you explicitly
terminate the instance. Rebooting an instance has no effect on
the private IP address.</para>
<para>A pool of floating IPs, configured by the cloud operator, is
available in OpenStack Compute. </para>
available in OpenStack Compute.</para>
<para>You can allocate a certain number of these to a project: The
maximum number of floating IP addresses per project is defined
by the quota. </para>
by the quota.</para>
<para>You can add a floating IP address from this set to an
instance of the project. Floating IP addresses can be
dynamically disassociated and associated with other instances
of the same project at any time. </para>
of the same project at any time.</para>
<para>Before you can assign a floating IP address to an instance,
you first must allocate floating IPs to a project. After
floating IP addresses have been allocated to the current
project, you can assign them to running instances. </para>
project, you can assign them to running instances.</para>
<para>One floating IP address can be assigned to only one instance
at a time. Floating IP addresses can be managed with the
<command>nova *floating-ip-*</command> commands, provided
@ -84,7 +84,7 @@
with:<screen><prompt>$</prompt> <userinput>nova floating-ip-list</userinput></screen>In
addition, you must know the instance's name (or ID).
To look up the instances that belong to the current
project, use the <code>nova list</code> command. </para>
project, use the <code>nova list</code> command.</para>
<screen><prompt>$</prompt> <userinput>nova add-floating-ip INSTANCE_NAME_OR_ID FLOATING_IP </userinput></screen>
<para>After you assign the IP with <command>nova
add-floating-ip</command> and configure security group rules for the instance, the instance is

36
doc/src/docbkx/openstack-admin-user/src/section_cli_manage_images.xml
View File

@ -7,9 +7,9 @@
<para>During set up of OpenStack cloud, the cloud operator sets
user permissions to manage images.</para>
<para>Image upload and management might be restricted to only
cloud administrators or cloud operators. </para>
cloud administrators or cloud operators.</para>
<para>After you upload an image, it is considered <emphasis
role="italic">golden</emphasis> and you cannot change it. </para>
role="italic">golden</emphasis> and you cannot change it.</para>
<para>You can upload images through the glance client or the Image
Service API. You can also use the nova client to list images,
set and delete image metadata, delete images, and take a
@ -96,12 +96,12 @@
<para>To update an image by name or ID: </para>
<para><screen><prompt>$</prompt> glance image-update IMAGE</screen></para>
<para> To modify image properties, use the following
<para>To modify image properties, use the following
optional arguments:</para>
<itemizedlist>
<listitem>
<para><parameter>--name NAME</parameter>. The
name of the image. </para>
name of the image.</para>
</listitem>
<listitem>
@ -109,36 +109,36 @@
DISK_FORMAT</parameter>. The disk
format of the image. Acceptable formats
are ami, ari, aki, vhd, vmdk, raw, qcow2,
vdi, and iso. </para>
vdi, and iso.</para>
</listitem>
<listitem>
<para><parameter>--container-format
CONTAINER_FORMAT</parameter>. The
container format of the image. Acceptable
formats are ami, ari, aki, bare, and ovf. </para>
formats are ami, ari, aki, bare, and ovf.</para>
</listitem>
<listitem>
<para><parameter>--owner
TENANT_ID</parameter>. The tenant who
should own the image. </para>
should own the image.</para>
</listitem>
<listitem>
<para><parameter>--size SIZE</parameter>. The
size of image data, in bytes. </para>
size of image data, in bytes.</para>
</listitem>
<listitem>
<para><parameter>--min-disk
DISK_GB</parameter>. The minimum size
of disk needed to boot image, in
gigabytes. </para>
gigabytes.</para>
</listitem>
<listitem>
<para><parameter>--min-ram
DISK_RAM</parameter>. The minimum
amount of ram needed to boot image, in
megabytes. </para>
megabytes.</para>
</listitem>
<listitem>
@ -147,7 +147,7 @@
the data for this image resides. For
example, if the image data is stored in
swift, you could specify
<literal>swift://account:key@example.com/container/obj</literal>. </para>
<literal>swift://account:key@example.com/container/obj</literal>.</para>
</listitem>
<listitem>
@ -155,12 +155,12 @@
Local file that contains disk image to be
uploaded during update. Alternatively, you
can pass images to the client through
stdin. </para>
stdin.</para>
</listitem>
<listitem>
<para><parameter>--checksum
CHECKSUM</parameter>. Hash of image
data to use for verification. </para>
data to use for verification.</para>
</listitem>
<listitem>
@ -170,26 +170,26 @@
usage, but indicates that the Glance
server should immediately copy the data
and store it in its configured image
store. </para>
store.</para>
</listitem>
<listitem>
<para><parameter>--is-public
[True|False]</parameter>. Makes an
image accessible to the public. </para>
image accessible to the public.</para>
</listitem>
<listitem>
<para><parameter>--is-protected
[True|False]</parameter>. Prevents an
image from being deleted. </para>
image from being deleted.</para>
</listitem>
<listitem>
<para><parameter>--property
KEY=VALUE</parameter>. Arbitrary
property to associate with image. Can be
used multiple times. </para>
used multiple times.</para>
</listitem>
<listitem>
@ -197,7 +197,7 @@
Deletes all image properties that are not
explicitly set in the update request.
Otherwise, those properties not referenced
are preserved. </para>
are preserved.</para>
</listitem>
<listitem>

24
doc/src/docbkx/openstack-admin-user/src/section_cli_nova.xml
View File

@ -143,7 +143,7 @@
<listitem>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> nova reboot &lt;server&gt; --hard</programlisting>
<para>Where <parameter>server</parameter> is the
server ID or name. </para>
server ID or name.</para>
<para>Omit the <option>--hard</option> option to
perform a soft reboot.</para>
</listitem>
@ -171,7 +171,7 @@
<para>Where <parameter>server</parameter> is the
server ID or name and
<parameter>flavor</parameter> is the ID or
name of the new flavor. </para>
name of the new flavor.</para>
<para>Specify the optional <option>--poll</option>
option to block while the instance resizes so
that progress can be reported.</para>
@ -497,7 +497,7 @@
<listitem>
<para><option>--no-public</option>.
Optional. Opts out of attaching
PublicNet to your server. </para>
PublicNet to your server.</para>
<note>
<para>RackConnect and Managed Cloud
customers will receive an error if
@ -540,7 +540,7 @@
is written to
<filename>/meta.js</filename> on
the new server. Can be specified
multiple times. </para>
multiple times.</para>
</listitem>
<listitem>
<para><option>--file</option>
@ -565,19 +565,19 @@
<para><option>--user_data</option>
<parameter>user-data</parameter>. User
data file, which is exposed by the
metadata server. </para>
metadata server.</para>
</listitem>
<listitem>
<para><option>--availability_zone</option>
<parameter>availability-zone</parameter>.
The availability zone for instance
placement. </para>
placement.</para>
</listitem>
<listitem>
<para><option>--security_groups</option>
<parameter>security_groups</parameter>.
A comma-separated list of security
group names. </para>
group names.</para>
</listitem>
<listitem>
<para><option>--block_device_mapping</option>
@ -602,15 +602,15 @@
NIC with a specified UUID to a
network, specify the
<option>net-id</option>=<parameter>private-net-id</parameter>
parameter. </para>
parameter.</para>
<para>Optionally, specify the
<option>v4-fixed-ip=</option><parameter>ip-addr</parameter>
parameter to specify an IPv4 fixed
address for NIC. </para>
address for NIC.</para>
<para>If you do not specify any networks
on the <option>--nic</option>
parameter, the Internet and ServiceNet
are attached to your server. </para>
are attached to your server.</para>
<note>
<para>ServiceNet is labeled as
<literal>private</literal> and the
@ -641,12 +641,12 @@
<listitem>
<para><option>--config-drive</option>
<parameter>value</parameter>. Enables
a configuration drive. </para>
a configuration drive.</para>
</listitem>
<listitem>
<para><option>--poll</option>. Blocks
while the instance builds so progress
can be reported. </para>
can be reported.</para>
</listitem>
</itemizedlist>
<para>For example, you might issue the following

24
doc/src/docbkx/openstack-admin-user/src/section_cli_set_quotas.xml
View File

@ -20,58 +20,58 @@
<varlistentry>
<term>Metadata Items</term>
<listitem>
<para>Number of metadata items per instance. </para>
<para>Number of metadata items per instance.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Injected Files</term>
<listitem>
<para>Number of injected files. </para>
<para>Number of injected files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Injected File Content Bytes</term>
<listitem>
<para>Number of bytes per injected file. </para>
<para>Number of bytes per injected file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VCPUs</term>
<listitem>
<para>Number of virtual CPUs that can be allocated in
total. </para>
total.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Instances</term>
<listitem>
<para>Total number of instances. </para>
<para>Total number of instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Volumes</term>
<listitem>
<para>Total number of volumes. </para>
<para>Total number of volumes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Gigabytes</term>
<listitem>
<para>Total size of all volumes, measured in
gigabytes. </para>
gigabytes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RAM (in MB)</term>
<listitem>
<para>Total RAM size of all instances, measured in
megabytes. </para>
megabytes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Floating IPs</term>
<listitem>
<para>Total number of floating IP addresses. </para>
<para>Total number of floating IP addresses.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -84,13 +84,13 @@
<varlistentry>
<term>Security Groups</term>
<listitem>
<para>Number of security groups. </para>
<para>Number of security groups.</para>
</listitem>
</varlistentry>
</variablelist>
<para>You can manage quotas with the nova
<command>quota-*</command> commands, which are provided by
the <literal>python-novaclient</literal> package. </para>
the <literal>python-novaclient</literal> package.</para>
<procedure>
<title>To show default quota values</title>
@ -115,7 +115,7 @@
<title>To set quota values for a project</title>
<step>
<para>Set the quota value for the instances parameter to
2. </para>
2.</para>
<screen><prompt>$</prompt> <userinput>nova quota-update --instances 2 PROJECT_ID</userinput> </screen>
<para>To view a list of options for the
<command>quota-update</command> command,

24
doc/src/docbkx/openstack-admin-user/src/section_cli_swift.xml
View File

@ -150,7 +150,7 @@
<listitem>
<programlisting language="bash" role="gutter: false"><prompt>$</prompt> swift reboot &lt;server&gt; --hard</programlisting>
<para>Where <parameter>server</parameter> is the
server ID or name. </para>
server ID or name.</para>
<para>Omit the <option>--hard</option> option to
perform a soft reboot.</para>
</listitem>
@ -178,7 +178,7 @@
<para>Where <parameter>server</parameter> is the
server ID or name and
<parameter>flavor</parameter> is the ID or
name of the new flavor. </para>
name of the new flavor.</para>
<para>Specify the optional <option>--poll</option>
option to block while the instance resizes so
that progress can be reported.</para>
@ -504,7 +504,7 @@
<listitem>
<para><option>--no-public</option>.
Optional. Opts out of attaching
PublicNet to your server. </para>
PublicNet to your server.</para>
<note>
<para>RackConnect and Managed Cloud
customers will receive an error if
@ -547,7 +547,7 @@
is written to
<filename>/meta.js</filename> on
the new server. Can be specified
multiple times. </para>
multiple times.</para>
</listitem>
<listitem>
<para><option>--file</option>
@ -572,19 +572,19 @@
<para><option>--user_data</option>
<parameter>user-data</parameter>. User
data file, which is exposed by the
metadata server. </para>
metadata server.</para>
</listitem>
<listitem>
<para><option>--availability_zone</option>
<parameter>availability-zone</parameter>.
The availability zone for instance
placement. </para>
placement.</para>
</listitem>
<listitem>
<para><option>--security_groups</option>
<parameter>security_groups</parameter>.
A comma-separated list of security
group names. </para>
group names.</para>
</listitem>
<listitem>
<para><option>--block_device_mapping</option>
@ -609,15 +609,15 @@
NIC with a specified UUID to a
network, specify the
<option>net-id</option>=<parameter>private-net-id</parameter>
parameter. </para>
parameter.</para>
<para>Optionally, specify the
<option>v4-fixed-ip=</option><parameter>ip-addr</parameter>
parameter to specify an IPv4 fixed
address for NIC. </para>
address for NIC.</para>
<para>If you do not specify any networks
on the <option>--nic</option>
parameter, the Internet and ServiceNet
are attached to your server. </para>
are attached to your server.</para>
<note>
<para>ServiceNet is labeled as
<literal>private</literal> and the
@ -648,12 +648,12 @@
<listitem>
<para><option>--config-drive</option>
<parameter>value</parameter>. Enables
a configuration drive. </para>
a configuration drive.</para>
</listitem>
<listitem>
<para><option>--poll</option>. Blocks
while the instance builds so progress
can be reported. </para>
can be reported.</para>
</listitem>
</itemizedlist>
<para>For example, you might issue the following

34
doc/src/docbkx/openstack-admin-user/src/section_dashboard_set_quotas.xml
View File

@ -28,58 +28,58 @@
<varlistentry>
<term>Metadata Items</term>
<listitem>
<para>Number of metadata items per instance. </para>
<para>Number of metadata items per instance.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Injected Files</term>
<listitem>
<para>Number of injected files. </para>
<para>Number of injected files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Injected File Content Bytes</term>
<listitem>
<para>Number of bytes per injected file. </para>
<para>Number of bytes per injected file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VCPUs</term>
<listitem>
<para>Number of virtual CPUs that can be allocated in
total. </para>
total.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Instances</term>
<listitem>
<para>Total number of instances. </para>
<para>Total number of instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Volumes</term>
<listitem>
<para>Total number of volumes. </para>
<para>Total number of volumes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Gigabytes</term>
<listitem>
<para>Total size of all volumes, measured in
gigabytes. </para>
gigabytes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RAM (in MB)</term>
<listitem>
<para>Total RAM size of all instances, measured in
megabytes. </para>
megabytes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Floating IPs</term>
<listitem>
<para>Total number of floating IP addresses. </para>
<para>Total number of floating IP addresses.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -92,7 +92,7 @@
<varlistentry>
<term>Security Groups</term>
<listitem>
<para>Number of security groups. </para>
<para>Number of security groups.</para>
</listitem>
</varlistentry>
</variablelist>
@ -100,28 +100,28 @@
<note> <para>The <guilabel>Quota</guilabel> category shows you the global
default quota values that are hard-coded in OpenStack
Nova. However, you cannot set quota values in the
<guilabel>Quota</guilabel> category. </para></note>
<guilabel>Quota</guilabel> category.</para></note>
<section xml:id="dashboard_set_quotas_procedure">
<title>Set quotas for a project</title>
<procedure><title>To set quotas for a project</title>
<step>
<para>On the <guilabel>Admin</guilabel> tab, select the
<guilabel>Projects</guilabel> category. </para>
<guilabel>Projects</guilabel> category.</para>
</step>
<step>
<para>Select the project for which to set or change
quota values. </para>
quota values.</para>
</step>
<step>
<para>From the <guilabel>Actions</guilabel> drop-down
list, select <guibutton>Modify Quota</guibutton>. </para>
list, select <guibutton>Modify Quota</guibutton>.</para>
<para>A window shows the default quota values for each
project, which are hard-coded in OpenStack Nova. </para>
project, which are hard-coded in OpenStack Nova.</para>
</step>
<step>
<para>Change the values for the quota parameters as
desired. </para>
desired.</para>
<!-- <mediaobject>
<imageobject>
<imagedata
@ -131,7 +131,7 @@
</mediaobject> -->
</step>
<step>
<para>Confirm your changes. </para>
<para>Confirm your changes.</para>
</step>
</procedure>
</section>

8
doc/src/docbkx/openstack-block-storage-admin/add-volume-node.xml
View File

@ -3,12 +3,12 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink"
version="1.0">
<title>Adding Block Storage Nodes</title>
<para>To offer more storage to your tenant's VMs, add another volume node running cinder services by following these steps. </para>
<para>To offer more storage to your tenant's VMs, add another volume node running cinder services by following these steps.</para>
<orderedlist>
<listitem><para>Install the required packages for cinder.</para></listitem>
<listitem><para>Create a volume group called cinder-volumes (configurable using the
<literal>cinder_volume</literal> parameter in <filename>cinder.conf</filename>). </para></listitem>
<literal>cinder_volume</literal> parameter in <filename>cinder.conf</filename>).</para></listitem>
<listitem><para>Configure tgtd with its <filename>targets.conf</filename> file and start the
<literal>tgtd</literal> service.</para></listitem>
@ -18,7 +18,7 @@
<listitem><para>Make sure the <literal>iscsi_ip_address</literal> setting in <filename>cinder.conf</filename>
matches the public IP of the node you're installing, then restart
the cinder services. </para></listitem>
the cinder services.</para></listitem>
</orderedlist>
<para>When you issue a <command>cinder-manage host list</command> command you should see the new volume node listed. If not, look at the logs in <filename>/var/log/cinder/volume.log</filename> for issues. </para>
<para>When you issue a <command>cinder-manage host list</command> command you should see the new volume node listed. If not, look at the logs in <filename>/var/log/cinder/volume.log</filename> for issues.</para>
</section>

28
doc/src/docbkx/openstack-block-storage-admin/backup-block-storage-disks.xml
View File

@ -16,11 +16,11 @@
<orderedlist>
<listitem>
<para><command>lvm2</command>, directly
manipulates the volumes. </para>
manipulates the volumes.</para>
</listitem>
<listitem>
<para><command>kpartx</command> discovers the
partition table created inside the instance. </para>
partition table created inside the instance.</para>
</listitem>
<listitem>
<para><command>tar</command> creates a
@ -44,7 +44,7 @@
volume itself. Remember the volumes
created through a
<command>nova volume-create</command>
exist in an LVM's logical volume. </para>
exist in an LVM's logical volume.</para>
<para>Before creating the
snapshot, ensure that you have enough
space to save it. As a precaution, you
@ -65,7 +65,7 @@
end of the section, we will present a script
that you could use to create scheduled
backups. The script itself exploits what we
discuss here. </para>
discuss here.</para>
<para>First, create the snapshot; this can be
achieved while the volume is attached to an
instance :</para>
@ -89,7 +89,7 @@
the snapshot volume. As a precaution, the size
should be the same as that of the original
volume, even if we know the whole space is not
currently used by the snapshot. </para>
currently used by the snapshot.</para>
<para>We now have a full snapshot, and it only took few seconds ! </para>
<para>Run <command>lvdisplay</command> again to
verify the snapshot. You should see now your
@ -142,14 +142,14 @@
<listitem>
<para>If we want to exploit that snapshot with the
<command>tar</command> program, we first
need to mount our partition on the Block Storage server. </para>
need to mount our partition on the Block Storage server.</para>
<para><command>kpartx</command> is a small utility
which performs table partition discoveries,
and maps it. It can be used to view partitions
created inside the instance. Without using the
partitions created inside instances, we won' t
be able to see its content and create
efficient backups. </para>
efficient backups.</para>
<para>
<programlisting>
<prompt>$</prompt> <userinput>kpartx -av /dev/nova-volumes/volume-00000001-snapshot</userinput>
@ -173,7 +173,7 @@
several partitions; for example.
<literal>nova--volumes-volume--00000001--snapshot2</literal>,
<literal>nova--volumes-volume--00000001--snapshot3</literal>
and so forth. </para>
and so forth.</para>
<para>We can now mount our partition : </para>
<para>
<programlisting>
@ -190,24 +190,24 @@
filesystem) there could be two causes :</para>
<para><itemizedlist>
<listitem>
<para> You didn't allocate enough
<para>You didn't allocate enough
space for the snapshot </para>
</listitem>
<listitem>
<para>
<command>kpartx</command> was
unable to discover the partition
table. </para>
table.</para>
</listitem>
</itemizedlist>Allocate more space to the
snapshot and try the process again. </para>
snapshot and try the process again.</para>
</listitem>
</itemizedlist>
<para>
<emphasis role="bold"> 3- Use tar in order to create archives</emphasis>
<itemizedlist>
<listitem>
<para> Now that the volume has been mounted,
<para>Now that the volume has been mounted,
you can create a backup of it : </para>
<para>
<screen>
@ -228,7 +228,7 @@
<listitem>
<para>You should always have the checksum for
your backup files. The checksum is a
unique identifier for a file. </para>
unique identifier for a file.</para>
<para>When you transfer that same file over
the network, you can run another checksum
calculation. If the checksums are
@ -246,7 +246,7 @@
<command>sha1sum</command> should be
used carefully, since the required time
for the calculation is directly
proportional to the file's size. </para>
proportional to the file's size.</para>
<para>For files larger than ~4-6 gigabytes,
and depending on your CPU, the process may
take a long time.</para>

2
doc/src/docbkx/openstack-block-storage-admin/bk-block-storage-adminguide.xml
View File

@ -32,7 +32,7 @@
</legalnotice>
<abstract>
<para>This document is for system administrators of the
OpenStack Block Storage Service. </para>
OpenStack Block Storage Service.</para>
</abstract>
<revhistory>
<!-- ... continue addding more revisions here as you change this document using the markup shown below... -->

6
doc/src/docbkx/openstack-block-storage-admin/block-storage-manage-volumes.xml
View File

@ -16,14 +16,14 @@
storage solution like SAN of NFS, where you can attach a
volume to multiple servers. With the OpenStack Block
Storage service, you can attach a volume to only one
instance at a time. </para>
instance at a time.</para>
<para>The OpenStack Block Storage service also provides
drivers that enable you to use several vendors' back-end
storage devices, in addition to or instead of the base LVM
implementation.</para>
</note>
<para>The following high-level procedure shows you how to create
and attach a volume to a server instance. </para>
and attach a volume to a server instance.</para>
<procedure>
<title>To create and attach a volume to a server
instance:</title>
@ -65,7 +65,7 @@
and labels it as LVM. The network uses
<literal>FlatManger</literal> is the
<literal>NetworkManager</literal> setting for
OpenStack Compute (Nova). </para>
OpenStack Compute (Nova).</para>
<para>Please note that the network mode doesn't interfere at
all with the way cinder works, but networking must be set
up for cinder to work. Please refer to <link

4
doc/src/docbkx/openstack-block-storage-admin/block-storage-overview.xml
View File

@ -42,7 +42,7 @@
<listitem>
<para><emphasis role="bold">cinder-backup</emphasis>
Provides a means to back up a Cinder Volume to
OpenStack Object Store (SWIFT). </para>
OpenStack Object Store (SWIFT).</para>
</listitem>
</itemizedlist>
<para>The OpenStack Block Storage service contains the following
@ -76,7 +76,7 @@
password are assigned per user. Key pairs granting
access to a volume are enabled per user, but quotas to
control resource consumption across available hardware
resources are per tenant. </para>
resources are per tenant.</para>
<para>For tenants, quota controls are available to
limit:</para>
<itemizedlist>

4
doc/src/docbkx/openstack-block-storage-admin/drivers/ceph-rbd-volume-driver.xml
View File

@ -78,7 +78,7 @@
consistency of the data. In an ideal setup
you need to run at least 3
<code>ceph-mon</code> daemons, on
separate servers. </para>
separate servers.</para>
</listitem>
</itemizedlist>
<para>Ceph developers recommend you use btrfs as a
@ -134,7 +134,7 @@
<para>For detailed installation instructions and
benchmarking information, see <link
xlink:href="http://www.sebastien-han.fr/blog/2012/06/10/introducing-ceph-to-openstack/"
>http://www.sebastien-han.fr/blog/2012/06/10/introducing-ceph-to-openstack/</link>. </para>
>http://www.sebastien-han.fr/blog/2012/06/10/introducing-ceph-to-openstack/</link>.</para>
</simplesect>
</section>

6
doc/src/docbkx/openstack-block-storage-admin/drivers/glusterfs-driver.xml
View File

@ -11,13 +11,13 @@
homepage</link>.</para>
<para>This driver enables use of GlusterFS in a similar fashion as
the NFS driver. It supports basic volume operations, and like
NFS, does not support snapshot/clone. </para>
NFS, does not support snapshot/clone.</para>
<note>
<para>You must use a Linux kernel of version 3.4 or greater
(or version 2.6.32 or greater in RHEL/CentOS 6.3+) when
working with Gluster-based volumes. See <link
xlink:href="https://bugs.launchpad.net/nova/+bug/1177103"
>Bug 1177103</link> for more information. </para>
>Bug 1177103</link> for more information.</para>
</note>
<para>To use Cinder with GlusterFS, first set the
<literal>volume_driver</literal> in
@ -104,7 +104,7 @@ volume_driver=cinder.volume.drivers.glusterfs.GlusterfsDriver
"<command>dd</command>" or a similar
command to create the full-sized file, so
volume creation takes a greater amount of
time. </para></td>
time.</para></td>
</tr>
</tbody>
</table>

16
doc/src/docbkx/openstack-block-storage-admin/drivers/hds-volume-driver.xml
View File

@ -51,7 +51,7 @@
<title>Configuration</title>
<para>
HDS driver supports the concept of differentiated services,
<footnote xml:id='hds-fn-svc-1'><para> Not to be confused with
<footnote xml:id='hds-fn-svc-1'><para>Not to be confused with
Cinder volume service </para> </footnote> where <link
linkend="multi_backend">volume type</link> can be associated
with the fine tuned performance characteristics of HDP -- the
@ -67,10 +67,10 @@
Configuration is read from an xml format file. Its sample is shown
below, for single backend and for multi-backend cases.
</para>
<note><itemizedlist><listitem><para> HUS configuration file is
<note><itemizedlist><listitem><para>HUS configuration file is
read at the start of cinder-volume service. Any configuration
changes after that will require a service restart.
</para></listitem> <listitem><para> It is not recommended to
</para></listitem> <listitem><para>It is not recommended to
manage a HUS array simultaneously from multiple cinder instances
or servers. <footnote xml:id='hds-one-instance-only'> <para>It is
okay to run manage multiple HUS arrays using multiple cinder
@ -259,12 +259,12 @@
HDS volume driver. Four differentiated service labels are
predefined: <literal>svc_0</literal>, <literal>svc_1</literal>,
<literal>svc_2</literal>, <literal>svc_3</literal><footnote
xml:id='hds-no-weight'><para> There is no relative precedence
xml:id='hds-no-weight'><para>There is no relative precedence
or weight amongst these four labels.</para></footnote>. Each
such service label in turn associates with the following
parameters/tags:
<orderedlist>
<listitem> <para> <literal>volume-types</literal>: A
<listitem><para><literal>volume-types</literal>: A
create_volume call with a certain <link
linkend="multi_backend">volume type</link> shall be matched up
with this tag. <literal>default</literal> is special in that
@ -275,9 +275,9 @@
occur in volume creation.
</para>
</listitem>
<listitem> <para> <literal>HDP</literal>, the pool ID
<listitem><para><literal>HDP</literal>, the pool ID
associated with the service. </para> </listitem>
<listitem> <para>
<listitem><para>
An iSCSI port dedicated to the service.
</para> </listitem>
</orderedlist>
@ -286,7 +286,7 @@
<literal>svc_1</literal>, <literal>svc_2</literal>,
<literal>svc_3</literal>) associated with it. But any mix of
these four service labels can be used in the same instance
<footnote xml:id='hds-stats-all-hdp'> <para> get_volume_stats() shall always provide the
<footnote xml:id='hds-stats-all-hdp'> <para>get_volume_stats() shall always provide the
available capacity based on the combined sum of all the HDPs
used in these services labels.</para></footnote>.
</para>

2
doc/src/docbkx/openstack-block-storage-admin/drivers/hp-lefthand-driver.xml
View File

@ -48,7 +48,7 @@
<simplesect>
<title>Configuring the VSA</title>
<para>In addition to configuring the cinder-volume service some pre configuration
has to happen on the VSA for proper functioning in an Openstack environment. </para>
has to happen on the VSA for proper functioning in an Openstack environment.</para>
<para>
<itemizedlist>
<listitem>

30
doc/src/docbkx/openstack-block-storage-admin/drivers/ibm-storwize-svc-driver.xml
View File

@ -30,7 +30,7 @@
<note>
<para>If using iSCSI, ensure that the compute nodes
have iSCSI network access to the Storwize family
or SVC system. </para>
or SVC system.</para>
</note>
<note>
<para>OpenStack Nova's Grizzly version supports iSCSI
@ -56,7 +56,7 @@
<note>
<para>If using FC, ensure that the compute nodes
have FC connectivity to the Storwize family
or SVC system. </para>
or SVC system.</para>
</note>
</simplesect>
<simplesect>
@ -68,13 +68,13 @@
iSCSI connections.
<note>
<para>CHAP secrets are not added to existing
hosts. </para>
hosts.</para>
</note>
<note>
<para>CHAP secrets are passed from Cinder to Nova
in clear text. This communication should be
secured to ensure that CHAP secrets are not
discovered. </para>
discovered.</para>
</note>
</para>
</simplesect>
@ -89,7 +89,7 @@
Details about the configuration flags and how
to provide the flags to the driver appear in the
<link linkend="ibm-storwize-svc-driver2">
next section</link>. </para>
next section</link>.</para>
</simplesect>
<simplesect>
<title>Configuring user authentication for the driver
@ -105,12 +105,12 @@
provided by the
<literal>san_ssh_port</literal> flag.
By default, the port value is configured to
be port 22 (SSH). </para>
be port 22 (SSH).</para>
<note>
<para>Make sure the compute node running
the nova-volume management driver has SSH
network access to
the storage system. </para>
the storage system.</para>
</note>
<para>To allow the driver to communicate with the
Storwize family or SVC system,
@ -125,12 +125,12 @@
storage and security administrator regarding
the preferred authentication method and how
passwords or SSH keys should be stored in a
secure manner. </para>
secure manner.</para>
<note>
<para>When creating a new user on the Storwize or
SVC system, make sure the user belongs to
the Administrator group or to another group
that has an Administrator role. </para>
that has an Administrator role.</para>
</note>
<para>If using password authentication, assign a
password to the user on the Storwize or SVC
@ -154,7 +154,7 @@
The private key should
be provided to the driver using the
<literal>san_private_key</literal>
configuration flag. </para>
configuration flag.</para>
</simplesect>
<simplesect>
<title>Creating a SSH key pair using OpenSSH</title>
@ -183,7 +183,7 @@ ssh-keygen -t rsa
configuration flag. The public key should be
uploaded to the Storwize family or SVC system
using the storage management GUI or command
line interface. </para>
line interface.</para>
<note>
<para>Ensure that Cinder has read permissions on
the private key file.</para>
@ -209,7 +209,7 @@ volume_driver = cinder.volume.drivers.storwize_svc.StorwizeSVCDriver
<para>The following options specify default values for all
volumes.
Some can be over-ridden using volume types, which
are described below. </para>
are described below.</para>
<table rules="all">
<caption>List of configuration flags for Storwize
storage and SVC driver</caption>
@ -426,7 +426,7 @@ volume_driver = cinder.volume.drivers.storwize_svc.StorwizeSVCDriver
or SVC system to prepare a new
FlashCopy mapping. The driver
accepts a maximum wait time of 600
seconds (10 minutes). </para></footnote>
seconds (10 minutes).</para></footnote>
(seconds)</para></td>
</tr>
<tr>
@ -481,7 +481,7 @@ enabled_backends = v7k1,v7k2
common options are placed under
<literal>[DEFAULT]</literal>, while options
specific to a back-end are placed in the appropriate
section. </para>
section.</para>
<para>By default, volumes will be allocated between back-ends
to balance allocated space.
@ -493,7 +493,7 @@ enabled_backends = v7k1,v7k2
and can be managed using the cinder client, using the
<literal>type-create</literal>, <literal>type-delete</literal>,
<literal>type-key</literal>, and <literal>type-list</literal>
arguments. </para>
arguments.</para>
<para>The <literal>extra specs</literal> keys which have the
"capabilities" prefix (called "scope") are interpreted by the

16
doc/src/docbkx/openstack-block-storage-admin/drivers/netapp-volume-driver.xml
View File

@ -17,7 +17,7 @@
clustered Data ONTAP systems provide OpenStack
compute instances with access to NetApp 7-Mode
storage controllers and clustered Data ONTAP
storage systems. </para>
storage systems.</para>
<section xml:id="netapp-iscsi-driver-7mode">
<title>NetApp iSCSI driver for 7-Mode storage controller</title>
<para>The NetApp iSCSI driver for 7-Mode is a
@ -30,7 +30,7 @@
additional NetApp management software, namely
OnCommand™, installed and configured for using
7-Mode storage controllers before configuring
the 7-Mode driver on OpenStack. </para>
the 7-Mode driver on OpenStack.</para>
<simplesect>
<title>Configuration options available for the 7-Mode system
driver</title>
@ -139,7 +139,7 @@
using vFiler to host OpenStack
volumes. MultiStore® must be
enabled before using vFiler for
provisioning. </para>
provisioning.</para>
</td>
</tr>
</tbody>
@ -148,7 +148,7 @@
<para>Make sure that at least one of the
flags netapp_storage_service or
netapp_storage_service_prefix is
specified in configuration. </para>
specified in configuration.</para>
</note>
<para>Refer to
<link xlink:href="https://communities.netapp.com/groups/openstack"
@ -164,14 +164,14 @@
clustered Data ONTAP storage systems that
allows the provisioning and managing the SAN
block storage entity, that is, NetApp LUN
using iSCSI protocol. </para>
using iSCSI protocol.</para>
<para>The NetApp iSCSI driver for clustered Data
ONTAP requires additional NetApp management
software namely OnCommand, WFA and the NetApp
Cloud Web Service application to be installed
and configured for using clustered Data ONTAP
systems before configuring ONTAP cluster
driver on OpenStack. </para>
driver on OpenStack.</para>
<simplesect>
<title>Configuration options for the clustered
Data ONTAP driver </title>
@ -225,7 +225,7 @@
<td><para/></td>
<td><para>The host name/IP address
of NetApp Cloud Web Service
installation. </para>
installation.</para>
</td>
</tr>
<tr>
@ -244,7 +244,7 @@
<td><para/></td>
<td><para>Login user name for
NetApp Cloud Web Service
installation. </para>
installation.</para>
</td>
</tr>
<tr>

2
doc/src/docbkx/openstack-block-storage-admin/drivers/nexenta-volume-driver.xml
View File

@ -6,7 +6,7 @@
<title>Nexenta</title>
<para>NexentaStor Appliance is NAS/SAN software platform designed for building reliable and fast network storage arrays. The
the OpenSolaris and uses ZFS as a disk management system. NexentaStor can serve as a storage node for the OpenStack and
for the virtual servers via iSCSI protocol. </para>
for the virtual servers via iSCSI protocol.</para>
<para>The Nexenta driver allows you to use Nexenta SA to
store Nova volumes. Every Nova volume is represented
by a single zvol in a predefined Nexenta volume. For

2
doc/src/docbkx/openstack-block-storage-admin/drivers/nfs-volume-driver.xml
View File

@ -76,7 +76,7 @@ volume_driver=cinder.volume.drivers.nfs.NfsDriver
<td><para>Optional</para></td>
<td><para><literal>0.95</literal></para></td>
<td><para>(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be
allocated to the volume destination. </para></td>
allocated to the volume destination.</para></td>
</tr>
<tr>
<td><para><literal>nfs_oversub_ratio</literal></para></td>

16
doc/src/docbkx/openstack-block-storage-admin/drivers/xen-sm-driver.xml
View File

@ -66,14 +66,14 @@
<para><emphasis role="bold"
>Backend:</emphasis> A term for a
particular storage backend. This could
be iSCSI, NFS, Netapp etc. </para>
be iSCSI, NFS, Netapp etc.</para>
</listitem>
<listitem>
<para><emphasis role="bold"
>Backend-config:</emphasis> All the
parameters required to connect to a
specific backend. For e.g. For NFS,
this would be the server, path, etc. </para>
this would be the server, path, etc.</para>
</listitem>
<listitem>
<para><emphasis role="bold"
@ -92,14 +92,14 @@
driver uses a simple "first-fit"
policy, where the first backend that
can successfully create this volume is
the one that is used. </para>
the one that is used.</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Operation</title>
<para>The admin uses the nova-manage command
detailed below to add flavors and backends. </para>
detailed below to add flavors and backends.</para>
<para>One or more cinder-volume service instances
will be deployed per availability zone. When
an instance is started, it will create storage
@ -110,7 +110,7 @@
completely symmetric and hence should be able
to service any
<literal>create_volume</literal> request
within the zone. </para>
within the zone.</para>
<note>
<title>On XenServer, PV guests
required</title>
@ -171,7 +171,7 @@ Note: SR type and config connection parameters are in keeping with the XenAPI Co
<prompt>$</prompt> nova-manage sm backend_delete &lt;backend-id>
</programlisting>
<para> Example: For the NFS storage manager plugin, the steps
<para>Example: For the NFS storage manager plugin, the steps
below may be used.
</para>
<programlisting>
@ -197,11 +197,11 @@ Note: SR type and config connection parameters are in keeping with the XenAPI Co
<para>Currently, the flavors have not been tied to
the volume types API. As a result, we simply
end up creating volumes in a "first fit" order
on the given backends. </para>
on the given backends.</para>
<para>The standard euca-* or OpenStack API
commands (such as volume extensions) should be
used for creating, destroying, attaching, or
detaching volumes. </para>
detaching volumes.</para>
</simplesect>
</section>
</section>

4
doc/src/docbkx/openstack-block-storage-admin/drivers/xenapi-nfs.xml
View File

@ -4,9 +4,9 @@
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0">
<title>XenAPINFS</title>
<para> XenAPINFS is a Block Storage (Cinder) driver which is using an
<para>XenAPINFS is a Block Storage (Cinder) driver which is using an
NFS share through XenAPI's Storage Manager to store virtual
disk images and exposing those virtual disks as volumes. </para>
disk images and exposing those virtual disks as volumes.</para>
<para>
This driver is not accessing the NFS share directly, it is only accessing the

Some files were not shown because too many files have changed in this diff Show More