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
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 4.0.0-ONAP http://gerrit.onap.org/r/oom --recurse-submodules
23 **Step 2.** Install Helm Plugins required to deploy ONAP::
25 > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
28 **Step 3.** Customize the helm charts like oom/kubernetes/onap/values.yaml or an override
29 file like onap-all.yaml, onap-vfw.yaml or openstack.yaml file to suit your deployment with items like the
30 OpenStack tenant information.
33 Standard and example override files (e.g. onap-all.yaml, openstack.yaml) can be found in
34 the oom/kubernetes/onap/resources/overrides/ directory.
37 a. You may want to selectively enable or disable ONAP components by changing
38 the `enabled: true/false` flags.
41 b. Encyrpt the OpenStack password using the shell tool for robot and put it in
42 the robot helm charts or robot section of openstack.yaml
45 c. Encrypt the OpenStack password using the java based script for SO helm charts
46 or SO section of openstack.yaml.
49 d. Update the OpenStack parameters that will be used by robot, SO and APPC helm
50 charts or use an override file to replace them.
55 a. Enabling/Disabling Components:
56 Here is an example of the nominal entries that need to be provided.
57 We have different values file available for different contexts.
59 .. literalinclude:: onap-values.yaml
63 b. Generating ROBOT Encrypted Password:
64 The ROBOT encrypted Password uses the same encryption.key as SO but an
65 openssl algorithm that works with the python based Robot Framework.
68 To generate ROBOT openStackEncryptedPasswordHere :
70 ``cd so/resources/config/mso/``
72 ``/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``
74 c. Generating SO Encrypted Password:
75 The SO Encrypted Password uses a java based encryption utility since the
76 Java encryption library is not easy to integrate with openssl/python that
80 To generate SO openStackEncryptedPasswordHere :
82 SO_ENCRYPTION_KEY=`cat ~/oom/kubenertes/so/resources/config/mso/encrypt.key`
83 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
85 git clone http://gerrit.onap.org/r/integration
86 cd integration/deployment/heat/onap-oom/scripts
88 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
91 d. Update the OpenStack parameters:
93 .. literalinclude:: example-integration-override.yaml
96 **Step 4.** To setup a local Helm server to server up the ONAP charts::
100 Note the port number that is listed and use it in the Helm repo add as
103 > helm repo add local http://127.0.0.1:8879
105 **Step 5.** Verify your Helm repository setup with::
109 local http://127.0.0.1:8879
111 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
113 > make all; make onap
115 **Step 7.** Display the onap charts that available to be deployed::
117 > helm search onap -l
119 .. literalinclude:: helm-search.txt
122 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.
124 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
128 The --timeout 900 is currently required in Dublin to address long running initialization tasks
129 for DMaaP and SO. Without this timeout value both applications may fail to deploy.
131 a. To deploy all ONAP applications use this command::
134 > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/openstack.yaml --timeout 900
136 b. If you are using a custom override (e.g. integration-override.yaml) use this command::
138 > helm deploy dev local/onap -f /root/integration-override.yaml --namespace onap --timeout 900
141 c. If you have a slower cloud environment you may want to use the public-cloud.yaml
142 which has longer delay intervals on database updates.::
144 > helm deploy dev local/onap -f /root/oom/kubernetes/onap/resources/environments/public-cloud.yaml -f /root/integration-override.yaml --namespace onap --timeout 900
147 **Step 9.** Commands to interact with the OOM installation
149 Use the following to monitor your deployment and determine when ONAP is
152 > kubectl get pods -n onap -o=wide
154 Undeploying onap can be done using the following command::
156 > helm undeploy dev --purge
159 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins