docs/oom_cloud_setup_guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright 2019 Amdocs, Bell Canada
   5
   6 .. Links
   7 .. _Microsoft Azure: https://wiki.onap.org/display/DW/Cloud+Native+Deployment#CloudNativeDeployment-MicrosoftAzure
   8 .. _Amazon AWS: https://wiki.onap.org/display/DW/Cloud+Native+Deployment#CloudNativeDeployment-AmazonAWS
   9 .. _Google GCE: https://wiki.onap.org/display/DW/Cloud+Native+Deployment#CloudNativeDeployment-GoogleGCE
  10 .. _VMware VIO: https://wiki.onap.org/display/DW/ONAP+on+VMware+Integrated+OpenStack+-+Container+Orchestration
  11 .. _OpenStack: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+OpenStack?src=contextnavpagetreemode
  12 .. _Setting Up Kubernetes with Rancher: https://wiki.onap.org/display/DW/Cloud+Native+Deployment
  13 .. _Setting Up Kubernetes with Kubeadm: https://wiki.onap.org/display/DW/Deploying+Kubernetes+Cluster+with+kubeadm
  14 .. _Cloud Native Deployment Wiki: https://wiki.onap.org/display/DW/Cloud+Native+Deployment
  15 .. _ONAP Development - 110 pod limit Wiki: https://wiki.onap.org/display/DW/ONAP+Development#ONAPDevelopment-Changemax-podsfromdefault110podlimit
  16
  17 .. figure:: oomLogoV2-medium.png
  18    :align: right
  19
  20 .. _cloud-setup-guide-label:
  21
  22 OOM Cloud Setup Guide
  23 #####################
  24
  25 OOM deploys and manages ONAP on a pre-established Kubernetes_ cluster - the
  26 creation of this cluster is outside of the scope of the OOM project as there
  27 are many options including public clouds with pre-established environments.
  28 However, this guide includes instructions for how to create and use some of the
  29 more popular environments which could be used to host ONAP. If creation of a
  30 Kubernetes cluster is required, the life-cycle of this cluster is independent
  31 of the life-cycle of the ONAP components themselves. Much like an OpenStack
  32 environment, the Kubernetes environment may be used for an extended period of
  33 time, possibly spanning multiple ONAP releases.
  34
  35 .. note::
  36   Inclusion of a cloud technology or provider in this guide does not imply an
  37   endorsement.
  38
  39 .. _Kubernetes: https://kubernetes.io/
  40
  41 Software Requirements
  42 =====================
  43
  44 The versions of Kubernetes that are supported by OOM are as follows:
  45
  46 .. table:: OOM Software Requirements
  47
  48   ==============     ===========  =====  ========  ========
  49   Release            Kubernetes   Helm   kubectl   Docker
  50   ==============     ===========  =====  ========  ========
  51   amsterdam          1.7.x        2.3.x  1.7.x     1.12.x
  52   beijing            1.8.10       2.8.2  1.8.10    17.03.x
  53   casablanca         1.11.5       2.9.1  1.11.5    17.03.x
  54   ==============     ===========  =====  ========  ========
  55
  56 Minimum Hardware Configuration
  57 ==============================
  58
  59 The hardware requirements are provided below. Note that this is for a
  60 full ONAP deployment (all components). Customizing ONAP to deploy only
  61 components that are needed will drastically reduce the requirements.
  62
  63 .. table:: OOM Hardware Requirements
  64
  65   =====  =====  ======  ====================
  66   RAM    HD     vCores  Ports
  67   =====  =====  ======  ====================
  68   224GB  160GB  112     0.0.0.0/0 (all open)
  69   =====  =====  ======  ====================
  70
  71 .. note::
  72   Kubernetes supports a maximum of 110 pods per node - configurable in the --max-pods=n setting off the
  73   "additional kubelet flags" box in the kubernetes template window described in 'ONAP Development - 110 pod limit Wiki'
  74   - this limit does not need to be modified . The use of many small
  75   nodes is preferred over a few larger nodes (for example 14x16GB - 8 vCores each).
  76   Subsets of ONAP may still be deployed on a single node.
  77
  78 Cloud Installation
  79 ==================
  80
  81 .. #. OOM supports deployment on major public clouds. The following guides
  82 ..    provide instructions on how to deploy ONAP on these clouds:
  83 ..
  84 ..    - `Microsoft Azure`_,
  85 ..    - `Amazon AWS`_,
  86 ..    - `Google GCE`_,
  87 ..    - `VMware VIO`_,
  88 ..    - IBM, and
  89 ..    - `Openstack`_.
  90 ..
  91 .. #. Alternatively, OOM can be deployed on a private set of physical hosts or VMs
  92 ..    (or even a combination of the two). The following guides describe how to
  93 ..    create a Kubernetes cluster with popular tools:
  94 ..
  95 ..    - `Setting up Kubernetes with Rancher`_ (recommended)
  96 ..    - `Setting up Kubernetes with Kubeadm`_
  97 ..    - `Setting up Kubernetes with Cloudify`_
  98
  99 OOM can be deployed on a private set of physical hosts or VMs (or even a
 100 combination of the two). The following guide describe the recommended method to
 101 setup a Kubernetes cluster: :ref:`onap-on-kubernetes-with-rancher`.
 102
 103 There are alternative deployment methods described on the `Cloud Native Deployment Wiki`_