[DCAE] R10 misc doc updates
Change-Id: I42df794af1165bda7f8ddecaab35cb391ead15f0
Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
Issue-ID: DCAEGEN2-2973
Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
diff --git a/docs/sections/build.rst b/docs/sections/build.rst
index 5323c3a..eda50be 100644
--- a/docs/sections/build.rst
+++ b/docs/sections/build.rst
@@ -1,4 +1,4 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+ .. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. _build:
@@ -21,76 +21,52 @@
- docs (rst)
- platformdoc (mkdoc)
-* dcaegen2.analytics
-
-
* dcaegen2.analytics.tca-gen2
- dcae-analytics (Java)
- eelf-logger (Java)
-
-* dcaegen2.collectors
- - dcaegen2.collectors.snmptrap (Python)
- - dcaegen2.collectors.ves (Java)
- - dcaegen2.collectors.hv-ves (Kotlin)
- - dcaegen2.collectors.datafile (Java)
- - dcaegen2.collectors.restconf (Java)
+* dcaegen2.collectors.snmptrap (Python)
+
+* dcaegen2.collectors.ves (Java)
+
+* dcaegen2.collectors.hv-ves (Kotlin)
+
+* dcaegen2.collectors.datafile (Java)
+
+* dcaegen2.collectors.restconf (Java)
* dcaegen2.services
- - dcaegen2.services.heartbeat (Python)
- - dcaegen2.services.prh (Java)
- - dcaegen2.services.bbs-eventprocessor (Java)
- - dcaegen2.services.pm-mapper (Java)
- - dcaegen2.services.ves-mapper (Java)
- - dcaegen2.services.son-handler (Java)
- dcaegen2.services.kpi-ms (Java)
- dcaegen2.services.pmsh (Python)
- dcaegen2.services.datalake-handler (Java)
+ - dcaegen2.services.slice-analysis-ms (Java)
+
+* dcaegen2.services.heartbeat (Python)
+
+* dcaegen2.services.prh (Java)
+
+* dcaegen2.services.pm-mapper (Java)
+
+* dcaegen2.services.ves-mapper (Java)
* dcaegen2.services.son-handler (Java)
-
+
* dcaegen2.deployments
- scripts (bash, python)
- tls-init-container (bash)
- - k8s-bootstrap-container (bash)
- healthcheck-container (Node.js)
- - k8s-bootstrap-container (bash)
- - tca-cdap-container (bash)
- - multisite-init-container (python)
- - dcae-remote-site (helm chart)
* dcaegen2.platform
-* dcaegen2.platform.blueprints
-
- - blueprints (yaml)
- - input-templates (yaml)
-
* dcaegen2.platform.cli (Python)
- component-json-schemas (yaml)
- dcae-cli (Python)
-* dcaegen2.platform.configbinding (Python)
-
-* dcaegen2.platform.deployment-handler (NodeJS)
-
-* dcaegen2.platform.inventory-api (Java)
-
-* dcaegen2.platform.plugins
-
- - dcae-policy (Python)
- - relationships (Python)
- - k8splugin (Python)
-
-* dcaegen2.platform.policy-handler (Python)
-
-* dcaegen2.platform.servicechange-handler (Clojure)
-
* dcaegen2.platform.ves-openapi-manager (Java)
* dcaegen2.utils
@@ -101,10 +77,11 @@
- python-dockering (Python)
- scripts (bash)
+* dcaegen2.services.sdk (Java)
Environment
-----------
-Building is conducted in a Linux environment that has the basic building tools such as JDK 8, Maven 3, Python 2.7 and 3.6, docker engine, etc.
+Building is conducted in a Linux environment that has the basic building tools such as JDK 11, Maven 3.6 or higher, Python 3.x, docker engine, etc.
Steps
@@ -114,7 +91,5 @@
Artifacts
---------
-Building of DCAE projects produce three different kinds of artifacts: Java jar files, raw file artifacts (including yaml files, scripts, wagon packages, etc), Pypi packages, and docker container images.
-
-
+Building of DCAE projects produce three different kinds of artifacts: Java jar files, raw file artifacts (including yaml files, scripts, wagon packages, etc), Pypi packages, and docker container images.
diff --git a/docs/sections/configuration.rst b/docs/sections/configuration.rst
index bd2608f..c12da9e 100644
--- a/docs/sections/configuration.rst
+++ b/docs/sections/configuration.rst
@@ -5,26 +5,36 @@
Configuration
=============
-DACEGEN2 platform is deployed via helm charts. The configuration are maintained as on values.yaml and can be updated for deployment if necessary.
+DACEGEN2 is deployed via helm charts. The configuration are maintained as on values.yaml and can be updated for deployment if necessary.
-For Frankfurt release, the helm charts for each platform component can be controlled via separate override file
-https://wiki.onap.org/pages/viewpage.action?pageId=71837415
+The helm charts for each component can be controlled via a separate override file under its respective component under ``oom/kubernetes/dcaegen2-services/components``
-
-
+Below is a list of DCAE Services and the corresponding helm chart override location.
.. csv-table::
:header: "Component", "Charts"
- :widths: 22,100
+ :widths: 25,100
- "Cloudify", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-cloudify-manager"
- "ConfigBinding Service", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-config-binding-service"
- "Deployment Handler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-deployment-handler"
- "Policy Handler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-policy-handler"
- "ServiceChangeHandler", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-servicechange-handler"
- "Inventory", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-inventory-api"
- "Dashboard", "https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-dashboard"
-
+ "DataFileCollector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-datafile-collector"
+ "DL AdminUI", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-datalake-admin-ui"
+ "DL DES", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-datalake-des"
+ "DL Feeder", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-datalake-feeder"
+ "Heartbeat mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-heartbeat"
+ "HV-VES Collector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-hv-ves-collector"
+ "KPI mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-kpi-ms"
+ "Healthcheck mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-ms-healthcheck"
+ "PM-Mapper", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-pm-mapper"
+ "PMSH", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-pmsh"
+ "PRH", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-prh"
+ "RestConf Collector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-restconf-collector"
+ "SliceAnalysis mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-slice-analysis-ms"
+ "SNMPTrap Collector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-snmptrap-collector"
+ "SON-Handler mS", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-son-handler"
+ "TCAgen2", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-tcagen2"
+ "VESCollector", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-ves-collector"
+ "VESMapper", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-ves-mapper"
+ "VES-OpenAPIManager", "https://git.onap.org/oom/tree/kubernetes/dcaegen2-services/components/dcae-ves-openapi-manager"
+
Deployment time configuration of DCAE components are defined in several places.
@@ -38,54 +48,15 @@
* In a Helm chart hierarchy, values defined in values.yaml files in higher level supersedes values defined in values.yaml files in lower level;
* Helm command line supplied values supersedes values defined in any values.yaml files.
-In addition, for DCAE components deployed through Cloudify Manager blueprints, their configuration parameters are defined in the following places:
- * The blueprint files can contain static values for configuration parameters;
- * The blueprint files are defined under the ``blueprints`` directory of the ``dcaegen2/platform/blueprints`` repo, named with "k8s" prefix.
- * The blueprint files can specify input parameters and the values of these parameters will be used for configuring parameters in Blueprints. The values for these input parameters can be supplied in several ways as listed below in the order of precedence (low to high):
- * The blueprint files can define default values for the input parameters;
- * The blueprint input files can contain static values for input parameters of blueprints. These input files are provided as config resources under the dcae-bootstrap chart;
- * The blueprint input files may contain Helm templates, which are resolved into actual deployment time values following the rules for Helm values.
+All DCAE Service components are deployed only via Helm. Instructions for deployment and configuration are documented under https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html
-DCAE Service components are deployed via Cloudify Blueprints. Instruction for deployment and configuration are documented under https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html
-
-Now we walk through an example, how to configure the Docker image for the DCAE VESCollector, which is deployed by Cloudify Manager.
-
-In the `k8s-ves.yaml <https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-ves.yaml>`_ blueprint, the Docker image to use is defined as an input parameter with a default value:
-
-.. code-block:: yaml
-
- tag_version:
- type: string
- default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
-
-The corresponding input file, ``https://git.onap.org/oom/tree/kubernetes/dcaegen2/components/dcae-bootstrap/resources/inputs/k8s-ves-inputs-tls.yaml``,
-it is defined again as:
-
-.. code-block:: yaml
-
- {{ if .Values.componentImages.ves }}
- tag_version: {{ include "common.repository" . }}/{{ .Values.componentImages.ves }}
- {{ end }}
-
-
-Thus, when ``common.repository`` and ``componentImages.ves`` are defined in the ``values.yaml`` files,
-their values will be plugged in here and the resulting ``tag_version`` value
-will be passed to the blueprint as the Docker image tag to use instead of the default value in the blueprint.
-
-The ``componentImages.ves`` value is provided in the ``oom/kubernetes/dcaegen2/charts/dcae-bootstrap/values.yaml`` file:
-
-.. code-block:: yaml
-
- componentImages:
- ves: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4
-
Config maps
-----------
-During installation of DCAEGEN2 module two config maps are installed by default: dcae-external-repo-configmap-schema-map and dcae-external-repo-configmap-sa88-rel16.
+During the installation of the DCAEGEN2-SERVICES module, two config maps are installed by default: dcae-external-repo-configmap-schema-map and dcae-external-repo-configmap-sa88-rel16.
Config maps are used by DCAEGEN VES and VES OPEN API components.
-Instruction how to generate the content of config maps is described in `README <https://gerrit.onap.org/r/gitweb?p=oom/utils.git;a=blob_plain;f=external-schema-repo-generator/README.md;hb=refs/heads/master>`_ file.
\ No newline at end of file
+Instruction how to generate the content of config maps is described in `README <https://gerrit.onap.org/r/gitweb?p=oom/utils.git;a=blob_plain;f=external-schema-repo-generator/README.md;hb=refs/heads/master>`_ file.
diff --git a/docs/sections/healthcheck.rst b/docs/sections/healthcheck.rst
index b85a1de..b7ec033 100644
--- a/docs/sections/healthcheck.rst
+++ b/docs/sections/healthcheck.rst
@@ -5,110 +5,80 @@
DCAE Health Check
=================
-OOM Deployment
---------------
-In OOM deployments, DCAE healthchecks are performed by a separate service--dcae-healthcheck.
-This service is packaged into a Docker image (``onap/org.onap.dcaegen2.deployments.healthcheck-container``),
+
+HealthCheck Services
+--------------------
+
+DCAE healthchecks are performed by a separate services.
+
+- dcae-ms-healthcheck
+- dcaemod-healthcheck
+
+These service is packaged into a Docker image (``onap/org.onap.dcaegen2.deployments.healthcheck-container``),
which is built in the ``healthcheck-container`` module in the ``dcaegen2/deployments`` repository.
-The service is deployed with a Helm chart (``oom/kubernetes/dcaegen2/charts/dcae-healthcheck``)
-when DCAE is deployed using OOM.
+dcae-ms-healthcheck is deployed along with services enabled under (``oom/kubernetes/dcaegen2-services``)
+dcaemod-healthcheck is deployed along with services enabled under (``oom/kubernetes/dcaemod``)
-The dcae-healthcheck container runs a service that exposes a simple Web API. In response to
+These healthcheck container runs as service that exposes a simple Web API. In response to
request, the service checks Kubernetes to verify that all of the expected
-DCAE platform and service components are in a ready state. The service
-has a fixed list of platform and service components that are normally deployed when DCAE is
-first installed, including components deployed with Helm charts and
-components deployed using Cloudify blueprints. In addition, the healthcheck
-service tracks and checks components that are deployed dynamically using Cloudify
-blueprints after the initial DCAE installation.
+DCAE platform and service components are in a ready state.
+
+The service has a fixed list service components identified by json file - `expected-components.json <https://github.com/onap/oom/blob/master/kubernetes/dcaegen2-services/resources/expected-components.json>`_
+; these are normally deployed when dcaegen2-services is installed. In addition, the healthcheck service also tracks and checks components that are deployed dynamically after the initial DCAE installation.
The healthcheck service is exposed as a Kubernetes ClusterIP Service named
-`dcae-healthcheck`. The service can be queried for status as shown below.
+`dcae-ms-healthcheck`. The service can be queried for status as shown below.
.. note::
- Run the below commands before running "curl dcae-healthcheck"
+ Run the below commands before running "curl dcae-ms-healthcheck"
- * To get the dcae-healthcheck pod name, run this: kubectl get pods -n onap | grep dcae-healthcheck
- * Then enter in to the shell of the container, run this: kubectl exec -it <dcae-healthcheck pod> -n onap bash
+ * To get the dcae-ms-healthcheck pod name, run following command:
+ .. code-block:: bash
+
+ kubectl get pods -n onap | grep dcae-ms-healthcheck
+
+ * Then enter in to the shell of the container, run the following command (substituting the pod name retrieved by the previous command):
+ .. code-block:: bash
+
+ kubectl exec -it <dcae-ms-healthcheck pod> -n onap bash
+
.. code-block:: json
- $ curl dcae-healthcheck
+ $ curl dcae-ms-healthcheck
{
- "type": "summary",
- "count": 14,
- "ready": 14,
- "items": [
- {
- "name": "dev-dcaegen2-dcae-cloudify-manager",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-config-binding-service",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-inventory-api",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-servicechange-handler",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-deployment-handler",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-policy-handler",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-ves-collector",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-tca-analytics",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-prh",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-hv-ves-collector",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-dashboard",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-snmptrap-collector",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-holmes-engine-mgmt",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-holmes-rule-mgmt",
- "ready": 1,
- "unavailable": 0
- }
- ]
- }
+ "type": "summary",
+ "count": 5,
+ "ready": 5,
+ "items": [{
+ "name": "onap-dcae-hv-ves-collector",
+ "ready": 1,
+ "unavailable": 0
+ },
+ {
+ "name": "onap-dcae-prh",
+ "ready": 1,
+ "unavailable": 0
+ },
+ {
+ "name": "onap-dcae-tcagen2",
+ "ready": 1,
+ "unavailable": 0
+ },
+ {
+ "name": "onap-dcae-ves-collector",
+ "ready": 1,
+ "unavailable": 0
+ },
+ {
+ "name": "onap-dcae-ves-openapi-manager",
+ "ready": 1,
+ "unavailable": 0
+ }
+ ]
+ }
+
+
+The dcaemod-healthcheck service is also exposed as a Kubernetes ClusterIP Service named
+`dcaemod-healthcheck`. The service can be queried similar to `dcae-ms-healthcheck`
diff --git a/docs/sections/installation_test.rst b/docs/sections/installation_test.rst
index 1c36bf3..1062f52 100644
--- a/docs/sections/installation_test.rst
+++ b/docs/sections/installation_test.rst
@@ -6,88 +6,43 @@
-----------------------
The healthcheck service is exposed as a Kubernetes ClusterIP Service named
-`dcae-healthcheck`. The service can be queried for status as shown below.
+`dcae-ms-healthcheck`. The service can be queried for status as shown below.
.. code-block:: json
- $ curl dcae-healthcheck
+ $ curl dcae-ms-healthcheck
{
- "type": "summary",
- "count": 14,
- "ready": 14,
- "items": [
- {
- "name": "dev-dcaegen2-dcae-cloudify-manager",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-config-binding-service",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-inventory-api",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-servicechange-handler",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-deployment-handler",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dev-dcaegen2-dcae-policy-handler",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-ves-collector",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-tca-analytics",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-prh",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-hv-ves-collector",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-dashboard",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-dcae-snmptrap-collector",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-holmes-engine-mgmt",
- "ready": 1,
- "unavailable": 0
- },
- {
- "name": "dep-holmes-rule-mgmt",
- "ready": 1,
- "unavailable": 0
- }
- ]
- }
+ "type": "summary",
+ "count": 5,
+ "ready": 5,
+ "items": [{
+ "name": "onap-dcae-hv-ves-collector",
+ "ready": 1,
+ "unavailable": 0
+ },
+ {
+ "name": "onap-dcae-prh",
+ "ready": 1,
+ "unavailable": 0
+ },
+ {
+ "name": "onap-dcae-tcagen2",
+ "ready": 1,
+ "unavailable": 0
+ },
+ {
+ "name": "onap-dcae-ves-collector",
+ "ready": 1,
+ "unavailable": 0
+ },
+ {
+ "name": "onap-dcae-ves-openapi-manager",
+ "ready": 1,
+ "unavailable": 0
+ }
+ ]
+ }
+
Data Flow Verification
diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst
index 0ab3a93..a56f675 100644
--- a/docs/sections/offeredapis.rst
+++ b/docs/sections/offeredapis.rst
@@ -7,10 +7,6 @@
:maxdepth: 1
:titlesonly:
- apis/dcaedashboard.rst
- apis/configbinding.rst
- apis/deployment-handler.rst
- apis/inventory.rst
apis/ves.rst
apis/ves-hv/index.rst
apis/PRH.rst
diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst
index 5d28f66..7efc68d 100644
--- a/docs/sections/release-notes.rst
+++ b/docs/sections/release-notes.rst
@@ -88,7 +88,7 @@
| **Release designation** | 10.0.0 Jakarta |
| | |
+--------------------------------------+--------------------------------------------------------+
-| **Release date** | 2022-05-12 |
+| **Release date** | 2022-06-02 |
| | |
+--------------------------------------+--------------------------------------------------------+
@@ -164,7 +164,7 @@
"dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
"dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
"dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:2.2.2"
- "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.1.1"
+ "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.1.2"
"dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.4"
"dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.3.1"
"dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.4.0"
diff --git a/docs/sections/user_guide.rst b/docs/sections/user_guide.rst
index 87001ee..f985fc3 100644
--- a/docs/sections/user_guide.rst
+++ b/docs/sections/user_guide.rst
@@ -9,6 +9,5 @@
:maxdepth: 1
:titlesonly:
- ./platform-doc/dcaedashboard_userguide.rst
./design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst
\ No newline at end of file