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 * 4.0.0-ONAP for Dublin
26 * 5.0.1-ONAP for El Alto
29 **Step 2.** Install Helm Plugins required to deploy ONAP::
31 > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
34 **Step 3.** Customize the helm charts like `oom/kubernetes/onap/values.yaml` or an override
35 file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file to suit your deployment
36 with items like the OpenStack tenant information.
39 Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) can be found in
40 the `oom/kubernetes/onap/resources/overrides/` directory.
43 a. You may want to selectively enable or disable ONAP components by changing
44 the ``enabled: true/false`` flags.
47 b. Encrypt the OpenStack password using the shell tool for robot and put it in
48 the robot helm charts or robot section of `openstack.yaml`
51 c. Encrypt the OpenStack password using the java based script for SO helm charts
52 or SO section of `openstack.yaml`.
55 d. Update the OpenStack parameters that will be used by robot, SO and APPC helm
56 charts or use an override file to replace them.
58 e. Add in the command line a value for the global master password (global.masterPassword).
62 a. Enabling/Disabling Components:
63 Here is an example of the nominal entries that need to be provided.
64 We have different values file available for different contexts.
66 .. literalinclude:: ../kubernetes/onap/values.yaml
70 b. Generating ROBOT Encrypted Password:
71 The ROBOT encrypted Password uses the same encryption.key as SO but an
72 openssl algorithm that works with the python based Robot Framework.
75 To generate ROBOT ``openStackEncryptedPasswordHere``::
77 cd so/resources/config/mso/
78 /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``
80 c. Generating SO Encrypted Password:
81 The SO Encrypted Password uses a java based encryption utility since the
82 Java encryption library is not easy to integrate with openssl/python that
83 ROBOT uses in Dublin and upper versions.
86 To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
87 ensure `default-jdk` is installed::
89 apt-get update; apt-get install default-jdk
93 SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
94 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
96 git clone http://gerrit.onap.org/r/integration
97 cd integration/deployment/heat/onap-rke/scripts
100 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
102 d. Update the OpenStack parameters:
104 There are assumptions in the demonstration VNF heat templates about the networking
105 available in the environment. To get the most value out of these templates and the
106 automation that can help confirm the setup is correct, please observe the following
110 ``openStackPublicNetId:``
111 This network should allow heat templates to add interfaces.
112 This need not be an external network, floating IPs can be assigned to the ports on
113 the VMs that are created by the heat template but its important that neutron allow
114 ports to be created on them.
116 ``openStackPrivateNetCidr: "10.0.0.0/16"``
117 This ip address block is used to assign OA&M addresses on VNFs to allow ONAP connectivity.
118 The demonstration heat templates assume that 10.0 prefix can be used by the VNFs and the
119 demonstration ip addressing plan embodied in the preload template prevent conflicts when
120 instantiating the various VNFs. If you need to change this, you will need to modify the preload
121 data in the robot helm chart like integration_preload_parametes.py and the demo/heat/preload_data
122 in the robot container. The size of the CIDR should be sufficient for ONAP and the VMs you expect
125 ``openStackOamNetworkCidrPrefix: "10.0"``
126 This ip prefix mush match the openStackPrivateNetCidr and is a helper variable to some of the
127 robot scripts for demonstration. A production deployment need not worry about this
128 setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix.
131 Example Keystone v2.0
133 .. literalinclude:: example-integration-override.yaml
136 Example Keystone v3 (required for Rocky and later releases)
138 .. literalinclude:: example-integration-override-v3.yaml
142 **Step 4.** To setup a local Helm server to server up the ONAP charts::
146 Note the port number that is listed and use it in the Helm repo add as
149 > helm repo add local http://127.0.0.1:8879
151 **Step 5.** Verify your Helm repository setup with::
155 local http://127.0.0.1:8879
157 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
159 > make SKIP_LINT=TRUE all; make SKIP_LINT=TRUE onap
161 **Step 7.** Display the onap charts that available to be deployed::
163 > helm search onap -l
165 .. literalinclude:: helm-search.txt
168 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.
170 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
174 The ``--timeout 900`` is currently required in Dublin and up to address long
175 running initialization tasks for DMaaP and SO. Without this timeout value both
176 applications may fail to deploy.
179 We've added the master password on the command line.
180 You shouldn't put it in a file for safety reason
181 please don't forget to change the value to something random
183 A space is also added in front of the command so "history" doesn't catch it.
184 This masterPassword is very sensitive, please be careful!
187 To deploy all ONAP applications use this command::
190 > 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
192 All override files may be customized (or replaced by other overrides) as per needs.
195 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.
197 `onap-all-ingress-nginx-vhost.yaml`
198 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.
199 Please use this file instad `onap-all.yaml` if you want to use experimental ingress controller feature.
202 Includes configuration values specific to the deployment environment.
204 Example: adapt readiness and liveness timers to the level of performance of your infrastructure
207 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.
209 **Step 9.** Verify ONAP installation
211 Use the following to monitor your deployment and determine when ONAP is ready for use::
213 > kubectl get pods -n onap -o=wide
216 While all pods may be in a Running state, it is not a guarantee that all components are running fine.
218 Launch the healthcheck tests using Robot to verify that the components are healthy::
220 > ~/oom/kubernetes/robot/ete-k8s.sh onap health
222 **Step 10.** Undeploy ONAP::
224 > helm undeploy dev --purge
226 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins