1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Amdocs, Bell Canada
10 .. figure:: oomLogoV2-medium.png
13 Once a kubernetes environment is available (follow the instructions in
14 :ref:`cloud-setup-guide-label` if you don't have a cloud environment
15 available), follow the following instructions to deploy ONAP.
17 **Step 1.** Clone the OOM repository from ONAP gerrit::
19 > git clone -b beijing http://gerrit.onap.org/r/oom
23 **Step 2.** Customize the onap/values.yaml file to suit your deployment. You
24 may want to selectively enable or disable ONAP components by changing the
25 `enabled: true/false` flags as shown below:
29 #################################################################
30 # Global configuration overrides.
32 # These overrides will affect all helm charts (ie. applications)
33 # that are listed below and are 'enabled'.
34 #################################################################
36 # Change to an unused port prefix range to prevent port conflicts
37 # with other instances running within the same k8s cluster
41 repository: nexus3.onap.org:10001
42 repositorySecret: eyJuZXh1czMub25hcC5vcmc6MTAwMDEiOnsidXNlcm5hbWUiOiJkb2NrZXIiLCJwYXNzd29yZCI6ImRvY2tlciIsImVtYWlsIjoiQCIsImF1dGgiOiJaRzlqYTJWeU9tUnZZMnRsY2c9PSJ9fQ==
44 readinessRepository: oomk8s
46 loggingRepository: docker.elastic.co
51 # default mount path root directory referenced
52 # by persistent volumes and log files
54 mountPath: /dockerdata-nfs
56 # flag to enable debugging - application support required
59 #################################################################
60 # Enable/disable and configure helm charts (ie. applications)
61 # to customize the ONAP deployment.
62 #################################################################
73 consul: # Consul Health Check Monitoring
93 robot: # Robot Health Check
99 so: # Service Orchestrator
105 # necessary to disable liveness probe when setting breakpoints
106 # in debugger so K8s doesn't restart unresponsive container
109 # so server configuration
111 # message router configuration
113 # openstack configuration
114 openStackUserName: "vnf_user"
115 openStackRegion: "RegionOne"
116 openStackKeyStoneUrl: "http://1.2.3.4:5000"
117 openStackServiceTenantName: "service"
118 openStackEncryptedPasswordHere: "c124921a3a0efbe579782cde8227681e"
120 # configure embedded mariadb
123 mariadbRootPassword: password
134 To generate openStackEncryptedPasswordHere :
136 root@olc-rancher:~# cd so/resources/config/mso/
138 root@olc-rancher:~/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
140 **Step 3.** To setup a local Helm server to server up the ONAP charts::
144 Note the port number that is listed and use it in the Helm repo add as
147 > helm repo add local http://127.0.0.1:8879
149 **Step 4.** Verify your Helm repository setup with::
153 local http://127.0.0.1:8879
155 **Step 5.** Build a local Helm repository (from the kubernetes directory)::
159 **Step 6.** Display the charts that available to be deployed::
162 NAME VERSION DESCRIPTION
163 local/appc 2.0.0 Application Controller
164 local/clamp 2.0.0 ONAP Clamp
165 local/common 2.0.0 Common templates for inclusion in other charts
166 local/onap 2.0.0 Open Network Automation Platform (ONAP)
167 local/robot 2.0.0 A helm Chart for kubernetes-ONAP Robot
168 local/so 2.0.0 ONAP Service Orchestrator
171 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.
173 **Step 7.** Once the repo is setup, installation of ONAP can be done with a
176 > helm install local/onap -n dev --namespace onap
179 The requirement for the use of the `onap` namespace will be lifted once the OOM team completes their Beijing deveivers.
181 Use the following to monitor your deployment and determine when ONAP is ready for use::
183 > kubectl get pods --all-namespaces -o=wide