docs/onap-oom-heat.rst

   1 Integration Environment Installation
   2 -------------------------------------
   3
   4 ONAP is deployed on top of kubernetes through the OOM installer.
   5 Kubernetes can be installed on bare metal or on different environments such as
   6 OpenStack (private or public cloud), Azure, AWS,..
   7
   8 The integration team maintains a heat template to install ONAP on OpenStack.
   9 This template creates the needed resources (VMs, networks, security groups,
  10 ...) in order to support a HA Kubernetes then a full ONAP installation.
  11
  12 Sample OpenStack RC (credential) files environment files or deployment scripts
  13 are provided, they correspond to files used on windriver environment.
  14 This environment is used by the integration team to validate the installation,
  15 perform tests and troubleshoot.
  16
  17 If you intend to deploy your own environment, they can be used as reference but
  18 must be adapted according to your context.
  19
  20 Source files
  21 ~~~~~~~~~~~~
  22
  23 - HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-rke?h=frankfurt
  24 - Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/Integration-SB-00-openrc?h=frankfurt
  25 - Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env?h=frankfurt
  26 - Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-rke/scripts/deploy.sh?h=frankfurt
  27
  28
  29 Heat Template Description
  30 ~~~~~~~~~~~~~~~~~~~~~~~~~
  31
  32 The ONAP Integration Project provides a sample HEAT template that
  33 fully automates the deployment of ONAP using OOM as described in
  34 OOM documentation (https://docs.onap.org/en/frankfurt/guides/onap-developer/settingup/index.html#installing-onap).
  35
  36 The ONAP OOM HEAT template deploys the entire ONAP platform.  It spins
  37 up an HA-enabled Kubernetes cluster, and deploys ONAP using OOM onto
  38 this cluster.
  39
  40 - 1 Shared NFS server (called Rancher VM for legacy reasons)
  41 - 3 orch VMs for Kubernetes HA controller and etcd roles
  42 - 12 k8s VMs for Kubernetes HA worker roles
  43
  44 See OOM documentation for details.
  45
  46
  47 Quick Start
  48 ~~~~~~~~~~~
  49
  50 Using the Wind River lab configuration as an example, here is what
  51 you need to do to deploy ONAP:
  52
  53 ::
  54
  55    git clone https://git.onap.org/integration
  56    cd integration/deployment/heat/onap-rke/
  57    source ./env/windriver/Integration-SB-00-openrc
  58    ./scripts/deploy.sh ./env/windriver/onap-oom.env
  59
  60
  61 Environment and RC files
  62 ~~~~~~~~~~~~~~~~~~~~~~~~
  63
  64 Before deploying ONAP to your own environment, it is necessary to
  65 customize the environment and RC files.  You should make a copy of the
  66 sample RC and environment files shown above and customize the values
  67 for your specific OpenStack environments.
  68
  69 The environment file contains a block called integration_override_yaml.
  70
  71 The content of this block will be used by OOM to overwrite some parts of its
  72 installation parameters used in the helm charts.
  73
  74 This file may deal with:
  75
  76 * Cloud adaptation (use the defined flavors, available images)
  77 * Proxies (apt, docker,..)
  78 * Pre-defined resources for use cases (networks, tenant references)
  79 * performance tuning (initialization timers)
  80
  81 Performance tuning reflects the adaptation to the hardware at a given time.
  82 The lab may evolve and the timers shall follow.
  83
  84 Be sure to customize the necessary values within this block to match your
  85 OpenStack environment as well.
  86
  87 **Notes on select parameters**
  88
  89 ::
  90
  91    apt_proxy: 10.12.5.2:8000
  92    docker_proxy: 10.12.5.2:5000
  93
  94    rancher_vm_flavor: m1.large
  95    k8s_vm_flavor: m1.xlarge
  96    etcd_vm_flavor: m1.medium # not currently used
  97    orch_vm_flavor: m1.medium
  98
  99    key_name: onap_key
 100
 101    helm_deploy_delay: 2.5m
 102
 103 It is recommended that you set up an apt proxy and a docker proxy
 104 local to your lab.  If you do not wish to use such proxies, you can
 105 set the apt_proxy and docker_proxy parameters to the empty string "".
 106
 107 rancher_vm_flavor needs to have 8 GB of RAM.
 108 k8s_vm_flavor needs to have at least 16 GB of RAM.
 109 orch_vm_flavor needs to have 4 GB of RAM.
 110 By default the template assumes that you have already imported a
 111 keypair named "onap_key" into your OpenStack environment.  If the
 112 desired keypair has a different name, change the key_name parameter.
 113
 114 The helm_deploy_delay parameter introduces a delay in-between the
 115 deployments of each ONAP helm subchart to help alleviate system load or
 116 contention issues caused by trying to spin up too many pods
 117 simultaneously.  The value of this parameter is passed to the Linux
 118 "sleep" command.  Adjust this parameter based on the performance and
 119 load characteristics of your OpenStack environment.
 120
 121
 122 Exploring the Rancher VM
 123 ~~~~~~~~~~~~~~~~~~~~~~~~
 124
 125 The Rancher VM that is spun up by this HEAT template serves the
 126 following key roles:
 127 - Hosts the /dockerdata-nfs/ NFS export shared by all the k8s VMs for persistent volumes
 128 - git clones the oom repo into /root/oom
 129 - git clones the integration repo into /root/integration
 130 - Creates the helm override file at /root/integration-override.yaml
 131 - Deploys ONAP using helm and OOM