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_helm3:
6 .. _quick-start-label-helm3:
8 OOM Quick Start Guide Helm3 (experimental)
9 ###########################################
11 .. figure:: oomLogoV2-medium.png
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.
18 **Step 1.** Clone the OOM repository from ONAP gerrit::
20 > git clone -b <BRANCH> http://gerrit.onap.org/r/oom --recurse-submodules
23 where <BRANCH> can be an official release tag, such as
25 * 4.0.0-ONAP for Dublin
26 * 5.0.1-ONAP for El Alto
30 **Step 2.** Install Helm Plugins required to deploy ONAP::
32 > cp -R ~/oom/kubernetes/helm/plugins/ ~/.local/share/helm/plugins
33 > helm plugin install https://github.com/chartmuseum/helm-push.git
35 **Step 3** Install Chartmuseum::
37 > curl -LO https://s3.amazonaws.com/chartmuseum/release/latest/bin/linux/amd64/chartmuseum
38 > chmod +x ./chartmuseum
39 > mv ./chartmuseum /usr/local/bin
41 **Step 4.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or
42 an override file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file
43 to suit your deployment with items like the OpenStack tenant information.
46 Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) can be found in
47 the `oom/kubernetes/onap/resources/overrides/` directory.
50 a. You may want to selectively enable or disable ONAP components by changing
51 the ``enabled: true/false`` flags.
54 b. Encrypt the OpenStack password using the shell tool for Robot and put it in
55 the Robot Helm charts or Robot section of `openstack.yaml`
58 c. Encrypt the OpenStack password using the java based script for SO Helm charts
59 or SO section of `openstack.yaml`.
62 d. Update the OpenStack parameters that will be used by Robot, SO and APPC Helm
63 charts or use an override file to replace them.
65 e. Add in the command line a value for the global master password (global.masterPassword).
69 a. Enabling/Disabling Components:
70 Here is an example of the nominal entries that need to be provided.
71 We have different values file available for different contexts.
73 .. literalinclude:: ../kubernetes/onap/values.yaml
77 b. Generating ROBOT Encrypted Password:
78 The Robot encrypted Password uses the same encryption.key as SO but an
79 openssl algorithm that works with the python based Robot Framework.
82 To generate Robot ``openStackEncryptedPasswordHere``::
84 cd so/resources/config/mso/
85 /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``
87 c. Generating SO Encrypted Password:
88 The SO Encrypted Password uses a java based encryption utility since the
89 Java encryption library is not easy to integrate with openssl/python that
90 Robot uses in Dublin and upper versions.
93 To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
94 ensure `default-jdk` is installed::
96 apt-get update; apt-get install default-jdk
100 SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
101 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
103 git clone http://gerrit.onap.org/r/integration
104 cd integration/deployment/heat/onap-rke/scripts
107 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
109 d. Update the OpenStack parameters:
111 There are assumptions in the demonstration VNF Heat templates about the
112 networking available in the environment. To get the most value out of these
113 templates and the automation that can help confirm the setup is correct, please
114 observe the following constraints.
117 ``openStackPublicNetId:``
118 This network should allow Heat templates to add interfaces.
119 This need not be an external network, floating IPs can be assigned to the
120 ports on the VMs that are created by the heat template but its important that
121 neutron allow ports to be created on them.
123 ``openStackPrivateNetCidr: "10.0.0.0/16"``
124 This ip address block is used to assign OA&M addresses on VNFs to allow ONAP
125 connectivity. The demonstration Heat templates assume that 10.0 prefix can be
126 used by the VNFs and the demonstration ip addressing plan embodied in the
127 preload template prevent conflicts when instantiating the various VNFs. If
128 you need to change this, you will need to modify the preload data in the
129 Robot Helm chart like integration_preload_parameters.py and the
130 demo/heat/preload_data in the Robot container. The size of the CIDR should
131 be sufficient for ONAP and the VMs you expect to create.
133 ``openStackOamNetworkCidrPrefix: "10.0"``
134 This ip prefix mush match the openStackPrivateNetCidr and is a helper
135 variable to some of the Robot scripts for demonstration. A production
136 deployment need not worry about this setting but for the demonstration VNFs
137 the ip asssignment strategy assumes 10.0 ip prefix.
139 Example Keystone v2.0
141 .. literalinclude:: example-integration-override.yaml
144 Example Keystone v3 (required for Rocky and later releases)
146 .. literalinclude:: example-integration-override-v3.yaml
150 **Step 5.** To setup a local Helm server to server up the ONAP charts::
152 > chartmuseum --storage local --storage-local-rootdir ~/helm3-storage -port 8879 &
154 Note the port number that is listed and use it in the Helm repo add as
157 > helm repo add local http://127.0.0.1:8879
159 **Step 6.** Verify your Helm repository setup with::
163 local http://127.0.0.1:8879
165 **Step 7.** Build a local Helm repository (from the kubernetes directory)::
167 > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all ; make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] onap
170 Sets the helm binary to be used. The default value use helm from PATH
173 **Step 8.** Display the onap charts that available to be deployed::
176 > helm search repo onap
178 .. literalinclude:: helm-search.txt
181 The setup of the Helm repository is a one time activity. If you make changes
182 to your deployment charts or values be sure to use ``make`` to update your
183 local Helm repository.
185 **Step 9.** Once the repo is setup, installation of ONAP can be done with a
189 The ``--timeout 900s`` is currently required in Dublin and later
190 versions up to address long running initialization tasks for DMaaP
191 and SO. Without this timeout value both applications may fail to
195 We've added the master password on the command line.
196 You shouldn't put it in a file for safety reason
197 please don't forget to change the value to something random
199 A space is also added in front of the command so "history" doesn't catch it.
200 This masterPassword is very sensitive, please be careful!
203 To deploy all ONAP applications use this command::
206 > 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
208 All override files may be customized (or replaced by other overrides) as per
212 Enables the modules in the ONAP deployment. As ONAP is very modular, it is
213 possible to customize ONAP and disable some components through this
216 `onap-all-ingress-nginx-vhost.yaml`
217 Alternative version of the `onap-all.yaml` but with global ingress controller
218 enabled. It requires the cluster configured with the nginx ingress controller
219 and load balancer. Please use this file instead `onap-all.yaml` if you want
220 to use experimental ingress controller feature.
223 Includes configuration values specific to the deployment environment.
225 Example: adapt readiness and liveness timers to the level of performance of
229 Includes all the OpenStack related information for the default target tenant
230 you want to use to deploy VNFs from ONAP and/or additional parameters for the
233 **Step 10.** Verify ONAP installation
235 Use the following to monitor your deployment and determine when ONAP is ready
238 > kubectl get pods -n onap -o=wide
241 While all pods may be in a Running state, it is not a guarantee that all components are running fine.
243 Launch the healthcheck tests using Robot to verify that the components are healthy::
245 > ~/oom/kubernetes/robot/ete-k8s.sh onap health
247 **Step 11.** Undeploy ONAP
252 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins