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 Amdocs, Bell Canada
5 .. _oom_quickstart_guide:
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 offical release tag, such as
25 5.0.1-ONAP for El Alto
26 6.0.0-ONAP for Frankfurt
28 **Step 2.** Install Helm Plugins required to deploy ONAP::
30 > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
33 **Step 3.** Customize the helm charts like `oom/kubernetes/onap/values.yaml` or an override
34 file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file to suit your deployment
35 with items like the OpenStack tenant information.
38 Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) can be found in
39 the `oom/kubernetes/onap/resources/overrides/` directory.
42 a. You may want to selectively enable or disable ONAP components by changing
43 the ``enabled: true/false`` flags.
46 b. Encrypt the OpenStack password using the shell tool for robot and put it in
47 the robot helm charts or robot section of `openstack.yaml`
50 c. Encrypt the OpenStack password using the java based script for SO helm charts
51 or SO section of `openstack.yaml`.
54 d. Update the OpenStack parameters that will be used by robot, SO and APPC helm
55 charts or use an override file to replace them.
57 e. Add in the command line a value for the global master password (global.masterPassword).
61 a. Enabling/Disabling Components:
62 Here is an example of the nominal entries that need to be provided.
63 We have different values file available for different contexts.
65 .. literalinclude:: ../kubernetes/onap/values.yaml
69 b. Generating ROBOT Encrypted Password:
70 The ROBOT encrypted Password uses the same encryption.key as SO but an
71 openssl algorithm that works with the python based Robot Framework.
74 To generate ROBOT ``openStackEncryptedPasswordHere``::
76 cd so/resources/config/mso/
77 /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 c. Generating SO Encrypted Password:
80 The SO Encrypted Password uses a java based encryption utility since the
81 Java encryption library is not easy to integrate with openssl/python that
82 ROBOT uses in Dublin and upper versions.
85 To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
86 ensure `default-jdk` is installed::
88 apt-get update; apt-get install default-jdk
92 SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
93 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
95 git clone http://gerrit.onap.org/r/integration
96 cd integration/deployment/heat/onap-rke/scripts
99 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
101 d. Update the OpenStack parameters:
103 There are assumptions in the demonstration VNF heat templates about the networking
104 available in the environment. To get the most value out of these templates and the
105 automation that can help confirm the setup is correct, please observe the following
109 ``openStackPublicNetId:``
110 This network should allow heat templates to add interfaces.
111 This need not be an external network, floating IPs can be assigned to the ports on
112 the VMs that are created by the heat template but its important that neutron allow
113 ports to be created on them.
115 ``openStackPrivateNetCidr: "10.0.0.0/16"``
116 This ip address block is used to assign OA&M addresses on VNFs to allow ONAP connectivity.
117 The demonstration heat templates assume that 10.0 prefix can be used by the VNFs and the
118 demonstration ip addressing plan embodied in the preload template prevent conflicts when
119 instantiating the various VNFs. If you need to change this, you will need to modify the preload
120 data in the robot helm chart like integration_preload_parametes.py and the demo/heat/preload_data
121 in the robot container. The size of the CIDR should be sufficient for ONAP and the VMs you expect
124 ``openStackOamNetworkCidrPrefix: "10.0"``
125 This ip prefix mush match the openStackPrivateNetCidr and is a helper variable to some of the
126 robot scripts for demonstration. A production deployment need not worry about this
127 setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix.
130 Example Keystone v2.0
132 .. literalinclude:: example-integration-override.yaml
135 Example Keystone v3 (required for Rocky and later releases)
137 .. literalinclude:: example-integration-override-v3.yaml
141 **Step 4.** To setup a local Helm server to server up the ONAP charts::
145 Note the port number that is listed and use it in the Helm repo add as
148 > helm repo add local http://127.0.0.1:8879
150 **Step 5.** Verify your Helm repository setup with::
154 local http://127.0.0.1:8879
156 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
158 > make SKIP_LINT=TRUE all; make SKIP_LINT=TRUE onap
160 **Step 7.** Display the onap charts that available to be deployed::
162 > helm search onap -l
164 .. literalinclude:: helm-search.txt
167 The setup of the Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use ``make`` to update your local Helm repository.
169 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
173 The ``--timeout 900`` is currently required in Dublin and up to address long
174 running initialization tasks for DMaaP and SO. Without this timeout value both
175 applications may fail to deploy.
178 We've added the master password on the command line.
179 You shouldn't put it in a file for safety reason
180 please don't forget to change the value to something random
182 A space is also added in front of the command so "history" doesn't catch it.
183 This masterPassword is very sensitive, please be careful!
186 To deploy all ONAP applications use this command::
189 > 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
191 All override files may be customized (or replaced by other overrides) as per needs.
194 Enables the modules in the ONAP deployment. As ONAP is very modular, it is possible to customize ONAP and disable some components through this configuration file.
196 `onap-all-ingress-nginx-vhost.yaml`
197 Alternative version of the `onap-all.yaml` but with global ingress controller enabled. It requires the cluster configured with the nginx ingress controller and load balancer.
198 Please use this file instad `onap-all.yaml` if you want to use experimental ingress controller feature.
201 Includes configuration values specific to the deployment environment.
203 Example: adapt readiness and liveness timers to the level of performance of your infrastructure
206 Includes all the Openstack related information for the default target tenant you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests.
208 **Step 9.** Verify ONAP installation
210 Use the following to monitor your deployment and determine when ONAP is ready for use::
212 > kubectl get pods -n onap -o=wide
215 While all pods may be in a Running state, it is not a guarantee that all components are running fine.
217 Launch the healthcheck tests using Robot to verify that the components are healthy::
219 > ~/oom/kubernetes/robot/ete-k8s.sh onap health
221 **Step 10.** Undeploy ONAP::
223 > helm undeploy dev --purge
225 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins