openstack/openstack-ansible
Code Issues Proposed changes

[docs] Minor edits to the overview chapter

Browse Source 
Copy-edits

Change-Id: I9aa3ecb6c6b74aa51b3fd7d5a99a66eceaf510d8
Implements: blueprint osa-install-guide-overhaul
This commit is contained in:
daz 2016-09-05 16:17:58 +10:00
parent bb3ddb31c7
commit 0ba4f8b71c
3 changed files with 44 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/install-guide/overview-osa.rst
View File

@ -8,7 +8,8 @@ For isolation and ease of maintenance, you can install OpenStack components
into Linux containers (LXC).
This documentation is intended for deployers, and walks through an
OpenStack-Ansible installation for a test and production environments.
OpenStack-Ansible installation for a test environment and production
environment.
Ansible
~~~~~~~
@ -23,9 +24,9 @@ Playbooks <http://docs.ansible.com/playbooks_intro.html>`_.
In this guide, we refer to two types of hosts:
* The host running Ansible playbooks is the `deployment host`.
* The hosts where Ansible installs OpenStack services and infrastructure
components are the `target host`.
* `Deployment host` - The host running Ansible playbooks.
* `Target hosts` - The hosts where Ansible installs OpenStack services and
infrastructure components.
Linux containers (LXC)
~~~~~~~~~~~~~~~~~~~~~~

75
doc/source/install-guide/overview-requirements.rst
View File

@ -1,14 +1,39 @@
=========================
Installation requirements
=========================
=============================================
Installation requirements and recommendations
=============================================
.. note::
This section describes software requirements, hardware recommendations, and
network recommendations for running OpenStack in a production environment.
These are the minimum requirements for OpenStack-Ansible. Larger
deployments require additional resources.
Software requirements
~~~~~~~~~~~~~~~~~~~~~
CPU requirements
~~~~~~~~~~~~~~~~
Ensure all hosts within an OpenStack-Ansible environment meet the following
minimum requirements:
* Ubuntu 16.04 LTS (Xenial Xerus)/Ubuntu 14.04 LTS (Trusty Tahr)
* OSA is tested regularly against the latest Ubuntu 16.04 LTS Xenial
point releases and Ubuntu 14.04 Trusty as well.
* Linux kernel version ``3.13.0-34-generic`` or later.
* For Trusty hosts, you must enable the ``trusty-backports`` or
repositories in ``/etc/apt/sources.list`` or
``/etc/apt/sources.list.d/``. For detailed instructions, see
`Ubuntu documentation <https://help.ubuntu.com/community/
UbuntuBackports#Enabling_Backports_Manually>`_.
* Secure Shell (SSH) client and server that supports public key
authentication
* Network Time Protocol (NTP) client for time synchronization (such as
``ntpd`` or ``chronyd``)
* Python 2.7.x must be on the hosts.
* en_US.UTF-8 as locale
CPU recommendations
~~~~~~~~~~~~~~~~~~~
* Compute hosts with multi-core processors that have `hardware-assisted
virtualization extensions`_ available. These extensions provide a
@ -22,8 +47,8 @@ CPU requirements
.. _hardware-assisted virtualization extensions: https://en.wikipedia.org/wiki/Hardware-assisted_virtualization
.. _Hyper-threading: https://en.wikipedia.org/wiki/Hyper-threading
Disk requirements
~~~~~~~~~~~~~~~~~
Disk recommendations
~~~~~~~~~~~~~~~~~~~~
Different hosts have different disk space requirements based on the
services running on each host:
@ -72,8 +97,8 @@ into logical volumes by creating a volume group called ``lxc``.
OpenStack-Ansible creates a 5GB logical volume for the filesystem of each
container running on the host.
Network requirements
~~~~~~~~~~~~~~~~~~~~
Network recommendations
~~~~~~~~~~~~~~~~~~~~~~~
.. note::
@ -97,29 +122,3 @@ the following features:
* Jumbo frames: Increases network performance by allowing more data to be sent
in each packet.
Software requirements
~~~~~~~~~~~~~~~~~~~~~
Ensure all hosts within an OpenStack-Ansible environment meet the following
minimum requirements:
* Ubuntu 16.04 LTS (Xenial Xerus)/Ubuntu 14.04 LTS (Trusty Tahr)
* OSA is tested regularly against the latest Ubuntu 16.04 LTS Xenial
point releases and Ubuntu 14.04 Trusty as well.
* Linux kernel version ``3.13.0-34-generic`` or later.
* For Trusty hosts, you must enable the ``trusty-backports`` or
repositories in ``/etc/apt/sources.list`` or
``/etc/apt/sources.list.d/``
See the `Ubuntu documentation
<https://help.ubuntu.com/community/UbuntuBackports#Enabling_Backports_Manually>`_ for more detailed instructions.
* Secure Shell (SSH) client and server that supports public key
authentication
* Network Time Protocol (NTP) client for time synchronization (such as
``ntpd`` or ``chronyd``)
* Python 2.7.x must be on the hosts.
* en_US.UTF-8 as locale

2
doc/source/install-guide/targethosts-prepare.rst
View File

@ -79,6 +79,8 @@ practices, refer to `GitHub's documentation on generating SSH keys`_.
``lxc_container_ssh_key`` variable to the public key for
the container.
.. _configuring-storage:
Configuring storage
~~~~~~~~~~~~~~~~~~~