Documentation updated for Bronze

Several links ot ONAP read-the-doc Frankfurt release added.

Issue-ID: OAM-18
Signed-off-by: demx8as6 <martin.skorupski@highstreet-technologies.com>
Change-Id: I0e9e0f58761928edfe4ecce9ec01d1f186fbfadd

diff --git a/docs/config-deploy.rst b/docs/config-deploy.rst
new file mode 100644 (file)
index 0000000..f46954d
--- /dev/null
+++ b/docs/config-deploy.rst
@@ -0,0 +1,203 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 highstreet technologies and others
+
+OAM Controller at SMO Configuration and Deployment
+==================================================
+
+TOBEREMOVED 
+
+.. code-block:: ruby
+
+   Some Ruby code.
+
+
+
+This documents the configuration and deployment of the O-RAN SC O1 Controller as
+part of the SMO implementations by the ONAP project.
+
+The SMO deployment for O-RAN-SC Bronze Release bases on ONAP-Frankfurt-Release
+
+This procedure provides:
+* ONAP-DCAE
+* ONAP-DMaaP
+* ONAP-SDNC (single node, SMO functionality)
+
+Limitations (wip)
+-----------------
+* ONAP-AAF: not yet supported
+
+Prerequisites
+-------------
+* kubernetes cluster (1.13.5)
+* helm installation (2.16.x)
+* More details: `setup cloud environment(openstack/kubernetes) <https://docs.onap.org/en/elalto/guides/onap-developer/settingup/index.html>`_
+
+Setup
+-----
+
+* clone oom repo from gerrit.onap.org
+* fetch patchset for ONAP-SDNC
+
+.. code-block:: RST
+  :linenos:
+
+   mkdir ~/workspace
+   cd ~/workspace
+   git clone -b frankfurt http://gerrit.onap.org/r/oom --recurse-submodules oom_smo
+   cd oom_smo
+   git fetch "https://gerrit.onap.org/r/oom" refs/changes/31/106331/6 && git checkout FETCH_HEAD
+   # HEAD is now at 275f7de9 [SDNC] oom for clustered disaggregated SDN-R
+   sudo cp -R ~/workspace/oom_smo/kubernetes/helm/plugins/ ~/.helm
+
+* verifiy if local helm repo is available, otherwise follow intructions in onap setup
+
+.. code-block:: RST
+  :linenos:
+
+  helm repo list
+  #NAME    URL
+  #stable  https://kubernetes-charts.storage.googleapis.com
+  #local   http://127.0.0.1:8879
+  
+* build local onap helm repo
+
+.. code-block:: RST
+  :linenos:
+ 
+  cd ~/workspace/oom_smo/kubernetes
+  make all; make onap
+  # take a coffee
+  helm search onap
+
+* create an overwrite yaml file, e.g. deploy_smo_bronce.yaml
+
+In Kubernetes deployment, all file contents are provided by a
+configuration map. Construction of Helm charts, config maps and other
+Kubernetes deployment resources is beyond the scope of this document.
+
+.. code-block:: RST
+  :linenos:
+
+  cat ~/workspace/smo/deploy_smo_bronce.yaml
+  # Copyright © 2020 Amdocs, Bell Canada, highstreet technologies GmbH
+  #
+  # Licensed under the Apache License, Version 2.0 (the "License");
+  # you may not use this file except in compliance with the License.
+  # You may obtain a copy of the License at
+  #
+  #       http://www.apache.org/licenses/LICENSE-2.0
+  #
+  # Unless required by applicable law or agreed to in writing, software
+  # distributed under the License is distributed on an "AS IS" BASIS,
+  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  # See the License for the specific language governing permissions and
+  # limitations under the License.
+   
+  ###################################################################
+  # This override file enables helm charts for all ONAP applications.
+  ###################################################################
+  global:
+    aafEnabled: false
+    masterPassword: Berlin1234!
+  cassandra:
+    enabled: false
+  mariadb-galera:
+    enabled: true
+  aaf:
+    enabled: false
+  aai:
+    enabled: false
+  appc:
+    enabled: false
+  clamp:
+    enabled: false
+  cli:
+    enabled: false
+  consul:
+    enabled: true
+  contrib:
+    enabled: false
+  dcaegen2:
+    enabled: true
+  dmaap:
+    enabled: true
+  esr:
+    enabled: false
+  log:
+    enabled: false
+  sniro-emulator:
+    enabled: false
+  oof:
+    enabled: false
+  msb:
+    enabled: true
+  multicloud:
+    enabled: false
+  nbi:
+    enabled: false
+  policy:
+    enabled: false
+  pomba:
+    enabled: false
+  portal:
+    enabled: false
+  robot:
+    enabled: false
+  sdc:
+    enabled: false
+  sdnc:
+    enabled: true
+    replicaCount: 1
+    config:
+      sdnr:
+        sdnrwt: true 
+        sdnronly: true
+        sdnrmode: dm
+        mountpointRegistrarEnabled: true
+        mountpointStateProviderEnabled: true
+    cds:
+      enabled: false
+    dmaap-listener:
+      enabled: false
+    ueb-listener:
+      enabled: false
+    sdnc-portal:
+      enabled: false
+    sdnc-ansible-server:
+      enabled: false
+    dgbuilder:
+      enabled: false
+    sdnc-web:
+      enabled: false
+  so:
+    enabled: false
+  uui:
+    enabled: false
+  vfc:
+    enabled: false
+  vid:
+    enabled: false
+  vnfsdk:
+    enabled: false
+  modeling:
+    enabled: false
+
+
+* deploy smo
+
+.. code-block:: RST
+  :linenos:
+
+  helm -n dev-smo local/onap -f ~/workspace/smo/deploy_smo_bronce.yaml --namespace onap --timeout 900
+
+* verifiy deployment
+
+.. code-block:: RST
+  :linenos:
+
+  helm ls
+
+* verifiy pnf-registration, fault notification use case
+
+Please open the O1 Dashboard: http://localhost:8181/odlux/index.html

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
new file mode 100644 (file)
index 0000000..211480d
--- /dev/null
+++ b/docs/developer-guide.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 highstreet technologies and others
+
+OAM Developer Guide
+===================
+
+This document provides a quickstart for developers of the O-RAN SC OAM components.
+
+All informations fo development are documented in coorespondding O-RAN-SC wiki:
+https://wiki.o-ran-sc.org/display/OAM/Operations+and+Maintenance

diff --git a/docs/index.rst b/docs/index.rst
index c243ffb..3ce7271 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,6 +15,9 @@ OAM Operation and Maintenance
    :caption: Contents:
 
    overview.rst
+   config-deploy.rst
+   developer-guide.rst
+   user-guide.rst
    release-notes.rst
 
 * :ref:`search`

diff --git a/docs/overview.rst b/docs/overview.rst
index e66e599..d01358d 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -16,20 +16,18 @@ O-RAN Working Group1.
 Project Resources
 -----------------
 
-The source code is available from the Linux Foundation Gerrit server:
+The project uses the following Linux Foundation resources:
 
+* The source code is maintained in this Gerrit:
     `<https://gerrit.o-ran-sc.org/r/admin/repos/oam>`_
 
-The build (CI) jobs are in the Linux Foundation Jenkins server:
-
+* The build (CI) jobs are in this Jenkins:
     `<https://jenkins.o-ran-sc.org/view/oam/>`_
 
-Issues are tracked in the Linux Foundation Jira server:
-
+* Issues are tracked in this Jira:
     `<https://jira.o-ran-sc.org/projects/OAM/>`_
 
-Project information is available in the Linux Foundation Wiki:
-
+* Project information is available in this Wiki:
     `<https://wiki.o-ran-sc.org/display/OAM/Operations+and+Maintenance>`_
 
 

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 84282f5..32e3d42 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2019 highstreet technologies GmbH
+.. Copyright (C) 2020 highstreet technologies GmbH
 
 
 Operation and Maintenance Release Notes
@@ -12,39 +12,55 @@ This document provides the release notes for O-RAN-SC Amber release of the Opera
    :depth: 3
    :local:
 
+Version 2.0.4, 2020-06-13
+--------------------------
 
-Version history
----------------
+* Documentation updated
+* Develop reusable OAM API such that the first consumer being a VTH can query, subscribe or publish on a DMAAP topic   Story
+* Create helm deployment for SMO
+* Featuresplit for starting devicemanages
+* Seed coder for an YANG linter
+* Please see also Release Notes of `ONAP SDNC <https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/release-notes.html#release-notes>`_ and `ONAP OOM <https://onap-doc.readthedocs.io/projects/onap-oom/en/frankfurt/release-notes.html#release-notes>`_
 
-+--------------------+--------------------+--------------------+--------------------+
-| **Date**           | **Ver.**           | **Author**         | **Comment**        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2019-09-08         | 0.1.0              |                    | Initial Version    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2019-09-18         | 0.1.1              |                    | Initial Version    |
-|                    |                    |                    | DEV environment    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2019-11-14         | 1.0.0              |                    | Docs added         |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
+Version 2.0.3, 2020-04-08
+-------------------------
 
+* What is an SMO?
+* Provide xRAN datamodels
+* Provide curl bash scripts for Software Management
+* Add jenkins jobs for oam
+* Add parents to model artifacts
+* Add top level pom file to distribution
+* Wrong image tag in nonrt-o1-controller distribution pom
+* Use ONAP release parents directly
+* Adjust artifact group name to ORAN naming rule
+* Use ORAN parents
+* Add push registry to distribution pom
 
-Summary
--------
+Version 2.0.2, 2020-03-16
+-------------------------
 
-According to the O-RAN-SC-OAM-Architecture document all ManagedElements 
-(near-real-time-RIC, O-CU-CP, O-CU-UP, O-DU and O-RU) implement the O1-interface.
+* Controller DeviceManager for O-RAN-SC
+* Provide O1 yang modules
 
-The O-RAN-OAM-interface specification defines
+Version 2.0.1, 2020-02-26
+-------------------------
 
-a NetConf-Server for Configuration Management (CM) and
-a http-client for Fault Managment (FM), Performance Management (PM) and other events
-on each Management-Service-Provider (MnS-Provider) running on the ManagedElement (ME).
+* Develop VTH for A1 interface
 
 
+Version 1.0.0, 2019-11-14
+-------------------------
 
-The O-RAN-SC-OAM project provides reference implementation according to the O-RAN OAM (WG1) documents. 
-In addition we provide a common MnS-Consumer for development and module test purposes. 
-The assumption is that the projects for the ManagedElements can concentrate on the more important user-plane.
+* Documentation added
+
+
+Version 0.1.1, 2019-09-18
+-------------------------
+
+* Development environment added
+
+
+Version 0.1.0, 2019-09-08
+-------------------------
+* Initial version

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
new file mode 100644 (file)
index 0000000..5e11de1
--- /dev/null
+++ b/docs/user-guide.rst
@@ -0,0 +1,10 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2020 highstreet technologies and others
+
+OAM User Guide
+==============
+
+This document provides a quickstart for users of the O-RAN SC O1 web application.
+
+Please see documentation of ODLUX Applications in ONAP: docs.onap.org/en/frankfurt/submodules/ccsdk/features.git/docs/guides/onap-user/applications.html
\ No newline at end of file