openstack/openstack-manuals
Code Issues Proposed changes

Some edits and fixes

Browse Source 
Some edits as a followup to https://review.openstack.org/#/c/65871

Change-Id: I7a869696b5239f916f3f96677f9cc312778d991f
This commit is contained in:
Andreas Jaeger 2014-01-10 15:45:59 +01:00
parent 923a20a27d
commit 8ce0d64df3
3 changed files with 51 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
doc/common/section_cli_keystone_services.xml
View File

@ -5,8 +5,8 @@
xml:id="adding-users-tenants-and-roles-with-python-keystoneclient"> xml:id="adding-users-tenants-and-roles-with-python-keystoneclient">
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<title>Create and manage services and service users</title> <title>Create and manage services and service users</title>
<para>The Identity Service enables you to define services in the <para>The Identity Service enables you to define services, as
following ways:</para> follows:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Service catalog template. The Identity Service acts <para>Service catalog template. The Identity Service acts
@ -14,16 +14,16 @@
services. The services. The
<literal>etc/default_catalog.templates</literal> <literal>etc/default_catalog.templates</literal>
template file defines the endpoints for services. When template file defines the endpoints for services. When
the Identity Service uses a template file back-end, the Identity Service uses a template file back end,
any changes that are made to the endpoints are cached. any changes that are made to the endpoints are cached.
These changes do not persist when you restart the These changes do not persist when you restart the
service or reboot the machine.</para> service or reboot the machine.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>A SQL back-end for the catalog service. When the <para>A SQL back end for the catalog service. When the
Identity Service is online, you must add the services Identity Service is online, you must add the services
to the catalog. When you deploy a system for to the catalog. When you deploy a system for
production, use the SQL back-end.</para> production, use the SQL back end.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>The <literal>auth_token</literal> middleware supports the <para>The <literal>auth_token</literal> middleware supports the
@ -32,11 +32,11 @@
<para>To authenticate users against the Identity Service, you must <para>To authenticate users against the Identity Service, you must
create a service user for each OpenStack service. For example, create a service user for each OpenStack service. For example,
create a service user for the Compute, Block Storage, and create a service user for the Compute, Block Storage, and
Network services.</para> Networking services.</para>
<para>To configure the OpenStack services with service users, <para>To configure the OpenStack services with service users,
create a project for all services and create users for each create a project for all services and create users for each
service. Assign the admin role to each service user-project service. Assign the admin role to each service user and
pair. This role enables users to validate tokens and project pair. This role enables users to validate tokens and
authenticate and authorize other user requests.</para> authenticate and authorize other user requests.</para>
<section xml:id="cli_service-create"> <section xml:id="cli_service-create">
<title>Create a service</title> <title>Create a service</title>
@ -56,16 +56,33 @@
+----------------------------------+----------+----------+---------------------------+</computeroutput></screen> +----------------------------------+----------+----------+---------------------------+</computeroutput></screen>
</step> </step>
<step> <step>
<para>To create a service, use the following command:</para> <para>To create a service, run this command:</para>
<screen><prompt>$</prompt> <userinput>keystone service-create --name <replaceable>service_name</replaceable> --type <replaceable>service_type</replaceable> --description <replaceable>service_description</replaceable></userinput></screen> <screen><prompt>$</prompt> <userinput>keystone service-create --name <replaceable>service_name</replaceable> --type <replaceable>service_type</replaceable> --description <replaceable>service_description</replaceable></userinput></screen>
<screen>Where: <para>The arguments are:</para>
-<replaceable>service_name</replaceable> = Name of new service (must be unique) <itemizedlist>
-<replaceable>service_type</replaceable> = Service type (one of: identity, compute, network, image, or object-store) <listitem>
-<replaceable>service_description</replaceable> = Description of service</screen> <para><code><replaceable>service_name</replaceable></code>.
<para>For example, to create a service named The unique name of the new service.</para>
<literal>swift</literal> of type </listitem>
<literal>object-store</literal>, run the <listitem>
following command:</para> <para><code><replaceable>service_type</replaceable></code>.
The service type, such as
<code>identity</code>,
<code>compute</code>,
<code>network</code>,
<code>image</code>,
<code>object-store</code> or any other
service identifier string.</para>
</listitem>
<listitem>
<para><code><replaceable>service_description</replaceable></code>.
The description of the service.</para>
</listitem>
</itemizedlist>
<para>For example, to create a
<literal>swift</literal> service of type
<literal>object-store</literal>, run this
command:</para>
<screen><prompt>$</prompt> <userinput>keystone service-create --name swift --type object-store --description "object store service"</userinput></screen> <screen><prompt>$</prompt> <userinput>keystone service-create --name swift --type object-store --description "object store service"</userinput></screen>
<screen><computeroutput>+-------------+----------------------------------+ <screen><computeroutput>+-------------+----------------------------------+
| Property | Value | | Property | Value |
@ -77,7 +94,8 @@
+-------------+----------------------------------+</computeroutput></screen> +-------------+----------------------------------+</computeroutput></screen>
</step> </step>
<step> <step>
<para>To get details for a specific service, run the following:</para> <para>To get details for a service, run this
command:</para>
<screen><prompt>$</prompt> <userinput>keystone service-get <replaceable>service_ID</replaceable></userinput></screen> <screen><prompt>$</prompt> <userinput>keystone service-get <replaceable>service_ID</replaceable></userinput></screen>
<para>For example:</para> <para>For example:</para>
<screen><prompt>$</prompt> <userinput>keystone service-get 84c23f4b942c44c38b9c42c5e517cd9a</userinput></screen> <screen><prompt>$</prompt> <userinput>keystone service-get 84c23f4b942c44c38b9c42c5e517cd9a</userinput></screen>
@ -98,12 +116,12 @@
<step> <step>
<para>Create a project for the service users. <para>Create a project for the service users.
Typically, this project is named Typically, this project is named
<literal>service</literal>, but you can choose <literal>service</literal>, but choose any
any name you like:</para> name you like:</para>
<screen><prompt>$</prompt> <userinput>keystone tenant-create --name service</userinput></screen> <screen><prompt>$</prompt> <userinput>keystone tenant-create --name service</userinput></screen>
<para>The output shows the ID for the project. Note <para>The output shows the ID for the project.</para>
this ID; you need it to create service users and <para>Make a note of this ID. You need it to create
assign roles.</para> service users and assign roles.</para>
<screen><computeroutput>+-------------+----------------------------------+ <screen><computeroutput>+-------------+----------------------------------+
| Property | Value | | Property | Value |
+-------------+----------------------------------+ +-------------+----------------------------------+
@ -119,8 +137,8 @@
</step> </step>
<step> <step>
<para>To assign the admin role to the service <para>To assign the admin role to the service
user-project pairs, get the ID of the admin user-project pairs, run this command to get the ID
role:</para> of the admin role:</para>
<screen><prompt>$</prompt> <userinput>keystone role-list</userinput></screen> <screen><prompt>$</prompt> <userinput>keystone role-list</userinput></screen>
<screen><computeroutput>+----------------------------------+---------------+ <screen><computeroutput>+----------------------------------+---------------+
| id | name | | id | name |
@ -134,20 +152,17 @@
+----------------------------------+---------------+</computeroutput></screen> +----------------------------------+---------------+</computeroutput></screen>
</step> </step>
<step> <step>
<para>Assign the admin role to the user-project pair, <para>Assign the admin role to the user-project
as follows:</para> pair:</para>
<screen><prompt>$</prompt> <userinput>keystone user-role-add --user <replaceable>SERVICE_USER_ID</replaceable> --role <replaceable>ADMIN_ROLE_ID</replaceable> --tenant <replaceable>SERVICE_PROJECT_ID</replaceable></userinput></screen> <screen><prompt>$</prompt> <userinput>keystone user-role-add --user <replaceable>SERVICE_USER_ID</replaceable> --role <replaceable>ADMIN_ROLE_ID</replaceable> --tenant <replaceable>SERVICE_PROJECT_ID</replaceable></userinput></screen>
</step> </step>
</procedure> </procedure>
</section> </section>
<section xml:id="cli_delete_service"> <section xml:id="cli_delete_service">
<title>Delete a service</title> <title>Delete a service</title>
<procedure xml:id="service-delete"> <para>To delete a specified service, specify its ID:</para>
<step> <screen><prompt>$</prompt> <userinput>keystone service-delete <replaceable>SERVICE_ID</replaceable></userinput></screen>
<para>To delete a specified service, specify its ID, <screen><computeroutput>+-------------+----------------------------------+
as follows:</para>
<screen><prompt>$</prompt> <userinput>keystone service-delete <replaceable>SERVICE_ID</replaceable></userinput></screen>
<screen><computeroutput>+-------------+----------------------------------+
| Property | Value | | Property | Value |
+-------------+----------------------------------+ +-------------+----------------------------------+
| description | object store service | | description | object store service |
@ -155,7 +170,5 @@
| name | swift | | name | swift |
| type | object-store | | type | object-store |
+-------------+----------------------------------+</computeroutput></screen> +-------------+----------------------------------+</computeroutput></screen>
</step>
</procedure>
</section> </section>
</section> </section>

4
doc/common/section_dashboard_access.xml
View File

@ -79,7 +79,7 @@
<para>The <guilabel>Project</guilabel> tab displays the <para>The <guilabel>Project</guilabel> tab displays the
details of the selected project.</para> details of the selected project.</para>
<figure xml:id="dashboard_project_user"> <figure xml:id="dashboard_project_user">
<title>Dashboard Projects</title> <title>Dashboard projects</title>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata fileref="figures/dashboard-project-tab.png" <imagedata fileref="figures/dashboard-project-tab.png"
@ -201,7 +201,7 @@
instances, volumes, flavors, images, projects, users, instances, volumes, flavors, images, projects, users,
services, and quotas.</para> services, and quotas.</para>
<figure xml:id="dashboard_admin_project_tab"> <figure xml:id="dashboard_admin_project_tab">
<title>Admin Tab</title> <title>Admin tab</title>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata <imagedata

2
doc/user-guide-admin/section_dashboard_admin_manage_projects_users.xml
View File

@ -167,7 +167,7 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<figure xml:id="cloud_dash_users_list"> <figure xml:id="cloud_dash_users_list">
<title>Edit the Users List</title> <title>Edit the users list</title>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata <imagedata