openstack/openstack-manuals
Code Issues Proposed changes

Add and update links to Queens project docs

Browse Source 
install-guide is version-independent, so we need to include links to
both releases.

Change-Id: Ie7bb2ed92d258d48a92f04579c6caae47573beb6
This commit is contained in:
Petr Kovar 2018-02-23 17:23:46 +01:00
parent 0a663c283a
commit 3edc5322ab
9 changed files with 76 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/common/app-support.rst
View File

@ -24,17 +24,17 @@ For the available OpenStack documentation, see
The following guides explain how to install a Proof-of-Concept OpenStack cloud
and its associated components:
* `Pike Installation Guides <https://docs.openstack.org/pike/install/>`_
* `Queens Installation Guides <https://docs.openstack.org/queens/install/>`_
The following books explain how to configure and run an OpenStack cloud:
* `Architecture Design Guide <https://docs.openstack.org/arch-design/>`_
* `Pike Administrator Guides <https://docs.openstack.org/pike/admin/>`_
* `Queens Administrator Guides <https://docs.openstack.org/queens/admin/>`_
* `Pike Configuration Guides <https://docs.openstack.org/pike/configuration/>`_
* `Queens Configuration Guides <https://docs.openstack.org/queens/configuration/>`_
* `Pike Networking Guide <https://docs.openstack.org/neutron/pike/admin/>`_
* `Queens Networking Guide <https://docs.openstack.org/neutron/queens/admin/>`_
* `High Availability Guide <https://docs.openstack.org/ha-guide/>`_
@ -44,8 +44,8 @@ The following books explain how to configure and run an OpenStack cloud:
The following book explains how to use the command-line clients:
* `Pike API Bindings
<https://docs.openstack.org/pike/language-bindings.html>`_
* `Queens API Bindings
<https://docs.openstack.org/queens/language-bindings.html>`_
The following documentation provides reference and guidance information
for the OpenStack APIs:

4
doc/install-guide/source/environment-security.rst
View File

@ -71,7 +71,9 @@ modifications to the host that can interfere with deployment automation
tools such as Ansible, Chef, and Puppet. For example, some OpenStack
services add a root wrapper to ``sudo`` that can interfere with security
policies. See the
`Compute service documentation for Pike <https://docs.openstack.org/nova/pike/admin/root-wrap-reference.html>`__
`Compute service documentation for Pike <https://docs.openstack.org/nova/pike/admin/root-wrap-reference.html>`_
or the
`Compute service documentation for Queens <https://docs.openstack.org/nova/queens/admin/root-wrap-reference.html>`_
for more information.
The Networking service assumes default values for kernel network

6
doc/install-guide/source/environment.rst
View File

@ -10,6 +10,8 @@ one networking service, and the Dashboard, the Object Storage service can
operate independently. If your use case only involves Object Storage, you can
skip to `Object Storage Installation Guide for Pike
<https://docs.openstack.org/swift/pike/install/>`_
or `Object Storage Installation Guide for Queens
<https://docs.openstack.org/swift/queens/install/>`_
after configuring the appropriate nodes for it.
You must use an account with administrative privileges to configure each node.
@ -68,7 +70,9 @@ of nested VMs.
interface.
For more information about system requirements, see the
`OpenStack Pike Administrator Guides <https://docs.openstack.org/pike/admin/>`_.
`OpenStack Pike Administrator Guides <https://docs.openstack.org/pike/admin/>`_
or the
`OpenStack Queens Administrator Guides <https://docs.openstack.org/queens/admin/>`_.
.. toctree::
:maxdepth: 1

5
doc/install-guide/source/launch-instance-cinder.rst
View File

@ -139,6 +139,9 @@ Attach the volume to an instance
For more information about how to manage volumes, see the
`python-openstackclient documentation for Pike
<https://docs.openstack.org/python-openstackclient/pike/cli/command-objects/volume.html>`__.
<https://docs.openstack.org/python-openstackclient/pike/cli/command-objects/volume.html>`_
or the
`python-openstackclient documentation for Queens
<https://docs.openstack.org/python-openstackclient/queens/cli/command-objects/volume.html>`_.
Return to :ref:`launch-instance`.

5
doc/install-guide/source/launch-instance-provider.rst
View File

@ -269,7 +269,10 @@ Access the instance remotely
If your instance does not launch or seem to work as you expect, see the
`Troubleshoot Compute documentation for Pike
<https://docs.openstack.org/nova/pike/admin/support-compute.html>`__
<https://docs.openstack.org/nova/pike/admin/support-compute.html>`_
or the
`Troubleshoot Compute documentation for Queens
<https://docs.openstack.org/nova/queens/admin/support-compute.html>`_
for more information or use one of
the :doc:`many other options <common/app-support>`
to seek assistance. We want your first installation to work!

5
doc/install-guide/source/launch-instance-selfservice.rst
View File

@ -309,7 +309,10 @@ Access the instance remotely
If your instance does not launch or seem to work as you expect, see the
`Troubleshoot Compute documentation for Pike
<https://docs.openstack.org/nova/pike/admin/support-compute.html>`__
<https://docs.openstack.org/nova/pike/admin/support-compute.html>`_
or the
`Troubleshoot Compute documentation for Queens
<https://docs.openstack.org/nova/queens/admin/support-compute.html>`_
for more information or use one of
the :doc:`many other options <common/app-support>`
to seek assistance. We want your first installation to work!

20
doc/install-guide/source/launch-instance.rst
View File

@ -14,10 +14,16 @@ tools on the controller node. However, you can follow the instructions
on any host that the tools are installed.
For more information on the CLI tools, see the
`OpenStackClient documentation for Pike
<https://docs.openstack.org/python-openstackclient/pike/cli/command-objects/server.html#server-create>`__.
<https://docs.openstack.org/python-openstackclient/pike/cli/command-objects/server.html#server-create>`_
or the
`OpenStackClient documentation for Queens
<https://docs.openstack.org/python-openstackclient/queens/cli/command-objects/server.html#server-create>`_.
To use the dashboard, see the
`Dashboard User Documentation for Pike
<https://docs.openstack.org/horizon/pike/user/>`__.
<https://docs.openstack.org/horizon/pike/user/>`_
or the
`Dashboard User Documentation for Queens
<https://docs.openstack.org/horizon/queens/user/>`_.
.. _launch-instance-networks:
@ -220,7 +226,10 @@ a stack that launches an instance.
For more information, see the
`Orchestration installation guide for Pike
<https://docs.openstack.org/heat/pike/>`_.
<https://docs.openstack.org/heat/pike/install/>`_
or the
`Orchestration installation guide for Queens
<https://docs.openstack.org/heat/queens/install/>`_.
Shared File Systems
-------------------
@ -230,4 +239,7 @@ a share and mount it in an instance.
For more information, see the
`Shared File Systems installation guide for Pike
<https://docs.openstack.org/manila/pike/>`_.
<https://docs.openstack.org/manila/pike/install/>`_
or the
`Shared File Systems installation guide for Queens
<https://docs.openstack.org/manila/queens/install/>`_.

30
doc/install-guide/source/openstack-services.rst
View File

@ -8,12 +8,11 @@ locations:
* `OpenStack Installation Guides for Pike
<https://docs.openstack.org/pike/install/>`_
* `OpenStack Installation Guides for Queens
<https://docs.openstack.org/queens/install/>`_
.. Note that this guide is release independent, so we will add more
entries to the list above.
Minimal deployment
==================
Minimal deployment for Pike
~~~~~~~~~~~~~~~~~~~~~~~~~~~
At a minimum, you need to install the following services. Install the services
in the order specified below:
@ -32,3 +31,24 @@ minimal deployment services:
* Dashboard – `horizon installation for Pike <https://docs.openstack.org/horizon/pike/install/>`_
* Block Storage service – `cinder installation for Pike <https://docs.openstack.org/cinder/pike/install/>`_
Minimal deployment for Queens
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
At a minimum, you need to install the following services. Install the services
in the order specified below:
* Identity service – `keystone installation for Queens
<https://docs.openstack.org/keystone/queens/install/>`_
* Image service – `glance installation for Queens
<https://docs.openstack.org/glance/queens/install/>`_
* Compute service – `nova installation for Queens
<https://docs.openstack.org/nova/queens/install/>`_
* Networking service – `neutron installation for Queens
<https://docs.openstack.org/neutron/queens/install/>`_
We advise to also install the following components after you have installed the
minimal deployment services:
* Dashboard – `horizon installation for Queens <https://docs.openstack.org/horizon/queens/install/>`_
* Block Storage service – `cinder installation for Queens <https://docs.openstack.org/cinder/queens/install/>`_

11
doc/install-guide/source/overview.rst
View File

@ -58,10 +58,17 @@ follows:
* Overlay (tunnel) traffic for self-service networks traverses the management
network instead of a dedicated network.
For more information on production architectures, see the
For more information on production architectures for Pike, see the
`Architecture Design Guide <https://docs.openstack.org/arch-design/>`_,
`OpenStack Networking Guide for Pike <https://docs.openstack.org/neutron/pike/admin/>`_,
and `OpenStack Administrator Guides for Pike <https://docs.openstack.org/pike/admin/>`_.
and
`OpenStack Administrator Guides for Pike <https://docs.openstack.org/pike/admin/>`_.
For more information on production architectures for Queens, see the
`Architecture Design Guide <https://docs.openstack.org/arch-design/>`_,
`OpenStack Networking Guide for Queens <https://docs.openstack.org/neutron/queens/admin/>`_,
and
`OpenStack Administrator Guides for Queens <https://docs.openstack.org/queens/admin/>`_.
.. _figure-hwreqs: