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:: images/oom_logo/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
35 **Step 2.** Install Helm Plugins required to deploy ONAP::
37 > cp -R ~/oom/kubernetes/helm/plugins/ ~/.local/share/helm/plugins
38 > helm plugin install https://github.com/chartmuseum/helm-push.git \
42 The ``--version 0.9.0`` is required as new version of helm (3.7.0 and up) is
43 now using ``push`` directly and helm-push is using ``cm-push`` starting
44 version ``0.10.0`` and up.
46 **Step 3.** Install Chartmuseum::
48 > curl -LO https://s3.amazonaws.com/chartmuseum/release/latest/bin/linux/amd64/chartmuseum
49 > chmod +x ./chartmuseum
50 > mv ./chartmuseum /usr/local/bin
52 **Step 4.** Install Cert-Manager::
54 > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.2.0/cert-manager.yaml
56 More details can be found :doc:`here <oom_setup_paas>`.
58 **Step 4.1** Install Strimzi Kafka Operator:
62 > helm repo add strimzi https://strimzi.io/charts/
64 - Install the operator::
66 > helm install strimzi-kafka-operator strimzi/strimzi-kafka-operator --namespace strimzi-system --version 0.28.0 --set watchAnyNamespace=true --create-namespace
68 More details can be found :doc:`here <oom_setup_paas>`.
70 **Step 5.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or
71 an override file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file
72 to suit your deployment with items like the OpenStack tenant information.
75 Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`)
76 can be found in the `oom/kubernetes/onap/resources/overrides/` directory.
79 a. You may want to selectively enable or disable ONAP components by changing
80 the ``enabled: true/false`` flags.
83 b. Encrypt the OpenStack password using the shell tool for Robot and put it in
84 the Robot Helm charts or Robot section of `openstack.yaml`
87 c. Encrypt the OpenStack password using the java based script for SO Helm
88 charts or SO section of `openstack.yaml`.
91 d. Update the OpenStack parameters that will be used by Robot, SO and APPC Helm
92 charts or use an override file to replace them.
94 e. Add in the command line a value for the global master password
95 (global.masterPassword).
99 a. Enabling/Disabling Components:
100 Here is an example of the nominal entries that need to be provided.
101 We have different values file available for different contexts.
103 .. literalinclude:: ../kubernetes/onap/values.yaml
107 b. Generating ROBOT Encrypted Password:
108 The Robot encrypted Password uses the same encryption.key as SO but an
109 openssl algorithm that works with the python based Robot Framework.
112 To generate Robot ``openStackEncryptedPasswordHere``::
114 cd so/resources/config/mso/
115 /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``
117 c. Generating SO Encrypted Password:
118 The SO Encrypted Password uses a java based encryption utility since the
119 Java encryption library is not easy to integrate with openssl/python that
120 Robot uses in Dublin and upper versions.
123 To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
124 ensure `default-jdk` is installed::
126 apt-get update; apt-get install default-jdk
130 SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
131 OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
133 git clone http://gerrit.onap.org/r/integration
134 cd integration/deployment/heat/onap-rke/scripts
137 java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
139 d. Update the OpenStack parameters:
141 There are assumptions in the demonstration VNF Heat templates about the
142 networking available in the environment. To get the most value out of these
143 templates and the automation that can help confirm the setup is correct, please
144 observe the following constraints.
147 ``openStackPublicNetId:``
148 This network should allow Heat templates to add interfaces.
149 This need not be an external network, floating IPs can be assigned to the
150 ports on the VMs that are created by the heat template but its important that
151 neutron allow ports to be created on them.
153 ``openStackPrivateNetCidr: "10.0.0.0/16"``
154 This ip address block is used to assign OA&M addresses on VNFs to allow ONAP
155 connectivity. The demonstration Heat templates assume that 10.0 prefix can be
156 used by the VNFs and the demonstration ip addressing plan embodied in the
157 preload template prevent conflicts when instantiating the various VNFs. If
158 you need to change this, you will need to modify the preload data in the
159 Robot Helm chart like integration_preload_parameters.py and the
160 demo/heat/preload_data in the Robot container. The size of the CIDR should
161 be sufficient for ONAP and the VMs you expect to create.
163 ``openStackOamNetworkCidrPrefix: "10.0"``
164 This ip prefix mush match the openStackPrivateNetCidr and is a helper
165 variable to some of the Robot scripts for demonstration. A production
166 deployment need not worry about this setting but for the demonstration VNFs
167 the ip asssignment strategy assumes 10.0 ip prefix.
169 Example Keystone v2.0
171 .. literalinclude:: yaml/example-integration-override.yaml
174 Example Keystone v3 (required for Rocky and later releases)
176 .. literalinclude:: yaml/example-integration-override-v3.yaml
180 **Step 6.** To setup a local Helm server to server up the ONAP charts::
182 > chartmuseum --storage local --storage-local-rootdir ~/helm3-storage -port 8879 &
184 Note the port number that is listed and use it in the Helm repo add as
187 > helm repo add local http://127.0.0.1:8879
189 **Step 7.** Verify your Helm repository setup with::
193 local http://127.0.0.1:8879
195 **Step 8.** Build a local Helm repository (from the kubernetes directory)::
197 > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all ; make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] onap
200 Sets the helm binary to be used. The default value use helm from PATH
203 **Step 9.** Display the onap charts that available to be deployed::
206 > helm search repo onap
208 .. literalinclude:: helm/helm-search.txt
211 The setup of the Helm repository is a one time activity. If you make changes
212 to your deployment charts or values be sure to use ``make`` to update your
213 local Helm repository.
215 **Step 10.** Once the repo is setup, installation of ONAP can be done with a
219 The ``--timeout 900s`` is currently required in Dublin and later
220 versions up to address long running initialization tasks for DMaaP
221 and SO. Without this timeout value both applications may fail to
225 We've added the master password on the command line.
226 You shouldn't put it in a file for safety reason
227 please don't forget to change the value to something random
229 A space is also added in front of the command so "history" doesn't catch it.
230 This masterPassword is very sensitive, please be careful!
233 To deploy all ONAP applications use this command::
236 > 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
238 All override files may be customized (or replaced by other overrides) as per
242 Enables the modules in the ONAP deployment. As ONAP is very modular, it is
243 possible to customize ONAP and disable some components through this
246 `onap-all-ingress-nginx-vhost.yaml`
247 Alternative version of the `onap-all.yaml` but with global ingress controller
248 enabled. It requires the cluster configured with the nginx ingress controller
249 and load balancer. Please use this file instead `onap-all.yaml` if you want
250 to use experimental ingress controller feature.
253 Includes configuration values specific to the deployment environment.
255 Example: adapt readiness and liveness timers to the level of performance of
259 Includes all the OpenStack related information for the default target tenant
260 you want to use to deploy VNFs from ONAP and/or additional parameters for the
263 **Step 11.** Verify ONAP installation
265 Use the following to monitor your deployment and determine when ONAP is ready
268 > kubectl get pods -n onap -o=wide
271 While all pods may be in a Running state, it is not a guarantee that all
272 components are running fine.
274 Launch the healthcheck tests using Robot to verify that the components are
277 > ~/oom/kubernetes/robot/ete-k8s.sh onap health
279 **Step 12.** Undeploy ONAP
284 More examples of using the deploy and undeploy plugins can be found here:
285 https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins