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