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-2020 Amdocs, Bell Canada, Orange, Samsung
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 official release tag, such as
25 * 4.0.0-ONAP for Dublin
26 * 5.0.1-ONAP for El Alto
30 **Step 2.** Install Helm Plugins required to deploy ONAP::
32 > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
35 **Step 3.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or
36 an override file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file
37 to suit your deployment with items like the OpenStack tenant information.
40 Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) can be found in
41 the `oom/kubernetes/onap/resources/overrides/` directory.
44 a. You may want to selectively enable or disable ONAP components by changing
45 the ``enabled: true/false`` flags.
48 b. Encrypt the OpenStack password using the shell tool for Robot and put it in
49 the Robot Helm charts or Robot section of `openstack.yaml`
52 c. Encrypt the OpenStack password using the java based script for SO Helm charts
53 or SO section of `openstack.yaml`.
56 d. Update the OpenStack parameters that will be used by Robot, SO and APPC Helm
57 charts or use an override file to replace them.
59 e. Add in the command line a value for the global master password (global.masterPassword).
63 a. Enabling/Disabling Components:
64 Here is an example of the nominal entries that need to be provided.
65 We have different values file available for different contexts.
67 .. literalinclude:: ../kubernetes/onap/values.yaml
71 b. Generating ROBOT Encrypted Password:
72 The Robot encrypted Password uses the same encryption.key as SO but an
73 openssl algorithm that works with the python based Robot Framework.
76 To generate Robot ``openStackEncryptedPasswordHere``::
78 cd so/resources/config/mso/
79 /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``
81 c. Generating SO Encrypted Password:
82 The SO Encrypted Password uses a java based encryption utility since the
83 Java encryption library is not easy to integrate with openssl/python that
84 Robot uses in Dublin and upper versions.
87 To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
88 ensure `default-jdk` is installed::
90 apt-get update; apt-get install default-jdk
94 SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
95 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
97 git clone http://gerrit.onap.org/r/integration
98 cd integration/deployment/heat/onap-rke/scripts
101 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
103 d. Update the OpenStack parameters:
105 There are assumptions in the demonstration VNF Heat templates about the
106 networking available in the environment. To get the most value out of these
107 templates and the automation that can help confirm the setup is correct, please
108 observe the following constraints.
111 ``openStackPublicNetId:``
112 This network should allow Heat templates to add interfaces.
113 This need not be an external network, floating IPs can be assigned to the
114 ports on the VMs that are created by the heat template but its important that
115 neutron allow ports to be created on them.
117 ``openStackPrivateNetCidr: "10.0.0.0/16"``
118 This ip address block is used to assign OA&M addresses on VNFs to allow ONAP
119 connectivity. The demonstration Heat templates assume that 10.0 prefix can be
120 used by the VNFs and the demonstration ip addressing plan embodied in the
121 preload template prevent conflicts when instantiating the various VNFs. If
122 you need to change this, you will need to modify the preload data in the
123 Robot Helm chart like integration_preload_parameters.py and the
124 demo/heat/preload_data in the Robot container. The size of the CIDR should
125 be sufficient for ONAP and the VMs you expect to create.
127 ``openStackOamNetworkCidrPrefix: "10.0"``
128 This ip prefix mush match the openStackPrivateNetCidr and is a helper
129 variable to some of the Robot scripts for demonstration. A production
130 deployment need not worry about this setting but for the demonstration VNFs
131 the ip asssignment strategy assumes 10.0 ip prefix.
133 Example Keystone v2.0
135 .. literalinclude:: example-integration-override.yaml
138 Example Keystone v3 (required for Rocky and later releases)
140 .. literalinclude:: example-integration-override-v3.yaml
144 **Step 4.** To setup a local Helm server to server up the ONAP charts::
148 Note the port number that is listed and use it in the Helm repo add as
151 > helm repo add local http://127.0.0.1:8879
153 **Step 5.** Verify your Helm repository setup with::
157 local http://127.0.0.1:8879
159 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
161 > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all
164 Sets the helm binary to be used. The default value use helm from PATH. Allow
165 the user to have multiple version of helm in operating system and choose
168 **Step 7.** Display the onap charts that available to be deployed::
170 > helm search onap -l
172 .. literalinclude:: helm-search.txt
175 The setup of the Helm repository is a one time activity. If you make changes
176 to your deployment charts or values be sure to use ``make`` to update your
177 local Helm repository.
179 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
183 The ``--timeout 900`` is currently required in Guilin and up to address long
184 running initialization tasks for DMaaP and SO. Without this timeout value both
185 applications may fail to deploy.
188 We've added the master password on the command line.
189 You shouldn't put it in a file for safety reason
190 please don't forget to change the value to something random
192 A space is also added in front of the command so "history" doesn't catch it.
193 This masterPassword is very sensitive, please be careful!
196 To deploy all ONAP applications use this command::
199 > 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
201 All override files may be customized (or replaced by other overrides) as per
205 Enables the modules in the ONAP deployment. As ONAP is very modular, it is
206 possible to customize ONAP and disable some components through this
209 `onap-all-ingress-nginx-vhost.yaml`
210 Alternative version of the `onap-all.yaml` but with global ingress controller
211 enabled. It requires the cluster configured with the nginx ingress controller
212 and load balancer. Please use this file instead `onap-all.yaml` if you want
213 to use experimental ingress controller feature.
216 Includes configuration values specific to the deployment environment.
218 Example: adapt readiness and liveness timers to the level of performance of
222 Includes all the OpenStack related information for the default target tenant
223 you want to use to deploy VNFs from ONAP and/or additional parameters for the
226 **Step 9.** Verify ONAP installation
228 Use the following to monitor your deployment and determine when ONAP is ready
231 > kubectl get pods -n onap -o=wide
234 While all pods may be in a Running state, it is not a guarantee that all components are running fine.
236 Launch the healthcheck tests using Robot to verify that the components are healthy::
238 > ~/oom/kubernetes/robot/ete-k8s.sh onap health
240 Launch Robot distribute health checks to verify whether ONAP runtime components are healthy::
242 > ~/oom/kubernetes/robot/ete-k8s.sh onap healthdist
244 **Step 10.** Undeploy ONAP
247 > helm undeploy dev --purge
249 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins