docs/onap-oom-heat.rst

   1 ONAP OOM HEAT Template
   2 ------------------
   3
   4 Source files
   5 ~~~~~~~~~~~~
   6
   7 - HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-oom?h=casablanca
   8 - Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-oom/env/windriver/Integration-SB-00-openrc?h=casablanca
   9 - Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-oom/env/windriver/onap-oom.env?h=casablanca
  10 - Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-oom/scripts/deploy.sh?h=casablanca
  11
  12 Description
  13 ~~~~~~~~~~~
  14
  15 The ONAP Integration Project provides a sample HEAT template that
  16 fully automates the deployment of ONAP using OOM as described in
  17 :ref:`ONAP Operations Manager (OOM) over Kubernetes`.
  18
  19 The ONAP OOM HEAT template deploys up the entire ONAP platform.  It
  20 spins up an HA-enabled Kubernetes cluster, and deploys ONAP using OOM
  21 onto this cluster.
  22 - 1 Rancher VM that also serves as a shared NFS server
  23 - 3 etcd VMs for the Kubernetes HA etcd plane
  24 - 2 orch VMs for the Kubernetes HA orchestration plane
  25 - 12 k8s VMs for the Kubernetes HA compute hosts
  26
  27
  28 Quick Start
  29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  30
  31 Using the Wind River lab configuration as an example, here is what
  32 you need to do to deploy ONAP:
  33
  34 ::
  35
  36  git clone https://git.onap.org/integration
  37  cd integration/deployment/heat/onap-oom/
  38  source ./env/windriver/Integration-SB-00-openrc
  39  ./scripts/deploy.sh ./env/windriver/onap-oom.env
  40
  41
  42 Environment and RC files
  43 ~~~~~~~~~~~~~~~~~~~~~~~~
  44
  45 Before deploying ONAP to your own environment, it is necessary to
  46 customize the environment and RC files.  You should make a copy of the
  47 sample RC and environment files shown above and customize the values
  48 for your specific OpenStack environments.
  49
  50 The environment file contains a block called
  51 integration_override_yaml.  The content of this block will be created
  52 as the file integration_override.yaml in the deployed Rancher VM, and
  53 used as the helm override files during the OOM deployment.  Be sure to
  54 customize the necessary values within this block to match your
  55 OpenStack environment as well.
  56
  57 **Notes on select parameters**
  58
  59 ::
  60  apt_proxy: 10.12.5.2:8000
  61  docker_proxy: 10.12.5.2:5000
  62
  63  rancher_vm_flavor: m1.large
  64  k8s_vm_flavor: m1.xlarge
  65  etcd_vm_flavor: m1.medium
  66  orch_vm_flavor: m1.medium
  67
  68  key_name: onap_key
  69
  70  helm_deploy_delay: 2.5m
  71
  72 It is recommended that you set up an apt proxy and a docker proxy
  73 local to your lab.  If you do not wish to use such proxies, you can
  74 set the apt_proxy and docker_proxy parameters to the empty string "".
  75
  76 rancher_vm_flavor needs to have 8 GB of RAM.
  77 k8s_vm_flavor needs to have 16 GB of RAM.
  78 etcd_vm_flavor needs to have 4 GB of RAM.
  79 orch_vm_flavor needs to have 4 GB of RAM.
  80
  81 By default the template assumes that you have already imported a
  82 keypair named "onap_key" into your OpenStack environment.  If the
  83 desired keypair has a different name, change the key_name parameter.
  84
  85 The helm_deploy_delay parameter introduces a delay in-between the
  86 deployment of each ONAP helm subchart to help alleviate system load or
  87 contention issues caused by trying to spin up too many pods
  88 simultaneously.  The value of this parameter is passed to the Linux
  89 "sleep" command.  Adjust this parameter based on the performance and
  90 load characteristics of your OpenStack environment.
  91