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 .. _oom_quickstart_guide:
   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 <BRANCH> http://gerrit.onap.org/r/oom --recurse-submodules
  21   > cd oom/kubernetes
  22
  23 where <BRANCH> can be an offical release tag, such as
  24 4.0.0-ONAP for Dublin
  25 5.0.1-ONAP for El Alto
  26
  27 **Step 2.** Install Helm Plugins required to deploy ONAP::
  28
  29   > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
  30
  31
  32 **Step 3.** Customize the helm charts like `oom/kubernetes/onap/values.yaml` or an override
  33 file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file to suit your deployment
  34 with items like the OpenStack tenant information.
  35
  36 .. note::
  37   Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) can be found in
  38   the `oom/kubernetes/onap/resources/overrides/` directory.
  39
  40
  41  a. You may want to selectively enable or disable ONAP components by changing
  42     the ``enabled: true/false`` flags.
  43
  44
  45  b. Encrypt the OpenStack password using the shell tool for robot and put it in
  46     the robot helm charts or robot section of `openstack.yaml`
  47
  48
  49  c. Encrypt the OpenStack password using the java based script for SO helm charts
  50     or SO section of `openstack.yaml`.
  51
  52
  53  d. Update the OpenStack parameters that will be used by robot, SO and APPC helm
  54     charts or use an override file to replace them.
  55
  56
  57
  58
  59 a. Enabling/Disabling Components:
  60 Here is an example of the nominal entries that need to be provided.
  61 We have different values file available for different contexts.
  62
  63 .. literalinclude:: ../kubernetes/onap/values.yaml
  64    :language: yaml
  65
  66
  67 b. Generating ROBOT Encrypted Password:
  68 The ROBOT encrypted Password uses the same encryption.key as SO but an
  69 openssl algorithm that works with the python based Robot Framework.
  70
  71 .. note::
  72   To generate ROBOT ``openStackEncryptedPasswordHere``::
  73
  74     cd so/resources/config/mso/
  75     /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``
  76
  77 c. Generating SO Encrypted Password:
  78 The SO Encrypted Password uses a java based encryption utility since the
  79 Java encryption library is not easy to integrate with openssl/python that
  80 ROBOT uses in Dublin.
  81
  82 .. note::
  83   To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
  84   ensure `default-jdk` is installed::
  85
  86     apt-get update; apt-get install default-jdk
  87
  88   Then execute::
  89
  90     SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
  91     OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
  92
  93     git clone http://gerrit.onap.org/r/integration
  94     cd integration/deployment/heat/onap-rke/scripts
  95
  96     javac Crypto.java
  97     java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
  98
  99 d. Update the OpenStack parameters:
 100
 101 There are assumptions in the demonstration VNF heat templates about the networking
 102 available in the environment. To get the most value out of these templates and the
 103 automation that can help confirm the setup is correct, please observe the following
 104 constraints.
 105
 106 ``openStackPublicNetId:``
 107   This network should allow heat templates to add interfaces.
 108   This need not be an external network, floating IPs can be assigned to the ports on
 109   the VMs that are created by the heat template but its important that neutron allow
 110   ports to be created on them.
 111
 112 ``openStackPrivateNetCidr: "10.0.0.0/16"``
 113   This ip address block is used to assign OA&M addresses on VNFs to allow ONAP connectivity.
 114   The demonstration heat templates assume that 10.0 prefix can be used by the VNFs and the
 115   demonstration ip addressing plan embodied in the preload template prevent conflicts when
 116   instantiating the various VNFs. If you need to change this, you will need to modify the preload
 117   data in the robot helm chart like integration_preload_parametes.py and the demo/heat/preload_data
 118   in the robot container. The size of the CIDR should be sufficient for ONAP and the VMs you expect
 119   to create.
 120
 121 ``openStackOamNetworkCidrPrefix: "10.0"``
 122   This ip prefix mush match the openStackPrivateNetCidr and is a helper variable to some of the
 123   robot scripts for demonstration. A production deployment need not worry about this
 124   setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix.
 125
 126
 127 Example Keystone v2.0
 128
 129 .. literalinclude:: example-integration-override.yaml
 130    :language: yaml
 131
 132 Example Keystone v3  (required for Rocky and later releases)
 133
 134 .. literalinclude:: example-integration-override-v3.yaml
 135    :language: yaml
 136
 137
 138
 139 **Step 4.** To setup a local Helm server to server up the ONAP charts::
 140
 141   > helm serve &
 142
 143 Note the port number that is listed and use it in the Helm repo add as
 144 follows::
 145
 146   > helm repo add local http://127.0.0.1:8879
 147
 148 **Step 5.** Verify your Helm repository setup with::
 149
 150   > helm repo list
 151   NAME   URL
 152   local  http://127.0.0.1:8879
 153
 154 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
 155
 156   > make all; make onap
 157
 158 **Step 7.** Display the onap charts that available to be deployed::
 159
 160   > helm search onap -l
 161
 162 .. literalinclude:: helm-search.txt
 163
 164 .. note::
 165   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.
 166
 167 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
 168 single command
 169
 170 .. note::
 171   The ``--timeout 900`` is currently required in Dublin to address long running initialization tasks
 172   for DMaaP and SO. Without this timeout value both applications may fail to deploy.
 173
 174 To deploy all ONAP applications use this command::
 175
 176     > cd oom/kubernetes
 177     > 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
 178
 179 All override files may be customized (or replaced by other overrides) as per needs.
 180
 181 `onap-all.yaml`
 182   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.
 183
 184 `environment.yaml`
 185   Includes configuration values specific to the deployment environment.
 186
 187   Example: adapt readiness and liveness timers to the level of performance of your infrastructure
 188
 189 `openstack.yaml`
 190   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.
 191
 192 **Step 9.** Verify ONAP installation
 193
 194 Use the following to monitor your deployment and determine when ONAP is ready for use::
 195
 196   > kubectl get pods -n onap -o=wide
 197
 198 .. note::
 199   While all pods may be in a Running state, it is not a guarantee that all components are running fine.
 200
 201   Launch the healthcheck tests using Robot to verify that the components are healthy::
 202
 203     > ~/oom/kubernetes/robot/ete-k8s.sh onap health
 204
 205 **Step 10.** Undeploy ONAP::
 206
 207   > helm undeploy dev --purge
 208
 209 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins