docs/oom_quickstart_guide.rst

   1 .. This work is licensed under a
   2 .. Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright 2019 Amdocs, Bell Canada
   5
   6 .. _quick-start-label:
   7
   8 OOM Quick Start Guide
   9 #####################
  10
  11 .. figure:: oomLogoV2-medium.png
  12    :align: right
  13
  14 Once a kubernetes environment is available (follow the instructions in
  15 :ref:`cloud-setup-guide-label` if you don't have a cloud environment
  16 available), follow the following instructions to deploy ONAP.
  17
  18 **Step 1.** Clone the OOM repository from ONAP gerrit::
  19
  20   > git clone -b 4.0.0-ONAP http://gerrit.onap.org/r/oom --recurse-submodules
  21   > cd oom/kubernetes
  22
  23 **Step 2.** Install Helm Plugins required to deploy ONAP::
  24
  25   > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
  26
  27
  28 **Step 3.** Customize the helm charts like oom/kubernetes/onap/values.yaml or an override
  29 file like onap-all.yaml, onap-vfw.yaml or openstack.yaml file to suit your deployment with items like the
  30 OpenStack tenant information.
  31
  32 .. note::
  33   Standard and example override files (e.g. onap-all.yaml, openstack.yaml) can be found in
  34   the oom/kubernetes/onap/resources/overrides/ directory.
  35
  36
  37  a. You may want to selectively enable or disable ONAP components by changing
  38     the `enabled: true/false` flags.
  39
  40
  41  b. Encyrpt the OpenStack password using the shell tool for robot and put it in
  42     the robot helm charts or robot section of openstack.yaml
  43
  44
  45  c. Encrypt the OpenStack password using the java based script for SO helm charts
  46     or SO section of openstack.yaml.
  47
  48
  49  d. Update the OpenStack parameters that will be used by robot, SO and APPC helm
  50     charts or use an override file to replace them.
  51
  52
  53
  54
  55 a. Enabling/Disabling Components:
  56 Here is an example of the nominal entries that need to be provided.
  57 We have different values file available for different contexts.
  58
  59 .. literalinclude:: onap-values.yaml
  60    :language: yaml
  61
  62
  63 b. Generating ROBOT Encrypted Password:
  64 The ROBOT encrypted Password uses the same encryption.key as SO but an
  65 openssl algorithm that works with the python based Robot Framework.
  66
  67 .. note::
  68   To generate ROBOT openStackEncryptedPasswordHere :
  69
  70   ``cd so/resources/config/mso/``
  71
  72   ``/oom/kubernetes/so/resources/config/mso# echo -n "<openstack tenant password>" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p``
  73
  74 c. Generating SO Encrypted Password:
  75 The SO Encrypted Password uses a java based encryption utility since the
  76 Java encryption library is not easy to integrate with openssl/python that
  77 ROBOT uses in Dublin.
  78
  79 .. note::
  80   To generate SO openStackEncryptedPasswordHere :
  81
  82   SO_ENCRYPTION_KEY=`cat ~/oom/kubenertes/so/resources/config/mso/encrypt.key`
  83   OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
  84
  85   git clone http://gerrit.onap.org/r/integration
  86
  87   cd integration/deployment/heat/onap-rke/scripts
  88   javac Crypto.java
  89   java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
  90
  91
  92 d. Update the OpenStack parameters:
  93
  94 .. literalinclude:: example-integration-override.yaml
  95    :language: yaml
  96
  97 **Step 4.** To setup a local Helm server to server up the ONAP charts::
  98
  99   > helm serve &
 100
 101 Note the port number that is listed and use it in the Helm repo add as
 102 follows::
 103
 104   > helm repo add local http://127.0.0.1:8879
 105
 106 **Step 5.** Verify your Helm repository setup with::
 107
 108   > helm repo list
 109   NAME   URL
 110   local  http://127.0.0.1:8879
 111
 112 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
 113
 114   > make all; make onap
 115
 116 **Step 7.** Display the onap charts that available to be deployed::
 117
 118   > helm search onap -l
 119
 120 .. literalinclude:: helm-search.txt
 121
 122 .. note::
 123   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.
 124
 125 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
 126 single command
 127
 128 .. note::
 129   The --timeout 900 is currently required in Dublin to address long running initialization tasks
 130   for DMaaP and SO. Without this timeout value both applications may fail to deploy.
 131
 132 To deploy all ONAP applications use this command::
 133
 134     > cd oom/kubernetes
 135     > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900
 136
 137 All override files may be customized (or replaced by other overrides) as per needs.
 138
 139 onap-all.yaml
 140
 141   Enables the modules in the ONAP deployment. As ONAP is very modular, it is possible to customize ONAP and disable some components through this configuration file.
 142
 143 environment.yaml
 144
 145   Includes configuration values specific to the deployment environment.
 146
 147   Example: adapt readiness and liveness timers to the level of performance of your infrastructure
 148
 149 openstack.yaml
 150
 151   Includes all the Openstack related information for the default target tenant you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests.
 152
 153 **Step 9.** Verify ONAP installation
 154
 155 Use the following to monitor your deployment and determine when ONAP is ready for use::
 156
 157   > kubectl get pods -n onap -o=wide
 158
 159 .. note::
 160   While all pods may be in a Running state, it is not a guarantee that all components are running fine.
 161
 162   Launch the healthcheck tests using Robot to verify that the components are healthy.
 163
 164   > ~/oom/kubernetes/robot/ete-k8s.sh onap health
 165
 166 **Step 10.** Undeploy ONAP
 167
 168 > helm undeploy dev --purge
 169
 170 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins