diff --git a/doc/source/install/deploy.rst b/doc/source/install/deploy.rst new file mode 100644 index 0000000..2733c4c --- /dev/null +++ b/doc/source/install/deploy.rst @@ -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]' diff --git a/doc/source/install/getting-started.rst b/doc/source/install/getting-started.rst index 3c528ed..711ccf9 100644 --- a/doc/source/install/getting-started.rst +++ b/doc/source/install/getting-started.rst @@ -9,7 +9,8 @@ Learn about Chef OpenStack consult the `online documentation `_ or `Learn Chef `_. * `Supported Platforms `_ -* `Deploy `_ on your own development OpenStack Cloud with `Test Kitchen `_. +* `Create `_ on your own development OpenStack Cloud with `Test Kitchen `_. +* `Deploy `_ on your own physical or virtual machines. * Chef OpenStack `genealogy `_. .. toctree:: diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 5460109..4964f89 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -7,5 +7,6 @@ Install Guide getting-started quickstart + deploy genealogy supported-platforms diff --git a/doc/source/install/quickstart.rst b/doc/source/install/quickstart.rst index c42becb..e1d947e 100644 --- a/doc/source/install/quickstart.rst +++ b/doc/source/install/quickstart.rst @@ -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]