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