Wrong value format in measurment ves example
[oam.git] / docs / config-deploy.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2020 highstreet technologies and others
4
5 OAM Controller Configuration and Deployment
6 ===========================================
7
8 This documents the configuration and deployment of the O-RAN SC O1 Controller as
9 part of the SMO implementations by the ONAP project.
10
11 The SMO deployment for O-RAN-SC Bronze Release bases on ONAP-Frankfurt-Release
12
13 This procedure provides:
14 * ONAP-DCAE
15 * ONAP-DMaaP
16 * ONAP-SDNC (single node, SMO functionality)
17
18 Limitations (wip)
19 -----------------
20 * ONAP-AAF: not yet supported
21
22 Prerequisites
23 -------------
24 * kubernetes cluster (1.13.5)
25 * helm installation (2.16.x)
26 * More details: `setup cloud environment(openstack/kubernetes) <https://docs.onap.org/en/elalto/guides/onap-developer/settingup/index.html>`_
27
28 Setup
29 -----
30
31 * clone oom repo from gerrit.onap.org
32 * fetch patchset for ONAP-SDNC
33
34 .. code-block:: RST
35   :linenos:
36
37    mkdir ~/workspace
38    cd ~/workspace
39    git clone -b frankfurt http://gerrit.onap.org/r/oom --recurse-submodules oom_smo
40    cd oom_smo
41    git fetch "https://gerrit.onap.org/r/oom" refs/changes/31/106331/6 && git checkout FETCH_HEAD
42    # HEAD is now at 275f7de9 [SDNC] oom for clustered disaggregated SDN-R
43    sudo cp -R ~/workspace/oom_smo/kubernetes/helm/plugins/ ~/.helm
44
45 * verify if local helm repo is available, otherwise follow instructions in onap setup
46
47 .. code-block:: RST
48   :linenos:
49
50   helm repo list
51   #NAME    URL
52   #stable  https://kubernetes-charts.storage.googleapis.com
53   #local   http://127.0.0.1:8879
54   
55 * build local onap helm repo
56
57 .. code-block:: RST
58   :linenos:
59  
60   cd ~/workspace/oom_smo/kubernetes
61   make all; make onap
62   # take a coffee
63   helm search onap
64
65 * create an overwrite yaml file, e.g. deploy_smo_bronce.yaml
66
67 In Kubernetes deployment, all file contents are provided by a
68 configuration map. Construction of Helm charts, config maps and other
69 Kubernetes deployment resources is beyond the scope of this document.
70
71 .. code-block:: RST
72   :linenos:
73
74   cat ~/workspace/smo/deploy_smo_bronce.yaml
75   # Copyright © 2020 Amdocs, Bell Canada, highstreet technologies GmbH
76   #
77   # Licensed under the Apache License, Version 2.0 (the "License");
78   # you may not use this file except in compliance with the License.
79   # You may obtain a copy of the License at
80   #
81   #       http://www.apache.org/licenses/LICENSE-2.0
82   #
83   # Unless required by applicable law or agreed to in writing, software
84   # distributed under the License is distributed on an "AS IS" BASIS,
85   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
86   # See the License for the specific language governing permissions and
87   # limitations under the License.
88    
89   ###################################################################
90   # This override file enables helm charts for all ONAP applications.
91   ###################################################################
92   global:
93     aafEnabled: false
94     masterPassword: Berlin1234!
95   cassandra:
96     enabled: false
97   mariadb-galera:
98     enabled: true
99   aaf:
100     enabled: false
101   aai:
102     enabled: false
103   appc:
104     enabled: false
105   clamp:
106     enabled: false
107   cli:
108     enabled: false
109   consul:
110     enabled: true
111   contrib:
112     enabled: false
113   dcaegen2:
114     enabled: true
115   dmaap:
116     enabled: true
117   esr:
118     enabled: false
119   log:
120     enabled: false
121   sniro-emulator:
122     enabled: false
123   oof:
124     enabled: false
125   msb:
126     enabled: true
127   multicloud:
128     enabled: false
129   nbi:
130     enabled: false
131   policy:
132     enabled: false
133   pomba:
134     enabled: false
135   portal:
136     enabled: false
137   robot:
138     enabled: false
139   sdc:
140     enabled: false
141   sdnc:
142     enabled: true
143     replicaCount: 1
144     config:
145       sdnr:
146         sdnrwt: true 
147         sdnronly: true
148         sdnrmode: dm
149         mountpointRegistrarEnabled: true
150         mountpointStateProviderEnabled: true
151     cds:
152       enabled: false
153     dmaap-listener:
154       enabled: false
155     ueb-listener:
156       enabled: false
157     sdnc-portal:
158       enabled: false
159     sdnc-ansible-server:
160       enabled: false
161     dgbuilder:
162       enabled: false
163     sdnc-web:
164       enabled: false
165   so:
166     enabled: false
167   uui:
168     enabled: false
169   vfc:
170     enabled: false
171   vid:
172     enabled: false
173   vnfsdk:
174     enabled: false
175   modeling:
176     enabled: false
177
178
179 * deploy smo
180
181 .. code-block:: RST
182   :linenos:
183
184   helm -n dev-smo local/onap -f ~/workspace/smo/deploy_smo_bronce.yaml --namespace onap --timeout 900
185
186 * verify deployment
187
188 .. code-block:: RST
189   :linenos:
190
191   helm ls
192
193 * verify pnf-registration, fault notification use case
194
195 Please open the O1 Dashboard: http://localhost:8181/odlux/index.html