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
31 **Step 2.** Install Helm Plugins required to deploy ONAP::
33 > cp -R ~/oom/kubernetes/helm/plugins/ ~/.local/share/helm/plugins
34 > helm plugin install https://github.com/chartmuseum/helm-push.git
36 **Step 3** Install Chartmuseum::
38 > curl -LO https://s3.amazonaws.com/chartmuseum/release/latest/bin/linux/amd64/chartmuseum
39 > chmod +x ./chartmuseum
40 > mv ./chartmuseum /usr/local/bin
42 **Step 4.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or
43 an override file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file
44 to suit your deployment with items like the OpenStack tenant information.
47 Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) can be found in
48 the `oom/kubernetes/onap/resources/overrides/` directory.
51 a. You may want to selectively enable or disable ONAP components by changing
52 the ``enabled: true/false`` flags.
55 b. Encrypt the OpenStack password using the shell tool for Robot and put it in
56 the Robot Helm charts or Robot section of `openstack.yaml`
59 c. Encrypt the OpenStack password using the java based script for SO Helm charts
60 or SO section of `openstack.yaml`.
63 d. Update the OpenStack parameters that will be used by Robot, SO and APPC Helm
64 charts or use an override file to replace them.
66 e. Add in the command line a value for the global master password (global.masterPassword).
70 a. Enabling/Disabling Components:
71 Here is an example of the nominal entries that need to be provided.
72 We have different values file available for different contexts.
74 .. literalinclude:: ../kubernetes/onap/values.yaml
78 b. Generating ROBOT Encrypted Password:
79 The Robot encrypted Password uses the same encryption.key as SO but an
80 openssl algorithm that works with the python based Robot Framework.
83 To generate Robot ``openStackEncryptedPasswordHere``::
85 cd so/resources/config/mso/
86 /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``
88 c. Generating SO Encrypted Password:
89 The SO Encrypted Password uses a java based encryption utility since the
90 Java encryption library is not easy to integrate with openssl/python that
91 Robot uses in Dublin and upper versions.
94 To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
95 ensure `default-jdk` is installed::
97 apt-get update; apt-get install default-jdk
101 SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
102 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
104 git clone http://gerrit.onap.org/r/integration
105 cd integration/deployment/heat/onap-rke/scripts
108 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
110 d. Update the OpenStack parameters:
112 There are assumptions in the demonstration VNF Heat templates about the
113 networking available in the environment. To get the most value out of these
114 templates and the automation that can help confirm the setup is correct, please
115 observe the following constraints.
118 ``openStackPublicNetId:``
119 This network should allow Heat templates to add interfaces.
120 This need not be an external network, floating IPs can be assigned to the
121 ports on the VMs that are created by the heat template but its important that
122 neutron allow ports to be created on them.
124 ``openStackPrivateNetCidr: "10.0.0.0/16"``
125 This ip address block is used to assign OA&M addresses on VNFs to allow ONAP
126 connectivity. The demonstration Heat templates assume that 10.0 prefix can be
127 used by the VNFs and the demonstration ip addressing plan embodied in the
128 preload template prevent conflicts when instantiating the various VNFs. If
129 you need to change this, you will need to modify the preload data in the
130 Robot Helm chart like integration_preload_parameters.py and the
131 demo/heat/preload_data in the Robot container. The size of the CIDR should
132 be sufficient for ONAP and the VMs you expect to create.
134 ``openStackOamNetworkCidrPrefix: "10.0"``
135 This ip prefix mush match the openStackPrivateNetCidr and is a helper
136 variable to some of the Robot scripts for demonstration. A production
137 deployment need not worry about this setting but for the demonstration VNFs
138 the ip asssignment strategy assumes 10.0 ip prefix.
140 Example Keystone v2.0
142 .. literalinclude:: example-integration-override.yaml
145 Example Keystone v3 (required for Rocky and later releases)
147 .. literalinclude:: example-integration-override-v3.yaml
151 **Step 5.** To setup a local Helm server to server up the ONAP charts::
153 > chartmuseum --storage local --storage-local-rootdir ~/helm3-storage -port 8879 &
155 Note the port number that is listed and use it in the Helm repo add as
158 > helm repo add local http://127.0.0.1:8879
160 **Step 6.** Verify your Helm repository setup with::
164 local http://127.0.0.1:8879
166 **Step 7.** Build a local Helm repository (from the kubernetes directory)::
168 > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all ; make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] onap
171 Sets the helm binary to be used. The default value use helm from PATH
174 **Step 8.** Display the onap charts that available to be deployed::
177 > helm search repo onap
179 .. literalinclude:: helm-search.txt
182 The setup of the Helm repository is a one time activity. If you make changes
183 to your deployment charts or values be sure to use ``make`` to update your
184 local Helm repository.
186 **Step 9.** Once the repo is setup, installation of ONAP can be done with a
190 The ``--timeout 900s`` is currently required in Dublin and later
191 versions up to address long running initialization tasks for DMaaP
192 and SO. Without this timeout value both applications may fail to
196 We've added the master password on the command line.
197 You shouldn't put it in a file for safety reason
198 please don't forget to change the value to something random
200 A space is also added in front of the command so "history" doesn't catch it.
201 This masterPassword is very sensitive, please be careful!
204 To deploy all ONAP applications use this command::
207 > helm deploy dev local/onap --namespace onap --create-namespace --set global.masterPassword=myAwesomePasswordThatINeedToChange -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900s
209 All override files may be customized (or replaced by other overrides) as per
213 Enables the modules in the ONAP deployment. As ONAP is very modular, it is
214 possible to customize ONAP and disable some components through this
217 `onap-all-ingress-nginx-vhost.yaml`
218 Alternative version of the `onap-all.yaml` but with global ingress controller
219 enabled. It requires the cluster configured with the nginx ingress controller
220 and load balancer. Please use this file instead `onap-all.yaml` if you want
221 to use experimental ingress controller feature.
224 Includes configuration values specific to the deployment environment.
226 Example: adapt readiness and liveness timers to the level of performance of
230 Includes all the OpenStack related information for the default target tenant
231 you want to use to deploy VNFs from ONAP and/or additional parameters for the
234 **Step 10.** Verify ONAP installation
236 Use the following to monitor your deployment and determine when ONAP is ready
239 > kubectl get pods -n onap -o=wide
242 While all pods may be in a Running state, it is not a guarantee that all components are running fine.
244 Launch the healthcheck tests using Robot to verify that the components are healthy::
246 > ~/oom/kubernetes/robot/ete-k8s.sh onap health
248 **Step 11.** Undeploy ONAP
253 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins