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
  16 .. figure:: oomLogoV2-medium.png
  17    :align: right
  18
  19 .. _cloud-setup-guide-label:
  20
  21 OOM Cloud Setup Guide
  22 #####################
  23
  24 OOM deploys and manages ONAP on a pre-established Kubernetes_ cluster - the
  25 creation of this cluster is outside of the scope of the OOM project as there
  26 are many options including public clouds with pre-established environments.
  27 However, this guide includes instructions for how to create and use some of the
  28 more popular environments which could be used to host ONAP. If creation of a
  29 Kubernetes cluster is required, the life-cycle of this cluster is independent
  30 of the life-cycle of the ONAP components themselves. Much like an OpenStack
  31 environment, the Kubernetes environment may be used for an extended period of
  32 time, possibly spanning multiple ONAP releases.
  33
  34 .. note::
  35   Inclusion of a cloud technology or provider in this guide does not imply an
  36   endorsement.
  37
  38 .. _Kubernetes: https://kubernetes.io/
  39
  40 Software Requirements
  41 =====================
  42
  43 The versions of Kubernetes that are supported by OOM are as follows:
  44
  45 .. table:: OOM Software Requirements
  46
  47   ==============  ==========  =====  =======  ========
  48   Release         Kubernetes  Helm   kubectl  Docker
  49   ==============  ==========  =====  =======  ========
  50   amsterdam       1.7.x       2.3.x  1.7.x    1.12.x
  51   beijing/master  1.8.10      2.8.2  1.8.10   17.03.x
  52   ==============  ==========  =====  =======  ========
  53
  54 Minimum Hardware Configuration
  55 ==============================
  56
  57 The minimum hardware requirements are provided below.  Note that although ONAP
  58 may operate on a single node as described production deployments will need at
  59 least three if not six nodes to ensure there is no single point of failure.
  60
  61 .. table:: OOM Hardware Requirements
  62
  63   =====  =====  ======  ====================
  64   RAM    HD     vCores  Ports
  65   =====  =====  ======  ====================
  66   128GB  160GB  16      0.0.0.0/0 (all open)
  67   =====  =====  ======  ====================
  68
  69 Cloud Installation
  70 ==================
  71
  72 #. OOM supports deployment on major public clouds. The following guides
  73    provide instructions on how to deploy ONAP on these clouds:
  74
  75    - `Microsoft Azure`_,
  76    - `Amazon AWS`_,
  77    - `Google GCE`_,
  78    - `VMware VIO`_,
  79    - IBM, and
  80    - `Openstack`_.
  81
  82 #. Alternatively, OOM can be deployed on a private set of physical hosts or VMs
  83    (or even a combination of the two). The following guides describe how to
  84    create a Kubernetes cluster with popular tools:
  85
  86    - `Setting up Kubernetes with Rancher`_ (recommended)
  87    - `Setting up Kubernetes with Kubeadm`_
  88    - `Setting up Kubernetes with Cloudify`_