From 4bca243c86df4ab437f711118f77e75dbb704589 Mon Sep 17 00:00:00 2001 From: Petr Kovar Date: Thu, 30 Aug 2018 15:55:45 +0200 Subject: [PATCH] Update install guide common content for Rocky No updates on distro packages yet. This deserves more automation with templates in the future, but get this in for now. Change-Id: I2cac95b57febe067e956be9d14808d1209b42495 --- doc/common/app-support.rst | 12 +++---- .../source/environment-security.rst | 6 ++-- doc/install-guide/source/environment.rst | 15 ++++---- .../source/launch-instance-cinder.rst | 8 ++--- .../source/launch-instance-provider.rst | 8 ++--- .../source/launch-instance-selfservice.rst | 8 ++--- doc/install-guide/source/launch-instance.rst | 35 ++++++++++--------- .../source/openstack-services.rst | 23 ++++++++++++ doc/install-guide/source/overview.rst | 6 ++++ 9 files changed, 79 insertions(+), 42 deletions(-) diff --git a/doc/common/app-support.rst b/doc/common/app-support.rst index f341f90269..3c8f960a62 100644 --- a/doc/common/app-support.rst +++ b/doc/common/app-support.rst @@ -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: -* `Queens Installation Guides `_ +* `Rocky Installation Guides `_ The following books explain how to configure and run an OpenStack cloud: * `Architecture Design Guide `_ -* `Queens Administrator Guides `_ +* `Rocky Administrator Guides `_ -* `Queens Configuration Guides `_ +* `Rocky Configuration Guides `_ -* `Queens Networking Guide `_ +* `Rocky Networking Guide `_ * `High Availability 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: -* `Queens API Bindings - `_ +* `Rocky API Bindings + `_ The following documentation provides reference and guidance information for the OpenStack APIs: diff --git a/doc/install-guide/source/environment-security.rst b/doc/install-guide/source/environment-security.rst index 62c6574db5..1f74c5518a 100644 --- a/doc/install-guide/source/environment-security.rst +++ b/doc/install-guide/source/environment-security.rst @@ -71,9 +71,11 @@ 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 `_ +`Compute service documentation for Pike `_, +the +`Compute service documentation for Queens `_, or the -`Compute service documentation for Queens `_ +`Compute service documentation for Rocky `_ for more information. The Networking service assumes default values for kernel network diff --git a/doc/install-guide/source/environment.rst b/doc/install-guide/source/environment.rst index 1dcb56547b..44758c79d4 100644 --- a/doc/install-guide/source/environment.rst +++ b/doc/install-guide/source/environment.rst @@ -8,10 +8,11 @@ node using the example architecture. Although most environments include Identity, Image service, Compute, at least 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 -`_ -or `Object Storage Installation Guide for Queens -`_ +skip to +`Object Storage Installation Guide for Pike `_, +`Object Storage Installation Guide for Queens `_, +or +`Object Storage Installation Guide for Rocky `_ after configuring the appropriate nodes for it. You must use an account with administrative privileges to configure each node. @@ -70,9 +71,11 @@ of nested VMs. interface. For more information about system requirements, see the -`OpenStack Pike Administrator Guides `_ +`OpenStack Pike Administrator Guides `_, +the +`OpenStack Queens Administrator Guides `_, or the -`OpenStack Queens Administrator Guides `_. +`OpenStack Rocky Administrator Guides `_. .. toctree:: :maxdepth: 1 diff --git a/doc/install-guide/source/launch-instance-cinder.rst b/doc/install-guide/source/launch-instance-cinder.rst index d5d758170b..8c1dd2f68f 100644 --- a/doc/install-guide/source/launch-instance-cinder.rst +++ b/doc/install-guide/source/launch-instance-cinder.rst @@ -138,10 +138,10 @@ Attach the volume to an instance to use the volume. For more information about how to manage volumes, see the -`python-openstackclient documentation for Pike -`_ +`python-openstackclient documentation for Pike `_, +the +`python-openstackclient documentation for Queens `_, or the -`python-openstackclient documentation for Queens -`_. +`python-openstackclient documentation for Rocky `_. Return to :ref:`launch-instance`. diff --git a/doc/install-guide/source/launch-instance-provider.rst b/doc/install-guide/source/launch-instance-provider.rst index 03282d9c7f..c6ab9a95c3 100644 --- a/doc/install-guide/source/launch-instance-provider.rst +++ b/doc/install-guide/source/launch-instance-provider.rst @@ -268,11 +268,11 @@ Access the instance remotely .. end If your instance does not launch or seem to work as you expect, see the -`Troubleshoot Compute documentation for Pike -`_ +`Troubleshoot Compute documentation for Pike `_, +the +`Troubleshoot Compute documentation for Queens `_, or the -`Troubleshoot Compute documentation for Queens -`_ +`Troubleshoot Compute documentation for Rocky `_ for more information or use one of the :doc:`many other options ` to seek assistance. We want your first installation to work! diff --git a/doc/install-guide/source/launch-instance-selfservice.rst b/doc/install-guide/source/launch-instance-selfservice.rst index 3ade27bc82..e4b2607e12 100644 --- a/doc/install-guide/source/launch-instance-selfservice.rst +++ b/doc/install-guide/source/launch-instance-selfservice.rst @@ -308,11 +308,11 @@ Access the instance remotely .. end If your instance does not launch or seem to work as you expect, see the -`Troubleshoot Compute documentation for Pike -`_ +`Troubleshoot Compute documentation for Pike `_, +the +`Troubleshoot Compute documentation for Queens `_, or the -`Troubleshoot Compute documentation for Queens -`_ +`Troubleshoot Compute documentation for Rocky `_ for more information or use one of the :doc:`many other options ` to seek assistance. We want your first installation to work! diff --git a/doc/install-guide/source/launch-instance.rst b/doc/install-guide/source/launch-instance.rst index fc21075eca..8ed9996e1b 100644 --- a/doc/install-guide/source/launch-instance.rst +++ b/doc/install-guide/source/launch-instance.rst @@ -9,21 +9,24 @@ instances. Networking option 1 includes one provider (external) network with one instance that uses it. Networking option 2 includes one provider network with one instance that uses it and one self-service (private) network with one instance that uses it. + The instructions in this section use command-line interface (CLI) 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 -`_ +`OpenStackClient documentation for Pike `_, +the +`OpenStackClient documentation for Queens `_, or the -`OpenStackClient documentation for Queens -`_. +`OpenStackClient documentation for Rocky `_. + To use the dashboard, see the -`Dashboard User Documentation for Pike -`_ +`Dashboard User Documentation for Pike `_, +the +`Dashboard User Documentation for Queens `_, or the -`Dashboard User Documentation for Queens -`_. +`Dashboard User Documentation for Rocky `_. .. _launch-instance-networks: @@ -225,11 +228,11 @@ If your environment includes the Orchestration service, you can create a stack that launches an instance. For more information, see the -`Orchestration installation guide for Pike -`_ +`Orchestration installation guide for Pike `_, +the +`Orchestration installation guide for Queens `_, or the -`Orchestration installation guide for Queens -`_. +`Orchestration installation guide for Rocky `_. Shared File Systems ------------------- @@ -238,8 +241,8 @@ If your environment includes the Shared File Systems service, you can create a share and mount it in an instance. For more information, see the -`Shared File Systems installation guide for Pike -`_ +`Shared File Systems installation guide for Pike `_, +the +`Shared File Systems installation guide for Queens `_, or the -`Shared File Systems installation guide for Queens -`_. +`Shared File Systems installation guide for Rocky `_. diff --git a/doc/install-guide/source/openstack-services.rst b/doc/install-guide/source/openstack-services.rst index d73852fdcc..f92c4c66b3 100644 --- a/doc/install-guide/source/openstack-services.rst +++ b/doc/install-guide/source/openstack-services.rst @@ -10,6 +10,8 @@ locations: `_ * `OpenStack Installation Guides for Queens `_ +* `OpenStack Installation Guides for Rocky + `_ Minimal deployment for Pike ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -52,3 +54,24 @@ minimal deployment services: * Dashboard – `horizon installation for Queens `_ * Block Storage service – `cinder installation for Queens `_ + +Minimal deployment for Rocky +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +At a minimum, you need to install the following services. Install the services +in the order specified below: + +* Identity service – `keystone installation for Rocky + `_ +* Image service – `glance installation for Rocky + `_ +* Compute service – `nova installation for Rocky + `_ +* Networking service – `neutron installation for Rocky + `_ + +We advise to also install the following components after you have installed the +minimal deployment services: + +* Dashboard – `horizon installation for Rocky `_ +* Block Storage service – `cinder installation for Rocky `_ diff --git a/doc/install-guide/source/overview.rst b/doc/install-guide/source/overview.rst index 06535ed004..2616b29ccb 100644 --- a/doc/install-guide/source/overview.rst +++ b/doc/install-guide/source/overview.rst @@ -70,6 +70,12 @@ For more information on production architectures for Queens, see the and `OpenStack Administrator Guides for Queens `_. +For more information on production architectures for Rocky, see the +`Architecture Design Guide `_, +`OpenStack Networking Guide for Rocky `_, +and +`OpenStack Administrator Guides for Rocky `_. + .. _figure-hwreqs: .. figure:: figures/hwreqs.png