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 2018 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
23 **Step 2.** Install Helm Plugins required to deploy the ONAP Casablanca release::
25 > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
28 **Step 3.** Customize the helm charts like onap.values.yaml or an override.yaml
29 like integration-override.yaml file to suit your deployment with items like the
30 OpenStack tenant information.
33 a. You may want to selectively enable or disable ONAP components by changing
34 the `enabled: true/false` flags.
37 b. Encyrpt the OpenStack password using the shell tool for robot and put it in
38 the robot helm charts or robot section of integration-override.yaml
41 c. Encrypt the OpenStack password using the java based script for SO helm charts
42 or SO section of integration-override.yaml.
45 d. Update the OpenStack parameters that will be used by robot, SO and APPC helm
46 charts or use an override file to replace them.
51 a. Enabling/Disabling Components:
52 Here is an example of the nominal entries that need to be provided. We have different
53 values file available for different contexts.
55 .. literalinclude:: onap-values.yaml
59 b. Generating ROBOT Encrypted Password:
60 The ROBOT encrypted Password uses the same encryption.key as SO but an
61 openssl algorithm that works with the python based Robot Framework.
64 To generate ROBOT openStackEncryptedPasswordHere :
66 ``root@olc-rancher:~# cd so/resources/config/mso/``
68 ``root@olc-rancher:~/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``
70 c. Generating SO Encrypted Password:
71 The SO Encrypted Password uses a java based encryption utility since the
72 Java encryption library is not easy to integrate with openssl/python that
76 To generate SO openStackEncryptedPasswordHere :
78 SO_ENCRYPTION_KEY=`cat ~/oom/kubenertes/so/resources/config/mso/encrypt.key`
79 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
81 git clone http://gerrit.onap.org/r/integration
82 cd integration/deployment/heat/onap-oom/scripts
84 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
87 d. Update the OpenStack parameters:
89 .. literalinclude:: example-integration-override.yaml
92 **Step 4.** To setup a local Helm server to server up the ONAP charts::
96 Note the port number that is listed and use it in the Helm repo add as
99 > helm repo add local http://127.0.0.1:8879
101 **Step 5.** Verify your Helm repository setup with::
105 local http://127.0.0.1:8879
107 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
109 > make all; make onap
111 **Step 7.** Display the onap charts that available to be deployed::
113 > helm search onap -l
115 .. literalinclude:: helm-search.txt
118 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.
120 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
123 a. If you updated the values directly use this command::
125 > helm deploy dev local/onap --namespace onap
128 b. If you are using an integration-override.yaml file use this command::
130 > helm deploy dev local/onap -f /root/integration-override.yaml --namespace onap
133 c. If you have a slower cloud environment you may want to use the public-cloud.yaml
134 which has longer delay intervals on database updates.::
136 > helm deploy dev local/onap -f /root/oom/kubernetes/onap/resources/environments/public-cloud.yaml -f /root/integration-override.yaml --namespace onap
139 **Step 9.** Commands to interact with the OOM installation
141 Use the following to monitor your deployment and determine when ONAP is
144 > kubectl get pods --all-namespaces -o=wide
146 Undeploying onap can be done using the following command::
148 > helm undeploy dev --purge
151 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins