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