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-2020 Amdocs, Bell Canada, Orange, Samsung
   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 official 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
  35 an override file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file
  36 to suit your deployment 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
 105 networking available in the environment. To get the most value out of these
 106 templates and the automation that can help confirm the setup is correct, please
 107 observe the following 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
 113   ports on the VMs that are created by the heat template but its important that
 114   neutron allow 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
 118   connectivity. The demonstration Heat templates assume that 10.0 prefix can be
 119   used by the VNFs and the demonstration ip addressing plan embodied in the
 120   preload template prevent conflicts when instantiating the various VNFs. If
 121   you need to change this, you will need to modify the preload data in the
 122   Robot Helm chart like integration_preload_parameters.py and the
 123   demo/heat/preload_data in the Robot container. The size of the CIDR should
 124   be sufficient for ONAP and the VMs you expect to create.
 125
 126 ``openStackOamNetworkCidrPrefix: "10.0"``
 127   This ip prefix mush match the openStackPrivateNetCidr and is a helper
 128   variable to some of the Robot scripts for demonstration. A production
 129   deployment need not worry about this setting but for the demonstration VNFs
 130   the ip asssignment strategy assumes 10.0 ip prefix.
 131
 132 Example Keystone v2.0
 133
 134 .. literalinclude:: example-integration-override.yaml
 135    :language: yaml
 136
 137 Example Keystone v3  (required for Rocky and later releases)
 138
 139 .. literalinclude:: example-integration-override-v3.yaml
 140    :language: yaml
 141
 142
 143 **Step 4.** To setup a local Helm server to server up the ONAP charts::
 144
 145   > helm serve &
 146
 147 Note the port number that is listed and use it in the Helm repo add as
 148 follows::
 149
 150   > helm repo add local http://127.0.0.1:8879
 151
 152 **Step 5.** Verify your Helm repository setup with::
 153
 154   > helm repo list
 155   NAME   URL
 156   local  http://127.0.0.1:8879
 157
 158 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
 159
 160   > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all ; make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] onap
 161
 162 `HELM_BIN`
 163   Sets the helm binary to be used. The default value use helm from PATH. Allow the user to have
 164   multiple version of helm in operating system and choose which one to use.
 165
 166 **Step 7.** Display the onap charts that available to be deployed::
 167
 168   > helm search onap -l
 169
 170 .. literalinclude:: helm-search.txt
 171
 172 .. note::
 173   The setup of the Helm repository is a one time activity. If you make changes
 174   to your deployment charts or values be sure to use ``make`` to update your
 175   local Helm repository.
 176
 177 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
 178 single command
 179
 180 .. note::
 181   The ``--timeout 900`` is currently required in Dublin and up to address long
 182   running initialization tasks for DMaaP and SO. Without this timeout value both
 183   applications may fail to deploy.
 184
 185 .. danger::
 186   We've added the master password on the command line.
 187   You shouldn't put it in a file for safety reason
 188   please don't forget to change the value to something random
 189
 190   A space is also added in front of the command so "history" doesn't catch it.
 191   This masterPassword is very sensitive, please be careful!
 192
 193
 194 To deploy all ONAP applications use this command::
 195
 196     > cd oom/kubernetes
 197     >  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
 198
 199 All override files may be customized (or replaced by other overrides) as per
 200 needs.
 201
 202 `onap-all.yaml`
 203   Enables the modules in the ONAP deployment. As ONAP is very modular, it is
 204   possible to customize ONAP and disable some components through this
 205   configuration file.
 206
 207 `onap-all-ingress-nginx-vhost.yaml`
 208   Alternative version of the `onap-all.yaml` but with global ingress controller
 209   enabled. It requires the cluster configured with the nginx ingress controller
 210   and load balancer. Please use this file instead `onap-all.yaml` if you want
 211   to use experimental ingress controller feature.
 212
 213 `environment.yaml`
 214   Includes configuration values specific to the deployment environment.
 215
 216   Example: adapt readiness and liveness timers to the level of performance of
 217   your infrastructure
 218
 219 `openstack.yaml`
 220   Includes all the OpenStack related information for the default target tenant
 221   you want to use to deploy VNFs from ONAP and/or additional parameters for the
 222   embedded tests.
 223
 224 **Step 9.** Verify ONAP installation
 225
 226 Use the following to monitor your deployment and determine when ONAP is ready
 227 for use::
 228
 229   > kubectl get pods -n onap -o=wide
 230
 231 .. note::
 232   While all pods may be in a Running state, it is not a guarantee that all components are running fine.
 233
 234   Launch the healthcheck tests using Robot to verify that the components are healthy::
 235
 236     > ~/oom/kubernetes/robot/ete-k8s.sh onap health
 237
 238 **Step 10.** Undeploy ONAP
 239 ::
 240
 241   > helm undeploy dev --purge
 242
 243 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins