openstack/openstack-manuals
Code Issues Proposed changes

Installation Guide XML IDs change

Browse Source 
Changing the XML IDs of several chapters in the installation
guide for consistency, and to match the section title, which
follows conventions. Minor subjective edits also included.

Change-Id: Id33aa27ef2027ac13f129c3bae150492b4bbfa13
backport:none
Implements: blueprint installation-guide-improvements
Co-Authored-By: Matt Kassawara <mkassawara@gmail.com>
This commit is contained in:
Joseph Robinson 2014-09-01 16:54:58 +10:00
parent d1a3c777a3
commit 6abfd37708
12 changed files with 30 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/install-guide/app_reserved_uids.xml
View File

@ -3,14 +3,13 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="reserved_uids">
xml:id="reserved_user_ids">
<title>Reserved user IDs</title>
<para>
In OpenStack, certain user IDs are reserved and used to run
specific OpenStack services and own specific OpenStack
files. These users are set up according to the distribution
packages. The following table gives an overview.
OpenStack reserves certain user IDs to run specific services and
own specific files. These user IDs are set up according to the
distribution packages. The following table gives an overview.
</para>
<note os="debian;opensuse;sles;ubuntu">

2
doc/install-guide/section_basics-queue.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="basics-queue">
xml:id="basics-messaging-server">
<?dbhtml stop-chunking?>
<title>Messaging server</title>
<para>OpenStack uses a <glossterm>message broker</glossterm> to coordinate

2
doc/install-guide/section_ceilometer-cinder.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ceilometer-install-cinder">
xml:id="ceilometer-agent-cinder">
<?dbhtml stop-chunking?>
<title>Add the Block Storage service agent for Telemetry</title>
<procedure>

2
doc/install-guide/section_ceilometer-glance.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ceilometer-install-glance">
xml:id="ceilometer-agent-glance">
<title>Configure the Image Service for Telemetry</title>
<procedure>
<step>

9
doc/install-guide/section_ceilometer-nova.xml
View File

@ -3,14 +3,13 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ceilometer-install-nova">
xml:id="ceilometer-agent-nova">
<?dbhtml stop-chunking?>
<title>Install the Compute agent for Telemetry</title>
<procedure>
<para>Telemetry provides an API service that provides a
collector and a range of disparate agents. This procedure
details how to install the agent that runs on the compute
node.</para>
<para>Telemetry provides an API service with a collector and a range
of disparate agents. This procedure details how to install the
agent that runs on the compute node.</para>
<step>
<para>Install the Telemetry service on the compute node:</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install ceilometer-agent-compute</userinput></screen>

2
doc/install-guide/section_ceilometer-swift.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="ceilometer-install-swift">
xml:id="ceilometer-agent-swift">
<title>Configure the Object Storage service for Telemetry</title>
<procedure>
<step>

26
doc/install-guide/section_cinder-controller.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="cinder-controller">
xml:id="cinder-install-controller-node">
<title>Install and configure controller node</title>
<para>This section describes how to install and configure the Block
Storage service, code-named cinder, on the controller node. This
@ -55,7 +55,7 @@
<substeps>
<step>
<para>Create a <literal>cinder</literal> user:</para>
<screen><prompt>$</prompt> <userinput>keystone user-create --name=cinder --pass=<replaceable>CINDER_PASS</replaceable> --email=<replaceable>EMAIL_ADDRESS</replaceable></userinput></screen>
<screen><prompt>$</prompt> <userinput>keystone user-create --name cinder --pass <replaceable>CINDER_PASS</replaceable> --email <replaceable>EMAIL_ADDRESS</replaceable></userinput></screen>
<para>Replace <replaceable>CINDER_PASS</replaceable> with a suitable
password and <replaceable>EMAIL_ADDRESS</replaceable> with
a suitable e-mail address.</para>
@ -64,27 +64,27 @@
<para>Link the <literal>cinder</literal> user to the
<literal>service</literal> tenant and <literal>admin</literal>
role:</para>
<screen><prompt>$</prompt> <userinput>keystone user-role-add --user=cinder --tenant=service --role=admin</userinput></screen>
<screen><prompt>$</prompt> <userinput>keystone user-role-add --user cinder --tenant service --role admin</userinput></screen>
</step>
</substeps>
</step>
<step>
<para>Create the Block Storage service (version 1 API) endpoints:</para>
<screen><prompt>$</prompt> <userinput>keystone service-create --name=cinder --type=volume --description="OpenStack Block Storage"</userinput>
<screen><prompt>$</prompt> <userinput>keystone service-create --name cinder --type volume --description "OpenStack Block Storage"</userinput>
<prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ volume / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s \
--internalurl=http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s \
--adminurl=http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s</userinput></screen>
--service-id $(keystone service-list | awk '/ volume / {print $2}') \
--publicurl http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s \
--internalurl http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s \
--adminurl http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s</userinput></screen>
</step>
<step>
<para>Create the Block Storage service (version 2 API) endpoints:</para>
<screen><prompt>$</prompt> <userinput>keystone service-create --name=cinderv2 --type=volumev2 --description="OpenStack Block Storage v2"</userinput>
<screen><prompt>$</prompt> <userinput>keystone service-create --name cinderv2 --type volumev2 --description "OpenStack Block Storage v2"</userinput>
<prompt>$</prompt> <userinput>keystone endpoint-create \
--service-id=$(keystone service-list | awk '/ volumev2 / {print $2}') \
--publicurl=http://<replaceable>controller</replaceable>:8776/v2/%\(tenant_id\)s \
--internalurl=http://<replaceable>controller</replaceable>:8776/v2/%\(tenant_id\)s \
--adminurl=http://<replaceable>controller</replaceable>:8776/v2/%\(tenant_id\)s</userinput></screen>
--service-id $(keystone service-list | awk '/ volumev2 / {print $2}') \
--publicurl http://<replaceable>controller</replaceable>:8776/v2/%\(tenant_id\)s \
--internalurl http://<replaceable>controller</replaceable>:8776/v2/%\(tenant_id\)s \
--adminurl http://<replaceable>controller</replaceable>:8776/v2/%\(tenant_id\)s</userinput></screen>
</step>
</procedure>
<procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">

2
doc/install-guide/section_cinder-node.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="cinder-node">
xml:id="cinder-install-storage-node">
<?dbhtml stop-chunking?>
<title>Configure a Block Storage service node</title>
<para>After you configure the services on the controller node,

2
doc/install-guide/section_debconf-concepts.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="debconf-general-principles">
xml:id="debconf-concepts">
<?dbhtml stop-chunking?>
<title>debconf concepts</title>
<para>This chapter explains how to use the Debian <systemitem

2
doc/install-guide/section_debconf-preseeding.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="debconf-preseeding">
xml:id="debconf-preseed-prompts">
<title>Pre-seed debconf prompts</title>
<para>You can pre-seed all <systemitem
class="library">debconf</systemitem> prompts. To pre-seed means

2
doc/install-guide/section_heat-install.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="heat-install">
xml:id="heat-install-controller-node">
<title>Install and configure Orchestration</title>
<para>This section describes how to install and configure the
Orchestration module (heat) on the controller node.</para>

2
doc/install-guide/section_keystone-openrc.xml
View File

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="keystone-openrc">
xml:id="keystone-client-environment-scripts">
<title>Create OpenStack client environment scripts</title>
<para>The previous section used a combination of environment variables and
command options to interact with the Identity service via the