[docs] Migrate ops and appendix content
1. Migrate Ops chapter and tips and tricks appendix to developer docs 2. Migrate Appendix G to a chapter in the developer docs 3. Minor edits Change-Id: I4070f02b75a8f9614545be0744e63ba76a3b49e2 Implements: blueprint osa-install-guide-overhaul
This commit is contained in:
daz
parent
9db4a6410c
commit
bdb856c8fe
@ -103,7 +103,7 @@ Deploying LBaaS v2
|
||||
# openstack-ansible os-neutron-install.yml
|
||||
# openstack-ansible os-horizon-install.yml
|
||||
|
||||
.. _lbaas-special-notes
|
||||
.. _lbaas-special-notes:
|
||||
|
||||
Special notes about LBaaS
|
||||
-------------------------
|
||||
|
||||
@ -10,12 +10,13 @@ Contents:
|
||||
:maxdepth: 2
|
||||
|
||||
quickstart-aio
|
||||
installation-hosts-limited-connectivity
|
||||
scripts
|
||||
playbooks
|
||||
extending
|
||||
ops
|
||||
contribute
|
||||
core-reviewers
|
||||
additional-roles
|
||||
inventory
|
||||
deploy-config
|
||||
|
||||
|
||||
@ -1,11 +1,6 @@
|
||||
`Home <index.html>`__ OpenStack-Ansible Installation Guide
|
||||
|
||||
===========================================================
|
||||
Appendix G. Installation on hosts with limited connectivity
|
||||
===========================================================
|
||||
|
||||
Introduction
|
||||
~~~~~~~~~~~~
|
||||
===============================================
|
||||
Installation on hosts with limited connectivity
|
||||
===============================================
|
||||
|
||||
Many playbooks and roles in OpenStack-Ansible retrieve dependencies from the
|
||||
public Internet by default. Many deployers block direct outbound connectivity
|
||||
@ -1,8 +1,6 @@
|
||||
`Home <index.html>`__ OpenStack-Ansible Installation Guide
|
||||
|
||||
===========================
|
||||
Appendix D: Tips and tricks
|
||||
===========================
|
||||
===============
|
||||
Tips and tricks
|
||||
===============
|
||||
|
||||
Ansible forks
|
||||
~~~~~~~~~~~~~
|
||||
@ -12,8 +10,8 @@ fork makes use of a Session. By default, Ansible sets the number of forks to
|
||||
5. However, you can increase the number of forks used in order to improve
|
||||
deployment performance in large environments.
|
||||
|
||||
Note that a number of forks larger than 10 will cause issues for any playbooks
|
||||
which make use of ``delegate_to`` or ``local_action`` in the tasks. It is
|
||||
Note that more than 10 forks will cause issues for any playbooks
|
||||
which use ``delegate_to`` or ``local_action`` in the tasks. It is
|
||||
recommended that the number of forks are not raised when executing against the
|
||||
Control Plane, as this is where delegation is most often used.
|
||||
|
||||
19
doc/source/developer-docs/ops.rst
Normal file
19
doc/source/developer-docs/ops.rst
Normal file
@ -0,0 +1,19 @@
|
||||
==========
|
||||
Operations
|
||||
==========
|
||||
|
||||
The following operations and troubleshooting information apply to
|
||||
installed environments.
|
||||
|
||||
.. toctree::
|
||||
|
||||
ops-addcomputehost.rst
|
||||
ops-galera.rst
|
||||
ops-logging.rst
|
||||
ops-tips.rst
|
||||
ops-troubleshooting.rst
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
.. include:: navigation.txt
|
||||
@ -1,7 +1,7 @@
|
||||
`Home <index.html>`_ OpenStack-Ansible Installation Guide
|
||||
|
||||
================================================
|
||||
Appendix H: Customizing host and service layouts
|
||||
Appendix E: Customizing host and service layouts
|
||||
================================================
|
||||
|
||||
Understanding the default layout
|
||||
|
||||
@ -1,10 +1,11 @@
|
||||
`Home <index.html>`__ OpenStack-Ansible Installation Guide
|
||||
|
||||
Appendix F. Using Nuage Neutron Plugin
|
||||
--------------------------------------
|
||||
======================================
|
||||
Appendix C. Using Nuage Neutron Plugin
|
||||
======================================
|
||||
|
||||
Introduction
|
||||
============
|
||||
~~~~~~~~~~~~
|
||||
|
||||
This document describes the steps required to deploy Nuage Networks VCS
|
||||
with OpenStack-Ansible (OSA). These steps include:
|
||||
@ -20,7 +21,7 @@ with OpenStack-Ansible (OSA). These steps include:
|
||||
- Execute the playbooks.
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
#. The deployment environment has been configured according to OSA
|
||||
best-practices. This includes cloning OSA software and bootstrapping
|
||||
@ -33,7 +34,7 @@ Prerequisites
|
||||
/opt/nuage-openstack-ansible
|
||||
|
||||
Configure Nuage Neutron Plugin
|
||||
==============================
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Configuring the Neutron plugin requires creating/editing of parameters
|
||||
in following two files:
|
||||
@ -122,7 +123,7 @@ Also modify the following parameters in this file as per your Nuage VCS environm
|
||||
- { name: "nuage_repo", link: "<Local PyPi Mirror URL>" }
|
||||
|
||||
Installation
|
||||
============
|
||||
~~~~~~~~~~~~
|
||||
|
||||
#. After multi-node OpenStack cluster is setup as detailed above; start
|
||||
the OpenStack deployment as listed in the OpenStack-Ansible Install guide by
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
`Home <index.html>`__ OpenStack-Ansible Installation Guide
|
||||
|
||||
=========================================
|
||||
Appendix E: Using PLUMgrid Neutron plugin
|
||||
Appendix D: Using PLUMgrid Neutron plugin
|
||||
=========================================
|
||||
|
||||
Installing source and host networking
|
||||
|
||||
@ -49,14 +49,6 @@ Installation
|
||||
install-openstack.rst
|
||||
|
||||
|
||||
Operations
|
||||
^^^^^^^^^^
|
||||
|
||||
.. toctree::
|
||||
|
||||
ops.rst
|
||||
|
||||
|
||||
Appendices
|
||||
^^^^^^^^^^
|
||||
|
||||
@ -64,8 +56,6 @@ Appendices
|
||||
|
||||
app-configfiles.rst
|
||||
app-resources.rst
|
||||
app-tips.rst
|
||||
app-plumgrid.rst
|
||||
app-nuage.rst
|
||||
app-no-internet-connectivity.rst
|
||||
app-custom-layouts.rst
|
||||
app-custom-layouts.rst
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
`Home <index.html>`_ OpenStack-Ansible Installation Guide
|
||||
|
||||
=====================
|
||||
Chapter 8. Operations
|
||||
=====================
|
||||
|
||||
The following operations and troubleshooting procedures apply to
|
||||
installed environments.
|
||||
|
||||
.. toctree::
|
||||
|
||||
ops-addcomputehost.rst
|
||||
ops-galera.rst
|
||||
ops-logging.rst
|
||||
ops-troubleshooting.rst
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
.. include:: navigation.txt
|
||||
@ -1,132 +0,0 @@
|
||||
.. _minor-upgrades:
|
||||
|
||||
==============
|
||||
Minor upgrades
|
||||
==============
|
||||
|
||||
.. note:: To avoid issues and simplify troubleshooting during an upgrade,
|
||||
first disable the security hardening role by setting your
|
||||
variable ``apply_security_hardening`` to ``False`` in the
|
||||
:file:`user_variables.yml` file.
|
||||
|
||||
A minor upgrade typically requires the following steps:
|
||||
|
||||
#. Change directory into the repository clone root directory:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# cd /opt/openstack-ansible
|
||||
|
||||
#. Ensure your OpenStack-Ansible code is on the latest Newton release tag (14.x.x):
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# git checkout stable/newton
|
||||
# LATEST_TAG=$(git describe --abbrev=0 --tags)
|
||||
# git checkout ${LATEST_TAG}
|
||||
|
||||
#. Update all the dependent roles to the latest version:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# ./scripts/bootstrap-ansible.sh
|
||||
|
||||
#. Change into the playbooks directory:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# cd playbooks
|
||||
|
||||
#. Update the hosts:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# openstack-ansible setup-hosts.yml
|
||||
|
||||
#. Update the infrastructure:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# openstack-ansible -e rabbitmq_upgrade=true \
|
||||
setup-infrastructure.yml
|
||||
|
||||
#. Update all OpenStack services:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# openstack-ansible setup-openstack.yml
|
||||
|
||||
.. note::
|
||||
|
||||
Scope upgrades to specific OpenStack components by
|
||||
executing each of the component playbooks using groups.
|
||||
|
||||
For example:
|
||||
|
||||
#. Update only the Compute hosts:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# openstack-ansible os-nova-install.yml --limit nova_compute
|
||||
|
||||
#. Update only a single Compute host:
|
||||
|
||||
.. note::
|
||||
|
||||
Skipping the ``nova-key`` tag is necessary as the keys on
|
||||
all Compute hosts will not be gathered.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# openstack-ansible os-nova-install.yml --limit <node-name> \
|
||||
--skip-tags 'nova-key'
|
||||
|
||||
To see which hosts belong to which groups, the
|
||||
``inventory-manage.py`` script shows all groups and their hosts.
|
||||
For example:
|
||||
|
||||
#. Change directory into the repository clone root directory:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# cd /opt/openstack-ansible
|
||||
|
||||
#. Show all groups and which hosts belong to them:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# ./scripts/inventory-manage.py -G
|
||||
|
||||
#. Show all hosts and which groups they belong:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# ./scripts/inventory-manage.py -g
|
||||
|
||||
To see which hosts a playbook will execute against, and to see which
|
||||
tasks will execute.
|
||||
|
||||
#. Change directory into the repository clone playbooks directory:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# cd /opt/openstack-ansible/playbooks
|
||||
|
||||
#. See the hosts in the ``nova_compute`` group which a playbook executes against:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# openstack-ansible os-nova-install.yml --limit nova_compute \
|
||||
--list-hosts
|
||||
|
||||
#. See the tasks which will be executed on hosts in the ``nova_compute`` group:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# openstack-ansible os-nova-install.yml --limit nova_compute \
|
||||
--skip-tags 'nova-key' \
|
||||
--list-tasks
|
||||
|
||||
--------------
|
||||
|
||||
.. include:: navigation.txt
|
||||
Loading…
Reference in New Issue
Block a user