openstack-manuals/doc/common-rst/app_support.rst

249 lines
8.9 KiB
ReStructuredText

=================
Community support
=================
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.
Documentation
~~~~~~~~~~~~~
For the available OpenStack documentation, see
`docs.openstack.org <http://docs.openstack.org>`__.
To provide feedback on documentation, join and use the
openstack-docs@lists.openstack.org mailing list at `OpenStack
Documentation Mailing
List <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>`__,
or `report a
bug <https://bugs.launchpad.net/openstack-manuals/+filebug>`__.
The following books explain how to install an OpenStack cloud and its
associated components:
- `Installation Guide for openSUSE 13.2 and SUSE Linux Enterprise
Server 12
<http://docs.openstack.org/liberty/install-guide-obs/>`__
- `Installation Guide for Red Hat Enterprise Linux 7, CentOS 7, and
Fedora
21 <http://docs.openstack.org/liberty/install-guide-rdo/>`__
- `Installation Guide for Ubuntu
14.04 <http://docs.openstack.org/liberty/install-guide-ubuntu/>`__
The following books explain how to configure and run an OpenStack cloud:
- `Architecture Design
Guide <http://docs.openstack.org/arch-design/content/>`__
- `Cloud Administrator
Guide <http://docs.openstack.org/admin-guide-cloud/>`__
- `Configuration
Reference <http://docs.openstack.org/liberty/config-reference/content/>`__
- `Operations Guide <http://docs.openstack.org/ops/>`__
- `Networking Guide <http://docs.openstack.org/networking-guide>`__
- `High Availability
Guide <http://docs.openstack.org/ha-guide/>`__
- `Security Guide <http://docs.openstack.org/sec/>`__
- `Virtual Machine Image
Guide <http://docs.openstack.org/image-guide/content/>`__
The following books explain how to use the OpenStack dashboard and
command-line clients:
- `API Guide <http://developer.openstack.org/api-guide/quick-start/>`__
- `End User Guide <http://docs.openstack.org/user-guide/>`__
- `Admin User
Guide <http://docs.openstack.org/user-guide-admin/>`__
- `Command-Line Interface
Reference <http://docs.openstack.org/cli-reference/content/>`__
The following documentation provides reference and guidance information
for the OpenStack APIs:
- `OpenStack API Complete Reference
(HTML) <http://developer.openstack.org/api-ref.html>`__
- `API Complete Reference
(PDF) <http://developer.openstack.org/api-ref-guides/bk-api-ref.pdf>`__
ask.openstack.org
~~~~~~~~~~~~~~~~~
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
`ask.openstack.org <https://ask.openstack.org>`__ site to ask questions
and get answers. When you visit the https://ask.openstack.org 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.
OpenStack mailing lists
~~~~~~~~~~~~~~~~~~~~~~~
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
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack. You might
be interested in the other mailing lists for specific projects or
development, which you can find `on the
wiki <https://wiki.openstack.org/wiki/MailingLists>`__. A description of all
mailing lists is available at https://wiki.openstack.org/wiki/MailingLists.
The OpenStack wiki
~~~~~~~~~~~~~~~~~~
The `OpenStack wiki <https://wiki.openstack.org/>`__ 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.
The Launchpad Bugs area
~~~~~~~~~~~~~~~~~~~~~~~
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
https://launchpad.net/+login. 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.
Some tips:
- Give a clear, concise summary.
- 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.
- Be sure to include the software and package versions that you are
using, especially if you are using a development branch, such as,
``"Kilo release" vs git commit bc79c3ecc55929bac585d04a03475b72e06a3208``.
- Any deployment-specific information is helpful, such as whether you
are using Ubuntu 14.04 or are performing a multi-node installation.
The following Launchpad Bugs areas are available:
- `Bugs: OpenStack Block Storage
(cinder) <https://bugs.launchpad.net/cinder>`__
- `Bugs: OpenStack Compute (nova) <https://bugs.launchpad.net/nova>`__
- `Bugs: OpenStack Dashboard
(horizon) <https://bugs.launchpad.net/horizon>`__
- `Bugs: OpenStack Identity
(keystone) <https://bugs.launchpad.net/keystone>`__
- `Bugs: OpenStack Image service
(glance) <https://bugs.launchpad.net/glance>`__
- `Bugs: OpenStack Networking
(neutron) <https://bugs.launchpad.net/neutron>`__
- `Bugs: OpenStack Object Storage
(swift) <https://bugs.launchpad.net/swift>`__
- `Bugs: Application catalog (murano) <https://bugs.launchpad.net/murano>`__
- `Bugs: Bare metal service (ironic) <https://bugs.launchpad.net/ironic>`__
- `Bugs: Containers service (magnum) <https://bugs.launchpad.net/magnum>`__
- `Bugs: Data processing service
(sahara) <https://bugs.launchpad.net/sahara>`__
- `Bugs: Database service (trove) <https://bugs.launchpad.net/trove>`__
- `Bugs: Deployment service (tuskar) <https://bugs.launchpad.net/tuskar>`__
- `Bugs: Key Manager Service (barbican) <https://bugs.launchpad.net/barbican>`__
- `Bugs: Orchestration (heat) <https://bugs.launchpad.net/heat>`__
- `Bugs: Shared file systems (manila) <https://bugs.launchpad.net/manila>`__
- `Bugs: Telemetry
(ceilometer) <https://bugs.launchpad.net/ceilometer>`__
- `Bugs: Workflow service
(mistral) <https://bugs.launchpad.net/mistral>`__
- `Bugs: Messaging service
(zaqar) <https://bugs.launchpad.net/zaqar>`__
- `Bugs: OpenStack API Documentation
(developer.openstack.org) <https://bugs.launchpad.net/openstack-api-site>`__
- `Bugs: OpenStack Documentation
(docs.openstack.org) <https://bugs.launchpad.net/openstack-manuals>`__
The OpenStack IRC channel
~~~~~~~~~~~~~~~~~~~~~~~~~
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
`https://webchat.freenode.net/ <https://webchat.freenode.net>`__. You can
also use Colloquy (Mac OS X, http://colloquy.info/), mIRC (Windows,
http://www.mirc.com/), 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
http://paste.openstack.org. 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 ``#openstack`` on
``irc.freenode.net``. You can find a list of all OpenStack IRC channels
at https://wiki.openstack.org/wiki/IRC.
Documentation feedback
~~~~~~~~~~~~~~~~~~~~~~
To provide feedback on documentation, join and use the
openstack-docs@lists.openstack.org mailing list at `OpenStack
Documentation Mailing
List <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>`__,
or `report a
bug <https://bugs.launchpad.net/openstack-manuals/+filebug>`__.
OpenStack distribution packages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following Linux distributions provide community-supported packages
for OpenStack:
- **Debian:** https://wiki.debian.org/OpenStack
- **CentOS, Fedora, and Red Hat Enterprise Linux:**
https://www.rdoproject.org/
- **openSUSE and SUSE Linux Enterprise Server:**
https://en.opensuse.org/Portal:OpenStack
- **Ubuntu:** https://wiki.ubuntu.com/ServerTeam/CloudArchive