openstack/openstack-manuals
Code Issues Proposed changes

Add condition to openRC file information in End User Guide

Browse Source 
Closes-Bug: #1252850

Change-Id: I7963bf23329c98f0b3639d25e7dd0c6359892876
author: diane fleming
This commit is contained in:
Diane Fleming
2013-11-19 14:29:40 -06:00
committed by Stephen Gordon
parent b249a95950
commit cd6de80262
4 changed files with 114 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
doc/common/section_cli_install.xml
View File

@@ -17,10 +17,10 @@
each OpenStack client.</para>
<note>
<para>For each command, replace
<replaceable>PROJECT</replaceable>
with the lower case name of the client to
install, such as <literal>nova</literal>.
Repeat for each client.</para>
<replaceable>PROJECT</replaceable> with the lower case
name of the client to install, such as
<literal>nova</literal>. Repeat for each
client.</para>
</note>
<table rules="all" width="75%">
<caption>Prerequisite software</caption>
@@ -35,7 +35,7 @@
<tbody>
<tr>
<td valign="top">
<para>Python 2.6 or later</para>
<para>Python 2.6 or newer</para>
</td>
<td>
<para>Currently, the clients do not support Python
@@ -44,16 +44,16 @@
</tr>
<tr>
<td valign="top">
<para><command>setuptools</command> package</para>
<para><package>setuptools</package> package</para>
</td>
<td>
<para>Installed by default on Mac OS X. Many Linux
distributions provide packages to make
<command>setuptools</command> easy to
<package>setuptools</package> easy to
install. Search your package manager for
<command>setuptools</command> to find an
<package>setuptools</package> to find an
installation package. If you cannot find one,
download the <command>setuptools</command>
download the <package>setuptools</package>
package directly from <link
xlink:href="http://pypi.python.org/pypi/setuptools"
>http://pypi.python.org/pypi/setuptools</link>.
@@ -61,16 +61,16 @@
</td>
</tr>
<tr>
<td valign="top"><command>pip</command> package</td>
<td valign="top"><package>pip</package> package</td>
<td>
<para>To install the clients on a Mac OS X or
Linux system, use <command>pip</command>. It
Linux system, use <package>pip</package>. It
is easy to use, ensures that you get the
latest version of the clients from the <link
xlink:href="http://pypi.python.org/pypi/python-novaclient/"
>Python Package Index</link>, and lets you
update or remove the packages later on.</para>
<para>Install <command>pip</command> through the
<para>Install <package>pip</package> through the
package manager for your system:</para>
<formalpara>
<title>Mac OS X</title>
@@ -80,10 +80,10 @@
<formalpara>
<title>Ubuntu 12.04</title>
<para>A packaged version enables you to use
<command>dpkg</command> or
<command>aptitude</command> to install
<package>dpkg</package> or
<package>aptitude</package> to install
the
python-novaclient:<screen><prompt>#</prompt> <userinput>aptitude install python-novaclient</userinput></screen></para>
<package>python-novaclient</package>:<screen><prompt>#</prompt> <userinput>aptitude install python-novaclient</userinput></screen></para>
</formalpara>
<formalpara>
<title>Ubuntu</title>
@@ -94,12 +94,12 @@
<para>A packaged version available in <link
xlink:href="http://openstack.redhat.com/"
>RDO</link> enables you to use
<command>yum</command> to install the
<package>yum</package> to install the
clients:
<screen><prompt>#</prompt> <userinput>yum install python-<replaceable>PROJECT</replaceable>client</userinput></screen></para>
</formalpara>
<para>Alternatively, install
<command>pip</command> and use it to
<package>pip</package> and use it to
manage client installation:</para>
<screen><prompt>#</prompt> <userinput>yum install python-pip</userinput></screen>
<formalpara>
@@ -108,19 +108,19 @@
xlink:href="https://build.opensuse.org/package/show?package=python-novaclient&amp;project=Cloud:OpenStack:Master"
>packaged version available in the
Open Build Service</link> enables you
to use <command>rpm</command> or
<command>zypper</command> to install
to use <package>rpm</package> or
<package>zypper</package> to install
the
python-novaclient:<screen><prompt>#</prompt> <userinput>zypper install python-<replaceable>PROJECT</replaceable></userinput></screen></para>
</formalpara><para>Alternatively, install
<command>pip</command> and use it to
<package>pip</package> and use it to
manage client installation:
<screen><prompt>#</prompt> <userinput>zypper install python-pip</userinput></screen></para>
<formalpara>
<title>openSUSE 12.3 and newer</title>
<para>A packaged version enables you to use
<command>rpm</command> or
<command>zypper</command> to install
<package>rpm</package> or
<package>zypper</package> to install
the clients:
<screen><prompt>#</prompt> <userinput>zypper install python-<replaceable>PROJECT</replaceable>client</userinput></screen></para>
</formalpara>
@@ -130,11 +130,11 @@
</table>
<section xml:id="cli_clients_install">
<title>Install the clients</title>
<para>Use <command>pip</command> to install the OpenStack
<para>Use <package>pip</package> to install the OpenStack
clients on a Mac OS X or Linux system. It is easy and
ensures that you get the latest version of the client from
the <link xlink:href="http://pypi.python.org/pypi">Python
Package Index</link>. Also, <command>pip</command>
Package Index</link>. Also, <package>pip</package>
lets you update or remove a package. After you install the
clients, you must source an <filename
xmlns:raxm="http://docs.rackspace.com/api/metadata"
@@ -144,8 +144,8 @@
<procedure>
<step>
<para>You must install each client separately.</para>
<para>Run the following command to install or update a
client package:</para>
<para>Run this command to install or update a client
package:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install [--upgrade] python-<replaceable>PROJECT</replaceable>client</userinput></screen>
<para>Where <replaceable>PROJECT</replaceable> is the
project name and has one of the following
@@ -180,25 +180,24 @@
API.</para>
</listitem>
<listitem>
<para><literal>ceilometer</literal>. Monitoring/Metering
API.</para>
<para><literal>ceilometer</literal>.
Monitoring/Metering API.</para>
</listitem>
</itemizedlist>
<para>For example, to install the nova client, run the
following command:</para>
<para>For example, to install the nova client, run
this command:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install python-novaclient</userinput></screen>
<para>To update the nova client, run the following
<para>To update the nova client, run this
command:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install --upgrade python-novaclient</userinput></screen>
<para>To remove the nova client, run the following
<para>To remove the nova client, run this
command:</para>
<screen><prompt>$</prompt> <userinput>sudo pip uninstall python-novaclient</userinput></screen>
</step>
<step>
<para>Before you can issue client commands, you must
create and source the
<filename>openrc</filename> file to set
environment variables. See <xref
<step audience="enduser">
<para>Before you can run client commands, you must
create and source the <filename>openrc</filename>
file to set environment variables. See <xref
linkend="cli_openrc"/>.</para>
</step>
</procedure>

87
doc/common/section_cli_openrc.xml
View File

@@ -2,31 +2,35 @@
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="cli_openrc">
xml:id="cli_openrc" audience="enduser">
<!-- create similar file for admin user -->
<title>Create and source the OpenStack RC file</title>
<para>To set the required environment variables for the OpenStack
command-line clients, you must either create or download an environment
file, and source it. It is project-specific and contains the
credentials used by all OpenStack services.</para>
<para>When you source the file, environment variables are set for your
current shell. They allow the commands to communicate to the OpenStack
services that run in the cloud.</para>
<para>If your OpenStack installation provides it, you can download the file
from the OpenStack dashboard as an administrative user or any other
user.</para>
command-line clients, you must either create or download an
environment file, and source it. It is project-specific and
contains the credentials used by all OpenStack
services.</para>
<para>When you source the file, environment variables are set for
your current shell. They allow the commands to communicate to
the OpenStack services that run in the cloud.</para>
<para>If your OpenStack installation provides it, you can download
the file from the OpenStack dashboard as an administrative
user or any other user.</para>
<procedure>
<step>
<para>Log in to the OpenStack dashboard, choose the
project for which you want to download the OpenStack
RC file, and click <emphasis role="bold">Access &amp;
Security</emphasis>.</para></step><step><para>Click
<guibutton>Download OpenStack RC File</guibutton>
and save the file.</para>
RC file, and click <guibutton>Access &amp;
Security</guibutton>.</para>
</step>
<step>
<para>Click <guibutton>Download OpenStack RC
File</guibutton> and save the file.</para>
</step>
<step>
<para>Copy the <filename>openrc.sh</filename> file to the
machine from where you want to run OpenStack commands.</para>
machine from where you want to run OpenStack
commands.</para>
<para>For example, copy the file to the machine from where
you want to upload an image with a glance client
command.</para>
@@ -35,33 +39,37 @@
<para>On any shell from where you want to run OpenStack
commands, source the <filename>openrc.sh</filename>
file for the respective project.</para>
<para>In this example, we source the
<para>In this example, you source the
<filename>demo-openrc.sh</filename> file for the
demo project:</para>
<screen><prompt>$</prompt> <userinput>source demo-openrc.sh</userinput></screen>
</step>
<step>
<para>When you are prompted for an OpenStack password,
enter the OpenStack password for the user who
downloaded the <filename>openrc.sh</filename>
file.</para> </step> <step><para>When you run OpenStack client commands, you can override some
environment variable settings by using the options
that are listed at the end of the <command>nova
help</command> output. For example, you can
override the <literal>OS_PASSWORD</literal> setting in
the <filename>openrc.sh</filename> file by specifying
a password on a nova command, as follows:</para>
enter the password for the user who downloaded the
<filename>openrc.sh</filename> file.</para>
</step>
<step>
<para>When you run OpenStack client commands, you can
override some environment variable settings by using
the options that are listed at the end of the
<command>nova help</command> output. For example,
you can override the <literal>OS_PASSWORD</literal>
setting in the <filename>openrc.sh</filename> file by
specifying a password on a nova command, as
follows:</para>
<screen><prompt>$</prompt> <userinput>nova --password &lt;password> image-list</userinput></screen>
<para>Where <parameter>password</parameter> is
your password.</para>
<para>Where <parameter>password</parameter> is your
password.</para>
</step>
</procedure>
<para>Alternatively, you can create the <filename>openrc.sh</filename> file from scratch.</para>
<para>Alternatively, you can create the
<filename>openrc.sh</filename> file from scratch.</para>
<procedure>
<step>
<para>Create the file <filename>openrc.sh</filename> containing the
authentication:</para>
<para>Create the <filename>openrc.sh</filename> file
containing the authentication:</para>
<programlisting language="bash">export OS_USERNAME=<replaceable>USERNAME</replaceable>
export OS_PASSWORD=<replaceable>PASSWORD</replaceable>
export OS_TENANT_NAME=<replaceable>PROJECT_NAME</replaceable>
@@ -72,16 +80,19 @@ export OS_REGION_NAME=<replaceable>RegionOne</replaceable></programlisting>
</step>
<step>
<para>On any shell from where you want to run OpenStack
commands, source the <filename>openrc.sh</filename>
file for the respective project.</para>
commands, source the <filename>openrc.sh</filename>
file for the respective project.</para>
<screen><prompt>$</prompt> <userinput>source openrc.sh</userinput></screen>
</step>
</procedure>
<note>
<para>The password will not be prompted with this method, but lives in
clear text in the <filename>openrc.sh</filename> file. Restrict the
permissions on this file to avoid security problems. You can also
remove the <literal>OS_PASSWORD</literal> variable from the file, and
use the <literal>--password</literal> option of OpenStack clients.</para>
<para>You are not prompted for the password with this method.
The password lives in clear text format in the
<filename>openrc.sh</filename> file. Restrict the
permissions on this file to avoid security problems. You
can also remove the <literal>OS_PASSWORD</literal>
variable from the file, and use the
<parameter>--password</parameter> parameter with
OpenStack client commands.</para>
</note>
</section>

60
doc/common/section_cli_overview.xml
View File

@@ -34,71 +34,69 @@
<itemizedlist>
<listitem>
<para><command>ceilometer</command>
(<application>python-ceilometerclient</application>).
(<package>python-ceilometerclient</package>).
Client for the Metering API that lets you create and
collect measurements across OpenStack.</para>
</listitem>
<listitem>
<para><command>cinder</command>
(<application>python-cinderclient</application>).
Client for the Block Storage Service API that lets you
create and manage volumes.</para>
(<package>python-cinderclient</package>). Client
for the Block Storage Service API that lets you create
and manage volumes.</para>
</listitem>
<listitem>
<para><command>glance</command>
(<application>python-glanceclient</application>).
Client for the Image Service API that lets you create
and manage images.</para>
(<package>python-glanceclient</package>). Client
for the Image Service API that lets you create and
manage images.</para>
</listitem>
<listitem>
<para><command>heat</command>
(<application>python-heatclient</application>).
Client for the Orchestration API that lets you launch
stacks from templates, view details of running stacks
including events and resources, and update and delete
(<package>python-heatclient</package>). Client for
the Orchestration API that lets you launch stacks from
templates, view details of running stacks including
events and resources, and update and delete
stacks.</para>
</listitem>
<listitem>
<para><command>keystone</command>
(<application>python-keystoneclient</application>).
Client for the Identity Service API that lets you
create and manage users, tenants, roles, endpoints,
and credentials.</para>
(<package>python-keystoneclient</package>). Client
for the Identity Service API that lets you create and
manage users, tenants, roles, endpoints, and
credentials.</para>
</listitem>
<listitem>
<para><command>neutron</command>
(<application>python-neutronclient</application>).
Client for the Networking API that lets you configure
(<package>python-neutronclient</package>). Client
for the Networking API that lets you configure
networks for guest servers. This client was previously
known as <command>quantum</command>.</para>
</listitem>
<listitem>
<para><command>nova</command>
(<application>python-novaclient</application>).
Client for the Compute API and its extensions. Use to
create and manage images, instances, and
flavors.</para>
(<package>python-novaclient</package>). Client for
the Compute API and its extensions. Use to create and
manage images, instances, and flavors.</para>
</listitem>
<listitem>
<para><command>swift</command>
(<application>python-swiftclient</application>).
Client for the Object Storage API that lets you gather
(<package>python-swiftclient</package>). Client
for the Object Storage API that lets you gather
statistics, list items, update metadata, upload,
download and delete files stored by the Object Storage
service. Provides access to a swift installation for
ad hoc processing.</para>
</listitem>
</itemizedlist>
<para>An OpenStack <command>common</command> client is in
development.</para>
<para audience="adminuser">See <link
<para>An OpenStack <command>common</command> client is in development.</para>
<para audience="adminuser">For client installation instructions, see
<link
xlink:href="http://docs.openstack.org/user-guide/content/install_clients.html"
>Install the OpenStack command-line clients</link> for
client installation instructions. See <link
>Install the OpenStack command-line clients</link>. For
information about the OpenStack RC file, see <link
xlink:href="http://docs.openstack.org/user-guide/content/cli_openrc.html"
>Download and source the OpenStack RC file</link> for
information about the OpenStack RC file. Both topics are in
the <link
>Download and source the OpenStack RC file</link>. Both
topics are in the <link
xlink:href="http://docs.openstack.org/user-guide/content/index.html"
><citetitle>OpenStack End User
Guide</citetitle></link>.</para>

1
doc/user-guide/ch_cli.xml
View File

@@ -16,7 +16,6 @@
<xi:include href="../common/section_cli_version.xml"/>
<?hard-pagebreak?>
<xi:include href="../common/section_cli_openrc.xml"/>
<?hard-pagebreak?>
<xi:include
href="../common/section_glance_cli_manage_images.xml"/>
<?hard-pagebreak?>