openstack/openstack-manuals
Code Issues Proposed changes

Merge "Added complete Doc Conventions in common guide."

Browse Source
This commit is contained in:
Jenkins 2013-12-02 15:51:20 +00:00 committed by Gerrit Code Review
commit 9cc06195de
9 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/common/section_fibrechannel.xml
View File

@ -5,9 +5,9 @@
<title>Fibre Channel support in Compute</title>
<para>Fibre Channel support in OpenStack Compute is remote block
storage attached to Compute nodes for VMs.</para>
<para>In the Grizzly release, Fibre Channel supports only the KVM
<para>In the Grizzly release, Fibre Channel supported only the KVM
hypervisor.</para>
<para>Nova and Cinder for Fibre Channel do not support automatic
<para>Compute and Block Storage for Fibre Channel do not support automatic
zoning. Fibre Channel arrays must be pre-zoned or directly
attached to the KVM hosts.</para>
<section xml:id="fibre-channel-reqs">

2
doc/common/section_glance_cli_manage_images.xml
View File

@ -212,7 +212,7 @@
<td><para>Similar to
<parameter>--location</parameter>
in usage, but indicates that the
Glance server should immediately copy
Image server should immediately copy
the data and store it in its
configured image store.</para>
</td>

2
doc/common/section_keystone-concepts-domain-management.xml
View File

@ -4,7 +4,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="identity-domains">
<title>Domains</title>
<para>A domain defines administrative boundaries for the management of Keystone entities. A
<para>A domain defines administrative boundaries for the management of Identity entities. A
domain may represent an individual, company, or operator-owned space. It is used for
exposing administrative activities directly to the system users.</para>
<para>A domain is a collection of tenants, users, and roles. Users may be given a domain's

4
doc/common/section_keystone-concepts-group-management.xml
View File

@ -9,7 +9,7 @@
assign a role to each user individually, assign a role to
the group. Every group is in a domain. Groups were
introduced with version 3 of the Identity API (the Grizzly
release of Keystone).</para>
release of Identity Service).</para>
<para>Identity API V3 provides the following group-related
operations:</para>
<itemizedlist>
@ -47,7 +47,7 @@
</itemizedlist>
<note>
<para>The Identity service server might not allow all
operations. For example, if using the Keystone server
operations. For example, if using the Identity server
with the LDAP Identity back end and group updates are
disabled, then a request to create, delete, or update
a group fails.</para>

16
doc/common/section_keystone-external-auth.xml
View File

@ -5,19 +5,19 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="1.0">
<title>External authentication with the Identity
Service</title>
<para>When Keystone runs in <literal>apache-httpd</literal>, you
can use external authentication methods that differ from the
authentication provided by the identity store back-end. For
example, you can use an SQL identity back-end together with
<para>When the Identity Service runs in <literal>apache-httpd</literal>,
you can use external authentication methods that differ from
the authentication provided by the identity store back-end.
For example, you can use an SQL identity back-end together with
X.509 authentication, Kerberos, and so on instead of using the
user name and password combination.</para>
<section xml:id="keystone-httpd-auth">
<title>Use HTTPD authentication</title>
<para>Web servers, like Apache HTTP, support many methods of
authentication. Keystone can allow the web server to
perform the authentication. The web server then passes the
authenticated user to Keystone by using the
<literal>REMOTE_USER</literal> environment variable.
authentication. The Identity Service can allow the web
server to perform the authentication. The web server then
passes the authenticated user to the Identity Service by
using the <literal>REMOTE_USER</literal> environment variable.
This user must already exist in the Identity Service
back-end so as to get a token from the controller. To use
this method, the Identity Service should run on

5
doc/common/section_keystone_certificates-for-pki.xml
View File

@ -13,9 +13,10 @@
files can be generated either using the
<command>keystone-manage</command> utility, or externally
generated. The files need to be in the locations specified by
the top level Keystone configuration file as specified in the
the top level Identity Service configuration file
<filename>keystone.conf</filename> 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 the Identity Service.</para>
<warning>
<para>The certificates can be world readable, but the private
key cannot be. The private key should only be readable by

2
doc/common/section_multiple-compute-nodes.xml
View File

@ -59,7 +59,7 @@ iface br100 inet static
<prompt>$</prompt> <userinput>sudo service nova-compute restart</userinput></screen>
</step>
<step>
<para>To avoid issues with KVM and permissions with Nova,
<para>To avoid issues with KVM and permissions with the Compute Service,
run these commands to ensure that your VMs run
optimally:</para>
<screen><prompt>#</prompt> <userinput>chgrp kvm /dev/kvm</userinput>

2
doc/common/section_storage-concepts.xml
View File

@ -13,7 +13,7 @@
<thead>
<tr>
<td>On-instance / ephemeral</td>
<td>Volumes block storage (Cinder)</td>
<td>Block storage (Cinder)</td>
<td>Object Storage (Swift)</td>
</tr>
</thead>

6
doc/common/section_using-vnc-console.xml
View File

@ -13,9 +13,9 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="getting-an-access-url">
<title>Get an access URL</title>
<para>Nova enables you to create access_urls through the
os-consoles extension. Support for accessing this URL is
provided by the nova client:</para>
<para>The Compute Service enables you to create access_urls
through the os-consoles extension. Support for accessing this
URL is provided by the nova client:</para>
<screen><prompt>$</prompt> <userinput>nova get-vnc-console <replaceable>[server_id]</replaceable> <replaceable>[novnc|xvpvnc]</replaceable></userinput></screen>
<para>Specify '<literal>novnc</literal>' to get a URL suitable for
pasting into a web browser.</para>