Merge "Add deploy documentation"

This commit is contained in:
Zuul 2018-09-12 08:48:01 +00:00 committed by Gerrit Code Review
commit 01a972c836
4 changed files with 34 additions and 6 deletions

View File

@ -0,0 +1,26 @@
.. _deploy:
===============================
Deploy Chef OpenStack cookbooks
===============================
Deploy Chef OpenStack cookbooks, using Chef, and test the setup using
Tempest.
* Software requirements:
* Ubuntu 18.04 LTS or CentOS 7 fresh install
* `git` installed
* `chef-client` installed: https://docs.chef.io/#setup
* Hardware requirements:
* At least 4GB of memory. 8GB or more is recommended.
* At least 10GB of storage.
.. code-block:: bash
$ git clone https://git.openstack.org/openstack/openstack-chef
$ cd openstack-chef
# mkdir -p /etc/chef && cp .chef/encrypted_data_bag_secret /etc/chef/openstack_data_bag_secret
# chef-client -z -E allinone -r 'role[allinone]'

View File

@ -9,7 +9,8 @@ Learn about Chef OpenStack
consult the `online documentation <https://docs.chef.io>`_ or
`Learn Chef <https://learn.chef.io>`_.
* `Supported Platforms <supported-platforms.html>`_
* `Deploy <quickstart.html>`_ on your own development OpenStack Cloud with `Test Kitchen <https://kitchen.ci>`_.
* `Create <quickstart.html>`_ on your own development OpenStack Cloud with `Test Kitchen <https://kitchen.ci>`_.
* `Deploy <deploy.html>`_ on your own physical or virtual machines.
* Chef OpenStack `genealogy <genealogy.html>`_.
.. toctree::

View File

@ -7,5 +7,6 @@ Install Guide
getting-started
quickstart
deploy
genealogy
supported-platforms

View File

@ -31,8 +31,8 @@ For production workloads, multiple nodes for specific roles are recommended.
.. _hardware-assisted virtualization: https://en.wikipedia.org/wiki/Hardware-assisted_virtualization
Building with Test Kitchen
--------------------------
Testing with Kitchen
--------------------
There are three basic steps to building OpenStack with Test Kitchen, with an optional first step should you need to customize your build:
@ -64,7 +64,7 @@ Start by cloing the OpenStack chef-repo repository and changing into the root di
# git clone https://git.openstack.org/openstack/openstack-chef \
/opt/openstack-chef
# cd openstack-chef
# cd /opt/openstack-chef
Next, switch to the applicable branch/tag to be deployed. Note that deploying
from the head of a branch may result in an unstable build due to changes in
@ -93,10 +93,10 @@ use of different services or test new cookbooks.
To use a different driver for Test Kitchen, such as for a multi-node
development environment, pass the ``KITCHEN_YAML`` environment variable as an
additional option to the ``kitchen`` command. For example, if you want to
deploy a containerized development environment, instead of an AIO, then execute:
deploy a containerized development environment, instead of a Vagrant AIO, then execute:
.. code-block:: shell-session
# KITCHEN_YAML=.kitchen.dokken.yml kitchen verify [7|1804|all]
# KITCHEN_YAML=.kitchen.dokken.yml kitchen verify [centos|ubuntu|all]