openstack/openstack-manuals
Code Issues Proposed changes

Merge "Add glossary to Install Guide"

Browse Source
This commit is contained in:
Jenkins 2014-01-24 23:31:07 +00:00 committed by Gerrit Code Review
commit 00df80dac5
12 changed files with 53 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/common/ch_getstart.xml
View File

@ -77,7 +77,8 @@
xlink:href="http://docs.openstack.org/developer/swift/"
>Swift</link></td>
<td>Stores and retrieves arbitrary unstructured
data objects via a RESTful, HTTP based API. It is highly
data objects via a <glossterm>RESTful</glossterm>,
HTTP based API. It is highly
fault tolerant with its data replication and scale out
architecture. Its implementation is not like a file server
with mountable directories.</td>

5
doc/common/section_keystone-concepts.xml
View File

@ -5,7 +5,7 @@
xml:id="keystone-concepts">
<?dbhtml stop-chunking?>
<title>Identity Service concepts</title>
<para>The Identity Service performs the following
<para>The <glossterm>Identity Service</glossterm> performs the following
functions:</para>
<itemizedlist spacing="compact">
<listitem>
@ -13,7 +13,8 @@
permissions.</para>
</listitem>
<listitem>
<para>Service catalog. Provides a catalog of available
<para><glossterm baseform="service catalog">Service
catalog</glossterm>. Provides a catalog of available
services with their API endpoints.</para>
</listitem>
</itemizedlist>

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

@ -568,4 +568,6 @@
<xi:include href="ch_ceilometer.xml"/>
<xi:include href="app_reserved_uids.xml"/>
<xi:include href="../common/app_support.xml"/>
<glossary role="auto"/>
</book>

28
doc/install-guide/ch_basics.xml
View File

@ -52,7 +52,8 @@
<para>For simple test cases, you can use machines with a single
network interface card.</para>
<para>The following example configures Networking on two networks
with static IP addresses and manually manages a list of host
with <glossterm baseform="static IP address">static IP addresses</glossterm>
and manually manages a list of host
names on each machine. If you manage a large network, you might
already have systems in place to manage this. If so, you can
skip this section but note that the rest of this guide assumes
@ -88,7 +89,8 @@
</note>
<warning os="centos;rhel"><para>
RHEL and derivatives including CentOS and Scientific Linux enable a
restrictive firewall by default. During this installation, certain steps
restrictive <glossterm>firewall</glossterm> by default. During this
installation, certain steps
will fail unless you alter this setting or disable the firewall. For
further information about securing your installation, refer to the
<link xlink:href="http://docs.openstack.org/sec/">OpenStack Security Guide</link>.</para>
@ -225,7 +227,8 @@ iface eth1 inet static
<section xml:id="basics-ntp">
<title>Network Time Protocol (NTP)</title>
<para>To synchronize services across multiple machines, you must
install NTP. The examples in this guide configure the controller
install <glossterm baseform="Network Time Protocol (NTP)">NTP</glossterm>.
The examples in this guide configure the controller
node as the reference server and any additional nodes to set
their time from the controller node.</para>
<para>Install the <literal>ntp</literal> package on each system
@ -484,7 +487,8 @@ bind-address = 192.168.0.10</programlisting>
access the RDO repository.</para>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install openstack-utils</userinput></screen>
<para os="opensuse;sles">Use the Open Build Service repositories
for Havana based on your openSUSE or SUSE Linux Enterprise
for <glossterm>Havana</glossterm> based on your openSUSE or
SUSE Linux Enterprise
Server version, for example if you run openSUSE 12.3 use:</para>
<screen os="opensuse"><prompt>#</prompt> <userinput>zypper addrepo -f obs://Cloud:OpenStack:Havana/openSUSE_12.3 Havana</userinput></screen>
<para os="sles"> If you use SUSE Linux Enterprise Server 11 SP3,
@ -533,7 +537,8 @@ bind-address = 192.168.0.10</programlisting>
allows you to install newer releases of OpenStack on the
stable supported version of Ubuntu.</para>
<step>
<para>Install the Ubuntu Cloud Archive for Havana:
<para>Install the Ubuntu Cloud Archive for
<glossterm>Havana</glossterm>:
<screen><prompt>#</prompt> <userinput>apt-get install python-software-properties</userinput>
<prompt>#</prompt> <userinput>add-apt-repository cloud-archive:havana</userinput></screen></para>
</step>
@ -547,7 +552,8 @@ bind-address = 192.168.0.10</programlisting>
<procedure xml:id="debian-cloud-archive" os="debian">
<title>To use the Debian Wheezy backports archive for
Havana</title>
<para>The Havana release is available only in Debian Sid
<para>The <glossterm>Havana</glossterm> release is available
only in Debian Sid
(otherwise called Unstable). However, the Debian maintainers
of OpenStack also maintain a non-official Debian repository
for OpenStack containing Wheezy backports.</para>
@ -609,10 +615,12 @@ bind-address = 192.168.0.10</programlisting>
<title>Messaging server</title>
<para>On the controller node, install the messaging queue server.
Typically this is <phrase os="ubuntu;debian;opensuse;sles"
>RabbitMQ</phrase><phrase os="centos;rhel;fedora"
>Qpid</phrase> but <phrase os="ubuntu;debian;opensuse;sles"
>Qpid</phrase><phrase os="centos;rhel;fedora"
>RabbitMQ</phrase> and ZeroMQ (0MQ) are also available.</para>
><glossterm>RabbitMQ</glossterm></phrase>
<phrase os="centos;rhel;fedora">
<glossterm>Qpid</glossterm></phrase> but
<phrase os="ubuntu;debian;opensuse;sles"><glossterm>Qpid</glossterm></phrase>
<phrase os="centos;rhel;fedora"><glossterm>RabbitMQ</glossterm></phrase>
and <glossterm>ZeroMQ</glossterm> (0MQ) are also available.</para>
<screen os="ubuntu;debian"><prompt>#</prompt> <userinput>apt-get install rabbitmq-server</userinput></screen>
<screen os="opensuse;sles"><prompt>#</prompt> <userinput>zypper install rabbitmq-server</userinput></screen>
<screen os="fedora;centos;rhel"><prompt>#</prompt> <userinput>yum install qpid-cpp-server memcached</userinput></screen>

16
doc/install-guide/ch_overview.xml
View File

@ -39,10 +39,14 @@
</listitem>
<listitem>
<para>The compute node runs the hypervisor portion of Compute,
which operates tenant virtual machines. By default, Compute uses
KVM as the hypervisor. Compute also provisions and operates
tenant networks and implements security groups. You can run more
than one compute node.</para>
which operates <glossterm>tenant</glossterm> virtual machines.
By default, Compute uses
<glossterm baseform="kernel-based VM (KVM)">KVM</glossterm>
as the <glossterm>hypervisor</glossterm>. Compute also
provisions and operates
tenant networks and implements
<glossterm baseform="security group">security groups</glossterm>.
You can run more than one compute node.</para>
</listitem>
<listitem>
<para>When implementing this architecture, skip
@ -71,7 +75,9 @@
<listitem>
<para>The network node runs the Networking plug-in agent and
several layer 3 agents that provision tenant networks and
provide services to them, including routing, NAT, and DHCP.
provide services to them, including routing, <glossterm
baseform="Network Address Translation (NAT)">NAT</glossterm>,
and <glossterm>DHCP</glossterm>.
It also handles external (internet) connectivity for tenant
virtual machines.</para>
</listitem>

1
doc/install-guide/pom.xml
View File

@ -84,6 +84,7 @@
</execution>
</executions>
<configuration>
<glossaryCollection>${basedir}/../glossary/glossary-terms.xml</glossaryCollection>
<!-- These parameters apply to pdf and webhelp -->
<profileAudience>installer</profileAudience>
<xincludeSupported>true</xincludeSupported>

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

@ -5,7 +5,7 @@
<title>Configure a Block Storage Service controller</title>
<note>
<para>This section describes how to configure OpenStack Block Storage
services on the <firstterm baseform="controller node">Controller node</firstterm>
services on the <glossterm baseform="controller node">Controller node</glossterm>
and assumes that a
second node provides storage through the <systemitem
class="service">cinder-volume</systemitem> service. For

5
doc/install-guide/section_keystone-services.xml
View File

@ -12,8 +12,9 @@
service.</para>
</listitem>
<listitem>
<para><command>keystone endpoint-create</command>. Associates API
endpoints with the service.</para>
<para><command>keystone endpoint-create</command>. Associates
<glossterm baseform="API endpoint">API endpoints</glossterm>
with the service.</para>
</listitem>
</itemizedlist>
<para>You must also register the Identity Service itself. Use the

9
doc/install-guide/section_keystone-users.xml
View File

@ -4,9 +4,12 @@
xml:id="keystone-users" os="rhel;centos;fedora;opensuse;sles;ubuntu">
<title>Define users, tenants, and roles</title>
<para>After you install the Identity Service, set up users,
tenants, and roles to authenticate against. These are used to allow access to
services and endpoints, described in the next section.</para>
<para>After you install the Identity Service, set up
<glossterm baseform="user">users</glossterm>,
<glossterm baseform="tenant">tenants</glossterm>, and roles to authenticate
against. These are used to allow access to
services and <glossterm baseform="endpoint">endpoints</glossterm>, described
in the next section.</para>
<para>Typically, you would indicate a user and password to
authenticate with the Identity Service. At this point, however, we

6
doc/install-guide/section_neutron-install.xml
View File

@ -572,7 +572,7 @@ neutron_insecure = True
<prompt>#</prompt> <userinput>ovs-vsctl add-br br-ex</userinput></screen>
</step>
<step>
<para>Add a <firstterm>port</firstterm> (connection) from
<para>Add a <glossterm>port</glossterm> (connection) from
the <replaceable>EXTERNAL_INTERFACE</replaceable>
interface to <literal>br-ex</literal> interface:</para>
<screen><prompt>#</prompt> <userinput>ovs-vsctl add-port br-ex <replaceable>EXTERNAL_INTERFACE</replaceable></userinput></screen>
@ -699,8 +699,8 @@ use_namespaces = True</programlisting>
<!-- TODO(sross): support provider networks? you need to modify things above for this to work -->
<step>
<para>Configure a firewall plug-in. If you do not wish to
enforce firewall rules, called <firstterm
baseform="security group">security groups</firstterm>
enforce firewall rules, called <glossterm
baseform="security group">security groups</glossterm>
by OpenStack, you can use
<literal>neutron.agent.firewall.NoopFirewall</literal>.
Otherwise, you can choose one of the Networking firewall

4
doc/install-guide/section_neutron-provider-router-with-private_networks.xml
View File

@ -635,8 +635,8 @@ export OS_AUTH_URL="http://<replaceable>controller</replaceable>:5000/v2.0/"</pr
in the API is created and owned by the cloud
administrator.</para>
<para>This model supports assigning public addresses to VMs by
using <firstterm baseform="floating IP">floating
IPs</firstterm>; the router maps public addresses from
using <glossterm baseform="floating IP">floating IPs</glossterm>;
the router maps public addresses from
the external network to fixed IPs on private networks.
Hosts without floating IPs can still create outbound
connections to the external network because the provider

2
doc/pom.xml
View File

@ -47,7 +47,7 @@
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.12.2</version>
<version>1.13.0</version>
</plugin>
</plugins>
</build>