From ecbc80c0a0b0576aa0543ef8a9ebd0955729fcfa Mon Sep 17 00:00:00 2001 From: Hiromu Asahina Date: Wed, 21 Jul 2021 00:18:41 +0900 Subject: [PATCH] Add hardware requirements The current `Install via Devstack` page doesn't have a hardware requirement which may cause installation failure or poor performance. Added a table that shows hardware requirements. Also, the current document mentioned `ussuri` in sentences, but it's too old. Updated the version referred in sentences from `ussuri` to the latest release `wallaby`. Change-Id: Ifd916c96e8f90d7abb411d3eb0669e8ac3b0cf84 Signed-off-by: Hiromu Asahina --- doc/source/install/devstack.rst | 37 ++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/doc/source/install/devstack.rst b/doc/source/install/devstack.rst index 5eb264105..a68eced0d 100644 --- a/doc/source/install/devstack.rst +++ b/doc/source/install/devstack.rst @@ -36,13 +36,43 @@ specifying branch name in your ``local.conf``. * For latest version installation, use ``master`` branch. * For specific release based installation, use corresponding branch name. - For ex, to install ``ussuri`` release, use ``stable/ussuri``. + For ex, to install ``wallaby`` release, use ``stable/wallaby``. For installation, ``stack.sh`` script in Devstack should be run as a non-root user with sudo enabled. Add a separate user ``stack`` and granting relevant privileges is a good way to install via Devstack [#f0]_. +Hardware Requirements +~~~~~~~~~~~~~~~~~~~~~ + +We recommend that your system meets the following hardware requirements: + +.. note:: + + These are reference values to install ``Openstack and Kubernetes as VIM`` + which generally requires the most resources. In reality, more parameters + affect required resources. + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Criteria + - Recommended + * - CPU + - 4 cores or more + * - RAM + - 16 GB or more + * - Storage + - 80 GB or more + +.. note:: + + We recommend that you run DevStack in a VM, rather than on your bare-metal + server. If you have to run devstack on a bare-metal server, It is recommended + to use a server that has at least two network interfaces [#f1]_. + Install ------- @@ -64,7 +94,7 @@ So the first step of installing tacker is to clone Devstack and prepare your #. Enable tacker related Devstack plugins in ``local.conf`` file The ``local.conf`` can be created manually, or copied from Tacker - repo [#f1]_. If copied, rename it as ``local.conf``. + repo [#f2]_. If copied, rename it as ``local.conf``. We have two choices for configuration basically: @@ -132,4 +162,5 @@ So the first step of installing tacker is to clone Devstack and prepare your .. rubric:: Footnotes .. [#f0] https://docs.openstack.org/devstack/latest/ -.. [#f1] https://opendev.org/openstack/tacker/src/branch/master/devstack +.. [#f1] https://docs.openstack.org/devstack/latest/networking.html +.. [#f2] https://opendev.org/openstack/tacker/src/branch/master/devstack