openstack/openstack-manuals
Code Issues Proposed changes
bb80d53e95
openstack-manuals/doc/common/app_support.xml
Diane Fleming 006cafd5a2 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
2014-04-03 15:37:12 -05:00

439 lines
21 KiB
XML
Raw Blame History

<?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>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
improving and adding to the main features of OpenStack, but if
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>
<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/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>
<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>
</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>
</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 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/"
><citetitle>OpenStack Block Storage
Service API v2
Reference</citetitle></link></para>
</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>
</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>
</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>
</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>
</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>
</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>
</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="http://wiki.openstack.org/MailingLists">on
the wiki</link>. A description of all mailing lists is
available at <link
xlink:href="http://wiki.openstack.org/MailingLists"
>http://wiki.openstack.org/MailingLists</link>.</para>
</section>
<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
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>
</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 even better, already 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 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>
</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>
</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/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>
</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/heat"
>Bugs: Orchestration (heat)</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/marconi"
>Bugs: Queue Service (marconi)</link></para>
</listitem>
<!-- Programs, sorted alphabetically -->
<listitem>
<para><link
xlink:href="https://bugs.launchpad.net/openstack-api-site"
>Bugs: OpenStack API Documentation
(api.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 and breathes 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="http://webchat.freenode.net"
>http://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 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-related 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="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>
View Git Blame Copy Permalink