openstack/openstack-manuals
Code Issues Proposed changes

Document client installation on Windows

Browse Source 
Python clients work on Windows as well, document how to install the
required python tools, and how to install and run the OpenStack clients.

Change-Id: I68261561de745c0555261ca2f2fbf3a0efefa9fb
This commit is contained in:
Gauvain Pocentek
2013-11-23 08:40:02 +01:00
parent ed8fd1c397
commit 0d9d038165
2 changed files with 55 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
doc/common/section_cli_install.xml
View File

@@ -47,24 +47,32 @@
<para><package>setuptools</package> package</para> <para><package>setuptools</package> package</para>
</td> </td>
<td> <td>
<para>Installed by default on Mac OS X. Many Linux <para>Installed by default on Mac OS X.</para>
distributions provide packages to make <para>Many Linux distributions provide packages to make
<package>setuptools</package> easy to <package>setuptools</package> easy to install. Search
install. Search your package manager for your package manager for <package>setuptools</package>
<package>setuptools</package> to find an to find an installation package. If you cannot find
installation package. If you cannot find one, one, download the <package>setuptools</package> package
download the <package>setuptools</package> directly from <link
package directly from <link xlink:href="http://pypi.python.org/pypi/setuptools"
xlink:href="http://pypi.python.org/pypi/setuptools" >http://pypi.python.org/pypi/setuptools</link>.</para>
>http://pypi.python.org/pypi/setuptools</link>. <para>The recommended way to install
<package>setuptools</package> on Microsoft Windows is
to follow the documentation provided <link
xlink:href="https://pypi.python.org/pypi/setuptools#windows"
>on the setuptools website</link>. Another option is
to use the unofficial binary installer maintained by
Christoph Gohlke (<link
xlink:href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools"
>http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools</link>).
</para> </para>
</td> </td>
</tr> </tr>
<tr> <tr>
<td valign="top"><package>pip</package> package</td> <td valign="top"><package>pip</package> package</td>
<td> <td>
<para>To install the clients on a Mac OS X or <para>To install the clients on a Linux, Mac OS X or Microsoft
Linux system, use <package>pip</package>. It Windows system, use <package>pip</package>. It
is easy to use, ensures that you get the is easy to use, ensures that you get the
latest version of the clients from the <link latest version of the clients from the <link
xlink:href="http://pypi.python.org/pypi/python-novaclient/" xlink:href="http://pypi.python.org/pypi/python-novaclient/"
@@ -77,6 +85,20 @@
<para> <para>
<screen><prompt>$</prompt> <userinput>sudo easy_install pip</userinput></screen></para> <screen><prompt>$</prompt> <userinput>sudo easy_install pip</userinput></screen></para>
</formalpara> </formalpara>
<formalpara>
<title>Microsoft Windows</title>
<para>Make sure that the
<filename>C:\Python27\Scripts</filename> directory
is defined in the <literal>PATH</literal>
environment variable, and use the
<command>easy_install</command> command from the
<package>setuptools</package> package:
<screen><prompt>C:\></prompt><userinput>easy_install pip</userinput></screen>
Another option is to use the unofficial binary
installer provided by Christoph Gohlke (<link
xlink:href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip"
>http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip</link>).</para>
</formalpara>
<formalpara> <formalpara>
<title>Ubuntu 12.04</title> <title>Ubuntu 12.04</title>
<para>A packaged version enables you to use <para>A packaged version enables you to use
@@ -131,9 +153,9 @@
<section xml:id="cli_clients_install"> <section xml:id="cli_clients_install">
<title>Install the clients</title> <title>Install the clients</title>
<para>Use <package>pip</package> 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 clients on a Linux, Mac OS X or Microsoft Windows system. It is
ensures that you get the latest version of the client from easy and ensures that you get the latest version of the client
the <link xlink:href="http://pypi.python.org/pypi">Python from the <link xlink:href="http://pypi.python.org/pypi">Python
Package Index</link>. Also, <package>pip</package> Package Index</link>. Also, <package>pip</package>
lets you update or remove a package. After you install the lets you update or remove a package. After you install the
clients, you must source an <filename clients, you must source an <filename
@@ -144,9 +166,11 @@
<procedure> <procedure>
<step> <step>
<para>You must install each client separately.</para> <para>You must install each client separately.</para>
<para>Run this command to install or update a client <para>Run this command to install a client package.</para>
package:</para> <para>For Mac OS X or Linux:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install [--upgrade] python-<replaceable>PROJECT</replaceable>client</userinput></screen> <screen><prompt>$</prompt> <userinput>sudo pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen>
<para>For Microsoft Windows:</para>
<screen><prompt>C:\></prompt><userinput>pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen>
<para>Where <replaceable>PROJECT</replaceable> is the <para>Where <replaceable>PROJECT</replaceable> is the
project name and has one of the following project name and has one of the following
values:</para> values:</para>
@@ -187,12 +211,15 @@
<para>For example, to install the nova client, run <para>For example, to install the nova client, run
this command:</para> this command:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install python-novaclient</userinput></screen> <screen><prompt>$</prompt> <userinput>sudo pip install python-novaclient</userinput></screen>
<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 this <para>To remove the nova client, run this
command:</para> command:</para>
<screen><prompt>$</prompt> <userinput>sudo pip uninstall python-novaclient</userinput></screen> <screen><prompt>$</prompt> <userinput>sudo pip uninstall python-novaclient</userinput></screen>
<para>To upgrade a package, add the
<literal>--upgrade</literal> option to the
<command>pip</command> command.</para>
<para>To update the nova client, run this
command:</para>
<screen><prompt>$</prompt> <userinput>sudo pip install --upgrade python-novaclient</userinput></screen>
</step> </step>
<step audience="enduser"> <step audience="enduser">
<para>Before you can run client commands, you must <para>Before you can run client commands, you must

7
doc/common/section_cli_openrc.xml
View File

@@ -17,6 +17,13 @@
your current shell. The variables enable the OpenStack client your current shell. The variables enable the OpenStack client
commands to communicate with the OpenStack services that run commands to communicate with the OpenStack services that run
in the cloud.</para> in the cloud.</para>
<note>
<title>Environment variables on Microsoft Windows</title>
<para>Defining environment variables using an environment file is not a
common practice on Microsoft Windows. Environment variables are usually
defined in the <literal>Advanced</literal> tab of the <literal>System
Properties</literal> dialog.</para>
</note>
<section xml:id="openrc-dashboard" audience="enduser"> <section xml:id="openrc-dashboard" audience="enduser">
<title>Download and source the OpenStack RC file</title> <title>Download and source the OpenStack RC file</title>
<procedure> <procedure>