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 2018 Amdocs, Bell Canada
   5
   6 .. Links
   7 .. _Microsoft Azure: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Microsoft+Azure
   8 .. _Amazon AWS: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Amazon+EC2
   9 .. _Google GCE: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Google+Compute+Engine
  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/ONAP+on+Kubernetes+on+Rancher
  13 .. _Setting Up Kubernetes with Kubeadm: https://wiki.onap.org/display/DW/Deploying+Kubernetes+Cluster+with+kubeadm
  14 .. _Setting Up Kubernetes with Cloudify: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes+on+Cloudify
  15 .. _ONAP on Kubernetes Wiki: https://wiki.onap.org/display/DW/ONAP+on+Kubernetes
  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/master  1.8.10      2.8.2  1.8.10   17.03.x
  53   ==============  ==========  =====  =======  ========
  54
  55 Minimum Hardware Configuration
  56 ==============================
  57
  58 The minimum hardware requirements are provided below.  Note that although ONAP
  59 may operate on a single node as described production deployments will need at
  60 least three if not six nodes to ensure there is no single point of failure.
  61
  62 .. table:: OOM Hardware Requirements
  63
  64   =====  =====  ======  ====================
  65   RAM    HD     vCores  Ports
  66   =====  =====  ======  ====================
  67   128GB  160GB  32      0.0.0.0/0 (all open)
  68   =====  =====  ======  ====================
  69
  70 .. note::
  71   Kubernetes supports a maximum of 110 pods per node which forces one to use at
  72   least two nodes to deploy all of ONAP although at least three are recommended
  73   (for example 4x32GB - 8 vCores each). Subsets of ONAP may still be deployed
  74   on a single node.
  75
  76 Cloud Installation
  77 ==================
  78
  79 .. #. OOM supports deployment on major public clouds. The following guides
  80 ..    provide instructions on how to deploy ONAP on these clouds:
  81 ..
  82 ..    - `Microsoft Azure`_,
  83 ..    - `Amazon AWS`_,
  84 ..    - `Google GCE`_,
  85 ..    - `VMware VIO`_,
  86 ..    - IBM, and
  87 ..    - `Openstack`_.
  88 ..
  89 .. #. Alternatively, OOM can be deployed on a private set of physical hosts or VMs
  90 ..    (or even a combination of the two). The following guides describe how to
  91 ..    create a Kubernetes cluster with popular tools:
  92 ..
  93 ..    - `Setting up Kubernetes with Rancher`_ (recommended)
  94 ..    - `Setting up Kubernetes with Kubeadm`_
  95 ..    - `Setting up Kubernetes with Cloudify`_
  96
  97 OOM can be deployed on a private set of physical hosts or VMs (or even a
  98 combination of the two). The following guide describe the recommended method to
  99 setup a Kubernetes cluster: :ref:`onap-on-kubernetes-with-rancher`.
 100
 101 There are alternative deployment methods described on the `ONAP on Kubernetes Wiki`_