Added complete Doc Convention to config-reference guide.
backport: havana Change-Id: I0936caed5cac45373df9bbc077f66bcfa2f96b58 Partial-Bug: #1121866
This commit is contained in:
parent
7ec78aef2d
commit
7ac18a94b8
@ -29,7 +29,7 @@
|
|||||||
less time to restore a volume than to take a full
|
less time to restore a volume than to take a full
|
||||||
copy.</para>
|
copy.</para>
|
||||||
<note>
|
<note>
|
||||||
<para>Cinder enables you to:</para>
|
<para>Block Storage Service enables you to:</para>
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Restore to a new volume, which
|
<para>Restore to a new volume, which
|
||||||
|
@ -7,7 +7,7 @@
|
|||||||
<para>This section describes how to configure the <systemitem
|
<para>This section describes how to configure the <systemitem
|
||||||
class="service">cinder-backup</systemitem> service and its
|
class="service">cinder-backup</systemitem> service and its
|
||||||
drivers.</para>
|
drivers.</para>
|
||||||
<para>The volume drivers are included with the Cinder repository
|
<para>The volume drivers are included with the Block Storage repository
|
||||||
(<link xlink:href="https://github.com/openstack/cinder"
|
(<link xlink:href="https://github.com/openstack/cinder"
|
||||||
>https://github.com/openstack/cinder</link>). To set a
|
>https://github.com/openstack/cinder</link>). To set a
|
||||||
backup driver, use the <literal>backup_driver</literal> flag.
|
backup driver, use the <literal>backup_driver</literal> flag.
|
||||||
@ -15,4 +15,4 @@
|
|||||||
<xi:include href="backup/ceph-backup-driver.xml"/>
|
<xi:include href="backup/ceph-backup-driver.xml"/>
|
||||||
<xi:include href="backup/tsm-backup-driver.xml"/>
|
<xi:include href="backup/tsm-backup-driver.xml"/>
|
||||||
<xi:include href="backup/swift-backup-driver.xml"/>
|
<xi:include href="backup/swift-backup-driver.xml"/>
|
||||||
</section>
|
</section>
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
||||||
xml:id="section_block-storage-overview">
|
xml:id="section_block-storage-overview">
|
||||||
<title>Introduction to the Block Storage Service</title>
|
<title>Introduction to the Block Storage Service</title>
|
||||||
<para>The Block Storage Service provides persistent
|
<para>The Openstack Block Storage Service provides persistent
|
||||||
block storage resources that OpenStack Compute instances can
|
block storage resources that OpenStack Compute instances can
|
||||||
consume. This includes secondary attached storage similar to
|
consume. This includes secondary attached storage similar to
|
||||||
the Amazon Elastic Block Storage (EBS) offering. In addition,
|
the Amazon Elastic Block Storage (EBS) offering. In addition,
|
||||||
@ -23,7 +23,7 @@
|
|||||||
app that authenticates and routes requests throughout
|
app that authenticates and routes requests throughout
|
||||||
the Block Storage Service. It supports the OpenStack
|
the Block Storage Service. It supports the OpenStack
|
||||||
APIs only, although there is a translation that can be
|
APIs only, although there is a translation that can be
|
||||||
done through Nova's EC2 interface, which calls in to
|
done through Compute's EC2 interface, which calls in to
|
||||||
the cinderclient.</para>
|
the cinderclient.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -41,8 +41,8 @@
|
|||||||
</listitem>
|
</listitem>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para><systemitem class="service">cinder-backup</systemitem>
|
<para><systemitem class="service">cinder-backup</systemitem>
|
||||||
Provides a means to back up a Cinder Volume to
|
Provides a means to back up a Block Storage Volume
|
||||||
OpenStack Object Store (SWIFT).</para>
|
to OpenStack Object Store (SWIFT).</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
<para>The Block Storage Service contains the following
|
<para>The Block Storage Service contains the following
|
||||||
|
@ -7,7 +7,7 @@
|
|||||||
<para>To use different volume drivers for the <systemitem
|
<para>To use different volume drivers for the <systemitem
|
||||||
class="service">cinder-volume</systemitem> service, use
|
class="service">cinder-volume</systemitem> service, use
|
||||||
the parameters described in these sections.</para>
|
the parameters described in these sections.</para>
|
||||||
<para>The volume drivers are included in the Cinder repository
|
<para>The volume drivers are included in the Block Storage repository
|
||||||
(<link xlink:href="https://github.com/openstack/cinder"
|
(<link xlink:href="https://github.com/openstack/cinder"
|
||||||
>https://github.com/openstack/cinder</link>). To set a
|
>https://github.com/openstack/cinder</link>). To set a
|
||||||
volume driver, use the <literal>volume_driver</literal> flag.
|
volume driver, use the <literal>volume_driver</literal> flag.
|
||||||
|
@ -7,9 +7,9 @@
|
|||||||
xmlns:ns4="http://www.w3.org/2000/svg"
|
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||||
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||||
xmlns:ns="http://docbook.org/ns/docbook">
|
xmlns:ns="http://docbook.org/ns/docbook">
|
||||||
<title>OpenStack Block Storage</title>
|
<title>Block Storage</title>
|
||||||
<para>The Block Storage Service works with many different storage
|
<para>The OpenStack Block Storage Service works with many different
|
||||||
drivers that you can configure by using these instructions.</para>
|
storage drivers that you can configure by using these instructions.</para>
|
||||||
<xi:include href="block-storage/section_block-storage-overview.xml"/>
|
<xi:include href="block-storage/section_block-storage-overview.xml"/>
|
||||||
<section xml:id="setting-flags-in-cinder-conf-file">
|
<section xml:id="setting-flags-in-cinder-conf-file">
|
||||||
<title><filename>cinder.conf</filename> configuration file</title>
|
<title><filename>cinder.conf</filename> configuration file</title>
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
||||||
xml:id="ch_configuring-openstack-compute">
|
xml:id="ch_configuring-openstack-compute">
|
||||||
<title>OpenStack Compute</title>
|
<title>Compute</title>
|
||||||
<para>The OpenStack Compute service is a cloud computing
|
<para>The OpenStack Compute service is a cloud computing
|
||||||
fabric controller, the main part of an IaaS system. It can
|
fabric controller, the main part of an IaaS system. It can
|
||||||
be used for hosting and manging cloud computing systems.
|
be used for hosting and manging cloud computing systems.
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
||||||
xml:id="ch_configuring-dashboard">
|
xml:id="ch_configuring-dashboard">
|
||||||
<title>OpenStack dashboard</title>
|
<title>Dashboard</title>
|
||||||
<para>This chapter describes how to configure the OpenStack
|
<para>This chapter describes how to configure the OpenStack
|
||||||
dashboard with Apache web server.</para>
|
dashboard with Apache web server.</para>
|
||||||
<xi:include href="../common/section_dashboard-configure.xml"/>
|
<xi:include href="../common/section_dashboard-configure.xml"/>
|
||||||
|
@ -7,9 +7,9 @@
|
|||||||
xmlns:ns4="http://www.w3.org/2000/svg"
|
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||||
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||||
xmlns:ns="http://docbook.org/ns/docbook">
|
xmlns:ns="http://docbook.org/ns/docbook">
|
||||||
<title>OpenStack Identity Service</title>
|
<title>Identity Service</title>
|
||||||
<?dbhtml stop-chunking?>
|
<?dbhtml stop-chunking?>
|
||||||
<para>The Identity Service has several configuration options.</para>
|
<para>The OpenStack Identity Service has several configuration options.</para>
|
||||||
<xi:include href="../common/section_identity-configure.xml"/>
|
<xi:include href="../common/section_identity-configure.xml"/>
|
||||||
<xi:include href="../common/section_keystone_certificates-for-pki.xml"/>
|
<xi:include href="../common/section_keystone_certificates-for-pki.xml"/>
|
||||||
<xi:include href="../common/section_keystone-ssl-config.xml"/>
|
<xi:include href="../common/section_keystone-ssl-config.xml"/>
|
||||||
|
@ -7,7 +7,7 @@
|
|||||||
xmlns:ns4="http://www.w3.org/2000/svg"
|
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||||
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||||
xmlns:ns="http://docbook.org/ns/docbook">
|
xmlns:ns="http://docbook.org/ns/docbook">
|
||||||
<title>OpenStack Image Service</title>
|
<title>Image Service</title>
|
||||||
<para>Compute relies on an external image service to store virtual
|
<para>Compute relies on an external image service to store virtual
|
||||||
machine images and maintain a catalog of available images. By
|
machine images and maintain a catalog of available images. By
|
||||||
default, Compute is configured to use the OpenStack Image Service
|
default, Compute is configured to use the OpenStack Image Service
|
||||||
|
@ -7,7 +7,7 @@
|
|||||||
xmlns:ns4="http://www.w3.org/2000/svg"
|
xmlns:ns4="http://www.w3.org/2000/svg"
|
||||||
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
|
||||||
xmlns:ns="http://docbook.org/ns/docbook">
|
xmlns:ns="http://docbook.org/ns/docbook">
|
||||||
<title>OpenStack Networking</title>
|
<title>Networking</title>
|
||||||
<para>This chapter explains the configuration options and scenarios for OpenStack Networking.
|
<para>This chapter explains the configuration options and scenarios for OpenStack Networking.
|
||||||
For installation prerequisites, steps, and use cases, refer to corresponding chapter in the
|
For installation prerequisites, steps, and use cases, refer to corresponding chapter in the
|
||||||
<emphasis role="italic">OpenStack Installation Guide</emphasis>.</para>
|
<emphasis role="italic">OpenStack Installation Guide</emphasis>.</para>
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
||||||
xml:id="ch_configuring-object-storage">
|
xml:id="ch_configuring-object-storage">
|
||||||
<title>OpenStack Object Storage</title>
|
<title>Object Storage</title>
|
||||||
<para>OpenStack Object Storage uses multiple configuration files
|
<para>OpenStack Object Storage uses multiple configuration files
|
||||||
for multiple services and background daemons, and
|
for multiple services and background daemons, and
|
||||||
<command>paste.deploy</command> to manage server
|
<command>paste.deploy</command> to manage server
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
xmlns="http://docbook.org/ns/docbook"
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||||
<title>OpenStack Identity Service</title>
|
<title>Identity Service</title>
|
||||||
<procedure>
|
<procedure>
|
||||||
<title>To configure the Identity Service for use with
|
<title>To configure the Identity Service for use with
|
||||||
Networking</title>
|
Networking</title>
|
||||||
@ -27,13 +27,13 @@ echo `"$@" | awk '/ id / { print $4 }'`
|
|||||||
</substeps>
|
</substeps>
|
||||||
</step>
|
</step>
|
||||||
<step>
|
<step>
|
||||||
<title>Create the OpenStack Networking service entry</title>
|
<title>Create the Networking service entry</title>
|
||||||
<para>OpenStack Networking must be available in the OpenStack
|
<para>OpenStack Networking must be available in the OpenStack
|
||||||
Compute service catalog. Create the service:</para>
|
Compute service catalog. Create the service:</para>
|
||||||
<screen><prompt>$</prompt> <userinput>NEUTRON_SERVICE_ID=$(get_id keystone service-create --name neutron --type network --description 'OpenStack Networking Service')</userinput></screen>
|
<screen><prompt>$</prompt> <userinput>NEUTRON_SERVICE_ID=$(get_id keystone service-create --name neutron --type network --description 'OpenStack Networking Service')</userinput></screen>
|
||||||
</step>
|
</step>
|
||||||
<step>
|
<step>
|
||||||
<title>Create the OpenStack Networking service endpoint
|
<title>Create the Networking service endpoint
|
||||||
entry</title>
|
entry</title>
|
||||||
<para>The way that you create an OpenStack Networking endpoint
|
<para>The way that you create an OpenStack Networking endpoint
|
||||||
entry depends on whether you are using the SQL catalog driver
|
entry depends on whether you are using the SQL catalog driver
|
||||||
@ -70,7 +70,7 @@ catalog.$Region.network.internalURL = http://10.211.55.17:9696
|
|||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</step>
|
</step>
|
||||||
<step>
|
<step>
|
||||||
<title>Create the OpenStack Networking service user</title>
|
<title>Create the Networking service user</title>
|
||||||
<para>You must provide admin user credentials that OpenStack
|
<para>You must provide admin user credentials that OpenStack
|
||||||
Compute and some internal components of OpenStack Networking
|
Compute and some internal components of OpenStack Networking
|
||||||
can use to access the OpenStack Networking API. The suggested
|
can use to access the OpenStack Networking API. The suggested
|
||||||
@ -106,7 +106,7 @@ catalog.$Region.network.internalURL = http://10.211.55.17:9696
|
|||||||
your distribution (<link xlink:href="docs.openstack.org"
|
your distribution (<link xlink:href="docs.openstack.org"
|
||||||
>docs.openstack.org</link>).</para>
|
>docs.openstack.org</link>).</para>
|
||||||
<section xml:id="nova_with_neutron">
|
<section xml:id="nova_with_neutron">
|
||||||
<title>OpenStack Compute</title>
|
<title>Compute</title>
|
||||||
<para>If you use OpenStack Networking, do not run the OpenStack
|
<para>If you use OpenStack Networking, do not run the OpenStack
|
||||||
Compute <systemitem class="service">nova-network</systemitem>
|
Compute <systemitem class="service">nova-network</systemitem>
|
||||||
service (like you do in traditional OpenStack Compute
|
service (like you do in traditional OpenStack Compute
|
||||||
|
@ -3,9 +3,9 @@
|
|||||||
xmlns="http://docbook.org/ns/docbook"
|
xmlns="http://docbook.org/ns/docbook"
|
||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||||
<title>Configure OpenStack Object Storage features</title>
|
<title>Configure Object Storage features</title>
|
||||||
<section xml:id="swift-zones">
|
<section xml:id="swift-zones">
|
||||||
<title>OpenStack Object Storage zones</title>
|
<title>Object Storage zones</title>
|
||||||
<para>In OpenStack Object Storage, data is placed across
|
<para>In OpenStack Object Storage, data is placed across
|
||||||
different tiers of failure domains. First, data is spread
|
different tiers of failure domains. First, data is spread
|
||||||
across regions, then zones, then servers, and finally
|
across regions, then zones, then servers, and finally
|
||||||
|
@ -76,8 +76,8 @@ Error: missing config path argument
|
|||||||
that file will be parsed.
|
that file will be parsed.
|
||||||
</para>
|
</para>
|
||||||
<para>
|
<para>
|
||||||
The swift service management tool <filename>swift-init</filename> has
|
The Object Storage service management tool <filename>swift-init</filename>
|
||||||
adopted the convention of looking for
|
has adopted the convention of looking for
|
||||||
<filename>/etc/swift/{type}-server.conf.d/</filename> if the file
|
<filename>/etc/swift/{type}-server.conf.d/</filename> if the file
|
||||||
<filename>/etc/swift/{type}-server.conf</filename> file does not
|
<filename>/etc/swift/{type}-server.conf</filename> file does not
|
||||||
exist.
|
exist.
|
||||||
|
Loading…
Reference in New Issue
Block a user