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 <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
27 **Step 2.** Install Helm Plugins required to deploy ONAP::
29 > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
32 **Step 3.** Customize the helm charts like oom/kubernetes/onap/values.yaml or an override
33 file like onap-all.yaml, onap-vfw.yaml or openstack.yaml file to suit your deployment with items like the
34 OpenStack tenant information.
37 Standard and example override files (e.g. onap-all.yaml, openstack.yaml) can be found in
38 the oom/kubernetes/onap/resources/overrides/ directory.
41 a. You may want to selectively enable or disable ONAP components by changing
42 the `enabled: true/false` flags.
45 b. Encyrpt the OpenStack password using the shell tool for robot and put it in
46 the robot helm charts or robot section of openstack.yaml
49 c. Encrypt the OpenStack password using the java based script for SO helm charts
50 or SO section of openstack.yaml.
53 d. Update the OpenStack parameters that will be used by robot, SO and APPC helm
54 charts or use an override file to replace them.
59 a. Enabling/Disabling Components:
60 Here is an example of the nominal entries that need to be provided.
61 We have different values file available for different contexts.
63 .. literalinclude:: onap-values.yaml
67 b. Generating ROBOT Encrypted Password:
68 The ROBOT encrypted Password uses the same encryption.key as SO but an
69 openssl algorithm that works with the python based Robot Framework.
72 To generate ROBOT openStackEncryptedPasswordHere :
74 ``cd so/resources/config/mso/``
76 ``/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``
78 c. Generating SO Encrypted Password:
79 The SO Encrypted Password uses a java based encryption utility since the
80 Java encryption library is not easy to integrate with openssl/python that
84 To generate SO openStackEncryptedPasswordHere and openStackSoEncryptedPassword:
86 SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
88 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
90 git clone http://gerrit.onap.org/r/integration
92 cd integration/deployment/heat/onap-rke/scripts
97 [ if javac is not installed 'apt-get update ; apt-get install default-jdk' ]
99 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
109 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"
118 This ip address block is used to assign OA&M addresses on VNFs to allow ONAP connectivity.
119 The demonstration heat templates assume that 10.0 prefix can be used by the VNFs and the
120 demonstration ip addressing plan embodied in the preload template prevent conflicts when
121 instantiating the various VNFs. If you need to change this, you will need to modify the preload
122 data in the robot helm chart like integration_preload_parametes.py and the demo/heat/preload_data
123 in the robot container. The size of the CIDR should be sufficient for ONAP and the VMs you expect
126 openStackOamNetworkCidrPrefix: "10.0"
128 This ip prefix mush match the openStackPrivateNetCidr and is a helper variable to some of the
129 robot scripts for demonstration. A production deployment need not worry about this
130 setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix.
133 Example Keystone v2.0
134 .. literalinclude:: example-integration-override.yaml
137 Example Keystone v3 (required for Rocky and later releases)
138 .. literalinclude:: example-integration-override-v3.yaml
143 **Step 4.** To setup a local Helm server to server up the ONAP charts::
147 Note the port number that is listed and use it in the Helm repo add as
150 > helm repo add local http://127.0.0.1:8879
152 **Step 5.** Verify your Helm repository setup with::
156 local http://127.0.0.1:8879
158 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
160 > make all; make onap
162 **Step 7.** Display the onap charts that available to be deployed::
164 > helm search onap -l
166 .. literalinclude:: helm-search.txt
169 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.
171 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
175 The --timeout 900 is currently required in Dublin to address long running initialization tasks
176 for DMaaP and SO. Without this timeout value both applications may fail to deploy.
178 To deploy all ONAP applications use this command::
181 > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900
183 All override files may be customized (or replaced by other overrides) as per needs.
187 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.
191 Includes configuration values specific to the deployment environment.
193 Example: adapt readiness and liveness timers to the level of performance of your infrastructure
197 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.
199 **Step 9.** Verify ONAP installation
201 Use the following to monitor your deployment and determine when ONAP is ready for use::
203 > kubectl get pods -n onap -o=wide
206 While all pods may be in a Running state, it is not a guarantee that all components are running fine.
208 Launch the healthcheck tests using Robot to verify that the components are healthy.
210 > ~/oom/kubernetes/robot/ete-k8s.sh onap health
212 **Step 10.** Undeploy ONAP
214 > helm undeploy dev --purge
216 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins