X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_cloud_setup_guide.rst;h=4fe943cf1832cc3376bb8dc8bd5f083f5d3dbeaf;hb=e343acfd09a8f96200eeeb79dacfe36a5445063e;hp=9cccc91431af0d4e9856d268ad612c191b3b679a;hpb=114736eb5119b023bc5f166a3b42aaf933b0b223;p=oom.git diff --git a/docs/oom_cloud_setup_guide.rst b/docs/oom_cloud_setup_guide.rst index 9cccc91431..4fe943cf18 100644 --- a/docs/oom_cloud_setup_guide.rst +++ b/docs/oom_cloud_setup_guide.rst @@ -1,7 +1,19 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. .. 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 +.. _ONAP on Kubernetes Wiki: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes + .. figure:: oomLogoV2-medium.png :align: right @@ -21,44 +33,70 @@ 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 - ============== ========== ===== ======= ======== - Release Kubernetes Helm kubectl Docker - ============== ========== ===== ======= ======== - amsterdam 1.7.x 2.3.x 1.7.x 1.12.x - beijing/master 1.8.5 2.7.x 1.8.5 1.12.x - ============== ========== ===== ======= ======== + ============== ========== ===== ======= ======== + Release Kubernetes Helm kubectl Docker + ============== ========== ===== ======= ======== + amsterdam 1.7.x 2.3.x 1.7.x 1.12.x + beijing 1.8.10 2.8.2 1.8.10 17.03.x + casablanca/master 1.8.10 2.9.1 1.8.10 17.03.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. -Cloud Installation -================== - -#. OOM supports deployment on major public clouds. The following guides - provide instructions on how to deploy ONAP on these clouds: +.. table:: OOM Hardware Requirements - - Microsoft Azure, - - Amazon AWS, - - Google GCD, - - VMware VIO, - - IBM, and - - Openstack + ===== ===== ====== ==================== + RAM HD vCores Ports + ===== ===== ====== ==================== + 128GB 160GB 32 0.0.0.0/0 (all open) + ===== ===== ====== ==================== -#. 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: +.. note:: + Kubernetes supports a maximum of 110 pods per node which forces one to use at + least two nodes to deploy all of ONAP although at least three are recommended + (for example 4x32GB - 8 vCores each). Subsets of ONAP may still be deployed + on a single node. - - Setting up Kubernetes with Rancher (recommended) - - Setting up Kubernetes with Kubeadm - - Setting up Kubernetes with Cloudify +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 GCE`_, +.. - `VMware VIO`_, +.. - IBM, and +.. - `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`_ + +OOM can be deployed on a private set of physical hosts or VMs (or even a +combination of the two). The following guide describe the recommended method to +setup a Kubernetes cluster: :ref:`onap-on-kubernetes-with-rancher`. + +There are alternative deployment methods described on the `ONAP on Kubernetes Wiki`_