diff --git a/doc/common/section_cli_install.xml b/doc/common/section_cli_install.xml index f2340859a0..1fe0d055e1 100644 --- a/doc/common/section_cli_install.xml +++ b/doc/common/section_cli_install.xml @@ -47,24 +47,32 @@ setuptools package - Installed by default on Mac OS X. Many Linux - distributions provide packages to make - setuptools easy to - install. Search your package manager for - setuptools to find an - installation package. If you cannot find one, - download the setuptools - package directly from http://pypi.python.org/pypi/setuptools. + Installed by default on Mac OS X. + Many Linux distributions provide packages to make + setuptools easy to install. Search + your package manager for setuptools + to find an installation package. If you cannot find + one, download the setuptools package + directly from http://pypi.python.org/pypi/setuptools. + The recommended way to install + setuptools on Microsoft Windows is + to follow the documentation provided on the setuptools website. Another option is + to use the unofficial binary installer maintained by + Christoph Gohlke (http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools). pip package - To install the clients on a Mac OS X or - Linux system, use pip. It + To install the clients on a Linux, Mac OS X or Microsoft + Windows system, use pip. It is easy to use, ensures that you get the latest version of the clients from the $ sudo easy_install pip + + Microsoft Windows + Make sure that the + C:\Python27\Scripts directory + is defined in the PATH + environment variable, and use the + easy_install command from the + setuptools package: + C:\>easy_install pip + Another option is to use the unofficial binary + installer provided by Christoph Gohlke (http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip). + Ubuntu 12.04 A packaged version enables you to use @@ -131,9 +153,9 @@
Install the clients Use pip 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 Python + clients on a Linux, Mac OS X or Microsoft Windows system. It is + easy and ensures that you get the latest version of the client + from the Python Package Index. Also, pip lets you update or remove a package. After you install the clients, you must source an You must install each client separately. - Run this command to install or update a client - package: - $ sudo pip install [--upgrade] python-PROJECTclient + Run this command to install a client package. + For Mac OS X or Linux: + $ sudo pip install python-PROJECTclient + For Microsoft Windows: + C:\>pip install python-PROJECTclient Where PROJECT is the project name and has one of the following values: @@ -187,12 +211,15 @@ For example, to install the nova client, run this command: $ sudo pip install python-novaclient - To update the nova client, run this - command: - $ sudo pip install --upgrade python-novaclient To remove the nova client, run this command: $ sudo pip uninstall python-novaclient + To upgrade a package, add the + --upgrade option to the + pip command. + To update the nova client, run this + command: + $ sudo pip install --upgrade python-novaclient Before you can run client commands, you must diff --git a/doc/common/section_cli_openrc.xml b/doc/common/section_cli_openrc.xml index 6f53b339d3..bd1ccfd4b8 100644 --- a/doc/common/section_cli_openrc.xml +++ b/doc/common/section_cli_openrc.xml @@ -17,6 +17,13 @@ your current shell. The variables enable the OpenStack client commands to communicate with the OpenStack services that run in the cloud. + + Environment variables on Microsoft Windows + Defining environment variables using an environment file is not a + common practice on Microsoft Windows. Environment variables are usually + defined in the Advanced tab of the System + Properties dialog. +
Download and source the OpenStack RC file