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