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
34 with items like the 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. Encrypt 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:: ../kubernetes/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/
75 /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``
77 c. Generating SO Encrypted Password:
78 The SO Encrypted Password uses a java based encryption utility since the
79 Java encryption library is not easy to integrate with openssl/python that
83 To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
84 ensure `default-jdk` is installed::
86 apt-get update; apt-get install default-jdk
90 SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
91 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
93 git clone http://gerrit.onap.org/r/integration
94 cd integration/deployment/heat/onap-rke/scripts
97 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
99 d. Update the OpenStack parameters:
101 There are assumptions in the demonstration VNF heat templates about the networking
102 available in the environment. To get the most value out of these templates and the
103 automation that can help confirm the setup is correct, please observe the following
106 ``openStackPublicNetId:``
107 This network should allow heat templates to add interfaces.
108 This need not be an external network, floating IPs can be assigned to the ports on
109 the VMs that are created by the heat template but its important that neutron allow
110 ports to be created on them.
112 ``openStackPrivateNetCidr: "10.0.0.0/16"``
113 This ip address block is used to assign OA&M addresses on VNFs to allow ONAP connectivity.
114 The demonstration heat templates assume that 10.0 prefix can be used by the VNFs and the
115 demonstration ip addressing plan embodied in the preload template prevent conflicts when
116 instantiating the various VNFs. If you need to change this, you will need to modify the preload
117 data in the robot helm chart like integration_preload_parametes.py and the demo/heat/preload_data
118 in the robot container. The size of the CIDR should be sufficient for ONAP and the VMs you expect
121 ``openStackOamNetworkCidrPrefix: "10.0"``
122 This ip prefix mush match the openStackPrivateNetCidr and is a helper variable to some of the
123 robot scripts for demonstration. A production deployment need not worry about this
124 setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix.
127 Example Keystone v2.0
129 .. literalinclude:: example-integration-override.yaml
132 Example Keystone v3 (required for Rocky and later releases)
134 .. literalinclude:: example-integration-override-v3.yaml
139 **Step 4.** To setup a local Helm server to server up the ONAP charts::
143 Note the port number that is listed and use it in the Helm repo add as
146 > helm repo add local http://127.0.0.1:8879
148 **Step 5.** Verify your Helm repository setup with::
152 local http://127.0.0.1:8879
154 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
156 > make all; make onap
158 **Step 7.** Display the onap charts that available to be deployed::
160 > helm search onap -l
162 .. literalinclude:: helm-search.txt
165 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.
167 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
171 The ``--timeout 900`` is currently required in Dublin to address long running initialization tasks
172 for DMaaP and SO. Without this timeout value both applications may fail to deploy.
174 To deploy all ONAP applications use this command::
177 > 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
179 All override files may be customized (or replaced by other overrides) as per needs.
182 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.
185 Includes configuration values specific to the deployment environment.
187 Example: adapt readiness and liveness timers to the level of performance of your infrastructure
190 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.
192 **Step 9.** Verify ONAP installation
194 Use the following to monitor your deployment and determine when ONAP is ready for use::
196 > kubectl get pods -n onap -o=wide
199 While all pods may be in a Running state, it is not a guarantee that all components are running fine.
201 Launch the healthcheck tests using Robot to verify that the components are healthy::
203 > ~/oom/kubernetes/robot/ete-k8s.sh onap health
205 **Step 10.** Undeploy ONAP::
207 > helm undeploy dev --purge
209 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins