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