diff options
Diffstat (limited to 'docs')
30 files changed, 123 insertions, 818 deletions
diff --git a/docs/sections/apis/dcaecdap.rst b/docs/sections/apis/dcaecdap.rst deleted file mode 100644 index 9e6bc92c..00000000 --- a/docs/sections/apis/dcaecdap.rst +++ /dev/null @@ -1,665 +0,0 @@ -.. This work is licensed under a - Creative Commons Attribution 4.0 International License. - -=============== -CDAP Broker API -=============== - -:Date: 2017-10-09 - -.. contents:: - :depth: 3 -.. - -Overview -======== - -Version information -------------------- - -*Version* : 4.0.10 - -Paths -===== - -GET / ------ - -Description -~~~~~~~~~~~ - -shows some information about this service - -Responses -~~~~~~~~~ - -+---------+--------------------------------------------+-------------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+============================================+===================+ -| **200** | successful response | `info <#_info>`__ | -+---------+--------------------------------------------+-------------------+ - -GET /application ----------------- - -Description -~~~~~~~~~~~ - -get all applications registered with this broker - -Responses -~~~~~~~~~ - -+---------+-------------------------------------------+---------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+===========================================+===============+ -| **200** | successful response | `appname <#_a | -| | | ppname>`__ | -| | | (array) | -+---------+-------------------------------------------+---------------+ - -PUT /application/{appname} --------------------------- - -Description -~~~~~~~~~~~ - -(This is a hacky way of supporting "oneOf" because Swagger does not -support oneOf https://github.com/OAI/OpenAPI-Specification/issues/333. -This is the same endpoint as PUT /application/appname, except the PUT -body is different.) - -Register a hydrator app for service and configuration discovery. This -will light up a metrics and health endpoint for this app. ``appname`` is -assumed to also be the key in consul. - -Parameters -~~~~~~~~~~ - -+----------+---------------+---------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+=================================+==================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+---------------------------------+------------------+ -| **Body** | | **putbody** | required put body | `hydratorappput | -| | | *required* | | <#_hydratorapppu | -| | | | t>`__ | -+----------+---------------+---------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+---------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+===============+ -| **200** | Successful response | `application | -| | | <#_applicatio | -| | | n>`__ | -+---------+----------------------------------------------------+---------------+ -| **400** | put was performed but the appname was already | No Content | -| | registered with the broker, or Invalid PUT body | | -+---------+----------------------------------------------------+---------------+ - -Consumes -~~~~~~~~ - -- ``application/json`` - -Produces -~~~~~~~~ - -- ``application/json`` - -POST /application/delete ------------------------- - -Description -~~~~~~~~~~~ - -endpoint to delete multiple applications at once. Returns an array of -status codes, where statuscode[i] = response returned from -DELETE(application/i) - -Parameters -~~~~~~~~~~ - -+----------+----------------+------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+================+==============================+==================+ -| **Body** | | **postbody** | required post body | `multideleteput | -| | | *required* | | <#_multideletepu | -| | | | t>`__ | -+----------+----------------+------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------+-------------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+==============================================+===================+ -| **200** | successful response | `returncode | -| | | <#_returncode>`__ | -| | | (array) | -+---------+----------------------------------------------+-------------------+ - -GET /application/{appname} --------------------------- - -Description -~~~~~~~~~~~ - -Returns the representation of the application resource, including the -links for healthcheck and metrics. - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+---------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+===============+ -| **200** | Successful response | `application | -| | | <#_applicatio | -| | | n>`__ | -+---------+----------------------------------------------------+---------------+ -| **404** | no app with name 'appname' registered with this | No Content | -| | broker. | | -+---------+----------------------------------------------------+---------------+ - -PUT /application/{appname} --------------------------- - -Description -~~~~~~~~~~~ - -Register an app for service and configuration discovery. This will light -up a metrics and health endpoint for this app. ``appname`` is assumed to -also be the key in consul. - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+--------------------------------+------------------+ -| **Body** | | **putbody** | required put body | `appput <#_apppu | -| | | *required* | | t>`__ | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+--------------------------------------------------+---------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+==================================================+===============+ -| **200** | Successful response | `Application | -| | | <#_applicatio | -| | | n>`__ | -+---------+--------------------------------------------------+---------------+ -| **400** | put was performed but the appname was already | No Content | -| | registered with the broker, or Invalid PUT body | | -+---------+--------------------------------------------------+---------------+ - -Consumes -~~~~~~~~ - -- ``application/json`` - -Produces -~~~~~~~~ - -- ``application/json`` - -DELETE /application/{appname} ------------------------------ - -Description -~~~~~~~~~~~ - -Remove an app for service and configuration discovery. This will remove -the metrics and health endpoints for this app. - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | Successful response | No Content | -+---------+----------------------------------------------------+----------------+ -| **404** | no app with name 'appname' registered with this | No Content | -| | broker. | | -+---------+----------------------------------------------------+----------------+ - -GET /application/{appname}/healthcheck --------------------------------------- - -Description -~~~~~~~~~~~ - -Perform a healthcheck on the running app appname. - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application to get | string (text) | -| | | *required* | the healthcheck for. | | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | Successful response, healthcheck pass | No Content | -+---------+----------------------------------------------------+----------------+ -| **404** | no app with name 'appname' registered with this | No Content | -| | broker, or the healthcheck has failed (though I | | -| | would like to disambiguiate from the first case, | | -| | CDAP returns a 404 for this). | | -+---------+----------------------------------------------------+----------------+ - -GET /application/{appname}/metrics ----------------------------------- - -Description -~~~~~~~~~~~ - -Get live (real-time) app specific metrics for the running app appname. -Metrics are customized per each app by the component developer - -Parameters -~~~~~~~~~~ - -+----------+---------------+--------------------------------+------------------+ -| Type | Name | Description | Schema | -+==========+===============+================================+==================+ -| **Path** | | **appname** | Name of the application to get | string (text) | -| | | *required* | metrics for. | | -+----------+---------------+--------------------------------+------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | Successful response | `MetricsObject | -| | | <#_metricsobje | -| | | ct>`__ | -+---------+----------------------------------------------------+----------------+ -| **404** | no app with name 'appname' registered with this | No Content | -| | broker. | | -+---------+----------------------------------------------------+----------------+ - -PUT /application/{appname}/reconfigure --------------------------------------- - -Description -~~~~~~~~~~~ - -Reconfigures the application. - -Parameters -~~~~~~~~~~ - -+----------+---------------+----------------------------+--------------------+ -| Type | Name | Description | Schema | -+==========+===============+============================+====================+ -| **Path** | | **appname** | Name of the application. | string (text) | -| | | *required* | | | -+----------+---------------+----------------------------+--------------------+ -| **Body** | | **putbody** | required put body | `reconfigput | -| | | *required* | | <#_reconfigput>`__ | -+----------+---------------+----------------------------+--------------------+ - -Responses -~~~~~~~~~ - -+---------+----------------------------------------------------+----------------+ -| HTTP | Description | Schema | -| Code | | | -+=========+====================================================+================+ -| **200** | Successful response | No Content | -+---------+----------------------------------------------------+----------------+ -| **400** | Bad request. Can happen with 1) {appname} is not | No Content | -| | registered with the broker, 2) the required PUT | | -| | body is wrong, or 3) the smart interface was | | -| | chosen and none of the config keys match anything | | -| | in app\_config or app\_preferences | | -+---------+----------------------------------------------------+----------------+ - -Definitions -=========== - -Application ------------ - -+---------------------+---------------------------------------------+------------------+ -| Name | Description | Schema | -+=====================+=============================================+==================+ -| | **appname** | application name | string | -| | *optional* | | | -+---------------------+---------------------------------------------+------------------+ -| | **connectionurl** | input URL that you can POST data into (URL | string | -| | *optional* | of the CDAP stream) | | -+---------------------+---------------------------------------------+------------------+ -| | **healthcheckurl**| fully qualified url to perform healthcheck | string | -| | *optional* | | | -+---------------------+---------------------------------------------+------------------+ -| | **metricsurl** | fully qualified url to get metrics from | string | -| | *optional* | | | -+---------------------+---------------------------------------------+------------------+ -| | **service | a list of HTTP services exposed by this | `service\_method | -| endpoints** | CDAP application | <#_service_metho | -| | *optional* | | d>`__ | -| | | (array) | -+---------------------+---------------------------------------------+------------------+ -| | **url** | fully qualified url of the resource | string | -| | *optional* | | | -+---------------------+---------------------------------------------+------------------+ - -MetricsObject -------------- - -key,value object where the key is 'appmetrics' and the value is an app -dependent json and specified by the component developer - -+--------------------------------+-------------------------------------------+ -| Name | Schema | -+================================+===========================================+ -| | **appmetrics** | object | -| | *optional* | | -+--------------------------------+-------------------------------------------+ - -appname -------- - -an application name - -*Type* : string - -appput ------- - -+-------------------------------+---------------------------------------------+--------------------+ -| Name | Description | Schema | -+===============================+=============================================+====================+ -| | **app\_config** | the application config JSON | object | -| | *optional* | | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **app\_preferences** | the application preferences JSON | object | -| | *optional* | | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **artifact\_name** | the name of the CDAP artifact to be added | string | -| | *optional* | | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **cdap\_application\_type** | denotes whether this is a program-flowlet | enum | -| | *optional* | style application or a hydrator pipeline. | (program-flowlet | -| | For program-flowlet style apps, this value | ) | -| | must be "program-flowlet" | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **jar\_url** | the URL that the JAR you’re deploying | string | -| | *optional* | resides | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **namespace** | the cdap namespace this is deployed into | string | -| | *optional* | | | -+-------------------------------+---------------------------------------------+--------------------+ -| | **program\_preferences** | | `programpref | -| | *optional* | | <#_programpref>`__ | -| | | (array) | -+-------------------------------+---------------------------------------------+--------------------+ -| | **programs** | | `programs | -| | *optional* | | <#_programs>`__ | -| | | (array) | -+-------------------------------+---------------------------------------------+--------------------+ -| | **services** | | `service\_endpoint | -| | *optional* | | <#_service_endpoin | -| | | t>`__ (array) | -+-------------------------------+---------------------------------------------+--------------------+ -| | **streamname** | name of the CDAP stream to ingest data into | string | -| | *optional* | this app. Should come from the developer | | -| | and Tosca model. | | -+-------------------------------+---------------------------------------------+--------------------+ - -hydratorappput --------------- - -+-----------------------------------+---------------------------------------------+---------------+ -| Name | Description | Schema | -+===================================+=============================================+===============+ -| | **cdap\_application\_TYPE** | denotes whether this is a program-flowlet | enum | -| | style application or a hydrator pipeline. | (hydrator-pip | -| | *required* | For hydrator, this value must be | eline) | -| | "hydrator-pipeline" | | -+-----------------------------------+---------------------------------------------+---------------+ -| | **dependencies** | represents a list of dependencies to be | `hydratordep | -| | *optional* | loaded for this pipeline. Not required. | <#_hydratorde | -| | | p>`__ (array) | -+-----------------------------------+---------------------------------------------+---------------+ -| | **namespace** | the cdap namespace this is deployed into | string | -| | *required* | | | -+-----------------------------------+---------------------------------------------+---------------+ -| | **pipeline\_config\_json\_url** | the URL of the config.json for this | string | -| | *required* | pipeline | | -+-----------------------------------+---------------------------------------------+---------------+ -| | **streamname** | name of the CDAP stream to ingest data into | string | -| | *required* | this app. Should come from the developer | | -| | and Tosca model. | | -+-----------------------------------+---------------------------------------------+---------------+ - -hydratordep ------------ - -represents a hydrator pipeline dependency. An equivalent to the -following CURLs are formed with the below four params shown in CAPS:: - - curl -v -w"\\n" -X POST - http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME - -H "Artifact-Extends:ARTIFACT\_EXTENDS\_HEADER" -H - “Artifact-Version:ARTIFACT\_VERSION\_HEADER” –data-binary @(DOWNLOADED - FROM ARTIFACT\_URL)","curl -v -w"\\n" -X PUT - http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME/versions/ARTIFACT_VERSION_HEADER/properties - -d (DOWNLOADED FROM UI\_PROPERTIES\_URL)" - -+---------------------------------+---------------------------------------------+----------+ -| Name | Description | Schema | -+=================================+=============================================+==========+ -| | **artifact\_extends\_header** | the value of the header that gets passed in | string | -| | *required* | for artifact-extends, e.g., | | -| | "Artifact-Extends:system:cdap-data-pipeline | | -| | [4.0.1,5.0.0)" | | -+---------------------------------+---------------------------------------------+----------+ -| | **artifact\_name** | the name of the artifact | string | -| | *required* | | | -+---------------------------------+---------------------------------------------+----------+ -| | **artifact\_url** | the URL of the artifact JAR | string | -| | *required* | | | -+---------------------------------+---------------------------------------------+----------+ -| | **artifact\_version\_header** | the value of the header that gets passed in | string | -| | *required* | for artifact-version, e.g., | | -| | "Artifact-Version:1.0.0-SNAPSHOT" | | -+---------------------------------+---------------------------------------------+----------+ -| | **ui\_properties\_url** | the URL of the properties.json if the | string | -| | *optional* | custom artifact has UI properties. This is | | -| | optional. | | -+---------------------------------+---------------------------------------------+----------+ - -info ----- - -some broker information - -+------------------+---------------------------------------------+-----------+ -| Name | Description | Schema | -+==================+=============================================+===========+ -| | **broker API | the API version of this running broker | string | -| version** | | | -| | *optional* | | | -+------------------+---------------------------------------------+-----------+ -| | **cdap GUI | The GUI port of the CDAP cluster this | integer | -| port** | broker is managing. Mostly to help users of | | -| | *optional* | this API check their application in cdap. | | -| | Note, will return UNKNOWN\_CDAP\_VERSION if | | -| | it cannot be determined. | | -+------------------+---------------------------------------------+-----------+ -| | **cdap | the version of the CDAP cluster this broker | string | -| cluster | is managing. Note, will return | | -| version** | UKNOWN\_CDAP\_VERSION if it cannot be | | -| | *optional* | determined. | | -+------------------+---------------------------------------------+-----------+ -| | **managed cdap | the url of the CDAP cluster API this broker | string | -| url** | is managing | | -| | *optional* | | | -+------------------+---------------------------------------------+-----------+ -| | **number | | integer | -| of applications | | | -| registered** | | | -| | *optional* | | | -+------------------+---------------------------------------------+-----------+ -| | **uptime (s)** | | integer | -| | *optional* | | | -+------------------+---------------------------------------------+-----------+ - -multideleteput --------------- - -+--------------------------------+----------------------------------+ -| Name | Schema | -+================================+==================================+ -| | **appnames** | `appname <#_appname>`__ (array) | -| | *optional* | | -+--------------------------------+----------------------------------+ - -programpref ------------ - -the list of programs in this CDAP app - -+--------------+---------------------------------------------+----------+ -| Name | Description | Schema | -+==============+=============================================+==========+ -| | **program\ | the name of the program | string | -| _id** | | | -| | *optional* | | | -+--------------+---------------------------------------------+----------+ -| | **program_ | the preference JSON to set for this program | object | -| \pref** | | | -| | *optional* | | | -+--------------+---------------------------------------------+----------+ -| | **program\ | must be one of flows, mapreduce, schedules, | string | -| _type** | spark, workflows, workers, or services | | -| | *optional* | | | -+--------------+---------------------------------------------+----------+ - -programs --------- - -the list of programs in this CDAP app - -+--------------+---------------------------------------------+-----------+ -| Name | Description | Schema | -+==============+=============================================+===========+ -| | **program\ | the name of the program | string | -| _id** | | | -| | *optional* | | | -+--------------+---------------------------------------------+-----------+ -| | **program\ | must be one of flows, mapreduce, schedules, | string | -| _type** | spark, workflows, workers, or services | | -| | *optional* | | | -+--------------+---------------------------------------------+-----------+ - -reconfigput ------------ - -+-----------------------------+-----------------------------+------------------+ -| Name | Description | Schema | -+=============================+=============================+==================+ -| | **config** | the config JSON | object | -| | *required* | | | -+-----------------------------+-----------------------------+------------------+ -| | **reconfiguration\_type** | the type of reconfiguration | enum | -| | *required* | | (program-flowlet | -| | | -app-config, | -| | | program-flowlet- | -| | | app-preferences, | -| | | program-flowlet- | -| | | smart) | -+-----------------------------+-----------------------------+------------------+ - -returncode ----------- - -an httpreturncode - -*Type* : integer - -service\_endpoint ------------------ - -describes a service endpoint, including the service name, the method -name, and the method type (GET, PUT, etc, most of the time will be GET) - -+--------------------------+-----------------------------------------+---------+ -| Name | Description | Schema | -+==========================+=========================================+=========+ -| | **endpoint\_method** | GET, POST, PUT, etc | string | -| | *optional* | | | -+--------------------------+-----------------------------------------+---------+ -| | **service\ _endpoint** | the name of the endpoint on the service | string | -| | *optional* | | | -+--------------------------+-----------------------------------------+---------+ -| | **service\_name** | the name of the service | string | -| | *optional* | | | -+--------------------------+-----------------------------------------+---------+ - -service\_method ---------------- - -a URL and HTTP method exposed via a CDAP service - -+--------------+---------------------------------------------+----------+ -| Name | Description | Schema | -+==============+=============================================+==========+ -| | **method** | HTTP method you can perform on the URL, | string | -| | *optional* | e.g., GET, PUT, etc | | -+--------------+---------------------------------------------+----------+ -| | **url** | the fully qualified URL in CDAP for this | string | -| | *optional* | | | -+--------------+---------------------------------------------+----------+ diff --git a/docs/sections/apis/mod-onboardingapi.rst b/docs/sections/apis/mod-onboardingapi.rst index 25fa709e..a76bef4a 100644 --- a/docs/sections/apis/mod-onboardingapi.rst +++ b/docs/sections/apis/mod-onboardingapi.rst @@ -413,8 +413,6 @@ Request -.. _d_fb61d9acd5848e8d882a33934d47ad4f: - Body ^^^^ @@ -528,7 +526,6 @@ Request -.. _d_fb61d9acd5848e8d882a33934d47ad4f: Body ^^^^ @@ -641,7 +638,6 @@ Headers -.. _d_fd89ec3540efda71c3748235024e0b4d: Body ^^^^ @@ -757,7 +753,6 @@ Headers -.. _d_7a085a9ab5ed1527229588d3b6d2c4c2: Body ^^^^ @@ -768,9 +763,9 @@ Body :widths: 20, 10, 15, 15, 30, 25 owner | No | string | | | - spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2003>` | | | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json + spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2004>` | | | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json -.. _i_24d5c9ce4ae509ac2272fb61bf0e2003: +.. _i_24d5c9ce4ae509ac2272fb61bf0e2004: **Spec schema:** @@ -875,8 +870,6 @@ Request -.. _d_fd89ec3540efda71c3748235024e0b4d: - Body ^^^^ @@ -886,9 +879,9 @@ Body :widths: 20, 10, 15, 15, 30, 25 owner | No | string | | | - spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5b>` | | | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json + spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5c>` | | | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json -.. _i_793f480461dccbb35537f2001ab7af5b: +.. _i_793f480461dccbb35537f2001ab7af5c: **Spec schema:** @@ -983,8 +976,6 @@ Request -.. _d_7a085a9ab5ed1527229588d3b6d2c4c2: - Body ^^^^ @@ -994,9 +985,9 @@ Body :widths: 20, 10, 15, 15, 30, 25 owner | No | string | | | - spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2003>` | | | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json + spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2004>` | | | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json -.. _i_24d5c9ce4ae509ac2272fb61bf0e2003: +.. _i_24d5c9ce4ae509ac2272fb61bf0e2004: **Spec schema:** @@ -1077,7 +1068,6 @@ Component List Model Structure components | No | array of :ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` | | | -.. _d_fd89ec3540efda71c3748235024e0b4d: Component Spec Model Structure ------------------------------ @@ -1088,9 +1078,9 @@ Component Spec Model Structure :widths: 20, 10, 15, 15, 30, 25 owner | No | string | | | - spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5b>` | | | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json + spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5v>` | | | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json -.. _i_793f480461dccbb35537f2001ab7af5b: +.. _i_793f480461dccbb35537f2001ab7af5v: **Spec schema:** @@ -1123,7 +1113,6 @@ Data Format List Model Structure dataFormats | No | array of :ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` | | | -.. _d_7a085a9ab5ed1527229588d3b6d2c4c2: Data Format Spec Model Structure -------------------------------- @@ -1169,7 +1158,6 @@ Error message Model Structure message | No | string | | | . . . . .Details about the unsuccessful API request -.. _d_fb61d9acd5848e8d882a33934d47ad4f: Patch Spec Model Structure -------------------------- diff --git a/docs/sections/build.rst b/docs/sections/build.rst index bc7a5489..2dcd5f5f 100644 --- a/docs/sections/build.rst +++ b/docs/sections/build.rst @@ -13,7 +13,7 @@ All DCAE projects use ONAP **oparent** project POM as ancestor. That is, DCAE p A number of DCAE projects are not written Java. For these projects we use the CodeHaus Maven Execution plugin for triggering a Bash script at various stages of Maven lifecycle. The script is mvn-phase-script.sh, located at the root of each non-Java DACE project. It is in this script that the actual build operation is performed at different Maven phases. For example, for a Python project, Maven test will actually trigger a call to tox to conduct project unit tests. -Below is a list of the repos and their sub-modules, and the language they are written in. +Below is a list of the repositories and their sub-modules, and the language they are written in. * dcaegen2 @@ -22,21 +22,9 @@ Below is a list of the repos and their sub-modules, and the language they are wr * dcaegen2.analytics -* dcaegen2.analytics.tca - - - dcae-analytics-aai (Java) - - dcae-analytics-cdap-common (Java) - - dcae-analytics-cdap-plugins (Java) - - dcae-analytics-cdap-tca (Java) - - dcae-analytics-common (Java) - - dcae-analytics-dmaap (Java) - - dcae-analytics-it (Java) - - dcae-analytics-model (Java) - - dcae-analytics-tca (Java) - - dcae-analytics-test (Java) - - dpo (Java) * dcaegen2.analytics.tca-gen2 + - dcae-analytics (Java) - eelf-logger (Java) diff --git a/docs/sections/configuration.rst b/docs/sections/configuration.rst index d9bdae4d..9ba0b8bd 100644 --- a/docs/sections/configuration.rst +++ b/docs/sections/configuration.rst @@ -63,6 +63,7 @@ The corresponding input file, ``https://git.onap.org/oom/tree/kubernetes/dcaegen it is defined again as: .. code-block:: yaml + {{ if .Values.componentImages.ves }} tag_version: {{ include "common.repository" . }}/{{ .Values.componentImages.ves }} {{ end }} 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 25bf0957..1ea72b33 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 @@ -331,12 +331,9 @@ 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 are- - -:: +The credentials to access the DCAE Dashboard Login: su1234 - Password: fusion 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 a2b0c2a3..cf676c48 100755 --- a/docs/sections/design-components/component-specification/component-type-docker.rst +++ b/docs/sections/design-components/component-specification/component-type-docker.rst @@ -30,7 +30,7 @@ to another artifact for a schema. The reference allows for XML and Protocol Buff but can be used as a pointer to JSON, Delimited Format, and Unstructured schemas as well. -.. _metadata: +.. _component_metadata: Component Metadata ------------------ diff --git a/docs/sections/design-components/component-specification/docker-specification.rst b/docs/sections/design-components/component-specification/docker-specification.rst index 63fef9b8..e40af02f 100755 --- a/docs/sections/design-components/component-specification/docker-specification.rst +++ b/docs/sections/design-components/component-specification/docker-specification.rst @@ -121,12 +121,9 @@ docker script example During deployment, the K8S plugin maps the healthcheck defined into
into a Kubernetes readiness probe.
-Kubernetes execs the script in the container (using the `docker exec API
- <https://docs.docker.com/engine/api/v1.29/#tag/Exec>`__ ).
-It will examine the
-script result to identify whether your component is healthy. Your
-component is considered healthy when the script returns ``0`` otherwise
-your component is considered not healthy.
+Kubernetes execs the script in the container (using the `docker exec API <https://docs.docker.com/engine/api/v1.29/#tag/Exec>`__ ).
+It will examine the script result to identify whether your component is healthy. Your
+component is considered healthy when the script returns ``0`` otherwise your component is considered not healthy.
Example:
diff --git a/docs/sections/installation_MS_ondemand.rst b/docs/sections/installation_MS_ondemand.rst index 3fb4c2d6..dc70edb3 100644 --- a/docs/sections/installation_MS_ondemand.rst +++ b/docs/sections/installation_MS_ondemand.rst @@ -15,7 +15,6 @@ Following Services are deployed via DCAE Bootstrap ./services/ves-http/index.rst ./services/ves-hv/index.rst ./services/prh/index.rst - ./services/tca-cdap/index.rst ./services/tcagen2-docker/index.rst Following additional MS are available for on-demand deployment as necessary for any usecases; instruction for deployment are provided under each MS. diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index c7252a8b..13803826 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -73,7 +73,7 @@ Below service components (mS) are available to be deployed on-demand. - PM-Subscription Handler - DataLake Handler (Admin and Feeder) - Slice Analysis - - DataExposure Service + - Data Extraction Service Notes: @@ -91,7 +91,7 @@ Release Data | **DCAE Project** | | | | | +--------------------------------------+--------------------------------------------------------+ -| **Docker images** |Refer :any:`Deliverable <guilin_deliverable>` | +| **Docker images** | Refer :any:`Deliverable <guilin_deliverable>` | | | | +--------------------------------------+--------------------------------------------------------+ | **Release designation** | 7.0.0 Guilin | @@ -107,8 +107,7 @@ New features - DCAE Enhancement - - Cloudify Container upgraded with new base image; plugins load optimized (DCAEGEN2-2236, DCAEGEN2-2207 -DCAEGEN2-2262) + - Cloudify Container upgraded with new base image; plugins load optimized (DCAEGEN2-2236, DCAEGEN2-2207, DCAEGEN2-2262) - Bootstrap container optimization (DCAEGEN2-1791) - MOD/Runtime – Enable configuration for dynamic topic support (DCAEGEN2-1996) - MOD/OnboardingAPI - Support for offline install (DCAEGEN2-2221) @@ -228,8 +227,8 @@ DCAE code has been formally scanned during build time using NexusIQ and all Crit Test Results ------------ - - `DCAE Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_ - - `DCAE MOD Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_ + - `DCAE R7 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_ + - `DCAE MOD R7 Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_ References @@ -265,13 +264,13 @@ Version: 5.0.2 ============== Abstract -======== +-------- This document provides the release notes for the El-Alto Maintenance release Summary -======= +------- This maintenance release is primarily to update expired certificates from original El-Alto released TLS-init container. @@ -280,7 +279,7 @@ This patch is not required for Frankfurt release (and beyond) as certificates ar retrieved from AAF at deployment time for all DCAE components. Release Data -============ +------------ +--------------------------------------+--------------------------------------+ | **Project** | DCAE | @@ -303,8 +302,7 @@ None **Bug fixes** -- `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate -expiration +- `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate expiration **Known Issues** Same as El-Alto Release @@ -320,18 +318,18 @@ Version: 6.0.1 ============== Abstract -======== +-------- This document provides the release notes for the Frankfurt Maintenance release Summary -======= +------- The focus of this release is to correct issues found on Frankfurt release. Release Data -============ +------------ +--------------------------------------+--------------------------------------+ | **Project** | DCAE | @@ -354,12 +352,11 @@ None **Bug fixes** -- `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue -while making call to oof -- `DCAEGEN2-2216 <https://jira.onap.org/browse/DCAEGEN2-2216>`_ SON-Handler: Change Policy notification - to align with policy component updates +- `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue while making call to oof +- `DCAEGEN2-2216 <https://jira.onap.org/browse/DCAEGEN2-2216>`_ SON-Handler: Change Policy notification to align with policy component updates **Known Issues** + Same as Frankfurt Release @@ -576,8 +573,8 @@ DCAE code has been formally scanned during build time using NexusIQ and all Crit Test Results ------------ - - `DCAE Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_ - - `DCAE MOD Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_ + - `DCAE R6 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_ + - `DCAE MOD R6 Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_ References @@ -739,7 +736,7 @@ Quick Links: - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_ - - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_ + - `Project Vulnerability Review Table for DCAE (El-Alto Maintenance) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_ **Upgrade Notes** @@ -830,7 +827,7 @@ Quick Links: - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_ - - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_ + - `Project Vulnerability Review Table for DCAE (El-Alto) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_ **Upgrade Notes** @@ -987,7 +984,7 @@ Quick Links: - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_ - - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_ + - `Project Vulnerability Review Table for DCAE (Dublin) <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_ **New component Notes** @@ -1199,7 +1196,7 @@ Quick Links: - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_ - - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_ + - `Project Vulnerability Review Table for DCAE (Casablanca) <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_ **New component Notes** @@ -1333,7 +1330,7 @@ Quick Links: - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_ - - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_ + - `Project Vulnerability Review Table for DCAE (Beijing) <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_ diff --git a/docs/sections/sdk/faq.rst b/docs/sections/sdk/faq.rst index 14abf8ac..ed8686d6 100644 --- a/docs/sections/sdk/faq.rst +++ b/docs/sections/sdk/faq.rst @@ -16,7 +16,7 @@ Which Java version is supported? For now we are compiling SDK using JDK 11. Hence we advice to use SDK on JDK 11. Are you sure Java 11 is supported? I can see a debug log from Netty. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you have enabled a debug log level for Netty packages you might have seen the following log: .. code-block:: java diff --git a/docs/sections/services/datalake-handler/index.rst b/docs/sections/services/datalake-handler/index.rst index 56ada5f2..3b445a55 100644 --- a/docs/sections/services/datalake-handler/index.rst +++ b/docs/sections/services/datalake-handler/index.rst @@ -3,7 +3,7 @@ DataLake-Handler MS -============== +=================== **DataLake-Handler MS** is a software component of ONAP that can systematically persist the events from DMaaP into supported Big Data storage systems. It has a Admin UI, where a system administrator configures which Topics to be monitored, and to which data storage to store the data. diff --git a/docs/sections/services/datalake-handler/installation.rst b/docs/sections/services/datalake-handler/installation.rst index 5d8b3341..16294b98 100644 --- a/docs/sections/services/datalake-handler/installation.rst +++ b/docs/sections/services/datalake-handler/installation.rst @@ -3,17 +3,17 @@ Deployment Steps DL-handler consists of two pods- the feeder and admin UI. It can be deployed by using cloudify blueprint. Datalake can be easily deployed through DCAE cloudify manager. The following steps guides you launch Datalake though cloudify manager. Pre-requisite ----------------- +------------- - Make sure mariadb-galera from OOM is properly deployed and functional. - An external database, such as Elasticsearch and MongoDB is deployed. After datalake getting deployed, the admin UI can be used to configure the sink database address and credentials. Log-in to the DCAE Bootstrap POD ---------------------------------------------------- +-------------------------------- First, we should find the bootstrap pod name through the following command and make sure that DCAE coudify manager is properly deployed. - .. image :: .images/bootstrap-pod.png + .. image :: ./images/bootstrap-pod.png Login to the DCAE bootstrap pod through the following command. .. code-block :: bash @@ -38,17 +38,17 @@ After validating, we can start to proceed blueprints uploading. Verify Uploaded Blueprints -------------------------- -Using "cft blueprint list" to varify your work. +Using "cfy blueprint list" to verify your work. .. code-block :: bash #cfy blueprint list You can see the following returned message to show the blueprints have been correctly uploaded. - .. image :: ./imagesblueprint-list.png + .. image :: ./images/blueprint-list.png Verify Plugin Versions ------------------------------------------------------------------------------- +---------------------- If the version of the plugin used is different, update the blueprint import to match. .. code-block :: bash @@ -74,11 +74,13 @@ Next, we are going to launch the datalake. Verify the Deployment Result ----------------------------- The following command can be used to list the datalake logs. + .. code-block :: bash + #kubectl logs <datalake-pod> -n onap The output should looks like. - .. image :: ./feeder-log.png + .. image :: ./images/feeder-log.png If you find any Java exception from log, make sure that the external database and datalake configuration are properly configured. Admin UI can be used to configure the external database configuration. @@ -97,4 +99,4 @@ Delete Blueprint .. code-block :: bash #cfy blueprints delete datalake-feeder - #cfy blueprints deltet datalake-admin-ui + #cfy blueprints delete datalake-admin-ui diff --git a/docs/sections/services/datalake-handler/overview.rst b/docs/sections/services/datalake-handler/overview.rst index 51dab104..09e41a5b 100644 --- a/docs/sections/services/datalake-handler/overview.rst +++ b/docs/sections/services/datalake-handler/overview.rst @@ -30,6 +30,7 @@ Note that not all data storage systems in the picture are supported. In R6, the - Couchbase
- Elasticsearch and Kibana
- HDFS
+
Depending on demands, new systems may be added to the supported list. In the following we use the term database for the storage,
even though HDFS is a file system (but with simple settings, it can be treats as a database, e.g. Hive.)
@@ -61,12 +62,9 @@ Features - Read data directly from Kafka for performance.
- Support for pluggable databases. To add a new database, we only need to implement its corrosponding service.
- - Support REST API for inter-component communications. Besides managing DatAlake settings in MariaDB,
- Admin UI also use this API to start/stop Feeder, query Feeder status and statistics.
+ - Support REST API for inter-component communications. Besides managing DatAlake settings in MariaDB, Admin UI also use this API to start/stop Feeder, query Feeder status and statistics.
- Use MariaDB to store settings.
- - Support data processing features. Before persisting data, data can be massaged in Feeder.
- Currently two features are implemented: Correlate Cleared Message (in org.onap.datalake.feeder.service.db.ElasticsearchService)
- and Flatten JSON Array (org.onap.datalake.feeder.service.StoreService).
+ - Support data processing features. Before persisting data, data can be massaged in Feeder. Currently two features are implemented: Correlate Cleared Message (in org.onap.datalake.feeder.service.db.ElasticsearchService) and Flatten JSON Array (org.onap.datalake.feeder.service.StoreService).
- Connection to Kafka and DBs are secured
diff --git a/docs/sections/services/datalake-handler/userguide.rst b/docs/sections/services/datalake-handler/userguide.rst index b3be9491..f1de54d0 100644 --- a/docs/sections/services/datalake-handler/userguide.rst +++ b/docs/sections/services/datalake-handler/userguide.rst @@ -1,8 +1,8 @@ Admin UI User Guide ---------------------- +------------------- Introduction -~~~~~~~~ +~~~~~~~~~~~~ DataLake Admin UI aims to provide a user-friendly dashboard to easily monitor and manage DataLake configurations for the involved components, ONAP topics, databases, and 3rd-party tools. Please refer to the link to access the Admin UI portal @@ -10,8 +10,9 @@ via http://datalake-admin-ui:30479 DataLake Feeder Management -****************** +************************** .. image:: ./images/adminui-feeder.png + Click the "DataLake Feeder" on the menu bar, and the dashboard will show the overview DataLake Feeder information, such as the numbers of topics. Also, you can enable or disable DataLake Feeder process backend process @@ -19,12 +20,14 @@ by using the toggle switch. Kafka Management -****************** +**************** .. image:: ./images/adminui-kafka.png + Click the "Kafka" on the menu bar, and it provides the kafka resource settings including add, modify and delete in the page to fulfill your management demand. .. image:: ./images/adminui-kafka-edit.png + You can modify the kafka resource via clicking the card, and click the plus button to add a new Kafka resource. Then, you will need to fill the required information such as identifying name, @@ -32,11 +35,12 @@ message router address and zookeeper address, and so on to build it up. Topics Management -****************** +***************** .. image:: ./images/adminui-topics.png .. image:: ./images/adminui-topic-edit1.png .. image:: ./images/adminui-topic-edit2.png .. image:: ./images/adminui-topic-edit3.png + The Topic page lists down all the topics which you have been configured by topic management. You can edit the topic setting via double click the specific row. The setting includes DataLake feeder status - catch the topic or not, @@ -45,37 +49,41 @@ And choose one or more Kafka items as topic resource and define the databased to store topic info are necessary. .. image:: ./images/adminui-topic-config.png + For the default configuration of Topics, you can click the "Default configurations" button to do the setting. When you add a new topic, these configurations will be filled into the form automatically. .. image:: ./images/adminui-topic-new.png + To add a new topic for the DataLake Feeder, you can click the "plus icon" button to catch the data into the 3rd-party database. Please be noted that only existing topics in the Kafka can be added. Database Management -****************** +******************* .. image:: ./images/adminui-dbs.png .. image:: ./images/adminui-dbs-edit.png + In the Database Management page, it allows you to add, modify and delete the database resources where the message from topics will be stored. DataLake supports a bunch of databases including Couchbase DB, Apache Druid, Elasticsearch, HDFS, and MongoDB. 3rd-Party Tools Management -****************** +************************** .. image:: ./images/adminui-tools.png + In the Tools page, it allows you to manage the resources of 3rd-party tools for data visualization. Currently, DataLake supports two Tools which are Kibana and Apache Superset. 3rd-Party Design Tools Management -****************** +********************************* .. image:: ./images/adminui-design.png .. image:: ./images/adminui-design-edit.png + After setting up the 3rd-party tools, you can import the template as the JSON, YAML or other formats for data exploration, data visualization and dashboarding. DataLake supports Kibana dashboarding, Kibana searching, Kibana visualization, Elasticsearch field mapping template, and Apache Druid Kafka indexing service. - diff --git a/docs/sections/services/dfc/certificates.rst b/docs/sections/services/dfc/certificates.rst index 2dc557b6..350cda63 100644 --- a/docs/sections/services/dfc/certificates.rst +++ b/docs/sections/services/dfc/certificates.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 + Certificates (From AAF) ======================= DCAE service components will use common certifcates generated from AAF/test instance and made available during deployment of DCAE TLS init container. diff --git a/docs/sections/services/heartbeat-ms/build_setup.rst b/docs/sections/services/heartbeat-ms/build_setup.rst index 6033affc..5df47234 100644 --- a/docs/sections/services/heartbeat-ms/build_setup.rst +++ b/docs/sections/services/heartbeat-ms/build_setup.rst @@ -95,7 +95,8 @@ CBS polling. The following environment variables are to be set.** The sample consul KV is as below.
::
- http://10.12.6.50:8500/ui/#/dc1/kv/mvp-dcaegen2-heartbeat-static
+
+ http://10.12.6.50:8500/ui/#/dc1/kv/mvp-dcaegen2-heartbeat-static
Go to the above link and click on KEY/VALUE tab
@@ -164,18 +165,21 @@ CBS polling. The following environment variables are to be set.** To check whether image is built or not, run below command
::
+
sudo Docker images |grep heartbeat.test1
**Run the Docker using below command which uses the environment file
mentioned in the above section.**
::
+
sudo Docker run -d --name hb1 --env-file env.list
heartbeat.test1:latest
To check the logs, run below command
::
+
sudo Docker logs -f hb1
**To stop the Docker run**
@@ -198,6 +202,7 @@ mentioned in the above section.** To run the maven build, execute any one of them.
::
+
sudo mvn -s settings.xml deploy
OR
sudo mvn -s settings.xml -X deploy
diff --git a/docs/sections/services/heartbeat-ms/testprocedure.rst b/docs/sections/services/heartbeat-ms/testprocedure.rst index a7c6f799..c312ee51 100644 --- a/docs/sections/services/heartbeat-ms/testprocedure.rst +++ b/docs/sections/services/heartbeat-ms/testprocedure.rst @@ -12,6 +12,7 @@ Login into postgres DB Run below commands to login into postgres DB and connect to HB Micro service DB.
::
+
sudo su postgres
psql
\l hb_vnf
@@ -19,6 +20,7 @@ Run below commands to login into postgres DB and connect to HB Micro service DB. Sample output is as below
::
+
ubuntu@r3-dcae:~$ sudo su postgres
postgres@r3-dcae:/home/ubuntu$ psql
psql (9.5.14)
diff --git a/docs/sections/services/mapper/SampleSnmpTrapConversion.rst b/docs/sections/services/mapper/SampleSnmpTrapConversion.rst index 71f5718b..b6ba41e4 100644 --- a/docs/sections/services/mapper/SampleSnmpTrapConversion.rst +++ b/docs/sections/services/mapper/SampleSnmpTrapConversion.rst @@ -3,7 +3,7 @@ .. Copyright 2018 Tech Mahindra Ltd. Sample Snmp trap Conversion: -=========================== +============================ Following is the **Sample SNMP Trap** that will be received by the Universal VES Adapter from the Snmp Trap Collector : diff --git a/docs/sections/services/mapper/delivery.rst b/docs/sections/services/mapper/delivery.rst index 6cb2cf2f..3f667635 100644 --- a/docs/sections/services/mapper/delivery.rst +++ b/docs/sections/services/mapper/delivery.rst @@ -9,7 +9,7 @@ Mapper is delivered with **1 Docker container** having spring boot microservice, | In current release, the UniversalVesAdapter is integrated with DCAE's config binding service. On start, it fetches the initial configuration from CBS and uses the same. Currently it is not having functionality to refresh the configuration changes made into Consul KV store. Docker Containers ---------------- +----------------- Docker images can be pulled from ONAP Nexus repository with below commands: - ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0-SNAPSHOT`` + ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:latest`` diff --git a/docs/sections/services/mapper/flow.rst b/docs/sections/services/mapper/flow.rst index 9fe3bfbb..ed05332c 100644 --- a/docs/sections/services/mapper/flow.rst +++ b/docs/sections/services/mapper/flow.rst @@ -2,38 +2,33 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018-2019 Tech Mahindra Ltd. -============ -Flow for converting Rest Conf Collector notification -============ -.. [1] RestConf Collector generates rcc-notication in JSON format and publishes it on DMaaP topic **unathenticated.DCAE_RCC_OUTPUT** -.. [2] The Universal VES Adapter(UVA) microservice has subscribed to this DMaaP topic. -.. [3] On receiving an event from DMaaP, the adapter uses the corresponding mapping file and converts received notification into the VES event. It uses the notification-id from the received notification to find the required mapping file. -.. [4] Those notifications for which no mapping file is identified, a default mapping file is used with generic mappings to create the VES event. -.. [5] The VES formatted Event will be then published on DMaaP topic **unauthenticated.VES_PNFREG_OUTPUT**. + +Flow for converting RestConf Collector notification +=================================================== +[1] RestConf Collector generates rcc-notication in JSON format and publishes it on DMaaP topic **unathenticated.DCAE_RCC_OUTPUT** +[2] The Universal VES Adapter(UVA) microservice has subscribed to this DMaaP topic. +[3] On receiving an event from DMaaP, the adapter uses the corresponding mapping file and converts the received notification into the VES event. It uses the notification-id from the received notification to find the required mapping file. +[4] Those notifications for which no mapping file is identified, a default mapping file is used with generic mappings to create the VES event. +[5] The VES formatted Event will be then published on DMaaP topic **unauthenticated.VES_PNFREG_OUTPUT**. .. image:: ./flow-rest-conf.png - :height: 200px - :width: 300 px - :scale: 50 % :alt: alternate text :align: left - ============ + Flow for converting SNMP Collector notification -============ -.. [1] VNF submits SNMP traps to the SNMP collector. -.. [2] Collector converts the trap into JSON format and publishes it on DMaaP topic **unauthenticated.ONAP-COLLECTOR-SNMPTRAP** -.. [3] The Universal VES Adapter(UVA) microservice has subscribed to this DMaaP topic. -.. [4] On receiving an event from DMaaP, the adapter uses the corresponding mapping file and converts received event into the VES event. It uses the enterprise ID from the received event to find the required mapping file. -.. [5] Those SNMP Traps for which no mapping file is identified, a default mapping file is used with generic mappings to create the VES event. -.. [6] The VES formatted Event will be then published on DMaaP topic **unauthenticated.SEC_FAULT_OUTPUT**. +=============================================== + +[1] VNF submits SNMP traps to the SNMP collector. +[2] Collector converts the trap into JSON format and publishes it on DMaaP topic **unauthenticated.ONAP-COLLECTOR-SNMPTRAP** +[3] The Universal VES Adapter(UVA) microservice has subscribed to this DMaaP topic. +[4] On receiving an event from DMaaP, the adapter uses the corresponding mapping file and converts the received event into the VES event. It uses the enterprise ID from the received event to find the required mapping file. +[5] Those SNMP Traps for which no mapping file is identified, a default mapping file is used with generic mappings to create the VES event. +[6] The VES formatted Event will be then published on DMaaP topic **unauthenticated.SEC_FAULT_OUTPUT**. .. image:: ./flow.png - :height: 200px - :width: 300 px - :scale: 50 % :alt: alternate text :align: left
\ No newline at end of file diff --git a/docs/sections/services/mapper/installation.rst b/docs/sections/services/mapper/installation.rst index 2add9d92..da0bcdc1 100644 --- a/docs/sections/services/mapper/installation.rst +++ b/docs/sections/services/mapper/installation.rst @@ -17,7 +17,7 @@ VES-Mapper can be deployed individually though it will throw errors if it can't VES-Mapper blueprint is available @ https://git.onap.org/dcaegen2/services/mapper/tree/UniversalVesAdapter/dpo/blueprints/k8s-vesmapper.yaml-template.yaml?h=elalto -VES-Mapper docker image is available in Nexus repo @ `nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1 <nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1>`_ +VES-Mapper docker image is available in Nexus repo @ `nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:latest <nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:latest>`_ @@ -27,11 +27,8 @@ VES-Mapper docker image is available in Nexus repo @ `nexus3.onap.org:10001/onap *a. Verify DMaaP configurations in the blueprint as per setup* Dmaap Configuration consists of subscribe url to fetch notifications from the respective collector and publish url to publish ves event. - - -``streams_publishes`` and ``streams_subscribes`` points to the publishing topic and subscribe topic respectively. - -update these ``urls`` as per your DMaaP configurations in the blueprint. + +``streams_publishes`` and ``streams_subscribes`` point to the publishing topic and subscribe topic respectively. Update these ``urls`` as per your DMaaP configurations in the blueprint. *b. Verify the Smooks mapping configuration in the blueprint as per the usecase. Blueprint contains default mapping for each supported collector ( SNMP Collector and RESTConf collector currently) which may serve the purpose for the usecase. The ``mapping-files`` in ``collectors`` contains the contents of the mapping file. diff --git a/docs/sections/services/mapper/mappingfile.rst b/docs/sections/services/mapper/mappingfile.rst index daf515d3..7333963c 100644 --- a/docs/sections/services/mapper/mappingfile.rst +++ b/docs/sections/services/mapper/mappingfile.rst @@ -12,7 +12,7 @@ The Adapter uses Smooks Framework to do the data format conversion by using the | http://www.smooks.org/guide SNMP Collector Default Mapping File -============ +=================================== Following is the default snmp mapping file which is used when no mapping file is found while processing event from SNMP Trap Collector. .. code-block:: xml @@ -60,7 +60,8 @@ Following is the default snmp mapping file which is used when no mapping file is </jb:bean></smooks-resource-list> RestConf Collector Default Mapping File -============ +======================================= + Following is the default RestConf collector mapping file which is used when no mapping file is found while processing notification from RestConf Collector. .. code-block:: xml diff --git a/docs/sections/services/mapper/troubleshooting.rst b/docs/sections/services/mapper/troubleshooting.rst index 5d524e5c..859bf6e4 100644 --- a/docs/sections/services/mapper/troubleshooting.rst +++ b/docs/sections/services/mapper/troubleshooting.rst @@ -34,7 +34,7 @@ Error and warning logs contain also: **Do not rely on exact log messages or their presence, as they are often subject to change.** Deployment/Installation errors --------------------- +------------------------------ **Missing Default Config File in case of using local config instead of Consul** @@ -45,10 +45,10 @@ Deployment/Installation errors |13:04:37.537 [main] ERROR errorLogger - Application stoped due to missing default Config file |13:04:37.538 [main] INFO o.s.s.c.ThreadPoolTaskExecutor - Shutting down ExecutorService 'applicationTaskExecutor' |15:40:43.982 [main] WARN debugLogger - All Smooks objects closed + **These log messages are printed when the default configuration file "kv.json", was not present.** - **Invalid Default Config File in case of using local config instead of Consul** If Default Config File is an invalid json file, we will get below exception diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst index a9f4f5bf..c699a35b 100644 --- a/docs/sections/services/pm-mapper/configuration.rst +++ b/docs/sections/services/pm-mapper/configuration.rst @@ -5,7 +5,7 @@ Configuration and Performance ============================= PM Mapper Filtering -""""""""" +""""""""""""""""""" The PM Mapper performs data reduction, by filtering the PM telemetry data it receives. This filtering information is provided to the service as part of its configuration, and is used to identify desired PM measurements (measType) contained within the data. The service can accept an exact match to the measType or regex(java.util.regex) identifying multiple measTypes (it is possible to use both types simultaneously). diff --git a/docs/sections/services/snmptrap/offeredapis.rst b/docs/sections/services/snmptrap/offeredapis.rst index 33a2c821..fabaff5f 100644 --- a/docs/sections/services/snmptrap/offeredapis.rst +++ b/docs/sections/services/snmptrap/offeredapis.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. _offeredapis: +.. _snmpofferedapis: Offered APIs ============ diff --git a/docs/sections/services/snmptrap/release-notes.rst b/docs/sections/services/snmptrap/release-notes.rst index 5c46d606..98ea3d40 100644 --- a/docs/sections/services/snmptrap/release-notes.rst +++ b/docs/sections/services/snmptrap/release-notes.rst @@ -15,11 +15,9 @@ Version: 2.3.0 **New Features** - - `https://jira.onap.org/browse/DCAEGEN2-2020` - Eliminate use of consul service discovery in snmptrap + - `https://jira.onap.org/browse/DCAEGEN2-2020` Eliminate use of consul service discovery in snmptrap - - `https://jira.onap.org/browse/DCAEGEN2-2068` - Updated dependency library version; stormwatch support + - `https://jira.onap.org/browse/DCAEGEN2-2068` Updated dependency library version; stormwatch support **Bug Fixes** @@ -45,12 +43,10 @@ Version: 1.4.0 **New Features** - - `https://jira.onap.org/browse/DCAEGEN2-630` - Added support for SNMPv3 traps with varying levels of privacy and authentication support. + - `https://jira.onap.org/browse/DCAEGEN2-630` Added support for SNMPv3 traps with varying levels of privacy and authentication support. **Bug Fixes** - - `https://jira.onap.org/browse/DCAEGEN2-842` - Remove additional RFC3584 (Sec 3.1 (4)) varbinds from published/logged SNMPv1 messages, fix DMAAP publish error for traps with no varbinds present. + - `https://jira.onap.org/browse/DCAEGEN2-842` Remove additional RFC3584 (Sec 3.1 (4)) varbinds from published/logged SNMPv1 messages, fix DMAAP publish error for traps with no varbinds present. **Known Issues** @@ -77,9 +73,9 @@ Support for config binding services. **Bug Fixes** - `https://jira.onap.org/browse/DCAEGEN2-465` + **Known Issues** - - `https://jira.onap.org/browse/DCAEGEN2-465` - Default config causes standalone instance startup failure. + - `https://jira.onap.org/browse/DCAEGEN2-465` Default config causes standalone instance startup failure. **Security Issues** - None @@ -91,6 +87,3 @@ Support for config binding services. **Other** -=========== - -End of Release Notes diff --git a/docs/sections/services/son-handler/son_handler_troubleshooting.rst b/docs/sections/services/son-handler/son_handler_troubleshooting.rst index 98dde1d1..644b0826 100644 --- a/docs/sections/services/son-handler/son_handler_troubleshooting.rst +++ b/docs/sections/services/son-handler/son_handler_troubleshooting.rst @@ -6,13 +6,15 @@ Troubleshooting steps Possible reasons & Solutions: 1. Microservice is not registered with the consul - Check the consul if the microservice is registered with it and the MS is able to fetch the app config from the CBS. Check if CBS and consul are deployed properly and try to redeploy the MS + The below logs will be seen if CBS is not reachable by the MS - 15:14:13.861 [main] WARN org.postgresql.Driver - JDBC URL port: 0 not valid (1:65535) + 15:14:13.861 [main] WARN org.postgresql.Driver - JDBC URL port: 0 not valid (1:65535) 15:14:13.862 [main] WARN o.s.b.w.s.c.AnnotationConfigServletWebServerApplicationContext - Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaConfiguration': Unsatisfied dependency expressed through constructor parameter 0; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'dataSource' defined in org.onap.dcaegen2.services.sonhms.Application: Initialization of bean failed; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'org.springframework.boot.autoconfigure.jdbc.DataSourceInitializerInvoker': Invocation of init method failed; nested exception is org.springframework.jdbc.datasource.init.UncategorizedScriptException: Failed to execute database script; nested exception is java.lang.RuntimeException: Driver org.postgresql.Driver claims to not accept jdbcUrl, jdbc:postgresql://null:0/sonhms 15:14:13.865 [main] INFO o.a.catalina.core.StandardService - Stopping service [Tomcat] 15:14:13.877 [main] INFO o.s.b.a.l.ConditionEvaluationReportLoggingListener - Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled. 15:14:13.880 [main] ERROR o.s.boot.SpringApplication - Application run failed + 2. MS is not able to fetch the config policies from the policy handler. - Check if the config policy for the MS is created and pushed into the policy module. The below logs will be seen if the config policies are not available. diff --git a/docs/sections/services/tcagen2-docker/installation.rst b/docs/sections/services/tcagen2-docker/installation.rst index 792f8a48..e0a5b738 100644 --- a/docs/sections/services/tcagen2-docker/installation.rst +++ b/docs/sections/services/tcagen2-docker/installation.rst @@ -18,10 +18,9 @@ Following are steps if manual deployment/undeployment is required. Steps to dep Enter the Cloudify Manager kuberenetes pod - - Tca-gen2 blueprint directory (/blueprints/k8s-tcagen2.yaml). The blueprint is also maintained in gerrit and can be downloaded from - https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-tcagen2.yaml + - Tca-gen2 blueprint directory (/blueprints/k8s-tcagen2.yaml). The blueprint is also maintained in gerrit and can be downloaded from https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-tcagen2.yaml - - Create input file required for deployment + - Create input file required for deployment Configuration of the service consists of generating an inputs file (YAML) which will be used as part of the Cloudify install. The tca-gen2 blueprints was designed with known defaults for the majority of the fields. @@ -34,6 +33,7 @@ Enter the Cloudify Manager kuberenetes pod :widths: auto :delim: ; :header: Property , Sample Value , Description , Required + tca_handle_in_subscribe_url ; http://message-router:3904/events/unauthenticated.TCAGEN2_OUTPUT/; DMaap topic to publish CL event output ; No tca_handle_in_subscribe_url ; http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/; DMaap topic to subscribe VES measurement feeds ; No tag_version ; nexus3.onap.org:10001/onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1 ; The tag of the Docker image will be used when deploying the tca-gen2. ; No diff --git a/docs/sections/services/ves-http/installation.rst b/docs/sections/services/ves-http/installation.rst index 5ecafcee..6c976684 100644 --- a/docs/sections/services/ves-http/installation.rst +++ b/docs/sections/services/ves-http/installation.rst @@ -41,8 +41,7 @@ If VESCollector instance need to be deployed with authentication disabled, follo - Execute into Bootstrap POD using kubectl command -- VES blueprint is available under /blueprints directory ``k8s-ves-tls.yaml``. A corresponding input files is also pre-loaded into bootstrap -pod under /inputs/k8s-ves-inputs.yaml +- VES blueprint is available under /blueprints directory ``k8s-ves-tls.yaml``. A corresponding input file is also pre-loaded into bootstrap pod under /inputs/k8s-ves-inputs.yaml - Deploy blueprint .. code-block:: bash diff --git a/docs/sections/services/ves-hv/index.rst b/docs/sections/services/ves-hv/index.rst index 8c1105a1..94703119 100644 --- a/docs/sections/services/ves-hv/index.rst +++ b/docs/sections/services/ves-hv/index.rst @@ -26,7 +26,7 @@ High Volume VES Collector overview and functions .. toctree:: :maxdepth: 1 - + architecture design repositories |