Rework to add PDF for complete API reference pages
Add link for comprehensive API Reference PDF to all index.html pages Partial-Bug: #1301473 Change-Id: I9ac759e0a26d64c1060a0ff1fc1a00565416fa2c author: diane fleming
This commit is contained in:
parent
717faea967
commit
006cafd5a2
@ -2,68 +2,74 @@
|
||||
<section xml:id="section_image-mgmt"
|
||||
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">
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||
<title>Image management</title>
|
||||
<para>The OpenStack Image Service discovers, registers, and retrieves virtual machine images.
|
||||
The service also includes a RESTful API that allows you to query VM image metadata and
|
||||
retrieve the actual image with HTTP requests. For more information about the API, see the
|
||||
<link xlink:href="http://api.openstack.org/api-ref.html#os-images-2.0"> OpenStack
|
||||
API</link> or the <link
|
||||
xlink:href="http://docs.openstack.org/developer/python-glanceclient/"> Python
|
||||
API</link>.</para>
|
||||
<para>The OpenStack Image Service can be controlled using a command-line tool. For more
|
||||
information about the using OpenStack Image command-line tool, see the <link
|
||||
xlink:href="http://docs.openstack.org/user-guide/content/cli_manage_images.html"> Manage
|
||||
Images</link> section in the <citetitle>OpenStack End User Guide</citetitle>.</para>
|
||||
<para>Virtual images that have been made available through the Image Service can be stored
|
||||
in a variety of ways. In order to use these services, you must have a working installation
|
||||
of the Image Service, with a working endpoint, and users that have been created in OpenStack
|
||||
Identity. Additionally, you must meet the environment variables required by the Compute and
|
||||
Image Service clients.</para>
|
||||
<para>The Image Service supports these back end stores:</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>File system</term>
|
||||
<listitem>
|
||||
<para>The OpenStack Image Service stores virtual machine images in the file
|
||||
system back end by default. This simple back end writes image files to the local
|
||||
file system.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Object Storage service</term>
|
||||
<listitem>
|
||||
<para>The OpenStack highly available service for storing objects.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>S3</term>
|
||||
<listitem>
|
||||
<para>The Amazon S3 service.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>HTTP</term>
|
||||
<listitem>
|
||||
<para>OpenStack Image Service can read virtual
|
||||
machine images that are available on the
|
||||
internet using HTTP. This store is read
|
||||
only.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Rados block device (RBD)</term>
|
||||
<listitem>
|
||||
<para>Stores images inside of a Ceph storage
|
||||
cluster using Ceph's RBD interface.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>GridFS</term>
|
||||
<listitem>
|
||||
<para>Stores images using MongoDB.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<para>The OpenStack Image Service discovers, registers, and
|
||||
retrieves virtual machine images. The service also includes a
|
||||
RESTful API that allows you to query VM image metadata and
|
||||
retrieve the actual image with HTTP requests. For more
|
||||
information about the API, see the <link
|
||||
xlink:href="http://api.openstack.org/api-ref.html"
|
||||
>OpenStack API Complete Reference</link> and the <link
|
||||
xlink:href="http://docs.openstack.org/developer/python-glanceclient/"
|
||||
>Python API</link>.</para>
|
||||
<para>The OpenStack Image Service can be controlled using a
|
||||
command-line tool. For more information about the using
|
||||
OpenStack Image command-line tool, see the <link
|
||||
xlink:href="http://docs.openstack.org/user-guide/content/cli_manage_images.html"
|
||||
>Manage Images</link> section in the <citetitle>OpenStack
|
||||
End User Guide</citetitle>.</para>
|
||||
<para>Virtual images that have been made available through the
|
||||
Image Service can be stored in a variety of ways. In order to
|
||||
use these services, you must have a working installation of
|
||||
the Image Service, with a working endpoint, and users that
|
||||
have been created in OpenStack Identity. Additionally, you
|
||||
must meet the environment variables required by the Compute
|
||||
and Image Service clients.</para>
|
||||
<para>The Image Service supports these back-end stores:</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>File system</term>
|
||||
<listitem>
|
||||
<para>The OpenStack Image Service stores virtual
|
||||
machine images in the file system back end by
|
||||
default. This simple back end writes image files
|
||||
to the local file system.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Object Storage service</term>
|
||||
<listitem>
|
||||
<para>The OpenStack highly available service for
|
||||
storing objects.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>S3</term>
|
||||
<listitem>
|
||||
<para>The Amazon S3 service.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>HTTP</term>
|
||||
<listitem>
|
||||
<para>OpenStack Image Service can read virtual machine
|
||||
images that are available on the internet using
|
||||
HTTP. This store is read only.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Rados block device (RBD)</term>
|
||||
<listitem>
|
||||
<para>Stores images inside of a Ceph storage cluster
|
||||
using Ceph's RBD interface.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>GridFS</term>
|
||||
<listitem>
|
||||
<para>Stores images using MongoDB.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
@ -5,7 +5,6 @@
|
||||
xml:id="app_community_support">
|
||||
<?dbhtml stop-chunking?>
|
||||
<title>Community support</title>
|
||||
|
||||
<para>Many resources are available to help you run and use
|
||||
OpenStack. Members of the OpenStack community can answer
|
||||
questions and help with bug suspicions. We are constantly
|
||||
@ -13,12 +12,11 @@
|
||||
you have any problems, do not hesitate to ask. Use the
|
||||
following resources to get OpenStack support and troubleshoot
|
||||
your existing 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>
|
||||
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
|
||||
@ -26,117 +24,130 @@
|
||||
>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>
|
||||
<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/trunk/install-guide/install/apt-debian/content/">
|
||||
<citetitle>Installation Guide for Debian 7.0</citetitle>
|
||||
</link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link xlink:href="http://docs.openstack.org/trunk/install-guide/install/zypper/content/">
|
||||
<citetitle>Installation Guide for openSUSE and SUSE Linux Enterprise Server</citetitle>
|
||||
</link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link xlink:href="http://docs.openstack.org/trunk/install-guide/install/yum/content/">
|
||||
<citetitle>Installation Guide for Red Hat Enterprise Linux,
|
||||
CentOS, and Fedora</citetitle>
|
||||
</link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link xlink:href="http://docs.openstack.org/trunk/install-guide/install/apt/content/">
|
||||
<citetitle>Installation Guide for Ubuntu 12.04 (LTS)</citetitle>
|
||||
</link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/trunk/install-guide/install/apt-debian/content/">
|
||||
<citetitle>Installation Guide for Debian
|
||||
7.0</citetitle>
|
||||
</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/trunk/install-guide/install/zypper/content/">
|
||||
<citetitle>Installation Guide for openSUSE and
|
||||
SUSE Linux Enterprise Server</citetitle>
|
||||
</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/trunk/install-guide/install/yum/content/">
|
||||
<citetitle>Installation Guide for Red Hat
|
||||
Enterprise Linux, CentOS, and
|
||||
Fedora</citetitle>
|
||||
</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/trunk/install-guide/install/apt/content/">
|
||||
<citetitle>Installation Guide for Ubuntu 12.04
|
||||
(LTS)</citetitle>
|
||||
</link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The following books explain how to configure and run an
|
||||
OpenStack cloud:</para>
|
||||
OpenStack cloud:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
|
||||
><citetitle>Cloud Administrator Guide</citetitle></link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/trunk/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/high-availability-guide/content/"
|
||||
><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/content/"
|
||||
><citetitle>Virtual Machine Image Guide</citetitle></link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/"
|
||||
><citetitle>Cloud Administrator
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/trunk/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/high-availability-guide/content/"
|
||||
><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/content/"
|
||||
><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://docs.openstack.org/api/quick-start/content/"
|
||||
><citetitle>API Quick Start</citetitle></link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/user-guide/content/"
|
||||
><citetitle>End User Guide</citetitle></link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/user-guide-admin/content/"
|
||||
><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>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/api/quick-start/content/"
|
||||
><citetitle>API Quick
|
||||
Start</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/user-guide/content/"
|
||||
><citetitle>End User
|
||||
Guide</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link
|
||||
xlink:href="http://docs.openstack.org/user-guide-admin/content/"
|
||||
><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://api.openstack.org/api-ref.html">OpenStack API Reference</link></para></listitem>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref.html"
|
||||
>OpenStack API Complete
|
||||
Reference (HTML)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://api.openstack.org/api-ref-guides/bk-api-ref.pdf"
|
||||
>API Complete Reference (PDF)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/api/openstack-block-storage/2.0/content/"
|
||||
@ -146,56 +157,65 @@
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/api/openstack-compute/2/content/"
|
||||
><citetitle>OpenStack Compute API v2 and Extensions Reference</citetitle></link></para>
|
||||
xlink:href="http://docs.openstack.org/api/openstack-compute/2/content/"
|
||||
><citetitle>OpenStack Compute API v2 and
|
||||
Extensions
|
||||
Reference</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
|
||||
><citetitle>OpenStack Identity Service API v2.0 Reference</citetitle></link></para>
|
||||
xlink:href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/"
|
||||
><citetitle>OpenStack Identity Service API
|
||||
v2.0 Reference</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/api/openstack-image-service/2.0/content/"
|
||||
><citetitle>OpenStack Image Service API v2 Reference</citetitle></link></para>
|
||||
xlink:href="http://docs.openstack.org/api/openstack-image-service/2.0/content/"
|
||||
><citetitle>OpenStack Image Service API v2
|
||||
Reference</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/"
|
||||
><citetitle>OpenStack Networking API v2.0 Reference</citetitle></link></para>
|
||||
xlink:href="http://docs.openstack.org/api/openstack-network/2.0/content/"
|
||||
><citetitle>OpenStack Networking API v2.0
|
||||
Reference</citetitle></link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link
|
||||
xlink:href="http://docs.openstack.org/api/openstack-object-storage/1.0/content/"
|
||||
><citetitle>OpenStack Object Storage API v1 Reference</citetitle></link></para>
|
||||
</listitem></itemizedlist>
|
||||
<para>The <link xlink:href="http://docs.openstack.org/training-guides/content/"
|
||||
><citetitle>Training Guides</citetitle></link>
|
||||
offer software training for cloud administration and management.</para>
|
||||
xlink:href="http://docs.openstack.org/api/openstack-object-storage/1.0/content/"
|
||||
><citetitle>OpenStack Object Storage API
|
||||
v1 Reference</citetitle></link></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The <link
|
||||
xlink:href="http://docs.openstack.org/training-guides/content/"
|
||||
><citetitle>Training Guides</citetitle></link>
|
||||
offer software training for cloud administration and
|
||||
management.</para>
|
||||
</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="http://ask.openstack.org"
|
||||
>ask.openstack.org</link> site to ask questions and
|
||||
get answers. When you visit the <link
|
||||
xlink:href="http://ask.openstack.org"
|
||||
>http://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 so on.</para>
|
||||
<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="http://ask.openstack.org"
|
||||
>ask.openstack.org</link> site to ask questions and
|
||||
get answers. When you visit the <link
|
||||
xlink:href="http://ask.openstack.org"
|
||||
>http://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 so on.</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
|
||||
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>.
|
||||
@ -210,21 +230,21 @@ and so on.</para>
|
||||
<section xml:id="support-wiki">
|
||||
<title>The OpenStack wiki</title>
|
||||
<para>The <link xlink:href="http://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
|
||||
>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
|
||||
nova, you can find lots 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>
|
||||
search for specific information, such as about networking
|
||||
or nova, you can find lots 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
|
||||
<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.
|
||||
@ -234,79 +254,100 @@ and so on.</para>
|
||||
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 so on.</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>"Grizzly release" vs git commit
|
||||
<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 so on.</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>"Grizzly release" vs git commit
|
||||
bc79c3ecc55929bac585d04a03475b72e06a3208</literal>.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Any deployment specific information is helpful,
|
||||
such as Ubuntu 12.04 or multi-node install.</para>
|
||||
</listitem>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Any deployment specific information is helpful,
|
||||
such as Ubuntu 12.04 or multi-node install.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The Launchpad Bugs areas are available here:</para>
|
||||
<itemizedlist>
|
||||
<!-- Core projects, sorted alphabetically -->
|
||||
<listitem>
|
||||
<para><link xlink:href="https://bugs.launchpad.net/nova">Bugs:
|
||||
OpenStack Block Storage (cinder)</link></para>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/nova"
|
||||
>Bugs: OpenStack Block Storage
|
||||
(cinder)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="https://bugs.launchpad.net/nova">Bugs:
|
||||
OpenStack Compute (nova)</link></para>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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/ironic"
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/ironic"
|
||||
>Bugs: Bare Metal (ironic)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="https://bugs.launchpad.net/sahara"
|
||||
>Bugs: Data Processing Service (sahara)</link></para>
|
||||
<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"
|
||||
<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/heat">Bugs:
|
||||
Orchestration (heat)</link></para>
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/heat"
|
||||
>Bugs: Orchestration (heat)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="https://bugs.launchpad.net/ceilometer"
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/ceilometer"
|
||||
>Bugs: Telemetry (ceilometer)</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><link xlink:href="https://bugs.launchpad.net/marconi"
|
||||
<para><link
|
||||
xlink:href="https://bugs.launchpad.net/marconi"
|
||||
>Bugs: Queue Service (marconi)</link></para>
|
||||
</listitem>
|
||||
<!-- Programs, sorted alphabetically -->
|
||||
@ -352,49 +393,46 @@ and so on.</para>
|
||||
>https://wiki.openstack.org/wiki/IRC</link>.</para>
|
||||
</section>
|
||||
<section xml:id="support-documentation-feedback">
|
||||
<title>Documentation feedback</title>
|
||||
<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>
|
||||
<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="http://wiki.debian.org/OpenStack">http://wiki.debian.org/OpenStack</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">CentOS, Fedora, and Red Hat
|
||||
Enterprise Linux:</emphasis> <link
|
||||
xlink:href="http://openstack.redhat.com/">http://openstack.redhat.com/</link>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">openSUSE and SUSE Linux
|
||||
Enterprise Server:</emphasis>
|
||||
<link xlink:href="http://en.opensuse.org/Portal:OpenStack"
|
||||
>http://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>
|
||||
<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="http://wiki.debian.org/OpenStack"
|
||||
>http://wiki.debian.org/OpenStack</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">CentOS, Fedora, and Red
|
||||
Hat Enterprise Linux:</emphasis>
|
||||
<link xlink:href="http://openstack.redhat.com/"
|
||||
>http://openstack.redhat.com/</link></para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><emphasis role="bold">openSUSE and SUSE Linux
|
||||
Enterprise Server:</emphasis>
|
||||
<link
|
||||
xlink:href="http://en.opensuse.org/Portal:OpenStack"
|
||||
>http://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>
|
||||
</appendix>
|
||||
|
@ -101,7 +101,11 @@ div.c1 {width: 100%;}
|
||||
<dl>
|
||||
<dd><a
|
||||
href="http://api.openstack.org/api-ref.html"
|
||||
>API Complete Reference</a>
|
||||
>API Complete Reference (HTML)</a>
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://api.openstack.org/api-ref-guides/bk-api-ref.pdf"
|
||||
>API Complete Reference (PDF)</a>
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://docs.openstack.org/api/openstack-block-storage/2.0/content/"
|
||||
|
@ -262,7 +262,11 @@
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://api.openstack.org/api-ref.html"
|
||||
>API Complete Reference</a>
|
||||
>API Complete Reference (HTML)</a>
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://api.openstack.org/api-ref-guides/bk-api-ref.pdf"
|
||||
>API Complete Reference (PDF)</a>
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://docs.openstack.org/api/openstack-block-storage/2.0/content/"
|
||||
|
@ -212,11 +212,11 @@
|
||||
>Virtual Machine Image
|
||||
Guide</a></dd>
|
||||
</dl>
|
||||
<h4 class="special">Training Guides</h4>
|
||||
<h4 class="special">Training guides</h4>
|
||||
<dl>
|
||||
<dd><a
|
||||
href="http://docs.openstack.org/training-guides/content/">
|
||||
Training Guides</a>
|
||||
Training guides</a>
|
||||
</dd>
|
||||
</dl>
|
||||
<h4 class="special">Get involved</h4>
|
||||
@ -258,7 +258,11 @@
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://api.openstack.org/api-ref.html"
|
||||
>API Complete Reference</a>
|
||||
>API Complete Reference (HTML)</a>
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://api.openstack.org/api-ref-guides/bk-api-ref.pdf"
|
||||
>API Complete Reference (PDF)</a>
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://docs.openstack.org/api/openstack-block-storage/2.0/content/"
|
||||
|
@ -260,7 +260,11 @@
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://api.openstack.org/api-ref.html"
|
||||
>API Complete Reference</a>
|
||||
>API Complete Reference (HTML)</a>
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://api.openstack.org/api-ref-guides/bk-api-ref.pdf"
|
||||
>API Complete Reference (PDF)</a>
|
||||
</dd>
|
||||
<dd><a
|
||||
href="http://docs.openstack.org/api/openstack-block-storage/2.0/content/"
|
||||
|
Loading…
Reference in New Issue
Block a user