docs/oom_cloud_setup_guide.rst

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