summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/oom_cloud_setup_guide.rst49
-rw-r--r--docs/oom_quickstart_guide.rst2
2 files changed, 37 insertions, 14 deletions
diff --git a/docs/oom_cloud_setup_guide.rst b/docs/oom_cloud_setup_guide.rst
index 9cccc91431..3de125b965 100644
--- a/docs/oom_cloud_setup_guide.rst
+++ b/docs/oom_cloud_setup_guide.rst
@@ -2,6 +2,16 @@
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2018 Amdocs, Bell Canada
+.. Links
+.. _Microsoft Azure: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Microsoft+Azure
+.. _Amazon AWS: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Amazon+EC2
+.. _Google GCE: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Google+Compute+Engine
+.. _VMware VIO: https://wiki.onap.org/display/DW/ONAP+on+VMware+Integrated+OpenStack+-+Container+Orchestration
+.. _OpenStack: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+OpenStack?src=contextnavpagetreemode
+.. _Setting Up Kubernetes with Rancher: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Rancher
+.. _Setting Up Kubernetes with Kubeadm: https://wiki.onap.org/display/DW/Deploying+Kubernetes+Cluster+with+kubeadm
+.. _Setting Up Kubernetes with Cloudify: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Cloudify
+
.. figure:: oomLogoV2-medium.png
:align: right
@@ -21,11 +31,14 @@ environment, the Kubernetes environment may be used for an extended period of
time, possibly spanning multiple ONAP releases.
.. note::
- Inclusion of a cloud technology or provider in this guide does not imply any
- endorsement of this technology.
+ Inclusion of a cloud technology or provider in this guide does not imply an
+ endorsement.
.. _Kubernetes: https://kubernetes.io/
+Software Requirements
+=====================
+
The versions of Kubernetes that are supported by OOM are as follows:
.. table:: OOM Software Requirements
@@ -37,9 +50,20 @@ The versions of Kubernetes that are supported by OOM are as follows:
beijing/master 1.8.5 2.7.x 1.8.5 1.12.x
============== ========== ===== ======= ========
-Minimum Hardware Requirements
-=============================
+Minimum Hardware Configuration
+==============================
+
+The minimum hardware requirements are provided below. Note that although ONAP
+may operate on a single node as described production deployments will need at
+least three if not six nodes to ensure there is no single point of failure.
+.. table:: OOM Hardware Requirements
+
+ ===== ===== ====== ====================
+ RAM HD vCores Ports
+ ===== ===== ====== ====================
+ 128GB 160GB 16 0.0.0.0/0 (all open)
+ ===== ===== ====== ====================
Cloud Installation
==================
@@ -47,18 +71,17 @@ Cloud Installation
#. OOM supports deployment on major public clouds. The following guides
provide instructions on how to deploy ONAP on these clouds:
- - Microsoft Azure,
- - Amazon AWS,
- - Google GCD,
- - VMware VIO,
+ - `Microsoft Azure`_,
+ - `Amazon AWS`_,
+ - `Google GCE`_,
+ - `VMware VIO`_,
- IBM, and
- - Openstack
+ - `Openstack`_.
#. Alternatively, OOM can be deployed on a private set of physical hosts or VMs
(or even a combination of the two). The following guides describe how to
create a Kubernetes cluster with popular tools:
- - Setting up Kubernetes with Rancher (recommended)
- - Setting up Kubernetes with Kubeadm
- - Setting up Kubernetes with Cloudify
-
+ - `Setting up Kubernetes with Rancher`_ (recommended)
+ - `Setting up Kubernetes with Kubeadm`_
+ - `Setting up Kubernetes with Cloudify`_
diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index 879bbb923d..eb5d373721 100644
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -166,7 +166,7 @@ follows::
**Step 7.** Once the repo is setup, installation of ONAP can be done with a
single command::
- > helm install local/onap -name dev --namespace onap
+ > helm install local/onap -n dev --namespace onap
.. note::
The requirement for the use of the `onap` namespace will be lifted once the OOM team completes their Beijing deveivers.