docs/oom_quickstart_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 .. _quick-start-label:
   6
   7 OOM Quick Start Guide
   8 #####################
   9
  10 .. figure:: oomLogoV2-medium.png
  11    :align: right
  12
  13 Once a kubernetes environment is available (follow the instructions in
  14 :ref:`cloud-setup-guide-label` if you don't have a cloud environment
  15 available), follow the following instructions to deploy ONAP.
  16
  17 **Step 1.** Clone the OOM repository from ONAP gerrit::
  18
  19   > git clone http://gerrit.onap.org/r/oom
  20   > cd oom/kubernetes
  21
  22
  23 **Step 2.** Customize the onap/values.yaml file to suit your deployment. You
  24 may want to selectively enable or disable ONAP components by changing the
  25 `enabled: true/false` flags as shown below:
  26
  27 .. code-block:: yaml
  28
  29   #################################################################
  30   # Global configuration overrides.
  31   #
  32   # These overrides will affect all helm charts (ie. applications)
  33   # that are listed below and are 'enabled'.
  34   #################################################################
  35   global:
  36     # Change to an unused port prefix range to prevent port conflicts
  37     # with other instances running within the same k8s cluster
  38     nodePortPrefix: 302
  39
  40     # image repositories
  41     repository: nexus3.onap.org:10001
  42     repositorySecret: eyJuZXh1czMub25hcC5vcmc6MTAwMDEiOnsidXNlcm5hbWUiOiJkb2NrZXIiLCJwYXNzd29yZCI6ImRvY2tlciIsImVtYWlsIjoiQCIsImF1dGgiOiJaRzlqYTJWeU9tUnZZMnRsY2c9PSJ9fQ==
  43     # readiness check
  44     readinessRepository: oomk8s
  45     # logging agent
  46     loggingRepository: docker.elastic.co
  47
  48     # image pull policy
  49     pullPolicy: Always
  50
  51     # default mount path root directory referenced
  52     # by persistent volumes and log files
  53     persistence:
  54       mountPath: /dockerdata-nfs
  55
  56     # flag to enable debugging - application support required
  57     debugEnabled: false
  58
  59   #################################################################
  60   # Enable/disable and configure helm charts (ie. applications)
  61   # to customize the ONAP deployment.
  62   #################################################################
  63   aaf:
  64     enabled: true
  65   aai:
  66     enabled: true
  67   appc:
  68     enabled: true
  69   clamp:
  70     enabled: true
  71   cli:
  72     enabled: true
  73   consul: # Consul Health Check Monitoring
  74     enabled: true
  75   dcaegen2:
  76     enabled: true
  77   esr:
  78     enabled: true
  79   log:
  80     enabled: true
  81   message-router:
  82     enabled: true
  83   mock:
  84     enabled: true
  85   msb:
  86     enabled: true
  87   multicloud:
  88     enabled: true
  89   policy:
  90     enabled: true
  91   portal:
  92     enabled: true
  93   robot: # Robot Health Check
  94     enabled: true
  95   sdc:
  96     enabled: true
  97   sdnc:
  98     enabled: true
  99   so: # Service Orchestrator
 100     enabled: true
 101
 102     replicaCount: 1
 103
 104     liveness:
 105       # necessary to disable liveness probe when setting breakpoints
 106       # in debugger so K8s doesn't restart unresponsive container
 107       enabled: true
 108
 109     # so server configuration
 110     config:
 111       # message router configuration
 112       dmaapTopic: "AUTO"
 113       # openstack configuration
 114       openStackUserName: "vnf_user"
 115       openStackRegion: "RegionOne"
 116       openStackKeyStoneUrl: "http://1.2.3.4:5000"
 117       openStackServiceTenantName: "service"
 118       openStackEncryptedPasswordHere: "c124921a3a0efbe579782cde8227681e"
 119
 120     # configure embedded mariadb
 121     mariadb:
 122       config:
 123         mariadbRootPassword: password
 124   uui:
 125     enabled: true
 126   vfc:
 127     enabled: true
 128   vid:
 129     enabled: true
 130   vnfsdk:
 131     enabled: true
 132
 133 **Step 3.** To setup a local Helm server to server up the ONAP charts::
 134
 135   > helm serve &
 136
 137 Note the port number that is listed and use it in the Helm repo add as
 138 follows::
 139
 140   > helm repo add local http://127.0.0.1:8879
 141
 142 **Step 4.** Verify your Helm repository setup with::
 143
 144   > helm repo list
 145   NAME   URL
 146   local  http://127.0.0.1:8879
 147
 148 **Step 5.** Build a local Helm repository (from the kubernetes directory)::
 149
 150   > make all
 151
 152 **Step 6.** Display the charts that available to be deployed::
 153
 154   > helm search -l
 155   NAME                    VERSION    DESCRIPTION
 156   local/appc              2.0.0      Application Controller
 157   local/clamp             2.0.0      ONAP Clamp
 158   local/common            2.0.0      Common templates for inclusion in other charts
 159   local/onap              2.0.0      Open Network Automation Platform (ONAP)
 160   local/robot             2.0.0      A helm Chart for kubernetes-ONAP Robot
 161   local/so                2.0.0      ONAP Service Orchestrator
 162
 163 .. note::
 164   The setup of the Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use `make` to update your local Helm repository.
 165
 166 **Step 7.** Once the repo is setup, installation of ONAP can be done with a
 167 single command::
 168
 169   > helm install local/onap -n dev --namespace onap
 170
 171 .. note::
 172   The requirement for the use of the `onap` namespace will be lifted once the OOM team completes their Beijing deveivers.
 173
 174 Use the following to monitor your deployment and determine when ONAP is ready for use::
 175
 176   > kubectl get pods --all-namespaces -o=wide