summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTony Hansen <tony@att.com>2022-04-27 14:16:31 +0000
committerGerrit Code Review <gerrit@onap.org>2022-04-27 14:16:31 +0000
commit271a964e6da9b5e1342a81ed10353a2fcff67695 (patch)
treefadbd454d2462dce4c52aa16d02a0a6723ed55e8 /docs
parentd042f17bb05f70f4230d4b8572dba5b31af783ca (diff)
parent709b2d6d6e4bef256843bb7381aae7da04f6c073 (diff)
Merge "DCAEMOD updates for J release"
Diffstat (limited to 'docs')
-rw-r--r--docs/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.rst91
-rw-r--r--docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst306
-rw-r--r--docs/sections/design-components/DCAE-MOD/DCAE-MOD-goals.rst5
-rw-r--r--docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component_v3.json412
-rw-r--r--docs/sections/design-components/component-specification/component-json-schema.rst2054
-rwxr-xr-xdocs/sections/design-components/component-specification/component-type-docker.rst21
-rwxr-xr-xdocs/sections/design-components/component-specification/data-formats.rst470
-rw-r--r--docs/sections/design-components/images/128713731_image2022.pngbin0 -> 12988 bytes
-rw-r--r--docs/sections/design-components/requirements-guidelines.rst306
-rw-r--r--docs/sections/sdk/apis.rst1
10 files changed, 2209 insertions, 1457 deletions
diff --git a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.rst b/docs/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.rst
index 64bd4dc2..096a448e 100644
--- a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.rst
+++ b/docs/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
=====================
DCAE MOD Architecture
=====================
@@ -104,18 +107,89 @@ major functionalities:
1. It accepts changes on the flow-graph via fbp protocol
-2. It generates and distributes blueprints based on the change made on
+2. It generates and distributes helm charts OR blueprints based on the change made on
the flow-graph
+
+Build Updates
+~~~~~~~~~~~~~
+
+New Java module - Helmgenerator-core was introduced for Helm charts
+generation. MOD/Runtime has been enhanced to include this new dependency
+(inaddition to Bp-generator for supporting cloudify blueprints flows).
+
+Below is snippet from -
+https://github.com/onap/dcaegen2-platform/blob/master/mod/runtimeapi/runtime-core/pom.xml
+
+::
+
+ <dependency>
+ <groupId>org.onap.dcaegen2.platform</groupId>
+ <artifactId>helmchartgenerator-core</artifactId>
+ <version>1.0.3</version>
+ </dependency>
+
+
+Chart Updates
+~~~~~~~~~~~~~
+
+MOD/Runtime Charts has been modified to include under resources, common
+base templates, Charts.yaml, add-on templates and Values.yaml with
+placeholder.
+
+|image3|
+
+The Helmgenerator-core modules uses these template to pull the required
+dependencies and generate new chart for MS onboarded. The parameters in
+component-spec provided during onboarding is used for final Values.yaml
+file generation.
+
+Deployment
+~~~~~~~~~~
+
+The MOD/RuntimeAPI introduces new configuration to identify distribution
+mechanism. Supported artifactType are **BLUEPRINT** or **HELM. **
+
+Blueprint – Distribution to Inventory/Dashboard
+
+Helm – Distribution to ChartMuseum
+
+For Jakarta release, the charts configuration has been set to support
+HELM distribution by default and configured for ONAP-internal
+chart-museum registry.  RuntimeAPI Chart updates
+https://github.com/onap/oom/blob/master/kubernetes/dcaemod/components/dcaemod-runtime-api/values.yaml
+
+::
+
+ artifactType: "HELM"
+ registryBaseurl: http://chart-museum:80
+ basehelmchartlocation: /helm-gen/
+
+
Blueprint Generator
-------------------
This tool allows the user to create a blueprint from a component spec json file.
-This tool is used by the runtime api.
+This tool is used by the runtime api when artifactType is set to **BLUEPRINT** under
+`RuntimeAPI charts
+ deployment <https://git.onap.org/oom/tree/kubernetes/dcaemod/components/dcaemod-runtime-api/values.yaml#n44>`__
+
+Helm Generator
+--------------
+
+This tool allows the user to create a DCAE Services helm chart from a component spec json file.
+This tool is used by the runtime api when artifactType is set to **HELM** under
+`RuntimeAPI charts
+ deployment <https://git.onap.org/oom/tree/kubernetes/dcaemod/components/dcaemod-runtime-api/values.yaml#n44>`__
+
Inventory API
-------------
+
+.. note::
+ Used only under BLUEPRINT mode
+
DCAE Inventory is a web
service that provides the following:
@@ -146,6 +220,9 @@ dashboard.
DCAE Dashboard
--------------
+.. note::
+ Used only under BLUEPRINT mode
+
The DCAE dashboard provides visibility into running DCAE services for
operational purposes. It queries the DCAE Inventory for aggregate
details on all the running DCAE services and for getting up-to-date
@@ -165,9 +242,11 @@ The registry api offers version control and retrieval for flows. The
distributor api can be used to set distribution targets. Once a flow is
designed and distributed, it goes to the distributor api which is
supposed to post graph changes (in accordance with fbp) to the runtime
-api. The runtime api generates and distributes blueprints based on the
-change made on the flow-graph. These blueprints received by the DCAE
-inventory can then be viewed and deployed from the DCAE dashboard.
+api. The runtime api generates and distributes deployment artifacts (either
+blueprints or helm charts) based on the
+change made on the flow-graph. The generated blueprints are received by the DCAE
+inventory can then be viewed and deployed from the DCAE dashboard. On helm mode,
+charts generated are pushed into configured Chartmuseum registry.
@@ -176,3 +255,5 @@ inventory can then be viewed and deployed from the DCAE dashboard.
.. |image1| image:: ../images/Onboarding-with-DCAE-MOD.png
.. |image2| image:: ../images/nifi-toolbar-components.png
+
+.. |image3| image:: ../images/128713731_image2022.png
diff --git a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst b/docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst
index fb51d84a..d042028f 100644
--- a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst
+++ b/docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst
@@ -1,5 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+
.. _moduserguide:
===================
@@ -57,8 +58,106 @@ Types of Users and Usage Instructions:
| | and validate it | |
+-------+-----------------------------+-----------------------------+
+1. Pre-requisite for DCAE MOD Deployment
+===========================================
+
+With complete of DCAE Helm tranformation in Jakarta release, DCAE MOD has been enhanced
+to support Helm chart generation for microservices onboarded.
+In order to support the HELM flow through MOD, following dependency should be met
+
+
+- An accessible ChartMuseum registry (internal or external)
+
+- As the provided registry is used both to pull required dependencies
+ and push new generated charts, all common charts used by DCAE
+ components must be available in this registry.
+
+.. note::
+ By default, MOD charts are set to use local chartmuseum registry. This can be modified by
+ updating the `RuntimeAPI charts
+ deployment <https://git.onap.org/oom/tree/kubernetes/dcaemod/components/dcaemod-runtime-api/values.yaml#n44>`__
+
+
+ONAP deployments (gating) will include Chartmuseum installation within
+ONAP cluster  (charts hosted here
+- https://github.com/onap/oom/tree/master/kubernetes/platform/components/chartmuseum). 
+
+Dependent charts such as - dcaegen2-services-common, readinessCheck,
+common, repositoryGenerator, postgres, mongo, serviceAccount,
+certInitializer should be preloaded into this registry as MOD retrieves
+them during new MS helm charts creation and linting.  To support the
+registry initialization, following scripts has been introduced. 
+
+- https://github.com/onap/oom/blob/master/kubernetes/contrib/tools/registry-initialize.sh
+
+- https://github.com/onap/oom/blob/master/kubernetes/robot/demo-k8s.sh
+
+Note:  Chartmuseum being a platform component, it has to be enabled
+on-demand and not available with generic ONAP installation. 
+
+Follow below steps to setup chartmuseum and pre-load required charts.
+
+Chartmuseum Installation
+------------------------
+
+Clone OOM repository and deploy optional Chartmuseum component
+
+**Chartmuseum Deployment**
+
+::
+
+ # git clone -b <BRANCH> http://gerrit.onap.org/r/oom --recurse-submodules
+ cd ~/oom/kubernetes/platform/components/chartmuseum
+ helm install -name dev-chartmuseum -n onap . -f ~/onap-1-override.yaml --set global.masterPassword=test1 --set global.pullPolicy=IfNotPresent
-1.    Deployment of DCAE MOD components via Helm charts
+
+.. note::
+ This instance of chartmuseum registry is deployed internal to ONAP cluster and
+ is different from the registry setup done part `OOM
+ deployment <https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html>`__
+ where local helm server is setup for serving chart and to pull/push the
+ charts generated make process
+
+Chartmuseum initialization 
+--------------------------
+
+As noted earlier, there are two scripts available for pre-load. The
+`registry-initialize.sh <https://github.com/onap/oom/blob/master/kubernetes/contrib/tools/registry-initialize.sh>`__
+retrieves the Chartmuseum credential from secret and load the charts
+individually based on parameter (default no parameters, will load all
+DCAE service charts and its dependencies).  And
+`demo-k8s.sh <https://github.com/onap/oom/blob/master/kubernetes/robot/demo-k8s.sh>`__
+is wrapper script used in gating, which invokes
+`registry-initialize.sh <https://github.com/onap/oom/blob/master/kubernetes/contrib/tools/registry-initialize.sh>`__
+with required parameters.
+
+**Chartmuseum initialization via demo-k8s.sh**
+
+::
+
+ cd ~/oom/kubernetes/robot
+ ./demo-k8s.sh onap registrySynch
+
+OR 
+
+**Chartmuseum initialization via registry-initialize script**
+
+::
+
+ cd ~/oom/kubernetes/contrib/tools
+ ./registry-initialize.sh -d ../../dcaegen2-services/charts/ -n onap -r dev-chartmuseum
+ ./registry-initialize.sh -d ../../dcaegen2-services/charts/ -n onap -r dev-chartmuseum -p common
+ ./registry-initialize.sh -h repositoryGenerator -n onap -r dev-chartmuseum
+ ./registry-initialize.sh -h readinessCheck -n onap -r dev-chartmuseum
+ ./registry-initialize.sh -h dcaegen2-services-common -n onap -r dev-chartmuseum
+ ./registry-initialize.sh -h postgres -n onap -r dev-chartmuseum
+ ./registry-initialize.sh -h serviceAccount -n onap -r dev-chartmuseum
+ ./registry-initialize.sh -h certInitializer -n onap -r dev-chartmuseum
+ ./registry-initialize.sh -h mongo -n onap -r dev-chartmuseum
+
+
+
+2.    Deployment of DCAE MOD components via Helm charts
=======================================================
The DCAE MOD components are deployed using the standard ONAP OOM
@@ -74,7 +173,8 @@ deployed.   The Rancher RKE installation process sets up a suitable
ingress controller.   In order to enable the use of the ingress
controller, it is necessary to override the OOM default global settings
for ingress configuration.   Specifically, the installation needs to set
-the following configuration in an override file::
+the following configuration in an override file
+::
ingress:
enabled: true
@@ -135,13 +235,21 @@ All MOD API's and UI access via ingress should use dcaemod.simpledemo.onap.org.
In order to access Design UI from local, add an entry for dcaemod.simpledemo.onap.org in /etc/hosts with the correct IP (any K8S node IP can be specified).
+Example below using generic override
+
+**Deploy MOD**
+
+::
+
+ helm install dev-dcaemod local/dcaemod --namespace onap -f ~/onap-override.yaml --set global.masterPassword=test1 --set global.pullPolicy=IfNotPresent
+
Using DCAE MOD without an Ingress Controller
Not currently supported
-2.    Configuring DCAE mod
+3.    Configuring DCAE mod
==========================
**a. Configure Nifi Registry url**
@@ -179,11 +287,12 @@ IPAddress is the host address or the DNS FQDN, if there is one, for one of the K
**c. Get the artifacts to test and onboard.**
-Let's fetch the artifacts/ spec files
+MOD components has been upgraded to use v3 specification for Helm flow support
-**Component Spec for DCAE-VES-Collector :** https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/spec/vescollector-componentspec.json
+VESCollector
+~~~~~~~~~~~~
-**Component Spec for DCAE-TCAgen2 :** https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/spec/vescollector-componentspec.json
+**Component Spec for DCAE-VES-Collector :** https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/spec/vescollector-componentspec-v3.json
**VES 5.28.4 Data Format :** https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/data-formats/VES-5.28.4-dataformat.json
@@ -191,8 +300,19 @@ Let's fetch the artifacts/ spec files
**VES Collector Response Data Format :** https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/data-formats/ves-response.json
+
+TCAGen2
+~~~~~~~
+
+**Component Spec for DCAE-TCAgen2 :** https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/spec/vescollector-componentspec.json
+
**TCA CL Data Format :** https://git.onap.org/dcaegen2/analytics/tca-gen2/tree/dcae-analytics/dpo/dcaeCLOutput.json
+**TCA DMAAP Format :** https://git.onap.org/dcaegen2/analytics/tca-gen2/tree/dcae-analytics/dpo/dmaap.json
+
+**TCA AAI Data Format :** https://git.onap.org/dcaegen2/analytics/tca-gen2/tree/dcae-analytics/dpo/aai.json
+
+
For the purpose of onboarding, a Sample Request body should be of the type -::
@@ -205,15 +325,16 @@ Request bodies of this type will be used in the onboarding requests you make usi
**The prepared Sample Request body for a component dcae-ves-collector looks like
so –**
-See :download:`VES Collector Spec <./Sample-Input-Files/Request-body-of-Sample-Component.json>`
+See :download:`VES Collector Spec <./Sample-Input-Files/Request-body-of-Sample-Component_v3.json>`
**The prepared Sample request body for a sample data format  looks like so -**
See :download:`VES data Format <./Sample-Input-Files/Request-body-of-Sample-Data-Format.json>`
+Similar updates should be done for other specification and data-formats files
-**d. To onboard a data format and a component**
+**d. Onboard data format and component-spec**
Each component has a description that tells what it does.
@@ -231,13 +352,30 @@ curl -X POST http://dcaemod.simpledemo.onap.org/onboarding/dataformats     -
curl -X POST http://dcaemod.simpledemo.onap.org/onboarding/components    -H "Content-Type: application/json" -d @<filepath to request>
+**Onboard Specs and DF**
+
+::
+
+ HOST=dcaemod.simpledemo.onap.org
+ curl -X POST http://$HOST/onboarding/dataformats -H "Content-Type: application/json" -d @ves-4.27.2-df.json
+ curl -X POST http://$HOST/onboarding/dataformats -H "Content-Type: application/json" -d @ves-5.28.4-df.json
+ curl -X POST http://$HOST/onboarding/dataformats -H "Content-Type: application/json" -d @ves-response-df.json
+ curl -X POST http://$HOST/onboarding/dataformats -H "Content-Type: application/json" -d @VES-7.30.2_ONAP-dataformat_onboard.json
+ curl -X POST http://$HOST/onboarding/components -H "Content-Type: application/json" -d @vescollector-componentspec-v3-mod.json
+
+ curl -X POST http://$HOST/onboarding/dataformats -H "Content-Type: application/json" -d @dcaeCLOutput-resp.json
+ curl -X POST http://$HOST/onboarding/dataformats -H "Content-Type: application/json" -d @aai-resp.json
+ curl -X POST http://$HOST/onboarding/components -H "Content-Type: application/json" -d @tcagen2-componentspec-v3-mod.json
+
+You can download the Component Specification and Data Formats used for
+the demo from here - `demo.zip <https://wiki.onap.org/download/attachments/128713665/demo.zip?version=1&modificationDate=1646673042000&api=v2>`__
**e. Verify the resources were created using**
-curl -X GET http://<IPAddress>/onboarding/dataformats
+curl -X GET http://dcaemod.simpledemo.onap.org/onboarding/dataformats
-curl -X GET http://<IPAddress>/onboarding/components
+curl -X GET http://dcaemod.simpledemo.onap.org/onboarding/components
**f. Verify the genprocessor (which polls onboarding periodically to convert component specs to nifi processor), converted the component**
@@ -248,7 +386,7 @@ processors
|image1|
-3.    Design & Distribution Flow
+4.    Design & Distribution Flow
================================
@@ -339,43 +477,100 @@ get a pop up a success message like so -
At this step, the design was packaged and sent to Runtime api.
-The runtime is supposed to generate the blueprint out of the packaged
-design/flow and push it to the DCAE inventory and the DCAE Dasboard.
-
-**c. Checking the components in the DCAE Dashboard**
-
-You should see the generated artifact/ blueprint in the DCAE Dashboard
-dashboard at https://<IPAddress>:30418/ccsdk-app/login_external.htm in
-our deployment. The name for each component will be appended by the flow
-name followed by underscore followed by the component’s name.
-
-The credentials to access the DCAE Dashboard
-
-Login: su1234
-Password: fusion
-
+The runtime is supposed to generate the Helmchart for components
+involved in the flow and push them to registry configured. The
+RuntimeAPI logs should looks like below for successful distribution (can
+be viewed through kubectl log -f command)
+
+**MOD/RuntimeAPI Console logs**
+
+::
+
+ 2022-03-07 18:13:25.865 INFO 1 --- [nio-9090-exec-8] o.o.d.r.web.controllers.GraphController : org.onap.dcae.runtime.web.models.GraphRequest@65efc9d3
+ 2022-03-07 18:13:26.119 INFO 1 --- [nio-9090-exec-1] o.o.d.r.web.controllers.GraphController : [org.onap.dcae.runtime.web.models.Action@335a6cff, org.onap.dcae.runtime.web.models.Action@291687dd, org.onap.dcae.runtime.web.models.Action@36d57691]
+ 2022-03-07 18:13:26.142 INFO 1 --- [nio-9090-exec-1] o.o.d.platform.helmchartgenerator.Utils : cloning dir/file at : /tmp/chart17927059362260733428
+ 2022-03-07 18:13:26.158 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : running: helm dep up /tmp/chart17927059362260733428
+ Hang tight while we grab the latest from your chart repositories...
+ ...Successfully got an update from the "local" chart repository
+ Update Complete. ⎈Happy Helming!⎈
+ Saving 7 charts
+ Downloading common from repo http://chart-museum:80
+ Downloading repositoryGenerator from repo http://chart-museum:80
+ Downloading readinessCheck from repo http://chart-museum:80
+ Downloading dcaegen2-services-common from repo http://chart-museum:80
+ Downloading postgres from repo http://chart-museum:80
+ Downloading serviceAccount from repo http://chart-museum:80
+ Downloading mongo from repo http://chart-museum:80
+ Deleting outdated charts
+ 2022-03-07 18:13:26.273 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : running: helm lint /tmp/chart17927059362260733428
+ 2022-03-07 18:13:30.641 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : ==> Linting /tmp/chart17927059362260733428
+ 2022-03-07 18:13:30.642 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : [INFO] Chart.yaml: icon is recommended
+ 2022-03-07 18:13:30.642 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl :
+ 2022-03-07 18:13:30.642 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : 1 chart(s) linted, 0 chart(s) failed
+ 2022-03-07 18:13:30.646 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : running: helm package -d /tmp/chart13832736430918913290 /tmp/chart17927059362260733428
+ 2022-03-07 18:13:30.737 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : Successfully packaged chart and saved it to: /tmp/chart13832736430918913290/dcae-ves-collector-1.10.1.tgz
+ 2022-03-07 18:13:30.836 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.d.ChartMuseumDistributor : {"saved":true}
+ 2022-03-07 18:13:30.857 INFO 1 --- [nio-9090-exec-1] o.o.d.platform.helmchartgenerator.Utils : cloning dir/file at : /tmp/chart7638328545634423550
+ 2022-03-07 18:13:30.870 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : running: helm dep up /tmp/chart7638328545634423550
+ Hang tight while we grab the latest from your chart repositories...
+ ...Successfully got an update from the "local" chart repository
+ Update Complete. ⎈Happy Helming!⎈
+ Saving 7 charts
+ Downloading common from repo http://chart-museum:80
+ Downloading repositoryGenerator from repo http://chart-museum:80
+ Downloading readinessCheck from repo http://chart-museum:80
+ Downloading dcaegen2-services-common from repo http://chart-museum:80
+ Downloading postgres from repo http://chart-museum:80
+ Downloading serviceAccount from repo http://chart-museum:80
+ Downloading mongo from repo http://chart-museum:80
+ Deleting outdated charts
+ 2022-03-07 18:13:31.022 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : running: helm lint /tmp/chart7638328545634423550
+ 2022-03-07 18:13:35.142 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : ==> Linting /tmp/chart7638328545634423550
+ 2022-03-07 18:13:35.143 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : [INFO] Chart.yaml: icon is recommended
+ 2022-03-07 18:13:35.143 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl :
+ 2022-03-07 18:13:35.143 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : 1 chart(s) linted, 0 chart(s) failed
+ 2022-03-07 18:13:35.148 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : running: helm package -d /tmp/chart14389934160290252569 /tmp/chart7638328545634423550
+ 2022-03-07 18:13:35.238 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.chartbuilder.HelmClientImpl : Successfully packaged chart and saved it to: /tmp/chart14389934160290252569/dcae-tcagen2-1.3.1.tgz
+ 2022-03-07 18:13:35.303 INFO 1 --- [nio-9090-exec-1] o.o.d.p.h.d.ChartMuseumDistributor : {"saved":true}
+
+
+5.    Validation & Deployment
+=============================
+
+** Verify if the charts are pushed into registry**
+
+
+Charts distributed by MOD/Runtime can be verified on Chartmuseum
+registry http://chart-museum:80/api/charts
+
+Refer to supported api under `Chartmuseum Docs <https://chartmuseum.com/docs/>`__
+
+Once the charts are retrieved, they can be installed using helm install command.
+
+::
+
+ curl -X GET http://<registry:port>/charts/dcae-tcagen2-1.3.1.tgz -u onapinitializer:demo123456! -o dcae-tcagen2-1.3.1.tgz
+ helm install -name dev-dcaegen2-services -n onap dcae-tcagen2-1.3.1.tgz --set global.masterPassword=test1 --set global.pullPolicy=Always --set mongo.enabled=true
+
+
+
+6.  Environment Cleanup
+-----------------------
+
+**Demo Env Cleanup**
+
+::
+
+ helm delete -n onap dev-chartmuseum # To remove Chartmuseum setup completely
+ helm delete -n onap dev-dcaegen2-services # To remove TCAGen2 services
+ helm delete -n onap dev-dcaemod # To undeploy DCAEMOD
+
+ # USE DELETE METHOD ON CHARTMUSEUM TO REMOVE ANY SPECIFIC CHART PACKAGE - example below
+ curl -X DELETE http://<registry:port>/api/charts/dcae-ves-collector/1.10.1 -u onapinitializer:demo123456!
+ curl -X DELETE http://<registry:port>/api/charts/dcae-tcagen2/1.3.1 -u onapinitializer:demo123456!
+
+**Remove also any persistence directory from /dockerdata-nfs/onap/ associated to chartmuseum and dcaemod**
-|image20|
-
-|image21|
-
-|image22|
-
-The generated Blueprint can be viewed.
-
-|image23|
-
-Finally, the generated Blueprint can be deployed.
-
-|image24|
-
-You can use/import the attached input configurations files to deploy. Drag and Drop these sample JSON files to fill in the configuration values.
-See :download:`VES Collector Input Configuration <./Sample-Input-Files/ves-deploy.input.json>`
-See :download:`Tcagen2 Input Configuration <./Sample-Input-Files/tca-deploy.input.json>`
-
-|image25|
-
-|image26|
.. |image0| image:: ../images/1.png
:width: 6.5in
@@ -437,22 +632,5 @@ See :download:`Tcagen2 Input Configuration <./Sample-Input-Files/tca-deploy.inpu
.. |image19| image:: ../images/20.png
:width: 4.91667in
:height: 2.41667in
-.. |image20| image:: ../images/21.png
- :width: 6.5in
- :height: 2.41667in
-.. |image21| image:: ../images/22.png
- :width: 6.5in
- :height: 3in
-.. |image22| image:: ../images/23.png
- :width: 6.5in
- :height: 2.16667in
-.. |image23| image:: ../images/24.png
- :width: 6.5in
- :height: 2.83333in
-.. |image24| image:: ../images/25.png
- :width: 6.5in
- :height: 3in
-.. |image25| image:: ../images/26.png
-.. |image26| image:: ../images/27.png
diff --git a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-goals.rst b/docs/sections/design-components/DCAE-MOD/DCAE-MOD-goals.rst
index 23d393b1..a0521cca 100644
--- a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-goals.rst
+++ b/docs/sections/design-components/DCAE-MOD/DCAE-MOD-goals.rst
@@ -1,3 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
==============
MOD Objectives
==============
@@ -37,7 +39,6 @@ an effort to reboot the onboarding and design experience in DCAE.
- Support automated adaptation of ML model from Acumos to DCAE design & runtime environment through the Acumos Adapter.
-- DCAE-MOD is developed by the DCAE team to ensure consistency across all DCAE implementation, with the long term objective to integrate with SDC as part of the Design Platform.
+- DCAE-MOD is developed by the DCAE team to ensure consistency across all DCAE implementation, with the long term objective to integrate with SDC & Policy/CLAMP as part of the Design Platform.
-- Integrate with ONAP User Experience portals (initially ONAP portal, later SDC portal).
diff --git a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component_v3.json b/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component_v3.json
new file mode 100644
index 00000000..ebbf3f64
--- /dev/null
+++ b/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component_v3.json
@@ -0,0 +1,412 @@
+ {
+ "spec":
+
+{
+ "self": {
+ "version": "1.10.1",
+ "name": "dcae-ves-collector",
+ "description": "Collector for receiving VES events through restful interface",
+ "component_type": "docker"
+ },
+ "streams": {
+ "subscribes": [],
+ "publishes": [{
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-fault"
+ },
+ {
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-measurement"
+ },
+ {
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-syslog"
+ },
+ {
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-heartbeat"
+ },
+ {
+ "format": "VES_specification",
+ "version": "7.30.2",
+ "type": "message router",
+ "config_key": "ves-other"
+ },
+ {
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-mobileflow"
+ },
+ {
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-statechange"
+ },
+ {
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-thresholdCrossingAlert"
+ },
+ {
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-voicequality"
+ },
+ {
+ "format": "VES_specification",
+ "version": "5.28.4",
+ "type": "message router",
+ "config_key": "ves-sipsignaling"
+ },
+ {
+ "format": "VES_specification",
+ "version": "7.30.2",
+ "type": "message router",
+ "config_key": "ves-pnfRegistration"
+ },
+ {
+ "format": "VES_specification",
+ "version": "7.30.2",
+ "type": "message router",
+ "config_key": "ves-notification"
+ },
+ {
+ "format": "VES_specification",
+ "version": "7.30.2",
+ "type": "message router",
+ "config_key": "ves-perf3gpp"
+ },
+ {
+ "format": "VES_specification",
+ "version": "7.30.2",
+ "type": "message router",
+ "config_key": "ves-3gpp-fault-supervision"
+ },
+ {
+ "format": "VES_specification",
+ "version": "7.30.2",
+ "type": "message router",
+ "config_key": "ves-3gpp-provisioning"
+ },
+ {
+ "format": "VES_specification",
+ "version": "7.30.2",
+ "type": "message router",
+ "config_key": "ves-3gpp-heartbeat"
+ },
+ {
+ "format": "VES_specification",
+ "version": "7.30.2",
+ "type": "message router",
+ "config_key": "ves-3gpp-performance-assurance"
+ }
+ ]
+ },
+ "services": {
+ "calls": [],
+ "provides": [{
+ "route": "/eventListener/v1",
+ "verb": "POST",
+ "request": {
+ "format": "VES_specification",
+ "version": "4.27.2"
+ },
+ "response": {
+ "format": "ves.coll.response",
+ "version": "1.0.0"
+ }
+ },
+ {
+ "route": "/eventListener/v2",
+ "verb": "POST",
+ "request": {
+ "format": "VES_specification",
+ "version": "4.27.2"
+ },
+ "response": {
+ "format": "ves.coll.response",
+ "version": "1.0.0"
+ }
+ },
+ {
+ "route": "/eventListener/v3",
+ "verb": "POST",
+ "request": {
+ "format": "VES_specification",
+ "version": "4.27.2"
+ },
+ "response": {
+ "format": "ves.coll.response",
+ "version": "1.0.0"
+ }
+ },
+ {
+ "route": "/eventListener/v4",
+ "verb": "POST",
+ "request": {
+ "format": "VES_specification",
+ "version": "4.27.2"
+ },
+ "response": {
+ "format": "ves.coll.response",
+ "version": "1.0.0"
+ }
+ },
+ {
+ "route": "/eventListener/v5",
+ "verb": "POST",
+ "request": {
+ "format": "VES_specification",
+ "version": "5.28.4"
+ },
+ "response": {
+ "format": "ves.coll.response",
+ "version": "1.0.0"
+ }
+ },
+ {
+ "route": "/eventListener/v7",
+ "verb": "POST",
+ "request": {
+ "format": "VES_specification",
+ "version": "7.30.2"
+ },
+ "response": {
+ "format": "ves.coll.response",
+ "version": "1.0.0"
+ }
+ }
+ ]
+ },
+ "parameters": [{
+ "name": "streams_publishes",
+ "value": "{\"ves-3gpp-fault-supervision\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_3GPP_FAULTSUPERVISION_OUTPUT\"},\"type\":\"message_router\"},\"ves-3gpp-heartbeat\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_3GPP_HEARTBEAT_OUTPUT\"},\"type\":\"message_router\"},\"ves-3gpp-performance-assurance\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_3GPP_PERFORMANCEASSURANCE_OUTPUT\"},\"type\":\"message_router\"},\"ves-3gpp-provisioning\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_3GPP_PROVISIONING_OUTPUT\"},\"type\":\"message_router\"},\"ves-fault\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_FAULT_OUTPUT\"},\"type\":\"message_router\"},\"ves-heartbeat\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_HEARTBEAT_OUTPUT\"},\"type\":\"message_router\"},\"ves-measurement\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.VES_MEASUREMENT_OUTPUT\"},\"type\":\"message_router\"},\"ves-notification\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.VES_NOTIFICATION_OUTPUT\"},\"type\":\"message_router\"},\"ves-other\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_OTHER_OUTPUT\"},\"type\":\"message_router\"},\"ves-pnfRegistration\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.VES_PNFREG_OUTPUT\"},\"type\":\"message_router\"}}",
+ "description": "standard http port collector will open for listening;",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.service.port",
+ "value": 8080,
+ "description": "standard http port collector will open for listening;",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.service.secure.port",
+ "value": 8443,
+ "description": "secure http port collector will open for listening ",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": true
+ },
+ {
+ "name": "collector.keystore.file.location",
+ "value": "/opt/app/dcae-certificate/cert.jks",
+ "description": "fs location of keystore file in vm",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.keystore.passwordfile",
+ "value": "/opt/app/dcae-certificate/jks.pass",
+ "description": "location of keystore password file in vm",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.truststore.file.location",
+ "value": "/opt/app/dcae-certificate/trust.jks",
+ "description": "fs location of truststore file in vm",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.truststore.passwordfile",
+ "value": "/opt/app/dcae-certificate/trust.pass",
+ "description": "location of truststore password file in vm",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.dmaap.streamid",
+ "value": "fault=ves-fault|syslog=ves-syslog|heartbeat=ves-heartbeat|measurementsForVfScaling=ves-measurement|mobileFlow=ves-mobileflow|other=ves-other|stateChange=ves-statechange|thresholdCrossingAlert=ves-thresholdCrossingAlert|voiceQuality=ves-voicequality|sipSignaling=ves-sipsignaling|notification=ves-notification|pnfRegistration=ves-pnfRegistration|3GPP-FaultSupervision=ves-3gpp-fault-supervision|3GPP-Heartbeat=ves-3gpp-heartbeat|3GPP-Provisioning=ves-3gpp-provisioning|3GPP-PerformanceAssurance=ves-3gpp-performance-assurance",
+ "description": "domain-to-streamid mapping used by VESCollector to distributes events based on domain. Both primary and secondary config_key are included for resilency (multiple streamid can be included commma separated). The streamids MUST match to topic config_keys. For single site without resiliency deployment - configkeys with -secondary suffix can be removed",
+ "sourced_at_deployment": true,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "auth.method",
+ "value": "noAuth",
+ "description": "Property to manage application mode, possible configurations: noAuth - default option - no security (http) , certOnly - auth by certificate (https), basicAuth - auth by basic auth username and password (https),certBasicAuth - auth by certificate and basic auth username / password (https),",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "header.authlist",
+ "value": "sample1,$2a$10$pgjaxDzSuc6XVFEeqvxQ5u90DKJnM/u7TJTcinAlFJVaavXMWf/Zi|userid1,$2a$10$61gNubgJJl9lh3nvQvY9X.x4e5ETWJJ7ao7ZhJEvmfJigov26Z6uq|userid2,$2a$10$G52y/3uhuhWAMy.bx9Se8uzWinmbJa.dlm1LW6bYPdPkkywLDPLiy",
+ "description": "List of id and base 64 encoded password.For each onboarding VNF - unique userid and password should be assigned and communicated to VNF owner. Password value should be base64 encoded in config here",
+ "policy_editable": false,
+ "sourced_at_deployment": true,
+ "designer_editable": true
+ },
+ {
+ "name": "collector.schema.checkflag",
+ "value": 1,
+ "description": "Schema check validation flag. When enabled, collector will validate input VES events against VES Schema defined on collector.schema.file ",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.schema.file",
+ "value": "{\"v1\":\"./etc/CommonEventFormat_27.2.json\",\"v2\":\"./etc/CommonEventFormat_27.2.json\",\"v3\":\"./etc/CommonEventFormat_27.2.json\",\"v4\":\"./etc/CommonEventFormat_27.2.json\",\"v5\":\"./etc/CommonEventFormat_28.4.1.json\",\"v7\":\"./etc/CommonEventFormat_30.2.1_ONAP.json\"}",
+ "description": "VES schema file name per version used for validation",
+ "designer_editable": true,
+ "sourced_at_deployment": false,
+ "policy_editable": false
+ },
+ {
+ "name": "event.transform.flag",
+ "value": 1,
+ "description": "flag to enable tranformation rules defined under eventTransform.json; this is applicable when event tranformation rules preset should be activated for transforming <VES5.4 events to 5.4",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "tomcat.maxthreads",
+ "value": "200",
+ "description": "Tomcat control for concurrent request",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.externalSchema.checkflag",
+ "value": 1,
+ "description": "Schema stndDefined validation flag. When enabled, collector will validate stndDefined fields in stndDefined domain events against mapped local schemas listed in file from property collector.externalSchema.mappingFileLocation.",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": true
+ },
+ {
+ "name": "collector.externalSchema.schemasLocation",
+ "value": "./etc/externalRepo/",
+ "description": "External schemas repository. Path to schemas storage directory.",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.externalSchema.mappingFileLocation",
+ "value": "./etc/externalRepo/schema-map.json",
+ "description": "Path to JSON file containing mapping of externally located stndDefined schemas to local schema files.",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "event.externalSchema.schemaRefPath",
+ "value": "$.event.stndDefinedFields.schemaReference",
+ "description": "An internal path from validated JSON. Defines which field is taken as public schema reference, which is later mapped.",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "event.externalSchema.stndDefinedDataPath",
+ "value": "$.event.stndDefinedFields.data",
+ "description": "An internal path from validated JSON. Defines which field of event will be validated during stndDefined validation.",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ },
+ {
+ "name": "collector.description.api.version.location",
+ "value": "etc/api_version_description.json",
+ "description": "Path to the file containing description of api versions",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ }
+ ],
+ "auxilary": {
+ "helm": {
+ "service": {
+ "type": "NodePort",
+ "name": "dcae-ves-collector",
+ "has_internal_only_ports": true,
+ "ports": [{
+ "name": "http",
+ "port": 8443,
+ "plain_port": 8080,
+ "port_protocol": "http",
+ "nodePort": 17,
+ "useNodePortExt": true
+ }]
+ }
+ },
+ "healthcheck": {
+ "type": "HTTP",
+ "interval": "15s",
+ "timeout": "1s",
+ "port": 8080,
+ "endpoint": "/healthcheck"
+ },
+ "volumes": [{
+ "config_volume": {
+ "name": "dcae-external-repo-configmap-schema-map"
+ },
+ "container": {
+ "bind": "/opt/app/VESCollector/etc/externalRepo/"
+ }
+ }, {
+ "config_volume": {
+ "name": "dcae-external-repo-configmap-sa88-rel16"
+ },
+ "container": {
+ "bind": "/opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/"
+ }
+ }],
+ "ports": [
+ "8080:0",
+ "8443:0"
+ ],
+ "log_info": {
+ "log_directory": "/opt/app/VESCollector/logs/"
+ },
+ "tls_info": {
+ "cert_directory": "/opt/app/dcae-certificate/",
+ "use_tls": true,
+ "use_external_tls": false
+ }
+ },
+ "artifacts": [{
+ "type": "docker image",
+ "uri": "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.10.1"
+ }]
+}
+,
+ "owner": "onboard_dev"
+ }
diff --git a/docs/sections/design-components/component-specification/component-json-schema.rst b/docs/sections/design-components/component-specification/component-json-schema.rst
index 1d2936b0..a6afcd41 100644
--- a/docs/sections/design-components/component-specification/component-json-schema.rst
+++ b/docs/sections/design-components/component-specification/component-json-schema.rst
@@ -6,1001 +6,1171 @@
Component JSON Schema Definition
================================
-The schema file used for DCAE onboarding is maintained in `gerrit <https://git.onap.org/dcaegen2/platform/plain/mod/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json>`__
+The schema file used for DCAE onboarding is maintained in `gerrit <https://git.onap.org/dcaegen2/platform/plain/mod/component-json-schemas/component-specification/dcae-cli-v3/component-spec-schema.json>`__
The same is provided below for documentation reference.
::
{
- "$schema": "http://json-schema.org/draft-04/schema#",
- "title": "Component specification schema",
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "version": {
- "$ref": "#/definitions/version"
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "title": "Component specification schema",
+ "type": "object",
+ "properties": {
+ "self": {
+ "type": "object",
+ "properties": {
+ "version": {
+ "$ref": "#/definitions/version"
+ },
+ "description": {
+ "type": "string"
+ },
+ "component_type": {
+ "type": "string",
+ "enum": [
+ "docker",
+ "cdap"
+ ]
+ },
+ "name": {
+ "$ref": "#/definitions/name"
+ }
+ },
+ "required": [
+ "version",
+ "name",
+ "description",
+ "component_type"
+ ]
},
- "description": {
- "type": "string"
+ "streams": {
+ "type": "object",
+ "properties": {
+ "publishes": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/definitions/publisher_http"
+ },
+ {
+ "$ref": "#/definitions/publisher_message_router"
+ },
+ {
+ "$ref": "#/definitions/publisher_data_router"
+ },
+ {
+ "$ref": "#/definitions/publisher_kafka"
+ }
+ ]
+ }
+ },
+ "subscribes": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "oneOf": [
+ {
+ "$ref": "#/definitions/subscriber_http"
+ },
+ {
+ "$ref": "#/definitions/subscriber_message_router"
+ },
+ {
+ "$ref": "#/definitions/subscriber_data_router"
+ },
+ {
+ "$ref": "#/definitions/subscriber_kafka"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "publishes",
+ "subscribes"
+ ]
},
- "component_type": {
- "type": "string",
- "enum": [
- "docker",
- "cdap"
- ]
+ "services": {
+ "type": "object",
+ "properties": {
+ "calls": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/caller"
+ }
+ },
+ "provides": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/provider"
+ }
+ }
+ },
+ "required": [
+ "calls",
+ "provides"
+ ]
},
- "name": {
- "$ref": "#/definitions/name"
- }
- },
- "required": [
- "version",
- "name",
- "description",
- "component_type"
- ]
- },
- "streams": {
- "type": "object",
- "properties": {
- "publishes": {
- "type": "array",
- "uniqueItems": true,
- "items": {
- "oneOf": [
- { "$ref": "#/definitions/publisher_http" },
- { "$ref": "#/definitions/publisher_message_router" },
- { "$ref": "#/definitions/publisher_data_router" },
- { "$ref": "#/definitions/publisher_kafka" }
+ "parameters": {
+ "anyOf": [
+ {
+ "$ref": "#/definitions/docker-parameters"
+ },
+ {
+ "$ref": "#/definitions/cdap-parameters"
+ }
]
- }
},
- "subscribes": {
- "type": "array",
- "uniqueItems": true,
- "items": {
+ "auxilary": {
"oneOf": [
- { "$ref": "#/definitions/subscriber_http" },
- { "$ref": "#/definitions/subscriber_message_router" },
- { "$ref": "#/definitions/subscriber_data_router" },
- { "$ref": "#/definitions/subscriber_kafka" }
+ {
+ "$ref": "#/definitions/auxilary_cdap"
+ },
+ {
+ "$ref": "#/definitions/auxilary_docker"
+ }
]
- }
- }
- },
- "required": [
- "publishes",
- "subscribes"
- ]
- },
- "services": {
- "type": "object",
- "properties": {
- "calls": {
- "type": "array",
- "uniqueItems": true,
- "items": {
- "$ref": "#/definitions/caller"
- }
- },
- "provides": {
- "type": "array",
- "uniqueItems": true,
- "items": {
- "$ref": "#/definitions/provider"
- }
- }
- },
- "required": [
- "calls",
- "provides"
- ]
- },
- "parameters" : {
- "anyOf" : [
- {"$ref": "#/definitions/docker-parameters"},
- {"$ref": "#/definitions/cdap-parameters"}
- ]
- },
- "auxilary": {
- "oneOf" : [
- {"$ref": "#/definitions/auxilary_cdap"},
- {"$ref": "#/definitions/auxilary_docker"}
- ]
- },
- "artifacts": {
- "type": "array",
- "description": "List of component artifacts",
- "items": {
- "$ref": "#/definitions/artifact"
- }
- },
- "policy_info": {
- "type": "object",
- "properties": {
- "policy":
- {
- "type": "array",
- "items":
- {
+ },
+ "artifacts": {
+ "type": "array",
+ "description": "List of component artifacts",
+ "items": {
+ "$ref": "#/definitions/artifact"
+ }
+ },
+ "policy_info": {
"type": "object",
- "properties":
- {
- "node_label":
- {
- "type": "string"
- },
- "policy_id":
- {
- "type": "string"
- },
- "policy_model_id":
- {
- "type": "string"
- }
+ "properties": {
+ "policy": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "node_label": {
+ "type": "string"
+ },
+ "policy_id": {
+ "type": "string"
+ },
+ "policy_model_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "policy_id",
+ "policy_model_id"
+ ]
+ }
+ }
},
- "required": ["node_label", "policy_model_id"]
- }
+ "additionalProperties": false
}
- },
- "additionalProperties": false
- }
- },
- "required": [
- "self",
- "streams",
- "services",
- "parameters",
- "auxilary",
- "artifacts"
- ],
- "additionalProperties": false,
- "definitions": {
- "cdap-parameters": {
- "description" : "There are three seperate ways to pass parameters to CDAP: app config, app preferences, program preferences. These are all treated as optional.",
- "type": "object",
- "properties" : {
- "program_preferences": {
- "description" : "A list of {program_id, program_type, program_preference} objects where program_preference is an object passed into program_id of type program_type",
- "type": "array",
- "uniqueItems": true,
- "items": {
- "$ref": "#/definitions/program_preference"
- }
- },
- "app_preferences" : {
- "description" : "Parameters Passed down to the CDAP preference API",
- "type": "array",
- "uniqueItems": true,
- "items": {
- "$ref": "#/definitions/parameter"
- }
- },
- "app_config" : {
- "description" : "Parameters Passed down to the CDAP App Config",
- "type": "array",
- "uniqueItems": true,
- "items": {
- "$ref": "#/definitions/parameter"
- }
- }
- }
- },
- "program_preference": {
- "type": "object",
- "properties": {
- "program_type": {
- "$ref": "#/definitions/program_type"
- },
- "program_id": {
- "type": "string"
- },
- "program_pref":{
- "description" : "Parameters that the CDAP developer wants pushed to this program's preferences API. Optional",
- "type": "array",
- "uniqueItems": true,
- "items": {
- "$ref": "#/definitions/parameter"
- }
- }
- },
- "required": ["program_type", "program_id", "program_pref"]
- },
- "program_type": {
- "type": "string",
- "enum": ["flows","mapreduce","schedules","spark","workflows","workers","services"]
},
- "docker-parameters": {
- "type": "array",
- "uniqueItems": true,
- "items": {
- "$ref": "#/definitions/parameter"
- }
- },
- "parameter": {
- "oneOf": [
- {"$ref": "#/definitions/parameter-list"},
- {"$ref": "#/definitions/parameter-other"}
- ]
- },
- "parameter-list": {
- "properties": {
- "name": {
- "type": "string"
- },
- "value": {
- "description": "Default value for the parameter"
- },
- "description": {
- "description": "Description for the parameter.",
- "type": "string"
- },
- "type": {
- "description": "Only valid type is list, the entry_schema is required - which contains the type of the list element. All properties set for the parameter apply to all elements in the list at this time",
- "type": "string",
- "enum": ["list"]
- },
- "required": {
- "description": "An optional key that declares a parameter as required (true) or not (false). Default is true.",
- "type": "boolean",
- "default": true
- },
- "constraints": {
- "description": "The optional list of sequenced constraint clauses for the parameter.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/parameter-constraints"
- }
- },
- "entry_schema": {
- "description": "The optional property used to declare the name of the Datatype definition for entries of certain types. entry_schema must be defined when the type is list. This is the only type it is currently supported for.",
- "type": "object",
- "uniqueItems": true,
- "items": {"$ref": "#/definitions/list-parameter"}
- },
- "designer_editable": {
- "description": "A required property that declares a parameter as editable by designer in SDC Tool (true) or not (false).",
- "type": "boolean"
- },
- "sourced_at_deployment": {
- "description": "A required property that declares that a parameter is assigned at deployment time (true) or not (false).",
- "type": "boolean"
- },
- "policy_editable": {
- "description": "A required property that declares a parameter as editable by DevOps in Policy UI (true) or not (false).",
- "type": "boolean"
- },
- "policy_group": {
- "description": "An optional property used to group policy_editable parameters into groups. Each group will become it's own policy model. Any parameters without this property will be grouped together to form their own policy model",
- "type": "string"
- },
- "policy_schema" :{
- "type": "array",
- "uniqueItems": true,
- "items": {"$ref": "#/definitions/policy_schema_parameter"}
- }
- },
- "required": [
- "name",
- "value",
- "description",
- "designer_editable",
- "policy_editable",
- "sourced_at_deployment",
- "entry_schema"
- ],
- "additionalProperties": false,
- "dependencies": {
- "policy_schema": ["policy_editable"]
- }
- },
- "parameter-other": {
- "properties": {
- "name": {
- "type": "string"
- },
- "value": {
- "description": "Default value for the parameter"
- },
- "description": {
- "description": "Description for the parameter.",
- "type": "string"
- },
- "type": {
- "description": "The required data type for the parameter.",
- "type": "string",
- "enum": [ "string", "number", "boolean", "datetime" ]
- },
- "required": {
- "description": "An optional key that declares a parameter as required (true) or not (false). Default is true.",
- "type": "boolean",
- "default": true
- },
- "constraints": {
- "description": "The optional list of sequenced constraint clauses for the parameter.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/parameter-constraints"
- }
- },
- "designer_editable": {
- "description": "A required property that declares a parameter as editable by designer in SDC Tool (true) or not (false).",
- "type": "boolean"
- },
- "sourced_at_deployment": {
- "description": "A required property that declares that a parameter is assigned at deployment time (true) or not (false).",
- "type": "boolean"
- },
- "policy_editable": {
- "description": "A required property that declares a parameter as editable in Policy UI (true) or not (false).",
- "type": "boolean"
- },
- "policy_group": {
- "description": "An optional property used to group policy_editable parameters into groups. Each group will become it's own policy model. Any parameters without this property will be grouped together to form their own policy model",
- "type": "string"
- },
- "policy_schema" :{
- "description": "An optional property used to define policy_editable parameters as lists or maps",
- "type": "array",
- "uniqueItems": true,
- "items": {"$ref": "#/definitions/policy_schema_parameter"}
- }
- },
- "required": [
- "name",
- "value",
- "description",
- "designer_editable",
- "sourced_at_deployment",
- "policy_editable"
- ],
- "additionalProperties": false,
- "dependencies": {
- "policy_schema": ["policy_editable"]
- }
- },
- "list-parameter": {
- "type": "object",
- "properties": {
- "type": {
- "description": "The required data type for each parameter in the list.",
- "type": "string",
- "enum": ["string", "number"]
- }
- },
- "required": [
- "type"
- ],
- "additionalProperties": false
- },
- "policy_schema_parameter": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "value": {
- "description": "Default value for the parameter"
- },
- "description": {
- "description": "Description for the parameter.",
- "type": "string"
- },
- "type": {
- "description": "The required data type for the parameter.",
- "type": "string",
- "enum": [ "string", "number", "boolean", "datetime", "list", "map" ]
- },
- "required": {
- "description": "An optional key that declares a parameter as required (true) or not (false). Default is true.",
- "type": "boolean",
- "default": true
- },
- "constraints": {
- "description": "The optional list of sequenced constraint clauses for the parameter.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/parameter-constraints"
- }
- },
- "entry_schema": {
- "description": "The optional key that is used to declare the name of the Datatype definition for entries of certain types. entry_schema must be defined when the type is either list or map. If the type is list and the entry type is a simple type (string, number, boolean, datetime), follow with a simple string to describe the entry type. If the type is list and the entry type is a map, follow with an array to describe the keys for the entry map. If the type is list and the entry type is also list, this is not currently supported here. If the type is map, then follow with an array to describe the keys for this map. ",
- "type": "array", "uniqueItems": true, "items": {"$ref": "#/definitions/policy_schema_parameter"}
- }
- },
- "required": [
- "name",
- "type"
- ],
- "additionalProperties": false
- },
- "parameter-constraints": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "equal": {
- "description": "Constrains a property or parameter to a value equal to (‘=’) the value declared."
- },
- "greater_than": {
- "description": "Constrains a property or parameter to a value greater than (‘>’) the value declared.",
- "type": "number"
- },
- "greater_or_equal": {
- "description": "Constrains a property or parameter to a value greater than or equal to (‘>=’) the value declared.",
- "type": "number"
- },
- "less_than": {
- "description": "Constrains a property or parameter to a value less than (‘<’) the value declared.",
- "type": "number"
- },
- "less_or_equal": {
- "description": "Constrains a property or parameter to a value less than or equal to (‘<=’) the value declared.",
- "type": "number"
- },
- "valid_values": {
- "description": "Constrains a property or parameter to a value that is in the list of declared values.",
- "type": "array"
- },
- "length": {
- "description": "Constrains the property or parameter to a value of a given length.",
- "type": "number"
- },
- "min_length": {
- "description": "Constrains the property or parameter to a value to a minimum length.",
- "type": "number"
- },
- "max_length": {
- "description": "Constrains the property or parameter to a value to a maximum length.",
- "type": "number"
- }
- }
- },
- "stream_message_router": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "#/definitions/name"
+ "required": [
+ "self",
+ "streams",
+ "services",
+ "parameters",
+ "auxilary",
+ "artifacts"
+ ],
+ "additionalProperties": false,
+ "definitions": {
+ "cdap-parameters": {
+ "description": "There are three seperate ways to pass parameters to CDAP: app config, app preferences, program preferences. These are all treated as optional.",
+ "type": "object",
+ "properties": {
+ "program_preferences": {
+ "description": "A list of {program_id, program_type, program_preference} objects where program_preference is an object passed into program_id of type program_type",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/program_preference"
+ }
+ },
+ "app_preferences": {
+ "description": "Parameters Passed down to the CDAP preference API",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/parameter"
+ }
+ },
+ "app_config": {
+ "description": "Parameters Passed down to the CDAP App Config",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/parameter"
+ }
+ }
+ }
},
- "version": {
- "$ref": "#/definitions/version"
+ "program_preference": {
+ "type": "object",
+ "properties": {
+ "program_type": {
+ "$ref": "#/definitions/program_type"
+ },
+ "program_id": {
+ "type": "string"
+ },
+ "program_pref": {
+ "description": "Parameters that the CDAP developer wants pushed to this program's preferences API. Optional",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/parameter"
+ }
+ }
+ },
+ "required": [
+ "program_type",
+ "program_id",
+ "program_pref"
+ ]
},
- "config_key": {
- "type": "string"
+ "program_type": {
+ "type": "string",
+ "enum": [
+ "flows",
+ "mapreduce",
+ "schedules",
+ "spark",
+ "workflows",
+ "workers",
+ "services"
+ ]
},
- "type": {
- "description": "Type of stream to be used",
- "type": "string",
- "enum": [
- "message router", "message_router"
- ]
- }
- },
- "required": [
- "format",
- "version",
- "config_key",
- "type"
- ]
- },
- "stream_kafka": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "#/definitions/name"
+ "docker-parameters": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/parameter"
+ }
},
- "version": {
- "$ref": "#/definitions/version"
+ "parameter": {
+ "oneOf": [
+ {
+ "$ref": "#/definitions/parameter-list"
+ },
+ {
+ "$ref": "#/definitions/parameter-other"
+ }
+ ]
},
- "config_key": {
- "type": "string"
+ "parameter-list": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "description": "Default value for the parameter"
+ },
+ "description": {
+ "description": "Description for the parameter.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Only valid type is list, the entry_schema is required - which contains the type of the list element. All properties set for the parameter apply to all elements in the list at this time",
+ "type": "string",
+ "enum": [
+ "list"
+ ]
+ },
+ "required": {
+ "description": "An optional key that declares a parameter as required (true) or not (false). Default is true.",
+ "type": "boolean",
+ "default": true
+ },
+ "constraints": {
+ "description": "The optional list of sequenced constraint clauses for the parameter.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/parameter-constraints"
+ }
+ },
+ "entry_schema": {
+ "description": "The optional property used to declare the name of the Datatype definition for entries of certain types. entry_schema must be defined when the type is list. This is the only type it is currently supported for.",
+ "type": "object",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/list-parameter"
+ }
+ },
+ "designer_editable": {
+ "description": "A required property that declares a parameter as editable by designer in SDC Tool (true) or not (false).",
+ "type": "boolean"
+ },
+ "sourced_at_deployment": {
+ "description": "A required property that declares that a parameter is assigned at deployment time (true) or not (false).",
+ "type": "boolean"
+ },
+ "policy_editable": {
+ "description": "A required property that declares a parameter as editable by DevOps in Policy UI (true) or not (false).",
+ "type": "boolean"
+ },
+ "policy_group": {
+ "description": "An optional property used to group policy_editable parameters into groups. Each group will become it's own policy model. Any parameters without this property will be grouped together to form their own policy model",
+ "type": "string"
+ },
+ "policy_schema": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/policy_schema_parameter"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "value",
+ "description",
+ "designer_editable",
+ "policy_editable",
+ "sourced_at_deployment",
+ "entry_schema"
+ ],
+ "additionalProperties": false,
+ "dependencies": {
+ "policy_schema": [
+ "policy_editable"
+ ]
+ }
},
- "type": {
- "description": "Type of stream to be used",
- "type": "string",
- "enum": [
- "kafka"
- ]
- }
- },
- "required": [
- "format",
- "version",
- "config_key",
- "type"
- ]
- },
- "publisher_http": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "#/definitions/name"
+ "parameter-other": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "description": "Default value for the parameter"
+ },
+ "description": {
+ "description": "Description for the parameter.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The required data type for the parameter.",
+ "type": "string",
+ "enum": [
+ "string",
+ "number",
+ "boolean",
+ "datetime"
+ ]
+ },
+ "required": {
+ "description": "An optional key that declares a parameter as required (true) or not (false). Default is true.",
+ "type": "boolean",
+ "default": true
+ },
+ "constraints": {
+ "description": "The optional list of sequenced constraint clauses for the parameter.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/parameter-constraints"
+ }
+ },
+ "designer_editable": {
+ "description": "A required property that declares a parameter as editable by designer in SDC Tool (true) or not (false).",
+ "type": "boolean"
+ },
+ "sourced_at_deployment": {
+ "description": "A required property that declares that a parameter is assigned at deployment time (true) or not (false).",
+ "type": "boolean"
+ },
+ "policy_editable": {
+ "description": "A required property that declares a parameter as editable in Policy UI (true) or not (false).",
+ "type": "boolean"
+ },
+ "policy_group": {
+ "description": "An optional property used to group policy_editable parameters into groups. Each group will become it's own policy model. Any parameters without this property will be grouped together to form their own policy model",
+ "type": "string"
+ },
+ "policy_schema": {
+ "description": "An optional property used to define policy_editable parameters as lists or maps",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/policy_schema_parameter"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "value",
+ "description",
+ "designer_editable",
+ "sourced_at_deployment",
+ "policy_editable"
+ ],
+ "additionalProperties": false,
+ "dependencies": {
+ "policy_schema": [
+ "policy_editable"
+ ]
+ }
},
- "version": {
- "$ref": "#/definitions/version"
- },
- "config_key": {
- "type": "string"
- },
- "type": {
- "description": "Type of stream to be used",
- "type": "string",
- "enum": [
- "http",
- "https"
- ]
- }
- },
- "required": [
- "format",
- "version",
- "config_key",
- "type"
- ]
- },
- "publisher_message_router": {
- "$ref": "#/definitions/stream_message_router"
- },
- "publisher_data_router": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "#/definitions/name"
+ "list-parameter": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The required data type for each parameter in the list.",
+ "type": "string",
+ "enum": [
+ "string",
+ "number"
+ ]
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "additionalProperties": false
},
- "version": {
- "$ref": "#/definitions/version"
+ "policy_schema_parameter": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "description": "Default value for the parameter"
+ },
+ "description": {
+ "description": "Description for the parameter.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The required data type for the parameter.",
+ "type": "string",
+ "enum": [
+ "string",
+ "number",
+ "boolean",
+ "datetime",
+ "list",
+ "map"
+ ]
+ },
+ "required": {
+ "description": "An optional key that declares a parameter as required (true) or not (false). Default is true.",
+ "type": "boolean",
+ "default": true
+ },
+ "constraints": {
+ "description": "The optional list of sequenced constraint clauses for the parameter.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/parameter-constraints"
+ }
+ },
+ "entry_schema": {
+ "description": "The optional key that is used to declare the name of the Datatype definition for entries of certain types. entry_schema must be defined when the type is either list or map. If the type is list and the entry type is a simple type (string, number, boolean, datetime), follow with a simple string to describe the entry type. If the type is list and the entry type is a map, follow with an array to describe the keys for the entry map. If the type is list and the entry type is also list, this is not currently supported here. If the type is map, then follow with an array to describe the keys for this map. ",
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/policy_schema_parameter"
+ }
+ }
+ },
+ "required": [
+ "name",
+ "type"
+ ],
+ "additionalProperties": false
},
- "config_key": {
- "type": "string"
+ "parameter-constraints": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "equal": {
+ "description": "Constrains a property or parameter to a value equal to (‘=’) the value declared."
+ },
+ "greater_than": {
+ "description": "Constrains a property or parameter to a value greater than (‘>’) the value declared.",
+ "type": "number"
+ },
+ "greater_or_equal": {
+ "description": "Constrains a property or parameter to a value greater than or equal to (‘>=’) the value declared.",
+ "type": "number"
+ },
+ "less_than": {
+ "description": "Constrains a property or parameter to a value less than (‘<’) the value declared.",
+ "type": "number"
+ },
+ "less_or_equal": {
+ "description": "Constrains a property or parameter to a value less than or equal to (‘<=’) the value declared.",
+ "type": "number"
+ },
+ "valid_values": {
+ "description": "Constrains a property or parameter to a value that is in the list of declared values.",
+ "type": "array"
+ },
+ "length": {
+ "description": "Constrains the property or parameter to a value of a given length.",
+ "type": "number"
+ },
+ "min_length": {
+ "description": "Constrains the property or parameter to a value to a minimum length.",
+ "type": "number"
+ },
+ "max_length": {
+ "description": "Constrains the property or parameter to a value to a maximum length.",
+ "type": "number"
+ }
+ }
},
- "type": {
- "description": "Type of stream to be used",
- "type": "string",
- "enum": [
- "data router", "data_router"
- ]
- }
- },
- "required": [
- "format",
- "version",
- "config_key",
- "type"
- ]
- },
- "publisher_kafka": {
- "$ref": "#/definitions/stream_kafka"
- },
- "subscriber_http": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "#/definitions/name"
+ "stream_message_router": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "$ref": "#/definitions/name"
+ },
+ "version": {
+ "$ref": "#/definitions/version"
+ },
+ "config_key": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of stream to be used",
+ "type": "string",
+ "enum": [
+ "message router",
+ "message_router"
+ ]
+ }
+ },
+ "required": [
+ "format",
+ "version",
+ "config_key",
+ "type"
+ ]
},
- "version": {
- "$ref": "#/definitions/version"
- },
- "route": {
- "type": "string"
- },
- "type": {
- "description": "Type of stream to be used",
- "type": "string",
- "enum": [
- "http",
- "https"
- ]
- }
- },
- "required": [
- "format",
- "version",
- "route",
- "type"
- ]
- },
- "subscriber_message_router": {
- "$ref": "#/definitions/stream_message_router"
- },
- "subscriber_data_router": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "#/definitions/name"
+ "stream_kafka": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "$ref": "#/definitions/name"
+ },
+ "version": {
+ "$ref": "#/definitions/version"
+ },
+ "config_key": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of stream to be used",
+ "type": "string",
+ "enum": [
+ "kafka"
+ ]
+ }
+ },
+ "required": [
+ "format",
+ "version",
+ "config_key",
+ "type"
+ ]
},
- "version": {
- "$ref": "#/definitions/version"
+ "publisher_http": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "$ref": "#/definitions/name"
+ },
+ "version": {
+ "$ref": "#/definitions/version"
+ },
+ "config_key": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of stream to be used",
+ "type": "string",
+ "enum": [
+ "http",
+ "https"
+ ]
+ }
+ },
+ "required": [
+ "format",
+ "version",
+ "config_key",
+ "type"
+ ]
},
- "route": {
- "type": "string"
+ "publisher_message_router": {
+ "$ref": "#/definitions/stream_message_router"
},
- "type": {
- "description": "Type of stream to be used",
- "type": "string",
- "enum": [
- "data router", "data_router"
- ]
+ "publisher_data_router": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "$ref": "#/definitions/name"
+ },
+ "version": {
+ "$ref": "#/definitions/version"
+ },
+ "config_key": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of stream to be used",
+ "type": "string",
+ "enum": [
+ "data router",
+ "data_router"
+ ]
+ }
+ },
+ "required": [
+ "format",
+ "version",
+ "config_key",
+ "type"
+ ]
},
- "config_key": {
- "description": "Data router subscribers require config info to setup their endpoints to handle requests. For example, needs username and password",
- "type": "string"
- }
- },
- "required": [
- "format",
- "version",
- "route",
- "type",
- "config_key"
- ]
- },
- "subscriber_kafka": {
- "$ref": "#/definitions/stream_kafka"
- },
- "provider" : {
- "oneOf" : [
- {"$ref": "#/definitions/docker-provider"},
- {"$ref": "#/definitions/cdap-provider"}
- ]
- },
- "cdap-provider" : {
- "type": "object",
- "properties" : {
- "request": {
- "$ref": "#/definitions/formatPair"
+ "publisher_kafka": {
+ "$ref": "#/definitions/stream_kafka"
},
- "response": {
- "$ref": "#/definitions/formatPair"
+ "subscriber_http": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "$ref": "#/definitions/name"
+ },
+ "version": {
+ "$ref": "#/definitions/version"
+ },
+ "route": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of stream to be used",
+ "type": "string",
+ "enum": [
+ "http",
+ "https"
+ ]
+ }
+ },
+ "required": [
+ "format",
+ "version",
+ "route",
+ "type"
+ ]
},
- "service_name" : {
- "type" : "string"
+ "subscriber_message_router": {
+ "$ref": "#/definitions/stream_message_router"
},
- "service_endpoint" : {
- "type" : "string"
+ "subscriber_data_router": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "$ref": "#/definitions/name"
+ },
+ "version": {
+ "$ref": "#/definitions/version"
+ },
+ "route": {
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of stream to be used",
+ "type": "string",
+ "enum": [
+ "data router",
+ "data_router"
+ ]
+ },
+ "config_key": {
+ "description": "Data router subscribers require config info to setup their endpoints to handle requests. For example, needs username and password",
+ "type": "string"
+ }
+ },
+ "required": [
+ "format",
+ "version",
+ "route",
+ "type",
+ "config_key"
+ ]
},
- "verb" : {
- "type": "string",
- "enum": ["GET", "PUT", "POST", "DELETE"]
- }
- },
- "required" : [
- "request",
- "response",
- "service_name",
- "service_endpoint",
- "verb"
- ]
- },
- "docker-provider": {
- "type": "object",
- "properties": {
- "request": {
- "$ref": "#/definitions/formatPair"
+ "subscriber_kafka": {
+ "$ref": "#/definitions/stream_kafka"
},
- "response": {
- "$ref": "#/definitions/formatPair"
+ "provider": {
+ "oneOf": [
+ {
+ "$ref": "#/definitions/docker-provider"
+ },
+ {
+ "$ref": "#/definitions/cdap-provider"
+ }
+ ]
},
- "route": {
- "type": "string"
+ "cdap-provider": {
+ "type": "object",
+ "properties": {
+ "request": {
+ "$ref": "#/definitions/formatPair"
+ },
+ "response": {
+ "$ref": "#/definitions/formatPair"
+ },
+ "service_name": {
+ "type": "string"
+ },
+ "service_endpoint": {
+ "type": "string"
+ },
+ "verb": {
+ "type": "string",
+ "enum": [
+ "GET",
+ "PUT",
+ "POST",
+ "DELETE"
+ ]
+ }
+ },
+ "required": [
+ "request",
+ "response",
+ "service_name",
+ "service_endpoint",
+ "verb"
+ ]
},
- "verb": {
- "type": "string",
- "enum": ["GET", "PUT", "POST", "DELETE"]
- }
- },
- "required": [
- "request",
- "response",
- "route"
- ]
- },
- "caller": {
- "type": "object",
- "properties": {
- "request": {
- "$ref": "#/definitions/formatPair"
+ "docker-provider": {
+ "type": "object",
+ "properties": {
+ "request": {
+ "$ref": "#/definitions/formatPair"
+ },
+ "response": {
+ "$ref": "#/definitions/formatPair"
+ },
+ "route": {
+ "type": "string"
+ },
+ "verb": {
+ "type": "string",
+ "enum": [
+ "GET",
+ "PUT",
+ "POST",
+ "DELETE"
+ ]
+ }
+ },
+ "required": [
+ "request",
+ "response",
+ "route"
+ ]
},
- "response": {
- "$ref": "#/definitions/formatPair"
+ "caller": {
+ "type": "object",
+ "properties": {
+ "request": {
+ "$ref": "#/definitions/formatPair"
+ },
+ "response": {
+ "$ref": "#/definitions/formatPair"
+ },
+ "config_key": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "request",
+ "response",
+ "config_key"
+ ]
},
- "config_key": {
- "type": "string"
- }
- },
- "required": [
- "request",
- "response",
- "config_key"
- ]
- },
- "formatPair": {
- "type": "object",
- "properties": {
- "format": {
- "$ref": "#/definitions/name"
+ "formatPair": {
+ "type": "object",
+ "properties": {
+ "format": {
+ "$ref": "#/definitions/name"
+ },
+ "version": {
+ "$ref": "#/definitions/version"
+ }
+ }
+ },
+ "name": {
+ "type": "string"
},
"version": {
- "$ref": "#/definitions/version"
- }
- }
- },
- "name": {
- "type": "string"
- },
- "version": {
- "type": "string",
- "pattern": "^(\\d+\\.)(\\d+\\.)(\\*|\\d+)$"
- },
- "artifact": {
- "type": "object",
- "description": "Component artifact object",
- "properties": {
- "uri": {
- "type": "string",
- "description": "Uri to artifact"
- },
- "type": {
- "type": "string",
- "enum": ["jar", "docker image"]
- }
- },
- "required": ["uri", "type"]
- },
-
- "auxilary_cdap": {
- "title": "cdap component specification schema",
- "type": "object",
- "properties": {
- "streamname": {
- "type": "string"
- },
- "artifact_name" : {
- "type": "string"
- },
- "artifact_version" : {
- "type": "string",
- "pattern": "^(\\d+\\.)(\\d+\\.)(\\*|\\d+)$"
- },
- "namespace":{
- "type": "string",
- "description" : "optional"
- },
- "programs": {
- "type": "array",
- "uniqueItems": true,
- "items": {
- "$ref": "#/definitions/cdap_program"
- }
- }
- },
- "required": [
- "streamname",
- "programs",
- "artifact_name",
- "artifact_version"
- ]
- },
- "cdap_program_type": {
- "type": "string",
- "enum": ["flows","mapreduce","schedules","spark","workflows","workers","services"]
- },
- "cdap_program": {
- "type": "object",
- "properties": {
- "program_type": {
- "$ref": "#/definitions/cdap_program_type"
+ "type": "string",
+ "pattern": "^(\\d+\\.)(\\d+\\.)(\\*|\\d+)$"
},
- "program_id": {
- "type": "string"
- }
- },
- "required": ["program_type", "program_id"]
- },
-
- "auxilary_docker": {
- "title": "Docker component specification schema",
- "type": "object",
- "properties": {
- "healthcheck": {
- "description": "Define the health check that Consul should perfom for this component",
- "type": "object",
- "oneOf": [
- { "$ref": "#/definitions/docker_healthcheck_http" },
- { "$ref": "#/definitions/docker_healthcheck_script" }
- ]
- },
- "ports": {
- "description": "Port mapping to be used for Docker containers. Each entry is of the format <container port>:<host port>.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "log_info": {
- "description": "Component specific details for logging",
- "type": "object",
- "properties": {
- "log_directory": {
- "description": "The path in the container where the component writes its logs. If the component is following the EELF requirements, this would be the directory where the four EELF files are being written. (Other logs can be placed in the directory--if their names in '.log', they'll also be sent into ELK.)",
- "type": "string"
- },
- "alternate_fb_path": {
- "description": "By default, the log volume is mounted at /var/log/onap/<component_type> in the sidecar container's file system. 'alternate_fb_path' allows overriding the default. Will affect how the log data can be found in the ELK system.",
- "type": "string"
- }
- },
- "additionalProperties": false
- },
- "tls_info": {
- "description": "Component information to use tls certificates",
- "type": "object",
- "properties": {
- "cert_directory": {
- "description": "The path in the container where the component certificates will be placed by the init container",
- "type": "string"
+ "artifact": {
+ "type": "object",
+ "description": "Component artifact object",
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "Uri to artifact"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "jar",
+ "docker image"
+ ]
+ }
},
- "use_tls": {
- "description": "Boolean flag to determine if the application is using tls certificates",
- "type": "boolean"
+ "required": [
+ "uri",
+ "type"
+ ]
+ },
+ "auxilary_cdap": {
+ "title": "cdap component specification schema",
+ "type": "object",
+ "properties": {
+ "streamname": {
+ "type": "string"
+ },
+ "artifact_name": {
+ "type": "string"
+ },
+ "artifact_version": {
+ "type": "string",
+ "pattern": "^(\\d+\\.)(\\d+\\.)(\\*|\\d+)$"
+ },
+ "namespace": {
+ "type": "string",
+ "description": "optional"
+ },
+ "programs": {
+ "type": "array",
+ "uniqueItems": true,
+ "items": {
+ "$ref": "#/definitions/cdap_program"
+ }
+ }
},
- "use_external_tls": {
- "description": "Boolean flag to determine if the application is using tls certificates for external communication",
- "type": "boolean"
- }
- },
- "required": [
- "cert_directory","use_tls"
- ],
- "additionalProperties": false
- },
- "databases": {
- "description": "The databases the application is connecting to using the pgaas",
- "type": "object",
- "additionalProperties": {
+ "required": [
+ "streamname",
+ "programs",
+ "artifact_name",
+ "artifact_version"
+ ]
+ },
+ "cdap_program_type": {
"type": "string",
"enum": [
- "postgres"
+ "flows",
+ "mapreduce",
+ "schedules",
+ "spark",
+ "workflows",
+ "workers",
+ "services"
]
- }
- },
- "policy": {
- "properties": {
- "trigger_type": {
- "description": "Only value of docker is supported at this time.",
- "type": "string",
- "enum": ["docker"]
+ },
+ "cdap_program": {
+ "type": "object",
+ "properties": {
+ "program_type": {
+ "$ref": "#/definitions/cdap_program_type"
+ },
+ "program_id": {
+ "type": "string"
+ }
},
- "script_path": {
- "description": "Script command that will be executed for policy reconfiguration",
- "type": "string"
- }
- },
- "required": [
- "trigger_type","script_path"
- ],
- "additionalProperties": false
- },
- "volumes": {
- "description": "Volume mapping to be used for Docker containers. Each entry is of the format below",
- "type": "array",
- "items": {
+ "required": [
+ "program_type",
+ "program_id"
+ ]
+ },
+ "auxilary_docker": {
+ "title": "Docker component specification schema",
"type": "object",
- "oneOf": [
- { "$ref": "#/definitions/host_path_volume" },
- { "$ref": "#/definitions/config_map_volume" }
+ "properties": {
+ "helm": {
+ "type": "object",
+ "properties": {
+ "applicationEnv": {
+ "type": "object"
+ },
+ "service": {
+ "description": "Mapping for kubernetes services",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "NodePort",
+ "ClusterIP"
+ ]
+ },
+ "name": {
+ "type": "string"
+ },
+ "ports": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "type",
+ "name",
+ "ports"
+ ]
+ }
+ },
+ "required": [
+ "service"
+ ]
+ },
+ "healthcheck": {
+ "description": "Define the health check that Consul should perfom for this component",
+ "type": "object",
+ "oneOf": [
+ {
+ "$ref": "#/definitions/docker_healthcheck_http"
+ },
+ {
+ "$ref": "#/definitions/docker_healthcheck_script"
+ }
+ ]
+ },
+ "ports": {
+ "description": "Port mapping to be used for Docker containers. Each entry is of the format <container port>:<host port>.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "log_info": {
+ "description": "Component specific details for logging",
+ "type": "object",
+ "properties": {
+ "log_directory": {
+ "description": "The path in the container where the component writes its logs. If the component is following the EELF requirements, this would be the directory where the four EELF files are being written. (Other logs can be placed in the directory--if their names in '.log', they'll also be sent into ELK.)",
+ "type": "string"
+ },
+ "alternate_fb_path": {
+ "description": "By default, the log volume is mounted at /var/log/onap/<component_type> in the sidecar container's file system. 'alternate_fb_path' allows overriding the default. Will affect how the log data can be found in the ELK system.",
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "tls_info": {
+ "description": "Component information to use tls certificates",
+ "type": "object",
+ "properties": {
+ "cert_directory": {
+ "description": "The path in the container where the component certificates will be placed by the init container",
+ "type": "string"
+ },
+ "use_tls": {
+ "description": "Boolean flag to determine if the application is using tls certificates",
+ "type": "boolean"
+ },
+ "use_external_tls": {
+ "description": "Boolean flag to determine if the application is using tls certificates for external communication",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "cert_directory",
+ "use_tls"
+ ],
+ "additionalProperties": false
+ },
+ "databases": {
+ "description": "The databases the application is connecting to using the pgaas",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "enum": [
+ "postgres"
+ ]
+ }
+ },
+ "policy": {
+ "properties": {
+ "trigger_type": {
+ "description": "Only value of docker is supported at this time.",
+ "type": "string",
+ "enum": [
+ "docker"
+ ]
+ },
+ "script_path": {
+ "description": "Script command that will be executed for policy reconfiguration",
+ "type": "string"
+ }
+ },
+ "required": [
+ "trigger_type",
+ "script_path"
+ ],
+ "additionalProperties": false
+ },
+ "volumes": {
+ "description": "Volume mapping to be used for Docker containers. Each entry is of the format below",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "oneOf": [
+ {
+ "$ref": "#/definitions/host_path_volume"
+ },
+ {
+ "$ref": "#/definitions/config_map_volume"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "healthcheck"
+ ],
+ "additionalProperties": false
+ },
+ "host_path_volume": {
+ "type": "object",
+ "properties": {
+ "host": {
+ "type": "object",
+ "path": {
+ "type": "string"
+ }
+ },
+ "container": {
+ "type": "object",
+ "bind": {
+ "type": "string"
+ },
+ "mode": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "host",
+ "container"
]
- }
- }
- },
- "required": [
- "healthcheck"
- ],
- "additionalProperties": false
- },
- "host_path_volume": {
- "type": "object",
- "properties": {
- "host": {
- "type": "object",
- "path": {
- "type": "string"
- }
},
- "container": {
- "type": "object",
- "bind": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- }
- }
- },
- "required": ["host", "container"]
- },
- "config_map_volume": {
- "type": "object",
- "properties": {
- "config_volume": {
- "type": "object",
- "name": {
- "type": "string"
- }
+ "config_map_volume": {
+ "type": "object",
+ "properties": {
+ "config_volume": {
+ "type": "object",
+ "name": {
+ "type": "string"
+ }
+ },
+ "container": {
+ "type": "object",
+ "bind": {
+ "type": "string"
+ },
+ "mode": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "config_volume",
+ "container"
+ ]
},
- "container": {
- "type": "object",
- "bind": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- }
- }
- },
- "required": ["config_volume", "container"]
- },
- "docker_healthcheck_http": {
- "properties": {
- "type": {
- "description": "Consul health check type",
- "type": "string",
- "enum": [
- "http",
- "https"
- ]
- },
- "interval": {
- "description": "Interval duration in seconds i.e. 10s",
- "default": "15s",
- "type": "string"
- },
- "timeout": {
- "description": "Timeout in seconds i.e. 10s",
- "default": "1s",
- "type": "string"
- },
- "endpoint": {
- "description": "Relative endpoint used by Consul to check health by making periodic HTTP GET calls",
- "type": "string"
- }
- },
- "required": [
- "type",
- "endpoint"
- ]
- },
- "docker_healthcheck_script": {
- "properties": {
- "type": {
- "description": "Consul health check type",
- "type": "string",
- "enum": [
- "script",
- "docker"
- ]
- },
- "interval": {
- "description": "Interval duration in seconds i.e. 10s",
- "default": "15s",
- "type": "string"
- },
- "timeout": {
- "description": "Timeout in seconds i.e. 10s",
- "default": "1s",
- "type": "string"
- },
- "script": {
- "description": "Script command that will be executed by Consul to check health",
- "type": "string"
+ "docker_healthcheck_http": {
+ "properties": {
+ "type": {
+ "description": "Consul health check type",
+ "type": "string",
+ "enum": [
+ "http",
+ "https",
+ "HTTP",
+ "HTTPS"
+ ]
+ },
+ "interval": {
+ "description": "Interval duration in seconds i.e. 10s",
+ "default": "15s",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Timeout in seconds i.e. 10s",
+ "default": "1s",
+ "type": "string"
+ },
+ "endpoint": {
+ "description": "Relative endpoint used by Consul to check health by making periodic HTTP GET calls",
+ "type": "string"
+ },
+ "port": {
+ "description": "Port mapping for readiness section",
+ "type": "integer"
+ },
+ "initialDelaySeconds": {
+ "description": "Initial delay in seconds for readiness section",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "type",
+ "endpoint"
+ ]
+ },
+ "docker_healthcheck_script": {
+ "properties": {
+ "type": {
+ "description": "Consul health check type",
+ "type": "string",
+ "enum": [
+ "script",
+ "docker"
+ ]
+ },
+ "interval": {
+ "description": "Interval duration in seconds i.e. 10s",
+ "default": "15s",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "Timeout in seconds i.e. 10s",
+ "default": "1s",
+ "type": "string"
+ },
+ "script": {
+ "description": "Script command that will be executed by Consul to check health",
+ "type": "string"
+ },
+ "initialDelaySeconds": {
+ "description": "Initial delay in seconds for readiness section",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "type",
+ "script"
+ ]
}
- },
- "required": [
- "type",
- "script"
- ]
}
- }
- }
+}
diff --git a/docs/sections/design-components/component-specification/component-type-docker.rst b/docs/sections/design-components/component-specification/component-type-docker.rst
index a685e342..db338cd1 100755
--- a/docs/sections/design-components/component-specification/component-type-docker.rst
+++ b/docs/sections/design-components/component-specification/component-type-docker.rst
@@ -1470,7 +1470,28 @@ the Docker image. For CDAP, this is the full path to the CDAP jar.
Auxilary
--------
+New V3 version of component spec schema introduced -
+https://github.com/onap/dcaegen2-platform/blob/master/mod/component-json-schemas/component-specification/dcae-cli-v3/component-spec-schema.json
+- Added new “helm” object under “auxilary\_docker” properties
+
+ - Includes “applicationEnv”
+
+ - Includes “service” definition
+
+- Readiness Configuration support
+
+ - docker\_healthcheck\_http
+
+ - Added HTTP/HTTPS for supported protocol enum list
+
+ - Added “port”
+
+ - Added “initialDelaySeconds”
+
+ - docker\_healthcheck\_script
+
+ - Added “initialDelaySeconds”
Health check
~~~~~~~~~~~~
diff --git a/docs/sections/design-components/component-specification/data-formats.rst b/docs/sections/design-components/component-specification/data-formats.rst
index 42194fa3..b0863ca4 100755
--- a/docs/sections/design-components/component-specification/data-formats.rst
+++ b/docs/sections/design-components/component-specification/data-formats.rst
@@ -1,235 +1,235 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. _data-formats:
-
-
-Data Formats
-============
-
-Data formats are descriptions of data; they are the data contract
-between your component and other components. When the components are
-‘composed’ into services in the Design tool, they can only be matched with
-components that have compatible data formats. Data formats will be
-onboarded to Design tool and assigned a UUID at that time. This UUID is then
-used to ensure compatibility amoung components. (If component X outputs
-data format ‘DF-Y’, and another component Z specifies ‘DF-Y’ as its
-input data format, then X is said to be ``composable`` with component
-Z).
-
-Since data formats will be shared across components, the onboarding
-catalog should be checked first to see if the desired data format is
-available before creating one. The vision is to have a repository of
-shared data formats that developers and teams can re-use and also
-provide them the means to extend and create new custom data formats. A
-data format is referenced by its data format id and version number.
-
-JSON schema
------------
-
- The data format specification is represented (and validated) against
- this `Data Format json schema <https://git.onap.org/dcaegen2/platform/plain/mod/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json>`__
- and described below:
-
-Meta Schema Definition
-~~~~~~~~~~~~~~~~~~~~~~
-
-The “Meta Schema” implementation defines how data format JSON schemas
-can be written to define user input. It is itself a JSON schema (thus it
-is a “meta schema”). It requires the name of the data format entry, the
-data format entry version and allows a description under “self” object.
-The meta schema version must be specified as the value of the
-“dataformatversion” key. Then the input schema itself is described as
-one of the four types listed below:
-
-+------------------+---------------------------------------------------+
-| Type | Description |
-+==================+===================================================+
-| jsonschema | inline standard JSON Schema definitions of JSON |
-| | inputs |
-+------------------+---------------------------------------------------+
-| delimitedschema | delimited data input using a JSON description and |
-| | defined delimiter |
-+------------------+---------------------------------------------------+
-| unstructured | unstructured text, and reference that allows a |
-| | pointer to another artifact for a schema. |
-+------------------+---------------------------------------------------+
-| reference | allows for XML and Protocol Buffers schema, |
-| | but can be used to reference other JSON, |
-| | delimitedschema and unstructured schemas as well. |
-+------------------+---------------------------------------------------+
-
-
-Example Schemas
----------------
-
-By reference example - Common Event Format
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-First the full JSON schema description of the Common Event Format would
-be loaded with a name of “Common Event Format” and the current version
-of “25.0.0”.
-
-Then the data format description is loaded by this schema:
-
-::
-
- {
- "self": {
- "name": "Common Event Format Definition",
- "version": "25.0.0",
- "description": "Common Event Format Definition"
-
- },
- "dataformatversion": "1.0.0",
- "reference": {
- "name": "Common Event Format",
- "format": "JSON",
- "version": "25.0.0"
- }
- }
-
-
-
-Simple JSON Example
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-
-::
-
- {
- "self": {
- "name": "Simple JSON Example",
- "version": "1.0.0",
- "description": "An example of unnested JSON schema for Input and output"
-
- },
- "dataformatversion": "1.0.0",
- "jsonschema": {
- "$schema": "http://json-schema.org/draft-04/schema#",
- "type": "object",
- "properties": {
- "raw-text": {
- "type": "string"
- }
- },
- "required": ["raw-text"],
- "additionalProperties": false
- }
- }
-
-Nested JSON Example
-~~~~~~~~~~~~~~~~~~~
-
-::
-
- {
- "self": {
- "name": "Nested JSON Example",
- "version": "1.0.0",
- "description": "An example of nested JSON schema for Input and output"
-
- },
- "dataformatversion": "1.0.0",
- "jsonschema": {
- "$schema": "http://json-schema.org/draft-04/schema#",
- "properties": {
- "numFound": {
- "type": "integer"
- },
- "start": {
- "type": "integer"
- },
- "engagements": {
- "type": "array",
- "items": {
- "properties": {
- "engagementID": {
- "type": "string",
- "transcript": {
- "type": "array",
- "items": {
- "type": {
- "type": "string"
- },
- "content": {
- "type": "string"
- },
- "senderName": {
- "type": "string"
- },
- "iso": {
- "type": "string"
- },
- "timestamp": {
- "type": "integer"
- },
- "senderId": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "additionalProperties": false
- }
- }
-
-Unstructured Example
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- {
- "self": {
- "name": "Unstructured Text Example",
- "version": "25.0.0",
- "description": "An example of a unstructured text used for both input and output for "
-
- },
- "dataformatversion": "1.0.0",
- "unstructured": {
- "encoding": "UTF-8"
- }
- }
-
-
-An example of a delimited schema
---------------------------------
-
-::
-
- {
- "self": {
- "name": "Delimited Format Example",
- "version": "1.0.0",
- "description": "Delimited format example just for testing"
-
- },
- "dataformatversion": "1.0.0",
- "delimitedschema": {
- "delimiter": "|",
- "fields": [{
- "name": "field1",
- "description": "test field1",
- "fieldtype": "string"
- }, {
- "name": "field2",
- "description": "test field2",
- "fieldtype": "boolean"
- }]
- }
- }
-
-Note: The referenced data format (in this case, a schema named “Common
-Event Format” with version of “25.0.0”) must already exist in the
-onboarding catalog.
-
-Working with Data Formats
--------------------------
-
-Data Formats can be validated using `schema <https://git.onap.org/dcaegen2/platform/plain/mod/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json>`__
-Once validated, the dataformat can be onboarded using :doc:`DCAE-MOD <../DCAE-MOD/DCAE-MOD-User-Guide>` \ No newline at end of file
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _data-formats:
+
+
+Data Formats
+============
+
+Data formats are descriptions of data; they are the data contract
+between your component and other components. When the components are
+‘composed’ into services in the Design tool, they can only be matched with
+components that have compatible data formats. Data formats will be
+onboarded to Design tool and assigned a UUID at that time. This UUID is then
+used to ensure compatibility amoung components. (If component X outputs
+data format ‘DF-Y’, and another component Z specifies ‘DF-Y’ as its
+input data format, then X is said to be ``composable`` with component
+Z).
+
+Since data formats will be shared across components, the onboarding
+catalog should be checked first to see if the desired data format is
+available before creating one. The vision is to have a repository of
+shared data formats that developers and teams can re-use and also
+provide them the means to extend and create new custom data formats. A
+data format is referenced by its data format id and version number.
+
+JSON schema
+-----------
+
+ The data format specification is represented (and validated) against
+ this `Data Format json schema <https://git.onap.org/dcaegen2/platform/plain/mod/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json>`__
+ and described below:
+
+Meta Schema Definition
+~~~~~~~~~~~~~~~~~~~~~~
+
+The “Meta Schema” implementation defines how data format JSON schemas
+can be written to define user input. It is itself a JSON schema (thus it
+is a “meta schema”). It requires the name of the data format entry, the
+data format entry version and allows a description under “self” object.
+The meta schema version must be specified as the value of the
+“dataformatversion” key. Then the input schema itself is described as
+one of the four types listed below:
+
++------------------+---------------------------------------------------+
+| Type | Description |
++==================+===================================================+
+| jsonschema | inline standard JSON Schema definitions of JSON |
+| | inputs |
++------------------+---------------------------------------------------+
+| delimitedschema | delimited data input using a JSON description and |
+| | defined delimiter |
++------------------+---------------------------------------------------+
+| unstructured | unstructured text, and reference that allows a |
+| | pointer to another artifact for a schema. |
++------------------+---------------------------------------------------+
+| reference | allows for XML and Protocol Buffers schema, |
+| | but can be used to reference other JSON, |
+| | delimitedschema and unstructured schemas as well. |
++------------------+---------------------------------------------------+
+
+
+Example Schemas
+---------------
+
+By reference example - Common Event Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+First the full JSON schema description of the Common Event Format would
+be loaded with a name of “Common Event Format” and the current version
+of “25.0.0”.
+
+Then the data format description is loaded by this schema:
+
+::
+
+ {
+ "self": {
+ "name": "Common Event Format Definition",
+ "version": "25.0.0",
+ "description": "Common Event Format Definition"
+
+ },
+ "dataformatversion": "1.0.0",
+ "reference": {
+ "name": "Common Event Format",
+ "format": "JSON",
+ "version": "25.0.0"
+ }
+ }
+
+
+
+Simple JSON Example
+~~~~~~~~~~~~~~~~~~~
+
+
+::
+
+ {
+ "self": {
+ "name": "Simple JSON Example",
+ "version": "1.0.0",
+ "description": "An example of unnested JSON schema for Input and output"
+
+ },
+ "dataformatversion": "1.0.0",
+ "jsonschema": {
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "type": "object",
+ "properties": {
+ "raw-text": {
+ "type": "string"
+ }
+ },
+ "required": ["raw-text"],
+ "additionalProperties": false
+ }
+ }
+
+Nested JSON Example
+~~~~~~~~~~~~~~~~~~~
+
+::
+
+ {
+ "self": {
+ "name": "Nested JSON Example",
+ "version": "1.0.0",
+ "description": "An example of nested JSON schema for Input and output"
+
+ },
+ "dataformatversion": "1.0.0",
+ "jsonschema": {
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "properties": {
+ "numFound": {
+ "type": "integer"
+ },
+ "start": {
+ "type": "integer"
+ },
+ "engagements": {
+ "type": "array",
+ "items": {
+ "properties": {
+ "engagementID": {
+ "type": "string",
+ "transcript": {
+ "type": "array",
+ "items": {
+ "type": {
+ "type": "string"
+ },
+ "content": {
+ "type": "string"
+ },
+ "senderName": {
+ "type": "string"
+ },
+ "iso": {
+ "type": "string"
+ },
+ "timestamp": {
+ "type": "integer"
+ },
+ "senderId": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "additionalProperties": false
+ }
+ }
+
+Unstructured Example
+~~~~~~~~~~~~~~~~~~~~
+
+::
+
+ {
+ "self": {
+ "name": "Unstructured Text Example",
+ "version": "25.0.0",
+ "description": "An example of a unstructured text used for both input and output for "
+
+ },
+ "dataformatversion": "1.0.0",
+ "unstructured": {
+ "encoding": "UTF-8"
+ }
+ }
+
+
+An example of a delimited schema
+--------------------------------
+
+::
+
+ {
+ "self": {
+ "name": "Delimited Format Example",
+ "version": "1.0.0",
+ "description": "Delimited format example just for testing"
+
+ },
+ "dataformatversion": "1.0.0",
+ "delimitedschema": {
+ "delimiter": "|",
+ "fields": [{
+ "name": "field1",
+ "description": "test field1",
+ "fieldtype": "string"
+ }, {
+ "name": "field2",
+ "description": "test field2",
+ "fieldtype": "boolean"
+ }]
+ }
+ }
+
+Note: The referenced data format (in this case, a schema named “Common
+Event Format” with version of “25.0.0”) must already exist in the
+onboarding catalog.
+
+Working with Data Formats
+-------------------------
+
+Data Formats can be validated using `schema <https://git.onap.org/dcaegen2/platform/plain/mod/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json>`__
+Once validated, the dataformat can be onboarded using :doc:`DCAE-MOD <../DCAE-MOD/DCAE-MOD-User-Guide>`
diff --git a/docs/sections/design-components/images/128713731_image2022.png b/docs/sections/design-components/images/128713731_image2022.png
new file mode 100644
index 00000000..0c9356c3
--- /dev/null
+++ b/docs/sections/design-components/images/128713731_image2022.png
Binary files differ
diff --git a/docs/sections/design-components/requirements-guidelines.rst b/docs/sections/design-components/requirements-guidelines.rst
index c887d4ff..015688fe 100644
--- a/docs/sections/design-components/requirements-guidelines.rst
+++ b/docs/sections/design-components/requirements-guidelines.rst
@@ -4,223 +4,67 @@
Onboarding Pre-requisite
========================
-Before a component is onboarded into DCAE, the component developer must ensure it
-is compliant with ONAP & DCAE goals and requirement in order to correctly be deployed and be managed. This
-page will discuss the changes which are grouped into the following
-categories:
-
-- :any:`Configuration management via ConfigBindingService <configuration_management>`
-- :any:`Docker images <docker_images>`
-- :any:`Policy Reconfiguration flow support <policy_reconfiguration>`
-- :any:`Operational Requirement <operation_requirement>`
-
-
-.. _configuration_management:
-
-Configuration Management
-------------------------
-
-All configuration for a component is stored in CONSUL under the
-components uniquely generated name which is provided by the environment
-variable ``HOSTNAME`` as well as ``SERVICE_NAME``. It is then made
-available to the component via a remote HTTP service call to CONFIG
-BINDING SERVICE.
-
-The main entry in CONSUL for the component contains its
-**generated application configuration**. This is based on the submitted
-component specification, and consists of the *interfaces* (streams and
-services/calls) and *parameters* sections. Other entries may exist as
-well, under specific keys, such as :dmaap . Each key represents a
-specific type of information and is also available to the component by
-calling CONFIG BINDING SERVICE. More on this below.
-
-Components are required to pull their
-**generated application configuration** at application startup using the environment
-setting exposed during deployment.
-
-
-Envs
-~~~~
-
-The platform provides a set of environment variables into each Docker
-container:
-
-+----------------------------+--------------+----------------------------------------+
-| Name | Type | Description |
-+============================+==============+========================================+
-| ``HOSTNAME`` | string | Unique name of the component instance |
-| | | that is generated |
-+----------------------------+--------------+----------------------------------------+
-| ``CONSUL_HOST`` | string | Hostname of the platform's Consul |
-| | | instance |
-+----------------------------+--------------+----------------------------------------+
-| ``CONFIG_BINDING_SERVICE`` | string | Hostname of the platform's config |
-| | | binding service instance |
-| | | |
-+----------------------------+--------------+----------------------------------------+
-| ``DOCKER_HOST`` | string | Host of the target platform Docker |
-| | | host to run the container on |
-+----------------------------+--------------+----------------------------------------+
-| ``CBS_CONFIG_URL`` | string | Fully resolved URL to query config |
-| | | from CONSUL via CBS |
-+----------------------------+--------------+----------------------------------------+
+Before a component is onboarded into DCAE, the component developer must ensure it
+is compliant with ONAP & DCAE goals and requirement in order to correctly be deployed and be managed.
.. _config_binding_service:
-Config Binding Service
-~~~~~~~~~~~~~~~~~~~~~~
+Config Binding Service SDK Integration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The config binding service is a platform HTTP service that is
-responsible for providing clients with its fully resolve configuration
-JSON at startup, and also other configurations objects
-when requested.
+With Jakarta release, Consul and ConfigBindingService interface has been deprecated from DCAE
+All Microservice configuration are resolved through files mounted via Configmap created part of
+dcae-services helm chart deployment.
-At runtime, components should make an HTTP GET on:
+CBS SDK library are available within DCAE which can be used by DCAE Microservices for configuration
+retrieval. For details on the API - refer `CBS SDK Java Library
+<https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/sdk/api.html>`__
-::
-
- <config binding service hostname>:<port>/service_component/NAME
+Its strongly recommended to use CBS SDK library for consistency across DCAE services to retrieve both static and policy driven configuration.
-For Docker components, NAME should be set to ``HOSTNAME``, which is
-provided as an ENV variable to the container.
+Topic Configuration
+~~~~~~~~~~~~~~~~~~~
-The binding service integrates with the streams and services section of
-the component specification. For example, if you specify that you call a
-service:
+With Helm flow integration in MOD, topic generation feature is not supported.
-::
-
- "services": {
- "calls": [{
- "config_key": "vnf-db",
- "request": {
- "format": "dcae.vnf.meta",
- "version": "1.0.0"
- },
- "response": {
- "format": "dcae.vnf.kpi",
- "version": "1.0.0"
- }
- }],
- ...
- }
-
-Then the config binding service will find all available IP addresses of
-services meeting the containers needs, and provide them to the container
-under your ``config_key``:
+Applications are required to identify the topic and feed information as application
+configuration.
+For application onboarded through MOD, these should be included in the specification file under **parameters**
::
- // your configuration
- {
- "vbf-db" : // see above
- [IP:Port1, IP:Port2,…] // all of these meet your needs, choose one.
- }
-
-Regarding ``<config binding service hostname>:<port>``, there is DNS
-work going on to make this resolvable in a convenient way inside of your
-container.
-
-For all Kubernetes deployments since El-Alto, an environment variable ``CBS_CONFIG_URL`` will be exposed
-by platform (k8s plugins) providing the exact URL to be used for configuration retrieval.
-Application can use this URL directly instead of constructing URL from HOSTNAME (which refers to ServiceComponentName)
-and CONFIG_BINDING_SERVICE env's. By default, this URL will use HTTPS CBS interface
-
-If you are integrating with CBS SDK, then the DNS resolution and configuration fetch
-are handled via library functions.
-
-Generated Application Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The DCAE platform uses the component specification to generate the
-component’s application configuration provided at deployment time. The
-component developer should expect to use this configuration JSON in the
-component.
-
-
-The following component spec snippet (from String Matching):
+ "parameters": [{
+ "name": "streams_publishes",
+ "value": "{\"ves-3gpp-fault-supervision\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_3GPP_FAULTSUPERVISION_OUTPUT\"},\"type\":\"message_router\"},\"ves-3gpp-heartbeat\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_3GPP_HEARTBEAT_OUTPUT\"},\"type\":\"message_router\"},\"ves-3gpp-performance-assurance\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_3GPP_PERFORMANCEASSURANCE_OUTPUT\"},\"type\":\"message_router\"},\"ves-3gpp-provisioning\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_3GPP_PROVISIONING_OUTPUT\"},\"type\":\"message_router\"},\"ves-fault\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_FAULT_OUTPUT\"},\"type\":\"message_router\"},\"ves-heartbeat\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_HEARTBEAT_OUTPUT\"},\"type\":\"message_router\"},\"ves-measurement\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.VES_MEASUREMENT_OUTPUT\"},\"type\":\"message_router\"},\"ves-notification\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.VES_NOTIFICATION_OUTPUT\"},\"type\":\"message_router\"},\"ves-other\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.SEC_OTHER_OUTPUT\"},\"type\":\"message_router\"},\"ves-pnfRegistration\":{\"dmaap_info\":{\"topic_url\":\"http:\/\/message-router:3904\/events\/unauthenticated.VES_PNFREG_OUTPUT\"},\"type\":\"message_router\"}}",
+ "description": "standard http port collector will open for listening;",
+ "sourced_at_deployment": false,
+ "policy_editable": false,
+ "designer_editable": false
+ }]
+For components delivered as Helm directly, it should be specified under **applicationConfig** section in values.yaml
::
- "streams":{
- "subscribes": [{
- "format": "VES_specification",
- "version": "4.27.2",
- "type": "message_router",
- "config_key" : "mr_input"
- }],
- "publishes": [{
- "format": "VES_specification",
- "version": "4.27.2",
- "config_key": "mr_output",
- "type": "message_router"
- }]
- },
- "services":{
- "calls": [{
- "config_key" : "aai_broker_handle",
- "verb": "GET",
- "request": {
- "format": "get_with_query_params",
- "version": "1.0.0"
- },
- "response": {
- "format": "aai_broker_response",
- "version": "3.0.0"
- }
- }],
- "provides": []
- },
-
-Will result in the following top level keys in the configuration
-
-::
+ streams_publishes:
+ ves-fault:
+ dmaap_info:
+ topic_url:"http://message-router:3904/events/unauthenticated.SEC_FAULT_OUTPUT"
+ type: message_router
+ ves-measurement:
+ dmaap_info:
+ topic_url: "http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT"
+ type: message_router
- "streams_publishes":{
- "mr_output":{ // notice the config key above
- "aaf_password":"XXX",
- "type":"message_router",
- "dmaap_info":{
- "client_role": null,
- "client_id": null,
- "location": null,
- "topic_url":"https://YOUR_HOST:3905/events/com.att.dcae.dmaap.FTL2.DCAE-CL-EVENT" // just an example
- },
- "aaf_username":"XXX"
- }
- },
- "streams_subscribes":{
- "mr_input":{ // notice the config key above
- "aaf_password":"XXX",
- "type":"message_router",
- "dmaap_info":{
- "client_role": null,
- "client_id": null,
- "location": null,
- "topic_url":"https://YOUR_HOST:3905/events/com.att.dcae.dmaap.FTL2.TerrysStringMatchingTest" // just an example
- },
- "aaf_username":"XXX"
- }
- },
- "services_calls":{
- "aai_broker_handle":[ // notice the config key above
- "135.205.226.128:32768" // based on deployment time, just an example
- ]
- }
-
-These keys will always be populated whether they are empty or not. So
-the minimum configuration you will get, (in the case of a component that
-provides an HTTP service, doesn’t call any services, and has no streams,
-is:
-::
+You can find examples of topic and feed configuration used in DCAE components from charts under OOM repository -
+https://github.com/onap/oom/tree/master/kubernetes/dcaegen2-services/components
- "streams_publishes":{},
- "streams_subscribes":{},
- "services_calls":{}
+Its recommended to follow similar topic construct for consistency across all DCAE Services. This will also enable using
+ `SDK DMAAP Java Library
+<https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/sdk/api.html>`__
+for easier integration.
-Thus your component should expect these well-known top level keys.
DCAE SDK
~~~~~~~~
@@ -237,15 +81,52 @@ DCAE has SDK/libraries which can be used for service components for easy integra
Policy Reconfiguration
----------------------
-Components must provide a way to receive policy reconfiguration, that
-is, configuration parameters that have been updated via the Policy UI.
-The component developer must either periodically poll the ConfigBindingService API
-to retrieve/refresh the new configuration or provides a script (defined in the :any:`Docker
-auxiliary specification <docker-auxiliary-details>`)
-that will be triggered when policy update is detected by the platform.
+Policy Framework based reconfiguration is supported via sidecar. The component owners are responsible for
+loading the required model and creating policies required.
+
+Once the policies are created, the corresponding policy_id should be listed in the component_spec or helm charts override as below
+
+Component spec must include the policy_info object and list of policy_id to be retrieved
+::
+ "policy_info":{
+ "policy": [
+ {
+ "node_label": "tca_policy_00",
+ "policy_model_id": "onap.policies.monitoring.cdap.tca.hi.lo.app",
+ "policy_id": "onap.vfirewall.tca"
+ },
+ {
+ "node_label":"tca_policy_01",
+ "policy_model_id":"onap.policies.monitoring.cdap.tca.hi.lo.app",
+ "policy_id":"onap.vdns.tca"
+ }
+ ]
+ }
+
+"node_label" is optional and can be ignored
+"policy_model_id" refers to model uploaded into policy framework
+"policy_id" refers to the instance of policy created for model specified.
+
+When the helm-charts are generated by DCAEMOD/Runtime, the charts will have following property defined in the values.yaml
+
+::
+ dcaePolicySyncImage: onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1
+ policies:
+ policyID: |
+ '["onap.vfirewall.tca","onap.vdns.tca"]'
+
+When using dcaegen2-services-common templates, the presence of **policies** property will deploy policy-sidecar automatically which will
+periodically pull configuration from Policy framework and make it available shared mountpoint to microservice container.
-.. _docker_images:
+More information on Policy side car can be found on this wiki - https://wiki.onap.org/display/DW/Policy+function+as+Sidecar
+
+.. note::
+ When using DCAE CBS SDK, policy config retrieval is supported natively by the library
+
+
+
+.. _docker_images:
Docker Images
-------------
@@ -258,6 +139,13 @@ For ONAP microservices, the components images are expected to pushed into ONAP n
part of `ONAP CI jobs <https://wiki.onap.org/display/DW/Using+Standard+Jenkins+Job+%28JJB%29+Templates>`__
+Helm Chart
+----------
+
+Components being delivered under ONAP/OOM must adopt dcaegen2-common-services template.
+Information about using the common templates to deploy a microservice can be
+found in :doc:`Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
+
.. _operation_requirement:
Operational Requirement
@@ -266,14 +154,14 @@ Operational Requirement
Logging
~~~~~~~
-All ONAP MS logging should follow logging specification defined by `logging project <https://wiki.onap.org/pages/viewpage.action?pageId=71831691>`__
+All ONAP MS logging should follow logging specification defined by `SECCOM <https://wiki.onap.org/display/DW/Jakarta+Best+Practice+Proposal+for+Standardized+Logging+Fields+-+v2>`__
The application log configuration must enable operation to choose if to be written into file or stdout or both during deployment.
-S3P
+S3P
~~~
-ONAP S3P (all scaling/resiliency/security/maintainability) goals should meet at the minimum level defined for DCAE project for the targeted release
-
-If the component is stateful, it should persist its state on external store (eg. pg, redis) to allow support for scaling and resiliency. This should be important design criteria for the component. If the components either publish/subscribe into DMAAP topic, then secure connection to DMAAP must be supported (platform will provide aaf_username/aaf_password for each topic as configuration).
+ONAP S3P (all scaling/resiliency/security/maintainability) goals should meet at the minimum level defined for DCAE project for the targeted release
+If the component is stateful, it should persist its state on external store (eg. pg, redis) to allow support for scaling and
+resiliency. This should be important design criteria for the component.
diff --git a/docs/sections/sdk/apis.rst b/docs/sections/sdk/apis.rst
index 823027f2..80d1489d 100644
--- a/docs/sections/sdk/apis.rst
+++ b/docs/sections/sdk/apis.rst
@@ -8,6 +8,7 @@ Available APIs
.. toctree::
:depth: 3
+.. _config_binding_service_sdk:
cbs-client - a Config Binding Service client
--------------------------------------------