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