Merge "Remove unused common files"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
e72d161216
|
|
@ -1,441 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<appendix 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="app_community_support">
|
||||
<?dbhtml stop-chunking?>
|
||||
<title>Community support</title>
|
||||
<para>The following resources are available to help you run and use
|
||||
OpenStack. The OpenStack community constantly improves and
|
||||
adds to the main features of OpenStack, but if you have
|
||||
any questions, do not hesitate to ask. Use the
|
||||
following resources to get OpenStack support,
|
||||
and troubleshoot your installations.</para>
|
||||
<section xml:id="support-documentation">
|
||||
<title>Documentation</title>
|
||||
<para>For the available OpenStack documentation, see <link
|
||||
xlink:href="http://docs.openstack.org"
|
||||
>docs.openstack.org</link>.</para>
|
||||
<para>To provide feedback on documentation, join and use the
|
||||
<email>openstack-docs@lists.openstack.org</email>
|
||||
mailing list at <link
|
||||
xlink:href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs"
|
||||
>OpenStack Documentation Mailing List</link>, or <link
|
||||
xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug"
|
||||
>report a bug</link>.</para>
|
||||
<para>The following books explain how to install an OpenStack
|
||||
cloud and its associated components:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/liberty/install-guide-obs/">
|
||||
<citetitle>Installation Guide for openSUSE 13.2 and
|
||||
SUSE Linux Enterprise Server 12</citetitle>
|
||||
</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/liberty/install-guide-rdo/">
|
||||
<citetitle>Installation Guide for Red Hat
|
||||
Enterprise Linux 7 and CentOS 7</citetitle>
|
||||
</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/liberty/install-guide-ubuntu/">
|
||||
<citetitle>Installation Guide for Ubuntu
|
||||
14.04 (LTS)</citetitle>
|
||||
</link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The following books explain how to configure and run an
|
||||
OpenStack cloud:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/arch-design/"
|
||||
><citetitle>Architecture Design
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/admin-guide-cloud/"
|
||||
><citetitle>Cloud Administrator
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/liberty/config-reference/content/"
|
||||
><citetitle>Configuration
|
||||
Reference</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/ops/"
|
||||
><citetitle>Operations
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/liberty/networking-guide/"
|
||||
><citetitle>Networking
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/ha-guide/"
|
||||
><citetitle>High Availability
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/sec/"
|
||||
><citetitle>Security
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/image-guide/"
|
||||
><citetitle>Virtual Machine Image
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The following books explain how to use the OpenStack
|
||||
dashboard and command-line clients:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://developer.openstack.org/api-guide/quick-start/"
|
||||
><citetitle>API
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/user-guide/"
|
||||
><citetitle>End User
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/user-guide-admin/"
|
||||
><citetitle>Admin User
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/cli-reference/content/"
|
||||
><citetitle>Command-Line Interface
|
||||
Reference</citetitle></link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The following documentation provides reference and
|
||||
guidance information for the OpenStack APIs:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://developer.openstack.org/api-ref.html"
|
||||
>OpenStack API Complete
|
||||
Reference (HTML)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://developer.openstack.org/api-ref-guides/bk-api-ref.pdf"
|
||||
>API Complete Reference (PDF)</link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
<section xml:id="support-ask_openstack">
|
||||
<title>ask.openstack.org</title>
|
||||
<para>During the set up or testing of OpenStack, you might
|
||||
have questions about how a specific task is completed or
|
||||
be in a situation where a feature does not work correctly.
|
||||
Use the <link xlink:href="https://ask.openstack.org"
|
||||
>ask.openstack.org</link> site to ask questions and
|
||||
get answers. When you visit the <link
|
||||
xlink:href="https://ask.openstack.org"
|
||||
>https://ask.openstack.org</link> site, scan the
|
||||
recently asked questions to see whether your question has
|
||||
already been answered. If not, ask a new question. Be sure
|
||||
to give a clear, concise summary in the title and provide
|
||||
as much detail as possible in the description. Paste in
|
||||
your command output or stack traces, links to screen
|
||||
shots, and any other information which
|
||||
might be useful.</para>
|
||||
</section>
|
||||
<section xml:id="support-mailing-lists">
|
||||
<title>OpenStack mailing lists</title>
|
||||
<para>A great way to get answers and insights is to post your
|
||||
question or problematic scenario to the OpenStack mailing
|
||||
list. You can learn from and help others who might have
|
||||
similar issues. To subscribe or view the archives, go to
|
||||
<link
|
||||
xlink:href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack"
|
||||
>http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack</link>.
|
||||
You might be interested in the other mailing lists for
|
||||
specific projects or development, which you can find <link
|
||||
xlink:href="https://wiki.openstack.org/wiki/MailingLists">on
|
||||
the wiki</link>. A description of all mailing lists is
|
||||
available at <link
|
||||
xlink:href="https://wiki.openstack.org/wiki/MailingLists"
|
||||
>https://wiki.openstack.org/wiki/MailingLists</link>.</para>
|
||||
</section>
|
||||
<section xml:id="support-wiki">
|
||||
<title>The OpenStack wiki</title>
|
||||
<para>The <link xlink:href="https://wiki.openstack.org/">OpenStack
|
||||
wiki</link> contains a broad range of topics but some of the
|
||||
information can be difficult to find or is a few pages deep.
|
||||
Fortunately, the wiki search feature enables you to search by title
|
||||
or content. If you search for specific information, such as about
|
||||
networking or OpenStack Compute, you can find a large amount of relevant
|
||||
material. More is being added all the time, so be sure to check back
|
||||
often. You can find the search box in the upper-right corner of any
|
||||
OpenStack wiki page.</para>
|
||||
</section>
|
||||
<section xml:id="support-bugs-area">
|
||||
<title>The Launchpad Bugs area</title>
|
||||
<para>The OpenStack community values your set up and testing efforts and
|
||||
wants your feedback. To log a bug, you must sign up for a Launchpad
|
||||
account at <link xlink:href="https://launchpad.net/+login"
|
||||
>https://launchpad.net/+login</link>. You can view existing bugs
|
||||
and report bugs in the Launchpad Bugs area. Use the search feature
|
||||
to determine whether the bug has already been reported or already
|
||||
been fixed. If it still seems like your bug is unreported, fill out
|
||||
a bug report.</para>
|
||||
<para>Some tips:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Give a clear, concise summary.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Provide as much detail as possible in the
|
||||
description. Paste in your command output or stack
|
||||
traces, links to screen shots, and any
|
||||
other information which might be useful.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Be sure to include the software and package
|
||||
versions that you are using, especially if you are
|
||||
using a development branch, such as,
|
||||
<literal>"Liberty release" vs git commit
|
||||
bc79c3ecc55929bac585d04a03475b72e06a3208</literal>.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Any deployment-specific information is helpful, such as
|
||||
whether you are using Ubuntu 14.04 or are performing a
|
||||
multi-node installation.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The following Launchpad Bugs areas are available:</para>
|
||||
<itemizedlist>
|
||||
<!-- Core projects, sorted alphabetically -->
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/cinder"
|
||||
>Bugs: OpenStack Block Storage
|
||||
(cinder)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/nova"
|
||||
>Bugs: OpenStack Compute (nova)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/horizon"
|
||||
>Bugs: OpenStack Dashboard
|
||||
(horizon)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/keystone"
|
||||
>Bugs: OpenStack Identity
|
||||
(keystone)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/glance"
|
||||
>Bugs: OpenStack Image service
|
||||
(glance)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/neutron"
|
||||
>Bugs: OpenStack Networking
|
||||
(neutron)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/swift"
|
||||
>Bugs: OpenStack Object Storage
|
||||
(swift)</link></para>
|
||||
</listitem>
|
||||
<!-- Modules, sorted alphabetically -->
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/murano"
|
||||
>Bugs: Application catalog (murano)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/ironic"
|
||||
>Bugs: Bare metal service (ironic)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/senlin"
|
||||
>Bugs: Clustering service (senlin)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/magnum"
|
||||
>Bugs: Containers service (magnum)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/sahara"
|
||||
>Bugs: Data processing service
|
||||
(sahara)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/trove"
|
||||
>Bugs: Database service (trove)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/tuskar"
|
||||
>Bugs: Deployment service (tuskar)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/barbican"
|
||||
>Bugs: Key Manager service (barbican)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/monasca"
|
||||
>Bugs: Monitoring (monasca)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/heat"
|
||||
>Bugs: Orchestration (heat)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/cloudkitty"
|
||||
>Bugs: Rating (cloudkitty)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/manila"
|
||||
>Bugs: Shared file systems (manila)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/ceilometer"
|
||||
>Bugs: Telemetry (ceilometer)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/gnocchi"
|
||||
>Bugs: Telemetry v3 (gnocchi)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/mistral"
|
||||
>Bugs: Workflow service (mistral)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/zaqar"
|
||||
>Bugs: Message Service (zaqar)</link></para>
|
||||
</listitem>
|
||||
<!-- Programs, sorted alphabetically -->
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/openstack-api-site"
|
||||
>Bugs: OpenStack API Documentation
|
||||
(developer.openstack.org)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/openstack-manuals"
|
||||
>Bugs: OpenStack Documentation
|
||||
(docs.openstack.org)</link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
<section xml:id="support-irc-channel">
|
||||
<title>The OpenStack IRC channel</title>
|
||||
<para>The OpenStack community lives in the #openstack IRC channel on the
|
||||
Freenode network. You can hang out, ask questions, or get immediate
|
||||
feedback for urgent and pressing issues. To install an IRC client or
|
||||
use a browser-based client, go to <link
|
||||
xlink:href="https://webchat.freenode.net"
|
||||
>https://webchat.freenode.net/</link>. You can also use Colloquy
|
||||
(Mac OS X, <link xlink:href="http://colloquy.info/"
|
||||
>http://colloquy.info/</link>), mIRC (Windows, <link
|
||||
xlink:href="http://www.mirc.com/">http://www.mirc.com/</link>),
|
||||
or XChat (Linux). When you are in the IRC channel and want to share
|
||||
code or command output, the generally accepted method is to use a
|
||||
Paste Bin. The OpenStack project has one at <link
|
||||
xlink:href="http://paste.openstack.org"
|
||||
>http://paste.openstack.org</link>. Just paste your longer
|
||||
amounts of text or logs in the web form and you get a URL that you
|
||||
can paste into the channel. The OpenStack IRC channel is
|
||||
<literal>#openstack</literal> on
|
||||
<literal>irc.freenode.net</literal>. You can find a list of all
|
||||
OpenStack IRC channels at <link
|
||||
xlink:href="https://wiki.openstack.org/wiki/IRC"
|
||||
>https://wiki.openstack.org/wiki/IRC</link>.</para>
|
||||
</section>
|
||||
<section xml:id="support-documentation-feedback">
|
||||
<title>Documentation feedback</title>
|
||||
<para>To provide feedback on documentation, join and use the
|
||||
<email>openstack-docs@lists.openstack.org</email> mailing list at
|
||||
<link xlink:href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs">OpenStack
|
||||
Documentation Mailing List</link>, or <link xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug">report a bug</link>.</para>
|
||||
</section>
|
||||
<section xml:id="distro-support">
|
||||
<title>OpenStack distribution packages</title>
|
||||
<para>The following Linux distributions provide
|
||||
community-supported packages for OpenStack:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">Debian:</emphasis>
|
||||
<link
|
||||
xlink:href="https://wiki.debian.org/OpenStack"
|
||||
>https://wiki.debian.org/OpenStack</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">CentOS, Fedora, and Red
|
||||
Hat Enterprise Linux:</emphasis>
|
||||
<link xlink:href="https://www.rdoproject.org/"
|
||||
>https://www.rdoproject.org/</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">openSUSE and SUSE Linux
|
||||
Enterprise Server:</emphasis>
|
||||
<link
|
||||
xlink:href="http://en.opensuse.org/Portal:OpenStack"
|
||||
>https://en.opensuse.org/Portal:OpenStack</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">Ubuntu:</emphasis>
|
||||
<link
|
||||
xlink:href="https://wiki.ubuntu.com/ServerTeam/CloudArchive"
|
||||
>https://wiki.ubuntu.com/ServerTeam/CloudArchive</link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</appendix>
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<preface 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="ch_preface">
|
||||
<title>Preface</title>
|
||||
<?dbhtml stop-chunking?>
|
||||
|
||||
<xi:include href="section_conventions.xml"/>
|
||||
</preface>
|
||||
|
|
@ -1,331 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<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="install_clients">
|
||||
<?dbhtml stop-chunking?>
|
||||
<title>Install the OpenStack command-line clients</title>
|
||||
<para>Install the prerequisite software and the Python package for
|
||||
each OpenStack client.</para>
|
||||
<section xml:id="install_prereq_software">
|
||||
<title>Install the prerequisite software</title>
|
||||
<para>Most Linux distributions include packaged versions of the
|
||||
command-line clients that you can install directly, see <xref
|
||||
linkend="cli_clients_install_packages"/>.
|
||||
</para>
|
||||
<para>
|
||||
If you need to install the command-line packages source
|
||||
packages, the following table lists the software that you
|
||||
need to have to run the command-line clients, and provides
|
||||
installation instructions as needed.
|
||||
</para>
|
||||
<table rules="all" width="75%">
|
||||
<caption>Prerequisite software</caption>
|
||||
<col width="15%"/>
|
||||
<col width="85%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Prerequisite</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
<para>Python 2.6 or later</para>
|
||||
</td>
|
||||
<td>
|
||||
<para>Interpreter for the Python programming language.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">
|
||||
<para><package>setuptools</package> package</para>
|
||||
</td>
|
||||
<td>
|
||||
<para>Installed by default on Mac OS X.</para>
|
||||
<para>Many Linux distributions provide packages to make
|
||||
<package>setuptools</package> easy to install. Search
|
||||
your package manager for <package>setuptools</package>
|
||||
to find an installation package. If you cannot find
|
||||
one, download the <package>setuptools</package> package
|
||||
directly from <link
|
||||
xlink:href="https://pypi.python.org/pypi/setuptools"
|
||||
>https://pypi.python.org/pypi/setuptools</link>.</para>
|
||||
<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"
|
||||
>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>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top"><package>pip</package> package</td>
|
||||
<td>
|
||||
<para>To install the clients on a Linux, Mac OS X,
|
||||
or Microsoft Windows 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="https://pypi.python.org/"
|
||||
>Python Package Index</link>, and lets
|
||||
you update or remove the packages later
|
||||
on.</para>
|
||||
<para>Since the installation process compiles source
|
||||
files, this requires the related Python development
|
||||
package for your operating system and distribution.</para>
|
||||
<para>Install <package>pip</package> through the
|
||||
package manager for your system:</para>
|
||||
<formalpara>
|
||||
<title>MacOS</title>
|
||||
<para><screen><prompt>#</prompt> <userinput>easy_install pip</userinput></screen></para>
|
||||
</formalpara>
|
||||
<formalpara>
|
||||
<title>Microsoft Windows</title>
|
||||
<para>Ensure 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>
|
||||
<title>Ubuntu and Debian</title>
|
||||
<para>
|
||||
<screen><prompt>#</prompt> <userinput>apt-get install python-dev python-pip</userinput></screen>
|
||||
</para>
|
||||
</formalpara>
|
||||
<para>
|
||||
Note that extra dependencies may be required, per
|
||||
operating system, depending on the package being
|
||||
installed, such as is the case with Tempest.
|
||||
</para>
|
||||
<formalpara>
|
||||
<title>Red Hat Enterprise Linux, CentOS, or Fedora</title>
|
||||
<para>A packaged version enables you to use <package>yum</package>
|
||||
to install the package:
|
||||
<screen><prompt>#</prompt> <userinput>yum install python-devel python-pip</userinput></screen>
|
||||
There are also packaged versions of the
|
||||
clients available in <link
|
||||
xlink:href="https://www.rdoproject.org/">RDO</link>
|
||||
that enable <package>yum</package> to
|
||||
install the clients as described in <xref
|
||||
linkend="cli_clients_install_packages"/>.
|
||||
</para>
|
||||
</formalpara>
|
||||
<formalpara>
|
||||
<title>SUSE Linux Enterprise Linux 11</title>
|
||||
<para>A <link
|
||||
xlink:href="https://build.opensuse.org/package/show?package=python-pip&project=Cloud:OpenStack:Master">packaged
|
||||
version available in the Open Build
|
||||
Service</link> enables you to use
|
||||
or <package>zypper</package> to install the package.
|
||||
First, add the Open Build Service repository:
|
||||
<screen><prompt>#</prompt> <userinput>zypper addrepo -f obs://Cloud:OpenStack:Kilo/SLE_12 Kilo</userinput></screen>
|
||||
Then install <package>pip</package> and use it to manage client installation:
|
||||
<screen><prompt>#</prompt> <userinput>zypper install python-devel python-pip</userinput></screen>
|
||||
There are also packaged versions of the clients available
|
||||
that enable <package>zypper</package> to install the
|
||||
clients as described in <xref linkend="cli_clients_install_packages"/>.
|
||||
</para>
|
||||
</formalpara>
|
||||
<formalpara>
|
||||
<title>openSUSE</title>
|
||||
<para>You can install
|
||||
<package>pip</package> and use it to
|
||||
manage client installation:
|
||||
<screen><prompt>#</prompt> <userinput>zypper install python-devel python-pip</userinput></screen>
|
||||
There are also packaged versions of the clients available
|
||||
that enable <package>zypper</package> to install the
|
||||
clients as described in <xref linkend="cli_clients_install_packages"/>
|
||||
</para>
|
||||
</formalpara>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section xml:id="cli_clients_install">
|
||||
<title>Install the clients</title>
|
||||
<para>When following the instructions in this section, replace
|
||||
<replaceable>PROJECT</replaceable> with the lowercase
|
||||
name of the client to install, such as
|
||||
<command>nova</command>. Repeat for each client. The
|
||||
following values are valid:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><literal>barbican</literal> - Key Manager service
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>ceilometer</literal> - Telemetry
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>cinder</literal> - Block Storage API
|
||||
and extensions</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>cloudkitty</literal> - Rating service
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>glance</literal> - Image service
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>gnocchi</literal> - Telemetry
|
||||
API v3</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>heat</literal> - Orchestration
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>monasca</literal> - Monitoring
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>neutron</literal> - Networking
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>nova</literal> - Compute API and
|
||||
extensions</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>sahara</literal> - Data Processing
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>senlin</literal> - Clustering service
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>swift</literal> - Object Storage
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>trove</literal> - Database service
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>tuskar</literal> - Deployment service
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>magnum</literal> - Containers service
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>manila</literal> - Shared file systems
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>mistral</literal> - Workflow service
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>murano</literal> - Application catalog
|
||||
API</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><literal>openstack</literal> - Common OpenStack client
|
||||
supporting multiple services</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<warning>
|
||||
<para>The following CLIs are deprecated in favor of
|
||||
<literal>openstack</literal>, the Common OpenStack
|
||||
client supporting multiple services:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><literal>keystone</literal> - Identity service
|
||||
API and extensions</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
</warning>
|
||||
<para>The following example shows the command for installing the nova
|
||||
client with <command>pip</command>.</para>
|
||||
<screen><prompt>#</prompt> <userinput>pip install python-novaclient</userinput></screen>
|
||||
<section xml:id="cli_clients_install_pip">
|
||||
<title>Installing with pip</title>
|
||||
<para>Use <package>pip</package> to install the OpenStack
|
||||
clients on a Linux, Mac OS X, or Microsoft Windows
|
||||
system. It is easy to use and ensures that you get the
|
||||
latest version of the client from the <link
|
||||
xlink:href="https://pypi.python.org/pypi">Python
|
||||
Package Index</link>. Also, <package>pip</package>
|
||||
enables you to update or remove a package.</para>
|
||||
<para>Install each client separately by using the
|
||||
following command:</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>For Mac OS X or Linux:</para>
|
||||
<screen><prompt>#</prompt> <userinput>pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen></listitem>
|
||||
<listitem><para>For Microsoft Windows:</para>
|
||||
<screen><prompt>C:\></prompt><userinput>pip install python-<replaceable>PROJECT</replaceable>client</userinput></screen></listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
<section xml:id="cli_clients_install_packages">
|
||||
<title>Installing from packages</title>
|
||||
<para>RDO, openSUSE, SUSE Linux Enterprise, Debian, and Ubuntu
|
||||
have client packages that can be installed without
|
||||
<command>pip</command>.</para>
|
||||
<para>On Red Hat Enterprise Linux, CentOS, or Fedora, use
|
||||
<command>yum</command> to install the clients from
|
||||
the packaged versions available in <link
|
||||
xlink:href="https://www.rdoproject.org/"
|
||||
>RDO</link>:
|
||||
<screen><prompt>#</prompt> <userinput>yum install python-<replaceable>PROJECT</replaceable>client</userinput></screen></para>
|
||||
<para>For Ubuntu or Debian, use <command>apt-get</command> to
|
||||
install the clients from the packaged versions:
|
||||
<screen><prompt>#</prompt> <userinput>apt-get install python-<replaceable>PROJECT</replaceable>client</userinput></screen></para>
|
||||
<para>For openSUSE, use <command>zypper</command> to install the clients
|
||||
from the distribution packages Service:
|
||||
<screen><prompt>#</prompt> <userinput>zypper install python-<replaceable>PROJECT</replaceable>client</userinput></screen></para>
|
||||
<para>For SUSE Linux Enterprise Server, use
|
||||
<command>zypper</command> to install the clients from
|
||||
the distribution packages in the Open Build Service. First,
|
||||
add the Open Build Service repository:
|
||||
<screen><prompt>#</prompt> <userinput>zypper addrepo -f obs://Cloud:OpenStack:Kilo/SLE_12 Kilo</userinput></screen>
|
||||
Then you can install the packages:
|
||||
<screen><prompt>#</prompt> <userinput>zypper install python-<replaceable>PROJECT</replaceable>client</userinput></screen>
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
<section xml:id="cli_clients_remove_upgrade">
|
||||
<title>Upgrade or remove clients</title>
|
||||
<para>To upgrade a client, add the
|
||||
<literal>--upgrade</literal> option to the
|
||||
<command>pip install</command> command:</para>
|
||||
<screen><prompt>#</prompt> <userinput>pip install --upgrade python-<replaceable>PROJECT</replaceable>client</userinput></screen>
|
||||
<para>To remove the a client, run the <command>pip
|
||||
uninstall</command> command:</para>
|
||||
<screen><prompt>#</prompt> <userinput>pip uninstall python-<replaceable>PROJECT</replaceable>client</userinput></screen>
|
||||
</section>
|
||||
<section xml:id="cli_clients_install_nextsteps" audience="enduser">
|
||||
<title>What's next</title>
|
||||
<para>Before you can run client commands, you must create
|
||||
and source the
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
file to set environment variables. See <xref
|
||||
linkend="cli_openrc"/>.</para>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -1,151 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<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">
|
||||
<?dbhtml stop-chunking?>
|
||||
<title>Set environment variables using the OpenStack RC
|
||||
file</title>
|
||||
<para>To set the required environment variables for the OpenStack
|
||||
command-line clients, you must create an environment file
|
||||
called an OpenStack rc file, or <filename>openrc.sh</filename>
|
||||
file.<phrase audience="enduser"> If your OpenStack
|
||||
installation provides it, you can download the file from
|
||||
the OpenStack dashboard as an administrative user or any
|
||||
other user.</phrase> This project-specific environment
|
||||
file contains the credentials that all OpenStack services
|
||||
use.</para>
|
||||
<para>When you source the file, environment variables are set for
|
||||
your current shell. The variables enable the OpenStack client
|
||||
commands to communicate with the OpenStack services that run
|
||||
in the cloud.</para>
|
||||
<note>
|
||||
<para>Defining environment variables using an environment file is not a
|
||||
common practice on Microsoft Windows. Environment variables are usually
|
||||
defined in the <guilabel>Advanced</guilabel> tab of the System
|
||||
Properties dialog box.</para>
|
||||
</note>
|
||||
<section xml:id="openrc-dashboard" audience="enduser">
|
||||
<title>Download and source the OpenStack RC file</title>
|
||||
<procedure>
|
||||
<step>
|
||||
<para>Log in to the OpenStack dashboard, choose the
|
||||
project for which you want to download the
|
||||
OpenStack RC file, on the <guibutton>Project</guibutton>
|
||||
tab, open the <guibutton>Compute</guibutton> tab and click
|
||||
<guibutton>Access & Security</guibutton>.</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>On the <guibutton>API Access</guibutton> tab, click
|
||||
<guibutton>Download OpenStack RC File</guibutton> and save
|
||||
the file. The filename will be of the form
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
where <replaceable>PROJECT</replaceable> is the
|
||||
name of the project for which you downloaded the
|
||||
file.</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>Copy the
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
file to the computer from which you want to run
|
||||
OpenStack commands.</para>
|
||||
<para>For example, copy the file to the computer from
|
||||
which you want to upload an image with a
|
||||
<command>glance</command> client
|
||||
command.</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>On any shell from which you want to run
|
||||
OpenStack commands, source the
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
file for the respective project.</para>
|
||||
<para>In the following example, the
|
||||
<filename>demo-openrc.sh</filename> file is
|
||||
sourced 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 password for the user who downloaded the
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
file.</para>
|
||||
</step>
|
||||
</procedure>
|
||||
</section>
|
||||
<section xml:id="openrc-create">
|
||||
<title>Create and source the OpenStack RC file</title>
|
||||
<para audience="enduser">Alternatively, you can create the
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
file from scratch, if for some reason you cannot download
|
||||
the file from the dashboard.</para>
|
||||
<procedure>
|
||||
<step>
|
||||
<para>In a text editor, create a file named
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
file and add the following authentication
|
||||
information:</para>
|
||||
<programlisting language="bash" audience="enduser">export OS_USERNAME=<replaceable>username</replaceable>
|
||||
export OS_PASSWORD=<replaceable>password</replaceable>
|
||||
export OS_TENANT_NAME=<replaceable>projectName</replaceable>
|
||||
export OS_AUTH_URL=<replaceable>https://identityHost:portNumber/v2.0</replaceable>
|
||||
# The following lines can be omitted
|
||||
export OS_TENANT_ID=<replaceable>tenantIDString</replaceable>
|
||||
export OS_REGION_NAME=<replaceable>regionName</replaceable>
|
||||
export OS_CACERT=<replaceable>/path/to/cacertFile</replaceable></programlisting>
|
||||
</step>
|
||||
<step>
|
||||
<para>On any shell from which you want to run
|
||||
OpenStack commands, source the
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
file for the respective project. In this example,
|
||||
you source the
|
||||
<filename>admin-openrc.sh</filename> file for
|
||||
the <replaceable>admin</replaceable>
|
||||
project:</para>
|
||||
<screen><prompt>$</prompt> <userinput>source admin-openrc.sh</userinput></screen>
|
||||
</step>
|
||||
</procedure>
|
||||
<note audience="enduser">
|
||||
<para>You are not prompted for the password with this
|
||||
method. The password lives in clear text format in the
|
||||
<filename><replaceable>PROJECT</replaceable>-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
|
||||
instead.</para>
|
||||
</note>
|
||||
<note audience="enduser">
|
||||
<para>You must set the OS_CACERT environment variable when
|
||||
using the https protocol in the OS_AUTH_URL environment setting because
|
||||
the verification process for the TLS (HTTPS) server certificate uses
|
||||
the one indicated in the environment. This certificate will be used when
|
||||
verifying the TLS (HTTPS) server certificate.</para>
|
||||
</note>
|
||||
</section>
|
||||
<section xml:id="override-variables">
|
||||
<title>Override environment variable values</title>
|
||||
<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>help</command> output
|
||||
of the various client commands. For example, you can override
|
||||
the <option>OS_PASSWORD</option> setting in the
|
||||
<filename><replaceable>PROJECT</replaceable>-openrc.sh</filename>
|
||||
file by specifying a password on a <command>keystone</command> command, as
|
||||
follows:</para>
|
||||
<screen><prompt>$</prompt> <userinput>keystone --os-password <replaceable>PASSWORD</replaceable> service-list</userinput></screen>
|
||||
<para>Where <replaceable>PASSWORD</replaceable> is your password.</para>
|
||||
<para>A user specifies their username and password credentials to interact
|
||||
with OpenStack, using any client command. These credentials can be specified
|
||||
using various mechanisms, namely, the environment variable or command-line argument.
|
||||
It is not safe to specify the password using either of these methods.</para>
|
||||
<para>For example, when you specify your password using the command-line client
|
||||
with the <parameter>--os-password</parameter> argument, anyone with access
|
||||
to your computer can view it in plain text with the <literal>ps</literal>
|
||||
field.</para>
|
||||
<para>To avoid storing the password in plain text, you can prompt for the
|
||||
OpenStack password interactively.</para>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -1,184 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<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="section_cli_overview">
|
||||
<title>Overview</title>
|
||||
<para>
|
||||
Each OpenStack project provides a command-line client, which
|
||||
enables you to access the project API through easy-to-use
|
||||
commands. For example, the Compute service provides a nova
|
||||
command-line client.</para>
|
||||
<para>
|
||||
You can run the commands from the command line, or include the
|
||||
commands within scripts to automate tasks. If you provide
|
||||
OpenStack credentials, such as your user name and password, you
|
||||
can run these commands on any computer.
|
||||
</para>
|
||||
<para>
|
||||
Internally, each command uses cURL command-line tools, which embed
|
||||
API requests. OpenStack APIs are RESTful APIs, and use the HTTP
|
||||
protocol. They include methods, URIs, media types, and response
|
||||
codes.</para>
|
||||
<para>
|
||||
OpenStack APIs are open-source Python clients, and can run on
|
||||
Linux or Mac OS X systems. On some client commands, you can
|
||||
specify a <command>debug</command> parameter to show the
|
||||
underlying API request for the command. This is a good way to
|
||||
become familiar with the OpenStack API calls.</para>
|
||||
<para>The following table lists the command-line client for each
|
||||
OpenStack service with its package name and description.</para>
|
||||
<table rules="all">
|
||||
<caption>OpenStack services and clients</caption>
|
||||
<col width="15%"/>
|
||||
<col width="10%"/>
|
||||
<col width="20%"/>
|
||||
<col width="55%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Service</th>
|
||||
<th>Client</th>
|
||||
<th>Package</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Application catalog</td>
|
||||
<td><command>murano</command></td>
|
||||
<td><package>python-muranoclient</package></td>
|
||||
<td>Creates and manages application catalog.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Block Storage</td>
|
||||
<td><command>cinder</command></td>
|
||||
<td><package>python-cinderclient</package></td>
|
||||
<td>Creates and manages volumes.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Clustering service</td>
|
||||
<td><command>senlin</command></td>
|
||||
<td><package>python-senlinclient</package></td>
|
||||
<td>Creates and manages clustering services.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Compute</td>
|
||||
<td><command>nova</command></td>
|
||||
<td><package>python-novaclient</package></td>
|
||||
<td>Creates and manages images, instances, and flavors.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Containers service</td>
|
||||
<td><command>magnum</command></td>
|
||||
<td><package>python-magnumclient</package></td>
|
||||
<td>Creates and manages containers.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Database service</td>
|
||||
<td><command>trove</command></td>
|
||||
<td><package>python-troveclient</package></td>
|
||||
<td>Creates and manages databases.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Data processing service</td>
|
||||
<td><command>sahara</command></td>
|
||||
<td><package>python-saharaclient</package></td>
|
||||
<td>Creates and manages Hadoop clusters on OpenStack.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Deployment service</td>
|
||||
<td><command>tuskar</command></td>
|
||||
<td><package>python-tuskarclient</package></td>
|
||||
<td>Plans Deployments.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Identity</td>
|
||||
<td><command>openstack</command></td>
|
||||
<td><package>python-openstackclient</package></td>
|
||||
<td>Creates and manages users, tenants, roles, endpoints, and credentials.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Image service</td>
|
||||
<td><command>glance</command></td>
|
||||
<td><package>python-glanceclient</package></td>
|
||||
<td>Creates and manages images.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Key Manager service</td>
|
||||
<td><command>barbican</command></td>
|
||||
<td><package>python-barbicanclient</package></td>
|
||||
<td>Creates and manages keys.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Monitoring</td>
|
||||
<td><command>monasca</command></td>
|
||||
<td><package>python-monascaclient</package></td>
|
||||
<td>Monitoring solution.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Networking</td>
|
||||
<td><command>neutron</command></td>
|
||||
<td><package>python-neutronclient</package></td>
|
||||
<td>Configures networks for guest servers. This client was
|
||||
previously called <command>quantum</command>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Object Storage</td>
|
||||
<td><command>swift</command></td>
|
||||
<td><package>python-swiftclient</package></td>
|
||||
<td>Gathers statistics, lists items, updates metadata, and uploads, downloads,
|
||||
and deletes files stored by the Object Storage service. Gains access to
|
||||
an Object Storage installation for ad hoc processing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Orchestration</td>
|
||||
<td><command>heat</command></td>
|
||||
<td><package>python-heatclient</package></td>
|
||||
<td>Launches stacks from templates, views details of running stacks including
|
||||
events and resources, and updates and deletes stacks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Rating service</td>
|
||||
<td><command>cloudkitty</command></td>
|
||||
<td><package>python-cloudkittyclient</package></td>
|
||||
<td>Rating service.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Shared file systems</td>
|
||||
<td><command>manila</command></td>
|
||||
<td><package>python-manilaclient</package></td>
|
||||
<td>Creates and manages shared file systems.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Telemetry</td>
|
||||
<td><command>ceilometer</command></td>
|
||||
<td><package>python-ceilometerclient</package></td>
|
||||
<td>Creates and collects measurements across OpenStack.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Telemetry v3</td>
|
||||
<td><command>gnocchi</command></td>
|
||||
<td><package>python-gnocchiclient</package></td>
|
||||
<td>Creates and collects measurements across OpenStack.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Workflow service</td>
|
||||
<td><command>mistral</command></td>
|
||||
<td><package>python-mistralclient</package></td>
|
||||
<td>Workflow service for OpenStack cloud.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Common client</td>
|
||||
<td><command>openstack</command></td>
|
||||
<td><package>python-openstackclient</package></td>
|
||||
<td>Common client for the OpenStack project.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para audience="adminuser">For client installation instructions, see <link
|
||||
xlink:href="http://docs.openstack.org/user-guide/common/cli_install_openstack_command_line_clients.html">Install
|
||||
the OpenStack command-line clients</link>. For information about the OpenStack RC file,
|
||||
see <link xlink:href="http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html">Download
|
||||
and source the OpenStack RC file</link>.</para>
|
||||
</section>
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<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="checking_version_cli">
|
||||
<title>Discover the version number for a client</title>
|
||||
<para>Run the following command to discover the version number
|
||||
for a client:</para>
|
||||
<screen><prompt>$</prompt> <userinput><replaceable>PROJECT</replaceable> --version</userinput></screen>
|
||||
<para>For example, to see the version number for the
|
||||
<command>nova</command> client, run the
|
||||
following command:</para>
|
||||
<screen><prompt>$</prompt> <userinput>nova --version</userinput></screen>
|
||||
<para>The version number (2.15.0 in the example) is returned.</para>
|
||||
<screen><computeroutput>2.15.0</computeroutput></screen>
|
||||
</section>
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<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="section_conventions">
|
||||
<?dbhtml stop-chunking?>
|
||||
<title>Conventions</title>
|
||||
<para>The OpenStack documentation uses several typesetting conventions.</para>
|
||||
<simplesect xml:id="conventions-admonitions">
|
||||
<title>Notices</title>
|
||||
<para>Notices take these forms:</para>
|
||||
<note>
|
||||
<para>A handy tip or reminder.</para>
|
||||
</note>
|
||||
<important>
|
||||
<para>Something you must be aware of before proceeding.</para>
|
||||
</important>
|
||||
<warning>
|
||||
<para>Critical information about the risk of data loss or security
|
||||
issues.</para>
|
||||
</warning>
|
||||
</simplesect>
|
||||
<simplesect xml:id="conventions-prompts">
|
||||
<title>Command prompts</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><emphasis role="bold"><prompt>$</prompt> prompt</emphasis></term>
|
||||
<listitem>
|
||||
<para>Any user, including the <literal>root</literal> user,
|
||||
can run commands that are
|
||||
prefixed with the <prompt>$</prompt> prompt.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><emphasis role="bold"><prompt>#</prompt> prompt</emphasis></term>
|
||||
<listitem>
|
||||
<para>The <literal>root</literal> user must run commands
|
||||
that are prefixed with the <prompt>#</prompt> prompt.
|
||||
You can also prefix these commands with the
|
||||
<command>sudo</command> command, if available,
|
||||
to run them.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</simplesect>
|
||||
</section>
|
||||
Loading…
Reference in New Issue