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