diff options
| author |   Vijay Venkatesh Kumar <vv770d@att.com> | 2023-03-02 18:43:34 -0500 |
|---|---|---|
| committer | Vijay Venkatesh Kumar <vv770d@att.com> | 2023-03-03 10:05:15 -0500 |
| commit | a6f72a8f1c7bd93ca5916cd73d4226208ff469d3 (patch) | |
| tree | 84acba64b6bf83c818fa07cdd72ed2181e112ccc /docs/sections | |
| parent | 74d53a77e5d74c921cfbc034a01f2cbf08e102a4 (diff) | |
Doc updates for London
Arch diagram updates
Remove MOD/design components
Remove cloudify based deployment
Standardize deployment steps for DCAE current Ms
Misc updates
onap-gerrit-review: -changelog-or-release-file-missing
onap-gerrit-review: -no-nl-ending-on-files
onap-gerrit-review: -missing-setup-py
onap-gerrit-review: -changelog-missing
Change-Id: I99c6c8e870fa2f54af0a9d26267d0fb6901c74a9
Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
Issue-ID: DCAEGEN2-3360
Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
Diffstat (limited to 'docs/sections')
80 files changed, 372 insertions, 11722 deletions
diff --git a/docs/sections/apis/mod-onboardingapi.json b/docs/sections/apis/mod-onboardingapi.json deleted file mode 100644 index 8e8ce9af..00000000 --- a/docs/sections/apis/mod-onboardingapi.json +++ /dev/null @@ -1,597 +0,0 @@ -{ - "swagger": "2.0", - "basePath": "/onboarding", - "paths": { - "/components": { - "post": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "409": { - "description": "Component already exists", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Component post" - } - } - }, - "description": "Add a Component to the Catalog", - "operationId": "post_component", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Component Spec" - } - }, { - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - }, - "get": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Component List" - } - } - }, - "description": "Get list of Components in the catalog", - "operationId": "get_components", - "parameters": [{ - "name": "name", - "in": "query", - "type": "string", - "description": "Name of component to filter for" - }, { - "name": "version", - "in": "query", - "type": "string", - "description": "Version of component to filter for" - }, { - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - } - }, - "/components/{component_id}": { - "parameters": [{ - "name": "component_id", - "in": "path", - "required": true, - "type": "string" - }], - "put": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Component not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success, Component replaced" - } - }, - "description": "Replace a Component Spec in the Catalog", - "operationId": "put_component", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Component Spec" - } - }], - "tags": ["onboarding"] - }, - "get": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Component not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/component fields by id" - } - } - }, - "description": "Get a Component", - "operationId": "get_component", - "parameters": [{ - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - }, - "patch": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Component not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "403": { - "description": "Forbidden Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success, Component status updated" - } - }, - "description": "Update a Component's status in the Catalog", - "operationId": "patch_component", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Patch Spec" - } - }], - "tags": ["onboarding"] - } - }, - "/dataformats": { - "post": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "409": { - "description": "Data Format already exists", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Data Format post" - } - } - }, - "description": "Add a Data Format to the Catalog", - "operationId": "post_dataformat", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Data Format Spec" - } - }, { - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - }, - "get": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Data Format List" - } - } - }, - "description": "Get list of Data Formats in the catalog", - "operationId": "get_dataformats", - "parameters": [{ - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - } - }, - "/dataformats/{dataformat_id}": { - "parameters": [{ - "name": "dataformat_id", - "in": "path", - "required": true, - "type": "string" - }], - "put": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Data Format not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success, Data Format added" - } - }, - "description": "Replace a Data Format Spec in the Catalog", - "operationId": "put_dataformat", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Data Format Spec" - } - }], - "tags": ["onboarding"] - }, - "get": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Data Format not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/dataformat fields by id" - } - } - }, - "description": "Get a Data Format", - "operationId": "get_dataformat", - "parameters": [{ - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - }, - "patch": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Data Format not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "403": { - "description": "Forbidden Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success, Data Format status updated" - } - }, - "description": "Update a Data Format's status in the Catalog", - "operationId": "patch_dataformat", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Patch Spec" - } - }], - "tags": ["onboarding"] - } - } - }, - "info": { - "title": "DCAE Onboarding HTTP API", - "version": "2.12.0" - }, - "produces": ["application/json"], - "consumes": ["application/json"], - "tags": [{ - "name": "onboarding", - "description": "Default namespace" - }], - "definitions": { - "Component Spec": { - "properties": { - "owner": { - "type": "string" - }, - "spec": { - "type": "object", - "description": "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" - } - } - }, - "Error message": { - "properties": { - "message": { - "type": "string", - "description": ". . . . .Details about the unsuccessful API request" - } - }, - "type": "object" - }, - "Component post": { - "required": ["componentUrl"], - "properties": { - "componentUrl": { - "type": "string", - "description": ". . . . Url to the Component Specification" - } - }, - "type": "object" - }, - "Component List": { - "properties": { - "components": { - "type": "array", - "items": { - "$ref": "#/definitions/component fields" - } - } - }, - "type": "object" - }, - "component fields": { - "required": ["componentType", "componentUrl", "description", "id", "modified", "name", "owner", "status", "version", "whenAdded"], - "properties": { - "id": { - "type": "string", - "description": ". . . . ID of the component" - }, - "name": { - "type": "string", - "description": ". . . . Name of the component" - }, - "version": { - "type": "string", - "description": ". . . . Version of the component" - }, - "owner": { - "type": "string", - "description": ". . . . ID of who added the component" - }, - "whenAdded": { - "type": "string", - "format": "date-time", - "description": ". . . . When component was added to the Catalog" - }, - "modified": { - "type": "string", - "format": "date-time", - "description": ". . . . When component was last modified" - }, - "status": { - "type": "string", - "description": ". . . . Status of the component" - }, - "description": { - "type": "string", - "description": ". . . . Description of the component" - }, - "componentType": { - "type": "string", - "description": ". . . . only \"docker\"" - }, - "componentUrl": { - "type": "string", - "description": ". . . . Url to the Component Specification" - } - }, - "type": "object" - }, - "Patch Spec": { - "required": ["owner", "status"], - "properties": { - "owner": { - "type": "string", - "description": "User ID" - }, - "status": { - "type": "string", - "description": ". . . . .[published] is the only status change supported right now", - "example": "published", - "enum": ["published", "revoked"] - } - }, - "type": "object" - }, - "component fields by id": { - "allOf": [{ - "$ref": "#/definitions/component fields" - }, { - "required": ["spec"], - "properties": { - "spec": { - "type": "object", - "description": "The Component Specification (json)" - } - }, - "type": "object" - }] - }, - "Data Format Spec": { - "properties": { - "owner": { - "type": "string" - }, - "spec": { - "type": "object", - "description": "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" - } - } - }, - "Data Format post": { - "required": ["dataFormatUrl"], - "properties": { - "dataFormatUrl": { - "type": "string", - "description": ". . . . Url to the Data Format Specification" - } - }, - "type": "object" - }, - "Data Format List": { - "properties": { - "dataFormats": { - "type": "array", - "items": { - "$ref": "#/definitions/dataformat fields" - } - } - }, - "type": "object" - }, - "dataformat fields": { - "required": ["dataFormatUrl", "description", "id", "modified", "name", "owner", "status", "version", "whenAdded"], - "properties": { - "id": { - "type": "string", - "description": ". . . . ID of the data format" - }, - "name": { - "type": "string", - "description": ". . . . Name of the data format" - }, - "version": { - "type": "string", - "description": ". . . . Version of the data format" - }, - "owner": { - "type": "string", - "description": ". . . . ID of who added the data format" - }, - "whenAdded": { - "type": "string", - "format": "date-time", - "description": ". . . . When data format was added to the Catalog" - }, - "modified": { - "type": "string", - "format": "date-time", - "description": ". . . . When data format was last modified" - }, - "status": { - "type": "string", - "description": ". . . . Status of the data format" - }, - "description": { - "type": "string", - "description": ". . . . Description of the data format" - }, - "dataFormatUrl": { - "type": "string", - "description": ". . . . Url to the Data Format Specification" - } - }, - "type": "object" - }, - "dataformat fields by id": { - "allOf": [{ - "$ref": "#/definitions/dataformat fields" - }, { - "required": ["spec"], - "properties": { - "spec": { - "type": "object", - "description": "The Data Format Specification (json)" - } - }, - "type": "object" - }] - } - }, - "responses": { - "ParseError": { - "description": "When a mask can't be parsed" - }, - "MaskError": { - "description": "When any error occurs on mask" - } - } -}
\ No newline at end of file diff --git a/docs/sections/apis/mod-onboardingapi.rst b/docs/sections/apis/mod-onboardingapi.rst deleted file mode 100644 index a76bef4a..00000000 --- a/docs/sections/apis/mod-onboardingapi.rst +++ /dev/null @@ -1,1285 +0,0 @@ -.. This work is licensed under a - Creative Commons Attribution 4.0 International License. - -Onboarding HTTP API (MOD) -========================= - -.. toctree:: - :maxdepth: 3 - - -Description -~~~~~~~~~~~ - -Onboarding API is sub-component under MOD provides following function: - -1. API to add/update data-formats -2. API to add/update components (component_Spec) - -These API can be invoked by MS owners or by Acumos adapter to upload artifact into MOD catalog - -.. csv-table:: - :header: "API name", "Swagger" - :widths: 10,5 - - "Inventory", ":download:`link <mod-onboardingapi.json>`" - -Base URL -~~~~~~~~ - -http:///onboarding - -ONBOARDING -~~~~~~~~~~ - - -Default namespace - - - - - -GET ``/components/{component_id}`` ----------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get a Component - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - component_id | path | Yes | string | | | - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` extended :ref:`inline <i_34dba329148d5512a1350568d728c028>` - -**Example:** - -.. code-block:: javascript - - { - "componentType": "somestring", - "componentUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "spec": {}, - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - } - -**404** -^^^^^^^ - -Component not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -GET ``/components`` -------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get list of Components in the catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - name | query | No | string | | | Name of component to filter for - version | query | No | string | | | Version of component to filter for - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`Component List <d_53b82f243acb3fd79572e5a8e909c801>` - -**Example:** - -.. code-block:: javascript - - { - "components": [ - { - "componentType": "somestring", - "componentUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - }, - { - "componentType": "somestring", - "componentUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - } - ] - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -GET ``/dataformats/{dataformat_id}`` ------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get a Data Format - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - dataformat_id | path | Yes | string | | | - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` extended :ref:`inline <i_19c008f5124504e9d9c719d157dab70f>` - -**Example:** - -.. code-block:: javascript - - { - "dataFormatUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "spec": {}, - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - } - -**404** -^^^^^^^ - -Data Format not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -GET ``/dataformats`` --------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get list of Data Formats in the catalog - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`Data Format List <d_9479fe3b8fa2fcaeb723c198da99e791>` - -**Example:** - -.. code-block:: javascript - - { - "dataFormats": [ - { - "dataFormatUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - }, - { - "dataFormatUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - } - ] - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -PATCH ``/components/{component_id}`` ------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Update a Component's status in the Catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - component_id | path | Yes | string | | | - - -Request -+++++++ - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | Yes | string | | | User ID - status | Yes | string | | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now - -.. code-block:: javascript - - { - "owner": "somestring", - "status": "published" - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success, Component status updated - - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**403** -^^^^^^^ - -Forbidden Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**404** -^^^^^^^ - -Component not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -PATCH ``/dataformats/{dataformat_id}`` --------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Update a Data Format's status in the Catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - dataformat_id | path | Yes | string | | | - - -Request -+++++++ - - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | Yes | string | | | User ID - status | Yes | string | | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now - -.. code-block:: javascript - - { - "owner": "somestring", - "status": "published" - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success, Data Format status updated - - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**403** -^^^^^^^ - -Forbidden Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**404** -^^^^^^^ - -Data Format not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -POST ``/components`` --------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Add a Component to the Catalog - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :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 - -.. _i_793f480461dccbb35537f2001ab7af5b: - -**Spec schema:** - - -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 - - - -.. code-block:: javascript - - { - "owner": "somestring", - "spec": {} - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`Component post <d_9eafe9d5168f431205b9fce1312b32bb>` - -**Example:** - -.. code-block:: javascript - - { - "componentUrl": "somestring" - } - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**409** -^^^^^^^ - -Component already exists - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -POST ``/dataformats`` ---------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Add a Data Format to the Catalog - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - 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_24d5c9ce4ae509ac2272fb61bf0e2004: - -**Spec schema:** - - -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 - - - -.. code-block:: javascript - - { - "owner": "somestring", - "spec": {} - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`Data Format post <d_6557e42aae4abfe7f132d85f512a1a26>` - -**Example:** - -.. code-block:: javascript - - { - "dataFormatUrl": "somestring" - } - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**409** -^^^^^^^ - -Data Format already exists - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -PUT ``/components/{component_id}`` ----------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Replace a Component Spec in the Catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - component_id | path | Yes | string | | | - - -Request -+++++++ - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - 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_793f480461dccbb35537f2001ab7af5c: - -**Spec schema:** - - -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 - - - -.. code-block:: javascript - - { - "owner": "somestring", - "spec": {} - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success, Component replaced - - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**404** -^^^^^^^ - -Component not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -PUT ``/dataformats/{dataformat_id}`` ------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Replace a Data Format Spec in the Catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - dataformat_id | path | Yes | string | | | - - -Request -+++++++ - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - 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_24d5c9ce4ae509ac2272fb61bf0e2004: - -**Spec schema:** - - -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 - - - -.. code-block:: javascript - - { - "owner": "somestring", - "spec": {} - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success, Data Format added - - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**404** -^^^^^^^ - -Data Format not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - -Data Structures -~~~~~~~~~~~~~~~ - -.. _d_53b82f243acb3fd79572e5a8e909c801: - -Component List Model Structure ------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - components | No | array of :ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` | | | - - -Component Spec Model Structure ------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - 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_793f480461dccbb35537f2001ab7af5v: - -**Spec schema:** - - -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 - - - -.. _d_9eafe9d5168f431205b9fce1312b32bb: - -Component post Model Structure ------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - componentUrl | Yes | string | | | . . . . Url to the Component Specification - -.. _d_9479fe3b8fa2fcaeb723c198da99e791: - -Data Format List Model Structure --------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - dataFormats | No | array of :ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` | | | - - -Data Format Spec Model Structure --------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :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 - -.. _i_24d5c9ce4ae509ac2272fb61bf0e2003: - -**Spec schema:** - - -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 - - - -.. _d_6557e42aae4abfe7f132d85f512a1a26: - -Data Format post Model Structure --------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - dataFormatUrl | Yes | string | | | . . . . Url to the Data Format Specification - -.. _d_e8453714bcbe180e59d1dfbfc583c9cb: - -Error message Model Structure ------------------------------ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - message | No | string | | | . . . . .Details about the unsuccessful API request - - -Patch Spec Model Structure --------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | Yes | string | | | User ID - status | Yes | string | | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now - -.. _d_41cf5e14516a536474c8079d332e86c7: - -component fields Model Structure --------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - componentType | Yes | string | | | . . . . only 'docker' - componentUrl | Yes | string | | | . . . . Url to the Component Specification - description | Yes | string | | | . . . . Description of the component - id | Yes | string | | | . . . . ID of the component - modified | Yes | string | date-time | | . . . . When component was last modified - name | Yes | string | | | . . . . Name of the component - owner | Yes | string | | | . . . . ID of who added the component - status | Yes | string | | | . . . . Status of the component - version | Yes | string | | | . . . . Version of the component - whenAdded | Yes | string | date-time | | . . . . When component was added to the Catalog - -.. _d_c86e31bb6b9a2aaf18cab261f501cdf1: - -component fields by id Model Structure --------------------------------------- - -:ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` extended :ref:`inline <i_34dba329148d5512a1350568d728c028>` - -.. _i_34dba329148d5512a1350568d728c028: - -**Inline schema:** - - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - componentType | Yes | string | | | . . . . only 'docker' - componentUrl | Yes | string | | | . . . . Url to the Component Specification - description | Yes | string | | | . . . . Description of the component - id | Yes | string | | | . . . . ID of the component - modified | Yes | string | date-time | | . . . . When component was last modified - name | Yes | string | | | . . . . Name of the component - owner | Yes | string | | | . . . . ID of who added the component - spec | Yes | :ref:`spec <i_ea9c5ae5ca1fb737a10e33ba863d3d34>` | | | The Component Specification (json) - status | Yes | string | | | . . . . Status of the component - version | Yes | string | | | . . . . Version of the component - whenAdded | Yes | string | date-time | | . . . . When component was added to the Catalog - -.. _i_ea9c5ae5ca1fb737a10e33ba863d3d34: - -**Spec schema:** - - -The Component Specification (json) - - - -.. _d_68ab1278c950fd214a4077565fd97922: - -dataformat fields Model Structure ---------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - dataFormatUrl | Yes | string | | | . . . . Url to the Data Format Specification - description | Yes | string | | | . . . . Description of the data format - id | Yes | string | | | . . . . ID of the data format - modified | Yes | string | date-time | | . . . . When data format was last modified - name | Yes | string | | | . . . . Name of the data format - owner | Yes | string | | | . . . . ID of who added the data format - status | Yes | string | | | . . . . Status of the data format - version | Yes | string | | | . . . . Version of the data format - whenAdded | Yes | string | date-time | | . . . . When data format was added to the Catalog - -.. _d_9c3ce799741cd0dae7f4d25c049e8a79: - -dataformat fields by id Model Structure ---------------------------------------- - -:ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` extended :ref:`inline <i_19c008f5124504e9d9c719d157dab70f>` - -.. _i_19c008f5124504e9d9c719d157dab70f: - -**Inline schema:** - - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - dataFormatUrl | Yes | string | | | . . . . Url to the Data Format Specification - description | Yes | string | | | . . . . Description of the data format - id | Yes | string | | | . . . . ID of the data format - modified | Yes | string | date-time | | . . . . When data format was last modified - name | Yes | string | | | . . . . Name of the data format - owner | Yes | string | | | . . . . ID of who added the data format - spec | Yes | :ref:`spec <i_c9a99411463ded6c619772d83b3882c8>` | | | The Data Format Specification (json) - status | Yes | string | | | . . . . Status of the data format - version | Yes | string | | | . . . . Version of the data format - whenAdded | Yes | string | date-time | | . . . . When data format was added to the Catalog - -.. _i_c9a99411463ded6c619772d83b3882c8: - -**Spec schema:** - - -The Data Format Specification (json) diff --git a/docs/sections/apis/swagger_inventory.yaml b/docs/sections/apis/swagger_inventory.yaml deleted file mode 100644 index 6fd57162..00000000 --- a/docs/sections/apis/swagger_inventory.yaml +++ /dev/null @@ -1,697 +0,0 @@ -# ================================================================================ -# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. -# ================================================================================ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ============LICENSE_END========================================================= -# -# ECOMP is a trademark and service mark of AT&T Intellectual Property. -swagger: '2.0' -info: - version: "3.0.4" - title: DCAE Inventory API - description: | - DCAE Inventory is a web service that provides the following: - - 1. Real-time data on all DCAE services and their components - 2. Comprehensive details on available DCAE service types - contact: - email: dcae@lists.openecomp.org -externalDocs: - description: DCAE Inventory - url: https://gerrit.onap.org/r/#/admin/projects/dcae/dcae-inventory -paths: - /dcae-service-types: - get: - summary: "" - description: "Get a list of `DCAEServiceType` objects." - operationId: "dcaeServiceTypesGet" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "typeName" - in: "query" - description: "Filter by service type name" - required: false - type: "string" - - name: "onlyLatest" - in: "query" - description: "If set to true, query returns just the latest versions of DCAE\ - \ service types. If set to false, then all versions are returned. Default\ - \ is true" - required: false - type: "boolean" - default: true - - name: "onlyActive" - in: "query" - description: "If set to true, query returns only *active* DCAE service types.\ - \ If set to false, then all DCAE service types are returned. Default is\ - \ true" - required: false - type: "boolean" - default: true - - name: "vnfType" - in: "query" - description: "Filter by associated vnf type. No wildcards, matches are explicit.\ - \ This field is treated case insensitive." - required: false - type: "string" - - name: "serviceId" - in: "query" - description: "Filter by assocaited service id. Instances with service id null\ - \ or empty is always returned." - required: false - type: "string" - - name: "serviceLocation" - in: "query" - description: "Filter by associated service location. Instances with service\ - \ location null or empty is always returned." - required: false - type: "string" - - name: "asdcServiceId" - in: "query" - description: "Filter by associated asdc design service id. Setting this to\ - \ `NONE` will return instances that have asdc service id set to null" - required: false - type: "string" - - name: "asdcResourceId" - in: "query" - description: "Filter by associated asdc design resource id. Setting this to\ - \ `NONE` will return instances that have asdc resource id set to null" - required: false - type: "string" - - name: "offset" - in: "query" - description: "Query resultset offset used for pagination (zero-based)" - required: false - type: "integer" - format: "int32" - responses: - 200: - description: "List of `DCAEServiceType` objects" - schema: - $ref: "#/definitions/InlineResponse200" - post: - summary: "" - description: "Inserts a new `DCAEServiceType` or updates an existing instance.\ - \ Updates are only allowed iff there are no running DCAE services of the requested\ - \ type," - operationId: "dcaeServiceTypesTypeNamePut" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/DCAEServiceTypeRequest" - responses: - 200: - description: "Single `DCAEServiceType` object." - schema: - $ref: "#/definitions/DCAEServiceType" - 400: - description: "Bad request provided." - schema: - $ref: "#/definitions/ApiResponseMessage" - 409: - description: "Failed to update because there are still DCAE services of\ - \ the requested type running." - schema: - $ref: "#/definitions/ApiResponseMessage" - /dcae-service-types/{typeId}: - get: - summary: "" - description: "Get a `DCAEServiceType` object." - operationId: "dcaeServiceTypesTypeIdGet" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "typeId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "Single `DCAEServiceType` object" - schema: - $ref: "#/definitions/DCAEServiceType" - 404: - description: "Resource not found" - schema: - $ref: "#/definitions/DCAEServiceType" - delete: - summary: "" - description: "Deactivates existing `DCAEServiceType` instances" - operationId: "dcaeServiceTypesTypeIdDelete" - consumes: - - "application/vnd.dcae.inventory.v1+json" - - "application/json" - produces: - - "application/vnd.dcae.inventory.v1+json" - - "application/json" - parameters: - - name: "typeId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "`DCAEServiceType` has been deactivated" - schema: - $ref: "#/definitions/ApiResponseMessage" - 410: - description: "`DCAEServiceType` already gone" - schema: - $ref: "#/definitions/ApiResponseMessage" - 404: - description: "`DCAEServiceType` not found" - schema: - $ref: "#/definitions/ApiResponseMessage" - /dcae-services: - get: - summary: "" - description: "Get a list of `DCAEService` objects." - operationId: "dcaeServicesGet" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "typeId" - in: "query" - description: "DCAE service type name" - required: false - type: "string" - - name: "vnfId" - in: "query" - required: false - type: "string" - - name: "vnfType" - in: "query" - description: "Filter by associated vnf type. This field is treated case insensitive." - required: false - type: "string" - - name: "vnfLocation" - in: "query" - required: false - type: "string" - - name: "componentType" - in: "query" - description: "Use to filter by a specific DCAE service component type" - required: false - type: "string" - - name: "shareable" - in: "query" - description: "Use to filter by DCAE services that have shareable components\ - \ or not" - required: false - type: "boolean" - - name: "created" - in: "query" - description: "Use to filter by created time" - required: false - type: "string" - - name: "offset" - in: "query" - description: "Query resultset offset used for pagination (zero-based)" - required: false - type: "integer" - format: "int32" - responses: - 200: - description: "List of `DCAEService` objects" - schema: - $ref: "#/definitions/InlineResponse2001" - 502: - description: "Bad response from DCAE controller" - schema: - $ref: "#/definitions/ApiResponseMessage" - 504: - description: "Failed to connect with DCAE controller" - schema: - $ref: "#/definitions/ApiResponseMessage" - /dcae-services-groupby/{propertyName}: - get: - summary: "" - description: "Get a list of unique values for the given `propertyName`" - operationId: "dcaeServicesGroupbyPropertyNameGet" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "propertyName" - in: "path" - description: "Property to find unique values. Restricted to `type`, `vnfType`,\ - \ `vnfLocation`" - required: true - type: "string" - responses: - 200: - description: "List of unique property values" - schema: - $ref: "#/definitions/DCAEServiceGroupByResults" - /dcae-services/{serviceId}: - get: - summary: "" - description: "Get a `DCAEService` object." - operationId: "dcaeServicesServiceIdGet" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "serviceId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "Single `DCAEService` object" - schema: - $ref: "#/definitions/DCAEService" - 502: - description: "Bad response from DCAE controller" - schema: - $ref: "#/definitions/ApiResponseMessage" - 404: - description: "DCAE service not found" - schema: - $ref: "#/definitions/ApiResponseMessage" - 504: - description: "Failed to connect with DCAE controller" - schema: - $ref: "#/definitions/ApiResponseMessage" - put: - summary: "" - description: "Put a new or update an existing `DCAEService` object." - operationId: "dcaeServicesServiceIdPut" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "serviceId" - in: "path" - required: true - type: "string" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/DCAEServiceRequest" - responses: - 200: - description: "Single `DCAEService` object" - schema: - $ref: "#/definitions/DCAEService" - 422: - description: "Bad request provided" - schema: - $ref: "#/definitions/ApiResponseMessage" - delete: - summary: "" - description: "Remove an existing `DCAEService` object." - operationId: "dcaeServicesServiceIdDelete" - consumes: - - "application/vnd.dcae.inventory.v1+json" - - "application/json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "serviceId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "DCAE service has been removed" - 404: - description: "Unknown DCAE service" - schema: - $ref: "#/definitions/ApiResponseMessage" -definitions: - DCAEServiceTypeRequest: - type: "object" - required: - - "blueprintTemplate" - - "owner" - - "typeName" - - "typeVersion" - properties: - owner: - type: "string" - typeName: - type: "string" - description: "Descriptive name for this DCAE service type" - typeVersion: - type: "integer" - format: "int32" - description: "Version number for this DCAE service type" - blueprintTemplate: - type: "string" - description: "String representation of a Cloudify blueprint with unbound variables" - serviceIds: - type: "array" - description: "List of service ids that are used to associate with DCAE service\ - \ type. DCAE service types with this propery as null or empty means them\ - \ apply for every service id." - items: - type: "string" - vnfTypes: - type: "array" - items: - type: "string" - serviceLocations: - type: "array" - description: "List of service locations that are used to associate with DCAE\ - \ service type. DCAE service types with this propery as null or empty means\ - \ them apply for every service location." - items: - type: "string" - asdcServiceId: - type: "string" - description: "Id of service this DCAE service type is associated with. Value\ - \ source is from ASDC's notification event's field `serviceInvariantUUID`." - asdcResourceId: - type: "string" - description: "Id of vf/vnf instance this DCAE service type is associated with.\ - \ Value source is from ASDC's notification event's field `resourceInvariantUUID`." - asdcServiceURL: - type: "string" - description: "URL to the ASDC service model" - DCAEServiceComponentRequest: - type: "object" - required: - - "componentId" - - "componentSource" - - "componentType" - - "shareable" - properties: - componentId: - type: "string" - description: "The id format is unique to the source" - componentType: - type: "string" - componentSource: - type: "string" - description: "Specifies the name of the underying source service that is responsible\ - \ for this components" - enum: - - "DCAEController" - - "DMaaPController" - shareable: - type: "integer" - format: "int32" - description: "Used to determine if this component can be shared amongst different\ - \ DCAE services" - DCAEServiceGroupByResultsPropertyValues: - type: "object" - properties: - count: - type: "integer" - format: "int32" - propertyValue: - type: "string" - dcaeServiceQueryLink: - description: "Link.title is the DCAE service property value. Following this\ - \ link will provide a list of DCAE services that all have this property\ - \ value." - $ref: "#/definitions/Link" - DCAEServiceGroupByResults: - type: "object" - properties: - propertyName: - type: "string" - description: "Property name of DCAE service that the group by operation was\ - \ performed on" - propertyValues: - type: "array" - items: - $ref: "#/definitions/DCAEServiceGroupByResultsPropertyValues" - InlineResponse200: - type: "object" - properties: - links: - $ref: "#/definitions/InlineResponse200Links" - totalCount: - type: "integer" - format: "int32" - items: - type: "array" - items: - $ref: "#/definitions/DCAEServiceType" - DCAEServiceRequest: - type: "object" - required: - - "components" - - "typeId" - - "vnfId" - - "vnfLocation" - - "vnfType" - properties: - typeId: - type: "string" - description: "Id of the associated DCAE service type" - vnfId: - type: "string" - description: "Id of the associated VNF that this service is monitoring" - vnfType: - type: "string" - description: "The type of the associated VNF that this service is monitoring" - vnfLocation: - type: "string" - description: "Location identifier of the associated VNF that this service\ - \ is monitoring" - deploymentRef: - type: "string" - description: "Reference to a Cloudify deployment" - components: - type: "array" - description: "List of DCAE service components that this service is composed\ - \ of" - items: - $ref: "#/definitions/DCAEServiceComponentRequest" - InlineResponse200Links: - type: "object" - properties: - previousLink: - $ref: "#/definitions/Link" - nextLink: - $ref: "#/definitions/Link" - description: "Pagination links" - ApiResponseMessage: - type: "object" - properties: - code: - type: "integer" - format: "int32" - type: - type: "string" - message: - type: "string" - DCAEService: - type: "object" - properties: - serviceId: - type: "string" - selfLink: - description: "Link.title is serviceId" - $ref: "#/definitions/Link" - created: - type: "string" - format: "date-time" - modified: - type: "string" - format: "date-time" - typeLink: - description: "Link.title is typeId" - $ref: "#/definitions/Link" - vnfId: - type: "string" - vnfLink: - description: "Link.title is vnfId" - $ref: "#/definitions/Link" - vnfType: - type: "string" - vnfLocation: - type: "string" - description: "Location information of the associated VNF" - deploymentRef: - type: "string" - description: "Reference to a Cloudify deployment" - components: - type: "array" - items: - $ref: "#/definitions/DCAEServiceComponent" - InlineResponse2001: - type: "object" - properties: - links: - $ref: "#/definitions/InlineResponse200Links" - totalCount: - type: "integer" - format: "int32" - items: - type: "array" - items: - $ref: "#/definitions/DCAEService" - UriBuilder: - type: "object" - Link: - type: "object" - properties: - title: - type: "string" - rel: - type: "string" - uri: - type: "string" - format: "uri" - uriBuilder: - $ref: "#/definitions/UriBuilder" - rels: - type: "array" - items: - type: "string" - params: - type: "object" - additionalProperties: - type: "string" - type: - type: "string" - DCAEServiceComponent: - type: "object" - required: - - "componentId" - - "componentLink" - - "componentSource" - - "componentType" - - "created" - - "modified" - - "shareable" - properties: - componentId: - type: "string" - description: "The id format is unique to the source" - componentLink: - description: "Link to the underlying resource of this component" - $ref: "#/definitions/Link" - created: - type: "string" - format: "date-time" - modified: - type: "string" - format: "date-time" - componentType: - type: "string" - componentSource: - type: "string" - description: "Specifies the name of the underying source service that is responsible\ - \ for this components" - enum: - - "DCAEController" - - "DMaaPController" - status: - type: "string" - location: - type: "string" - description: "Location information of the component" - shareable: - type: "integer" - format: "int32" - description: "Used to determine if this component can be shared amongst different\ - \ DCAE services" - DCAEServiceType: - type: "object" - required: - - "blueprintTemplate" - - "created" - - "owner" - - "selfLink" - - "typeId" - - "typeName" - - "typeVersion" - properties: - owner: - type: "string" - typeName: - type: "string" - description: "Descriptive name for this DCAE service type" - typeVersion: - type: "integer" - format: "int32" - description: "Version number for this DCAE service type" - blueprintTemplate: - type: "string" - description: "String representation of a Cloudify blueprint with unbound variables" - serviceIds: - type: "array" - description: "List of service ids that are used to associate with DCAE service\ - \ type. DCAE service types with this propery as null or empty means them\ - \ apply for every service id." - items: - type: "string" - vnfTypes: - type: "array" - items: - type: "string" - serviceLocations: - type: "array" - description: "List of service locations that are used to associate with DCAE\ - \ service type. DCAE service types with this propery as null or empty means\ - \ them apply for every service location." - items: - type: "string" - asdcServiceId: - type: "string" - description: "Id of service this DCAE service type is associated with. Value\ - \ source is from ASDC's notification event's field `serviceInvariantUUID`." - asdcResourceId: - type: "string" - description: "Id of vf/vnf instance this DCAE service type is associated with.\ - \ Value source is from ASDC's notification event's field `resourceInvariantUUID`." - asdcServiceURL: - type: "string" - description: "URL to the ASDC service model" - typeId: - type: "string" - description: "Unique identifier for this DCAE service type" - selfLink: - description: "Link to self where the Link.title is typeName" - $ref: "#/definitions/Link" - created: - type: "string" - format: "date-time" - description: "Created timestamp for this DCAE service type in epoch time" - deactivated: - type: "string" - format: "date-time" - description: "Deactivated timestamp for this DCAE service type in epoch time" diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst index c82391d4..88a240e6 100644 --- a/docs/sections/apis/ves-hv/index.rst +++ b/docs/sections/apis/ves-hv/index.rst @@ -56,7 +56,6 @@ HV-VES Collector forwards incoming messages to a particular DMaaP Kafka topic ba In both cases raw bytes might be extracted using ``org.apache.kafka.common.serialization.ByteArrayDeserializer``. The resulting bytes might be further passed to ``parseFrom`` methods included in classes generated from GPB definitions. WTP is not used here - it is only used in communication between PNF/VNF and the collector. -By default, **HV-VES** will use routing defined in **k8s-hv-ves.yaml-template** in **dcaegen2/platform/blueprints project** when deployed using Cloudify. In case of Helm deployment routing is defined in values.yaml file in HV-VES Helm Chart. diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst index 11271e98..344b84de 100644 --- a/docs/sections/architecture.rst +++ b/docs/sections/architecture.rst @@ -15,7 +15,7 @@ data collection needs, event processors for data standardization, analytics that The architecture of DCAE with Helm transformation is more flexible, microservice oriented and supports model based component design and deployment through DCAE-MOD. Also with migration to helm, DCAE microservice deployments can be handled independently, dependencies are captured under its helm charts.
-Under the Cloudify/DCAE Platform architecture, DCAE Service components relied on Consul's distributed K-V to manage and store component configuration. With Platform simplification under DCAE Transformation initiative for Kohn, Consul dependency has been removed across all DCAE service components. All Microservice configuration are currently resolved through files mounted via Configmap created part of dcae-services helm chart deployment.
+All Microservice configuration are currently resolved through files mounted via Configmap created part of dcae-services helm chart deployment.
DCAE Components
@@ -41,7 +41,6 @@ The following lists the components included in ONAP DCAE. All DCAE components a - PNF Registration Handler
- VES Mapper Service
- PM-Mapper Service
- - BBS-EventProcessor Service
- PM Subcription Handler
- DataLake Handlers (DL-Admin, DL-Feeder, DES)
- Misc Services
@@ -54,7 +53,7 @@ The figure below shows the DCAE architecture and how the components work with ea The following diagram has been created on https://app.diagrams.net/. There is an editable version of the diagram
in repository under path docs/sections/images/architecture_diagram. Import this file to mentioned page to edit diagram.
-.. image:: images/R11_architecture_diagram.png
+.. image:: images/R12_architecture_diagram.png
Deployment Scenarios
diff --git a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.rst b/docs/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.rst deleted file mode 100644 index 096a448e..00000000 --- a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-Architecture.rst +++ /dev/null @@ -1,259 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -===================== -DCAE MOD Architecture -===================== - - -DCAE MOD is composed of a mix of components developed in ONAP and other -components taken from the Apache Nifi project and modified for -appropriate use. The MOD architecture and design was intended to simplify the onboarding -and design experience in ONAP addressing below goals. - -.. toctree:: - :maxdepth: 1 - - ./DCAE-MOD-goals.rst - - -MOD aims to streamline the construction, management, -and evolution of DCAE flows from role to role, from environment to -environment, and from release to release. MOD is composed of three functional areas: onboarding, design, and -distribution and caters to different `user group <./Roles>`__ - - -The below illustrations describe the architecture of DCAE-MOD and show the -usage flow in DCAE MOD - -|image0| - -|image1| - -Onboarding API --------------- - -It is a component developed to onboard -models/components/microservices (spec files) into DCAE MOD. - -Genprocessor ------------- - -It has been developed in Java. This project is a tool to -experiment with generating a Nifi Processor POJO from a DCAE component -spec. - -Nifi Web UI ------------ - -It is a component taken from the Apache Nifi Project but modified for -use in the MOD project. - -Apache NiFi is a dataflow system based on the concepts of flow-based -programming. It supports powerful and scalable directed graphs of data -routing, transformation, and system mediation logic. NiFi has a -web-based user interface for design, control, feedback, and monitoring -of dataflows. It is highly configurable along several dimensions of -quality of service, such as loss-tolerant versus guaranteed delivery, -low latency versus high throughput, and priority-based queuing. NiFi -provides fine-grained data provenance for all data received, forked, -joined cloned, modified, sent, and ultimately dropped upon reaching its -configured end-state. - -The NiFi UI provides mechanisms for creating automated dataflows, as -well as visualizing, editing, monitoring, and administering those -dataflows. The UI can be broken down into several segments, each -responsible for different functionality of the application. This section -provides screenshots of the application and highlights the different -segments of the UI. Each segment is discussed in further detail later in -the document. - -The users of Apache Nifi will find that it is used very differently than -intended to serve our purpose in the DCAE-MOD project. - - -Registry API ------------- - -This component taken from the Apache Nifi project, is a REST API that -provides an interface to a registry with operations for saving, -versioning, reading NiFi flows and components. - -Distributor API ---------------- - -It is a component developed using the Flask framework in Python. -It is a HTTP API to manage distribution targets for DCAE design. -Distribution targets are DCAE runtime environments that have been -registered and are enabled to accept flow design changes that are to be -orchestrated in that environment. - -Flow Based Programming (FBP) ----------------------------- - -NiFi’s fundamental design concepts closely relate to the main ideas of -Flow Based -Programming `[fbp] <https://nifi.apache.org/docs/nifi-docs/html/overview.html#fbp>`__. - -For more information on how some of the main NiFi concepts map to FBP, -check out https://nifi.apache.org/docs/nifi-docs/html/overview.html - -Runtime API ------------ - -It is developed in Java’s Spring Boot framework. It -is a HTTP API to support runtime environment for DCAE-MOD. It has two -major functionalities: - -1. It accepts changes on the flow-graph via fbp protocol - -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 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: - -1. Real-time data on all DCAE services and their components - -2. Comprehensive details on available DCAE service types - -DCAE Inventory is a composite API that relies on other APIs to obtain -resources on underlying components and uses these resources to compose a -DCAE service resource. In addition, DCAE Inventory will store data that -is unique to the DCAE service level including: - -1. DCAE service metadata - -2. DCAE service type description and composition details - -3. Relationships between DCAE service and DCAE service types and their - respective VNF and VNF types - -DCAE Inventory has a REST interface to service client requests. It has a -well-defined query interface that would filter result sets based upon -resource attributes. - -Here, think of it as a back end API for the DCAE dashboard. The runtime -posts Cloudify Blueprints to this API so they show up in the DCAE -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 -status information on DCAE services and their components. - -End-to-End Flow ---------------- - -A model/component/microservice can be onboarded by a ms Developer by -posting a spec file on the onboarding API. Alternatively, an Acumos -model can be onboarded using the Acumos Adapter. Once successfully -onboarded, the genprocessor converts converts them to jars and onboards -them into Nifi i.e DCAE MOD. These artifacts are now available to use -from the Modified Nifi Web UI i.e DCAE Designer. - -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 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. - - - -.. |image0| image:: ../images/DCAE-Mod-Architecture.png - -.. |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 deleted file mode 100644 index d042028f..00000000 --- a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst +++ /dev/null @@ -1,636 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. _moduserguide: - -=================== -DCAE MOD User Guide -=================== - - - -- `Types of Users and Usage - Instructions: <#DCAEMODUserGuide(draft)-TypesofUsersand>`__ - -- `1. Deployment of DCAE MOD components via Helm - charts <#DCAEMODUserGuide(draft)-1.DeploymentofD>`__ - - - `Using DCAE MOD without an Ingress - Controller <#DCAEMODUserGuide(draft)-UsingDCAEMODwit>`__ - -- `2. Configuring DCAE - mod <#DCAEMODUserGuide(draft)-2.ConfiguringDC>`__ - -- `3. Design & Distribution - Flow <#DCAEMODUserGuide(draft)-3.Design&Distri>`__ - - -Types of Users and Usage Instructions: -====================================== - -+-------+-----------------------------+-----------------------------+ -| Sr.No | User | Usage Instructions | -+=======+=============================+=============================+ -| 1. | Developers who are looking | - Access the Nifi | -| | to onboard their mS | Web UI url provided to you | -| | | | -| | | - Follow steps 2.c | -| | | to 2.f | -| | | | -| | | - You should be able | -| | | to see your microservices | -| | | in the Nifi Web UI by | -| | | clicking and dragging | -| | | ‘Processor’ on the canvas, | -| | | and searching for the name | -| | | of the | -| | | micros | -| | | ervice/component/processor. | -+-------+-----------------------------+-----------------------------+ -| 2. | Designers who are building | - Access the Nifi | -| | the flows through UI and | Web UI url provided to you | -| | triggering distribution | | -| | | - Follow steps 3 to | -| | | the end of the document | -+-------+-----------------------------+-----------------------------+ -| 3. | Infrastructure/ Admins who | - Follow start to | -| | want to stand up DCAE Mod | the end | -| | 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 - - -.. 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 -deployment process. When deploying ONAP using the helm deploy command, -DCAE MOD components are deployed when the dcaemod.enabled flag is set to -true, either via a --set option on the command line or by an entry in an -overrides file. In this respect, DCAE MOD is no different from any -other ONAP subsystem. - -The default DCAE MOD deployment relies on an nginx ingress controller -being available in the Kubernetes cluster where DCAE MOD is being -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 -:: - - ingress: - enabled: true - virtualhost: - baseurl: "simpledemo.onap.org" - -When DCAE MOD is deployed with an ingress controller, several endpoints -are exposed outside the cluster at the ingress controller's external IP -address and port. (In the case of a Rancher RKE installation, there is -an ingress controller on every worker node, listening at the the -standard HTTP port (80).) These exposed endpoints are needed by users -using machines outside the Kubernetes cluster. - -+--------------+--------------------------------------------------+--------------------------+ -| **Endpoint** | ** Routes to (cluster | **Description** | -| | internal address)** | | -+==============+==================================================+==========================+ -| /nifi | http://dcaemod-designtool:8080/nifi | Design tool Web UI | -| | | | -+--------------+--------------------------------------------------+--------------------------+ -| /nifi-api | http://dcaemod-designtool:8080/nifi-api | Design tool API | -| | | | -+--------------+--------------------------------------------------+--------------------------+ -| /nifi-jars | http://dcaemod-nifi-registry:18080/nifi-jars | Flow registry listing of | -| | | JAR files built from | -| | | component specs | -+--------------+--------------------------------------------------+--------------------------+ -| /onboarding | http://dcaemod-onboarding-api:8080/onboarding | Onboarding API | -| | | | -+--------------+--------------------------------------------------+--------------------------+ -| /distributor | http://dcaemod-distributor-api:8080/distributor | Distributor API | -| | | | -+--------------+--------------------------------------------------+--------------------------+ - -| To access the design Web UI, for example, a user would use the URL : - http://*ingress_controller_address:ingress_controller_port*/nifi. -| *ingress_controller_address* is the the IP address or DNS FQDN of the - ingress controller and -| *ingress_controller_port* is the port on which the ingress controller - is listening for HTTP requests. (If the port is 80, the HTTP default, - then there is no need to specify a port.) - -There are two additional *internal* endpoints that users need to know, -in order to configure a registry client and a distribution target in the -design tool's controller settings. - -+------------------------+--------------------------------------------+ -| **Configuration Item** | **Endpoint URL** | -+========================+============================================+ -| Registry client | http://dcaemod-nifi-registry:18080 | -+------------------------+--------------------------------------------+ -| Distribution target | http://dcaemod-runtime-api:9090 | -+------------------------+--------------------------------------------+ - -With Guilin release, OOM/ingress template has been updated to enable virtual host by default. -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 - - -3. Configuring DCAE mod -========================== - -**a. Configure Nifi Registry url** - -Next check Nifi settings by selecting the Hamburger button in the Nifi -UI. It should lead you to the Nifi Settings screen - -|image16| - -|image3| - -Add a registry client. The Registry client url will be -http://dcaemod-nifi-registry:18080 - -|image4| - - -**b. Add distribution target which will be the runtime api url** - -Set the distribution target in the controller settings - -|image17| - -Distribution target URL will be -`http://dcaemod-runtime-api:9090 <http://dcaemod-runtime-api:9090/>`__ - - - -Now let’s access the Nifi (DCAE designer) UI - http://dcaemod.simpledemo.onap.org/nifi - -IPAddress is the host address or the DNS FQDN, if there is one, for one of the Kubernetes nodes. - -|image0| - - -**c. Get the artifacts to test and onboard.** - -MOD components has been upgraded to use v3 specification for Helm flow support - -VESCollector -~~~~~~~~~~~~ - -**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 - -**VES 7.30.2.1 Data Format :** https://git.onap.org/dcaegen2/collectors/ves/tree/etc/CommonEventFormat_30.2.1_ONAP.jsonormat.json - -**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 -:: - - { "owner": "<some value>", "spec": <some json object> } - -where the json object inside the spec field can be a component spec json. - -Request bodies of this type will be used in the onboarding requests you make using curl or the onboarding swagger interface. - -**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_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. Onboard data format and component-spec** - -Each component has a description that tells what it does. - -These requests would be of the type - -curl -X POST http://<onboardingapi host>/onboarding/dataformats -H "Content-Type: application/json" -d -@<filepath to request> - -curl -X POST http://<onboardingapi host>/onboarding/components -H "Content-Type: application/json" -d -@<filepath to request> - -In our case, - -curl -X POST http://dcaemod.simpledemo.onap.org/onboarding/dataformats -H "Content-Type: application/json" -d @<filepath to request> - -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://dcaemod.simpledemo.onap.org/onboarding/dataformats - -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** - -Open http://dcaemod.simpledemo.onap.org/nifi-jars in a browser. - -These jars should now be available for you to use in the nifi UI as -processors - -|image1| - -4. Design & Distribution Flow -================================ - - -**a**. To start creating flows, we need to create a process group first. The -name of the process group will be the name of the flow. Drag and Drop on -the canvas, the ‘Processor Group’ icon from the DCAE Designer bar on the -top. - -|image2| - - -Now enter the process group by double clicking it, - -You can now drag and drop on the canvas ‘Processor’ icon from the top -DCAE Designer tab. You can search for a particular component in the -search box that appears when you attempt to drag the ‘Processor’ icon to -the canvas. - -|image5| - -If the Nifi registry linking worked, you should see the “Import” button -when you try to add a Processor or Process group to the Nifi canvas, -like so- - -|image6| - -By clicking on the import button, we can import already created saved -and version controlled flows from the Nifi registry, if they are -present. - -|image7| - -We can save created flows by version controlling them like so starting -with a 'right click' anywhere on the canvas- - -|image8| - -Ideally you would name the flow and process group the same, because -functionally they are similar. - -|image9| - -When the flow is checked in, the bar at the bottom shows a green -checkmark - -|image10| - -Note: Even if you move a component around on the canvas, and its -position on the canvas changes, it is recognized as a change, and it -will have to recommitted. - -You can add additional components in your flow and connect them. - -DcaeVesCollector connects to DockerTcagen2. - -|image11| - -|image12| - -|image13| - -Along the way you need to also provide topic names in the settings -section. These can be arbitrary names. - -|image14| - -To recap, see how DcaeVesCollector connects to DockerTcagen2. Look at -the connection relationships. Currently there is no way to validate -these relationships. Notice how it is required to name the topics by -going to Settings. - -The complete flow after joining our components looks like so - -|image15| - - -**b. Submit/ Distribute the flow:** - -Once your flow is complete and saved in the Nifi registry, you can -choose to submit it for distribution. - -|image18| - -If the flow was submitted successfully to the runtime api, you should -get a pop up a success message like so - - -|image19| - -At this step, the design was packaged and sent to Runtime api. - -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** - - -.. |image0| image:: ../images/1.png - :width: 6.5in - :height: 1.08333in -.. |image1| image:: ../images/2.png - :width: 6.5in - :height: 1.58333in -.. |image2| image:: ../images/3.png - :width: 5.83333in - :height: 3.58333in -.. |image3| image:: ../images/4.png - :width: 4.91667in - :height: 2.16667in -.. |image4| image:: ../images/5.png - :width: 6.5in - :height: 2.66667in -.. |image5| image:: ../images/6.png - :width: 6.5in - :height: 3.33333in -.. |image6| image:: ../images/7.png - :width: 4.91667in - :height: 2.25in -.. |image7| image:: ../images/8.png - :width: 4.91667in - :height: 2.58333in -.. |image8| image:: ../images/9.png - :width: 6.5in - :height: 4.58333in -.. |image9| image:: ../images/10.png - :width: 6.5in - :height: 4in -.. |image10| image:: ../images/11.png - :width: 4.91667in - :height: 0.41667in -.. |image11| image:: ../images/12.png - :width: 6.33333in - :height: 3.16667in -.. |image12| image:: ../images/13.png - :width: 6in - :height: 2.66667in -.. |image13| image:: ../images/14.png - :width: 6.5in - :height: 3.41667in -.. |image14| image:: ../images/15.png - :width: 6.5in - :height: 3.58333in -.. |image15| image:: ../images/16.png - :width: 6.5in - :height: 2.25in -.. |image16| image:: ../images/17.png - :width: 6.5in - :height: 2.83333in -.. |image17| image:: ../images/18.png - :width: 6.5in - :height: 3.08333in -.. |image18| image:: ../images/19.png - :width: 4.91667in - :height: 1.91667in -.. |image19| image:: ../images/20.png - :width: 4.91667in - :height: 2.41667in - - diff --git a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-goals.rst b/docs/sections/design-components/DCAE-MOD/DCAE-MOD-goals.rst deleted file mode 100644 index a0521cca..00000000 --- a/docs/sections/design-components/DCAE-MOD/DCAE-MOD-goals.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -============== -MOD Objectives -============== - -MOD stands for "micro-service onboarding and design" and the project is -an effort to reboot the onboarding and design experience in DCAE. - - -**Goals and Stretch Goals** ---------------------------- - - -- Due to resource constraints, there are mismatched capabilities between SDC/DCAE-DS and DCAE mS deployment. - -- Due to #1, mS developers upload handcrafted blueprint, and stay involved throughout the deployment process. This also ties mS development to specific Cloudify implementation. - -- There is no Service Assurance flow design in SDC/DCAE-DS, and so there are no reusable flow designs for the Service Designer. - -- There is extensive reliance on developers’ involvement in providing [Inputs.json] as runtime configurations for mS deployment. - -- There is no E2E tracking of the microservice lifecycle. - - -**To address these problems, the new DCAE MOD, replacing the mS onboarding & DCAE-DS in SDC, aims to -** - - - -- Move DCAE mS onboarding & design from SDC project to DCAE Project. - -- Provide simplified mS Onboarding, Service Assurance flow design, & mS microservice design time & runtime configurations to support developers, service designers, and operations. - -- Auto-generate blueprint at the end of the design process, not onboarded before the design process. - -- Support Policy onboarding & artifact distribution to Policy/CLAMP to support Self Service Control Loop. - -- Streamline the process of constructing to deploying flows, Provide the ability to track flows - capture and store the progress and evolution of flows and Provide clear coordination and accountability i.e Provide catalog & data for microservice lifecycle tracking. It fits the ECOMP's release process and must provide clear visibility along the entire process and across different environments. - -- 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 & Policy/CLAMP as part of the Design Platform. - - diff --git a/docs/sections/design-components/DCAE-MOD/Roles.rst b/docs/sections/design-components/DCAE-MOD/Roles.rst deleted file mode 100644 index c3460841..00000000 --- a/docs/sections/design-components/DCAE-MOD/Roles.rst +++ /dev/null @@ -1,168 +0,0 @@ -===== -Roles -===== - - -Here is master list of all roles involved in ECOMP with DCAE: - -- System engineer - -- Component developer/expert - components are also referred to as - micro-services but include collectors, analytics - -- Designer - -- Tester - -- Operations - -- Platform developer - -- Manager - - -System engineer ---------------- - -Person who knows the high-level technical requirements for DCAE's -upcoming release cycle and dictates the development needs. This person -is responsible for the service assurance flows. This person expresses -the nodes and connections of a flow at a high level in a new graph or an -existing graph and assigns nodes to component developer/experts to be -implemented. - -This person must know: - -- What newly added flows should look like at a high level - -- What changes that are needed to existing flows - -- Target environments/sites/locations that need the flows at what SLA - -- Data requirements e.g. volume, rate, format, retention - -This person creates a top-level representation of the flow and assigns -the pieces to developers or experts for implementation. - - -Component developer/expert --------------------------- - -Person who is responsible for defining an assigned node's subgraph. -This person can be: - -- A developer who might be onboarding a new component or a new version - of an existing component to fulfill the system engineer's - requirements - -- A domain expert who selects a suitable existing component, wires and - configures. This expert knows the intricacies of a class of - components (e.g. Acumos machine learning). - -Developers ----------- - -They must know: - -- The target DCAE runtime and can develop a component to successfully - run on the runtime - -- The DCAE onboarding process for components including the development - testing procedure - -- Best practices of data flow management (data provenance?) - -- Lifecycle of DCAE components specifically impact of changes to - existing running instances globally - -- The resource requirement of the developed component - -Experts -------- - -They must know: - -- The target DCAE runtime - -- The technical capabilities of a set of components in order to best - select - -- The technical needs of the set of components in order to properly - configure and connect - -Designer --------- - - -Person who is responsible for connecting remote nodes to flows and -configuring all nodes in a flow in the context of the flow and in the -context of the greater graph. An example of the former is connecting a -flow with a collector to a black boxed vMME. An example of the latter -is assigning the threshold to a threshold-crossing-analytics component -when it is connected to a specific VES collector who is connected to a -specific vMME. - -This person knows: - -- The VNFs to monitor and the technical details to correctly connect - with them - -- Enough about the capability of a component and understands the - characteristics and requirements of a flow to properly - assign designer_editable configuration parameters - -This person has the ability to promote flows through the development -process (i.e. FTL to IST to ETE) and will coordinate with testers to -make sure the progression happens. - -Tester ------- - -Person who is responsible for testing a promoted new flow or newly -edited flow. Once the designer has promoted a flow to a tester's -environment, the tester will have ready access to the deployment -artifacts necessary to apply the runtime changes that will reflect the -flow design and verify the resulting functionality matches to the system -engineer's expectations. - -Person knows and owns a DCAE runtime. - -Read access to the design tool would be useful for troubleshooting. - - -Operations ----------- - -Person who is responsible that DCAE both platform and service assurance -flows are all operational in production environments and locations. -Once a flow has been fully certified, the required deployment artifact -is provided to operations and operations is responsible for applying the -runtime changes to reflect the flow design. - -Person knows and owns a DCAE runtime. - -Read access to the design tool would be useful for troubleshooting. - - - -Manager -------- - - -Person who are accountable to the business of the successful delivery of -a set of service assurance flows. Read access to the design tool -specifically high level reports are useful to understand if goals are -being met and to better measure project success. - -Platform developer ------------------- - - -Person who is responsible for the development of the DCAE platform which -ranges from onboarding, design, and runtime. In the scope of onboarding -and design, they are also responsible (unless there's an internal -operational team) for the operational concerns which means the tooling -built in this effort will need to be continually supported. -Their **users** are all the above. The design tool is intended to span -across multiple environments thus must run where all the required -parties have access. diff --git a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component.json b/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component.json deleted file mode 100644 index 68667836..00000000 --- a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component.json +++ /dev/null @@ -1,328 +0,0 @@ -{ - "owner": "mS-Developer", - "spec": { - "self": { - "version": "1.5.4", - "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": "5.28.4", - "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.1", - "type": "message router", - "config_key": "ves-pnfRegistration" - }, - { - "format": "VES_specification", - "version": "7.30.1", - "type": "message router", - "config_key": "ves-notification" - }, - { - "format": "VES_specification", - "version": "7.30.1", - "type": "message router", - "config_key": "ves-perf3gpp" - } - ] - }, - "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.1" - }, - "response": { - "format": "ves.coll.response", - "version": "1.0.0" - } - } - ] - }, - "parameters": [ - { - "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|measurement=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|perf3gpp=ves-perf3gpp", - "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.1.1.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 - } - ], - "auxilary": { - "healthcheck": { - "type": "http", - "interval": "15s", - "timeout": "1s", - "endpoint": "/healthcheck" - }, - "volumes": [ - { - "container": { - "bind": "/opt/app/dcae-certificate" - }, - "host": { - "path": "/opt/app/dcae-certificate" - } - }, - { - "container": { - "bind": "/opt/app/VESCollector/logs" - }, - "host": { - "path": "/opt/logs/DCAE/VESCollector/logs" - } - }, - { - "container": { - "bind": "/opt/app/VESCollector/etc" - }, - "host": { - "path": "/opt/logs/DCAE/VESCollector/etc" - } - } - ], - "ports": [ - "8080:0", - "8443:0" - ], - "log_info": { - "log_directory": "/opt/app/VESCollector/logs/" - }, - "tls_info": { - "cert_directory": "/opt/app/dcae-certificate/", - "use_tls": true - } - }, - "artifacts": [ - { - "type": "docker image", - "uri": "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:latest" - } - ] - } -}
\ No newline at end of file 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 deleted file mode 100644 index ebbf3f64..00000000 --- a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Component_v3.json +++ /dev/null @@ -1,412 +0,0 @@ - { - "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/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Data-Format.json b/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Data-Format.json deleted file mode 100644 index ebf73150..00000000 --- a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/Request-body-of-Sample-Data-Format.json +++ /dev/null @@ -1,2124 +0,0 @@ -{ - "owner": "mS-Developer", - "spec": { - "self": { - "name": "VES_specification", - "version": "5.28.4", - "description": "VES spec for 5.4.1" - }, - "dataformatversion": "1.0.0", - "jsonschema": { - "$schema": "http://json-schema.org/draft-04/schema#", - "title": "VES Event Listener", - "type": "object", - "properties": { - "event": { - "$ref": "#/definitions/event" - }, - "eventList": { - "$ref": "#/definitions/eventList" - } - }, - "definitions": { - "schemaHeaderBlock": { - "description": "schema date, version, author and associated API", - "type": "object", - "properties": { - "associatedApi": { - "description": "VES Event Listener", - "type": "string" - }, - "lastUpdatedBy": { - "description": "re2947", - "type": "string" - }, - "schemaDate": { - "description": "September 12, 2017", - "type": "string" - }, - "schemaVersion": { - "description": "28.4", - "type": "number" - } - } - }, - "schemaLicenseAndCopyrightNotice": { - "description": "Copyright (c) 2017, AT&T Intellectual Property. All rights reserved", - "type": "object", - "properties": { - "apacheLicense2.0": { - "description": "Licensed under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at:", - "type": "string" - }, - "licenseUrl": { - "description": "http://www.apache.org/licenses/LICENSE-2.0", - "type": "string" - }, - "asIsClause": { - "description": "Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.", - "type": "string" - }, - "permissionsAndLimitations": { - "description": "See the License for the specific language governing permissions and limitations under the License.", - "type": "string" - } - } - }, - "codecsInUse": { - "description": "number of times an identified codec was used over the measurementInterval", - "type": "object", - "properties": { - "codecIdentifier": { - "type": "string" - }, - "numberInUse": { - "type": "integer" - } - }, - "required": [ - "codecIdentifier", - "numberInUse" - ] - }, - "command": { - "description": "command from an event collector toward an event source", - "type": "object", - "properties": { - "commandType": { - "type": "string", - "enum": [ - "heartbeatIntervalChange", - "measurementIntervalChange", - "provideThrottlingState", - "throttlingSpecification" - ] - }, - "eventDomainThrottleSpecification": { - "$ref": "#/definitions/eventDomainThrottleSpecification" - }, - "heartbeatInterval": { - "type": "integer" - }, - "measurementInterval": { - "type": "integer" - } - }, - "required": [ - "commandType" - ] - }, - "commandList": { - "description": "array of commands from an event collector toward an event source", - "type": "array", - "items": { - "$ref": "#/definitions/command" - }, - "minItems": 0 - }, - "commonEventHeader": { - "description": "fields common to all events", - "type": "object", - "properties": { - "domain": { - "description": "the eventing domain associated with the event", - "type": "string", - "enum": [ - "fault", - "heartbeat", - "measurementsForVfScaling", - "mobileFlow", - "other", - "sipSignaling", - "stateChange", - "syslog", - "thresholdCrossingAlert", - "voiceQuality" - ] - }, - "eventId": { - "description": "event key that is unique to the event source", - "type": "string" - }, - "eventName": { - "description": "unique event name", - "type": "string" - }, - "eventType": { - "description": "for example - applicationVnf, guestOS, hostOS, platform", - "type": "string" - }, - "internalHeaderFields": { - "$ref": "#/definitions/internalHeaderFields" - }, - "lastEpochMicrosec": { - "description": "the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds", - "type": "number" - }, - "nfcNamingCode": { - "description": "3 character network function component type, aligned with vfc naming standards", - "type": "string" - }, - "nfNamingCode": { - "description": "4 character network function type, aligned with vnf naming standards", - "type": "string" - }, - "priority": { - "description": "processing priority", - "type": "string", - "enum": [ - "High", - "Medium", - "Normal", - "Low" - ] - }, - "reportingEntityId": { - "description": "UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process", - "type": "string" - }, - "reportingEntityName": { - "description": "name of the entity reporting the event, for example, an EMS name; may be the same as sourceName", - "type": "string" - }, - "sequence": { - "description": "ordering of events communicated by an event source instance or 0 if not needed", - "type": "integer" - }, - "sourceId": { - "description": "UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process", - "type": "string" - }, - "sourceName": { - "description": "name of the entity experiencing the event issue", - "type": "string" - }, - "startEpochMicrosec": { - "description": "the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds", - "type": "number" - }, - "version": { - "description": "version of the event header", - "type": "number" - } - }, - "required": [ - "domain", - "eventId", - "eventName", - "lastEpochMicrosec", - "priority", - "reportingEntityName", - "sequence", - "sourceName", - "startEpochMicrosec", - "version" - ] - }, - "counter": { - "description": "performance counter", - "type": "object", - "properties": { - "criticality": { - "type": "string", - "enum": [ - "CRIT", - "MAJ" - ] - }, - "name": { - "type": "string" - }, - "thresholdCrossed": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "criticality", - "name", - "thresholdCrossed", - "value" - ] - }, - "cpuUsage": { - "description": "usage of an identified CPU", - "type": "object", - "properties": { - "cpuIdentifier": { - "description": "cpu identifer", - "type": "string" - }, - "cpuIdle": { - "description": "percentage of CPU time spent in the idle task", - "type": "number" - }, - "cpuUsageInterrupt": { - "description": "percentage of time spent servicing interrupts", - "type": "number" - }, - "cpuUsageNice": { - "description": "percentage of time spent running user space processes that have been niced", - "type": "number" - }, - "cpuUsageSoftIrq": { - "description": "percentage of time spent handling soft irq interrupts", - "type": "number" - }, - "cpuUsageSteal": { - "description": "percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing", - "type": "number" - }, - "cpuUsageSystem": { - "description": "percentage of time spent on system tasks running the kernel", - "type": "number" - }, - "cpuUsageUser": { - "description": "percentage of time spent running un-niced user space processes", - "type": "number" - }, - "cpuWait": { - "description": "percentage of CPU time spent waiting for I/O operations to complete", - "type": "number" - }, - "percentUsage": { - "description": "aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running", - "type": "number" - } - }, - "required": [ - "cpuIdentifier", - "percentUsage" - ] - }, - "diskUsage": { - "description": "usage of an identified disk", - "type": "object", - "properties": { - "diskIdentifier": { - "description": "disk identifier", - "type": "string" - }, - "diskIoTimeAvg": { - "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval", - "type": "number" - }, - "diskIoTimeLast": { - "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval", - "type": "number" - }, - "diskIoTimeMax": { - "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval", - "type": "number" - }, - "diskIoTimeMin": { - "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval", - "type": "number" - }, - "diskMergedReadAvg": { - "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskMergedReadLast": { - "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval", - "type": "number" - }, - "diskMergedReadMax": { - "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval", - "type": "number" - }, - "diskMergedReadMin": { - "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval", - "type": "number" - }, - "diskMergedWriteAvg": { - "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskMergedWriteLast": { - "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval", - "type": "number" - }, - "diskMergedWriteMax": { - "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval", - "type": "number" - }, - "diskMergedWriteMin": { - "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval", - "type": "number" - }, - "diskOctetsReadAvg": { - "description": "number of octets per second read from a disk or partition; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskOctetsReadLast": { - "description": "number of octets per second read from a disk or partition; provide the last measurement within the measurement interval", - "type": "number" - }, - "diskOctetsReadMax": { - "description": "number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval", - "type": "number" - }, - "diskOctetsReadMin": { - "description": "number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval", - "type": "number" - }, - "diskOctetsWriteAvg": { - "description": "number of octets per second written to a disk or partition; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskOctetsWriteLast": { - "description": "number of octets per second written to a disk or partition; provide the last measurement within the measurement interval", - "type": "number" - }, - "diskOctetsWriteMax": { - "description": "number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval", - "type": "number" - }, - "diskOctetsWriteMin": { - "description": "number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval", - "type": "number" - }, - "diskOpsReadAvg": { - "description": "number of read operations per second issued to the disk; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskOpsReadLast": { - "description": "number of read operations per second issued to the disk; provide the last measurement within the measurement interval", - "type": "number" - }, - "diskOpsReadMax": { - "description": "number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval", - "type": "number" - }, - "diskOpsReadMin": { - "description": "number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval", - "type": "number" - }, - "diskOpsWriteAvg": { - "description": "number of write operations per second issued to the disk; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskOpsWriteLast": { - "description": "number of write operations per second issued to the disk; provide the last measurement within the measurement interval", - "type": "number" - }, - "diskOpsWriteMax": { - "description": "number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval", - "type": "number" - }, - "diskOpsWriteMin": { - "description": "number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval", - "type": "number" - }, - "diskPendingOperationsAvg": { - "description": "queue size of pending I/O operations per second; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskPendingOperationsLast": { - "description": "queue size of pending I/O operations per second; provide the last measurement within the measurement interval", - "type": "number" - }, - "diskPendingOperationsMax": { - "description": "queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval", - "type": "number" - }, - "diskPendingOperationsMin": { - "description": "queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval", - "type": "number" - }, - "diskTimeReadAvg": { - "description": "milliseconds a read operation took to complete; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskTimeReadLast": { - "description": "milliseconds a read operation took to complete; provide the last measurement within the measurement interval", - "type": "number" - }, - "diskTimeReadMax": { - "description": "milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval", - "type": "number" - }, - "diskTimeReadMin": { - "description": "milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval", - "type": "number" - }, - "diskTimeWriteAvg": { - "description": "milliseconds a write operation took to complete; provide the average measurement within the measurement interval", - "type": "number" - }, - "diskTimeWriteLast": { - "description": "milliseconds a write operation took to complete; provide the last measurement within the measurement interval", - "type": "number" - }, - "diskTimeWriteMax": { - "description": "milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval", - "type": "number" - }, - "diskTimeWriteMin": { - "description": "milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval", - "type": "number" - } - }, - "required": [ - "diskIdentifier" - ] - }, - "endOfCallVqmSummaries": { - "description": "provides end of call voice quality metrics", - "type": "object", - "properties": { - "adjacencyName": { - "description": " adjacency name", - "type": "string" - }, - "endpointDescription": { - "description": "Either Caller or Callee", - "type": "string", - "enum": [ - "Caller", - "Callee" - ] - }, - "endpointJitter": { - "description": "", - "type": "number" - }, - "endpointRtpOctetsDiscarded": { - "description": "", - "type": "number" - }, - "endpointRtpOctetsReceived": { - "description": "", - "type": "number" - }, - "endpointRtpOctetsSent": { - "description": "", - "type": "number" - }, - "endpointRtpPacketsDiscarded": { - "description": "", - "type": "number" - }, - "endpointRtpPacketsReceived": { - "description": "", - "type": "number" - }, - "endpointRtpPacketsSent": { - "description": "", - "type": "number" - }, - "localJitter": { - "description": "", - "type": "number" - }, - "localRtpOctetsDiscarded": { - "description": "", - "type": "number" - }, - "localRtpOctetsReceived": { - "description": "", - "type": "number" - }, - "localRtpOctetsSent": { - "description": "", - "type": "number" - }, - "localRtpPacketsDiscarded": { - "description": "", - "type": "number" - }, - "localRtpPacketsReceived": { - "description": "", - "type": "number" - }, - "localRtpPacketsSent": { - "description": "", - "type": "number" - }, - "mosCqe": { - "description": "1-5 1dp", - "type": "number" - }, - "packetsLost": { - "description": "", - "type": "number" - }, - "packetLossPercent": { - "description": "Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp)", - "type": "number" - }, - "rFactor": { - "description": "0-100", - "type": "number" - }, - "roundTripDelay": { - "description": "millisecs", - "type": "number" - } - }, - "required": [ - "adjacencyName", - "endpointDescription" - ] - }, - "event": { - "description": "the root level of the common event format", - "type": "object", - "properties": { - "commonEventHeader": { - "$ref": "#/definitions/commonEventHeader" - }, - "faultFields": { - "$ref": "#/definitions/faultFields" - }, - "heartbeatFields": { - "$ref": "#/definitions/heartbeatFields" - }, - "measurementsForVfScalingFields": { - "$ref": "#/definitions/measurementsForVfScalingFields" - }, - "mobileFlowFields": { - "$ref": "#/definitions/mobileFlowFields" - }, - "otherFields": { - "$ref": "#/definitions/otherFields" - }, - "sipSignalingFields": { - "$ref": "#/definitions/sipSignalingFields" - }, - "stateChangeFields": { - "$ref": "#/definitions/stateChangeFields" - }, - "syslogFields": { - "$ref": "#/definitions/syslogFields" - }, - "thresholdCrossingAlertFields": { - "$ref": "#/definitions/thresholdCrossingAlertFields" - }, - "voiceQualityFields": { - "$ref": "#/definitions/voiceQualityFields" - } - }, - "required": [ - "commonEventHeader" - ] - }, - "eventDomainThrottleSpecification": { - "description": "specification of what information to suppress within an event domain", - "type": "object", - "properties": { - "eventDomain": { - "description": "Event domain enum from the commonEventHeader domain field", - "type": "string" - }, - "suppressedFieldNames": { - "description": "List of optional field names in the event block that should not be sent to the Event Listener", - "type": "array", - "items": { - "type": "string" - } - }, - "suppressedNvPairsList": { - "description": "Optional list of specific NvPairsNames to suppress within a given Name-Value Field", - "type": "array", - "items": { - "$ref": "#/definitions/suppressedNvPairs" - } - } - }, - "required": [ - "eventDomain" - ] - }, - "eventDomainThrottleSpecificationList": { - "description": "array of eventDomainThrottleSpecifications", - "type": "array", - "items": { - "$ref": "#/definitions/eventDomainThrottleSpecification" - }, - "minItems": 0 - }, - "eventList": { - "description": "array of events", - "type": "array", - "items": { - "$ref": "#/definitions/event" - } - }, - "eventThrottlingState": { - "description": "reports the throttling in force at the event source", - "type": "object", - "properties": { - "eventThrottlingMode": { - "description": "Mode the event manager is in", - "type": "string", - "enum": [ - "normal", - "throttled" - ] - }, - "eventDomainThrottleSpecificationList": { - "$ref": "#/definitions/eventDomainThrottleSpecificationList" - } - }, - "required": [ - "eventThrottlingMode" - ] - }, - "faultFields": { - "description": "fields specific to fault events", - "type": "object", - "properties": { - "alarmAdditionalInformation": { - "description": "additional alarm information", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "alarmCondition": { - "description": "alarm condition reported by the device", - "type": "string" - }, - "alarmInterfaceA": { - "description": "card, port, channel or interface name of the device generating the alarm", - "type": "string" - }, - "eventCategory": { - "description": "Event category, for example: license, link, routing, security, signaling", - "type": "string" - }, - "eventSeverity": { - "description": "event severity", - "type": "string", - "enum": [ - "CRITICAL", - "MAJOR", - "MINOR", - "WARNING", - "NORMAL" - ] - }, - "eventSourceType": { - "description": "type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction", - "type": "string" - }, - "faultFieldsVersion": { - "description": "version of the faultFields block", - "type": "number" - }, - "specificProblem": { - "description": "short description of the alarm or problem", - "type": "string" - }, - "vfStatus": { - "description": "virtual function status enumeration", - "type": "string", - "enum": [ - "Active", - "Idle", - "Preparing to terminate", - "Ready to terminate", - "Requesting termination" - ] - } - }, - "required": [ - "alarmCondition", - "eventSeverity", - "eventSourceType", - "faultFieldsVersion", - "specificProblem", - "vfStatus" - ] - }, - "featuresInUse": { - "description": "number of times an identified feature was used over the measurementInterval", - "type": "object", - "properties": { - "featureIdentifier": { - "type": "string" - }, - "featureUtilization": { - "type": "integer" - } - }, - "required": [ - "featureIdentifier", - "featureUtilization" - ] - }, - "field": { - "description": "name value pair", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name", - "value" - ] - }, - "filesystemUsage": { - "description": "disk usage of an identified virtual machine in gigabytes and/or gigabytes per second", - "type": "object", - "properties": { - "blockConfigured": { - "type": "number" - }, - "blockIops": { - "type": "number" - }, - "blockUsed": { - "type": "number" - }, - "ephemeralConfigured": { - "type": "number" - }, - "ephemeralIops": { - "type": "number" - }, - "ephemeralUsed": { - "type": "number" - }, - "filesystemName": { - "type": "string" - } - }, - "required": [ - "blockConfigured", - "blockIops", - "blockUsed", - "ephemeralConfigured", - "ephemeralIops", - "ephemeralUsed", - "filesystemName" - ] - }, - "gtpPerFlowMetrics": { - "description": "Mobility GTP Protocol per flow metrics", - "type": "object", - "properties": { - "avgBitErrorRate": { - "description": "average bit error rate", - "type": "number" - }, - "avgPacketDelayVariation": { - "description": "Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets", - "type": "number" - }, - "avgPacketLatency": { - "description": "average delivery latency", - "type": "number" - }, - "avgReceiveThroughput": { - "description": "average receive throughput", - "type": "number" - }, - "avgTransmitThroughput": { - "description": "average transmit throughput", - "type": "number" - }, - "durConnectionFailedStatus": { - "description": "duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval", - "type": "number" - }, - "durTunnelFailedStatus": { - "description": "Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval", - "type": "number" - }, - "flowActivatedBy": { - "description": "Endpoint activating the flow", - "type": "string" - }, - "flowActivationEpoch": { - "description": "Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available", - "type": "number" - }, - "flowActivationMicrosec": { - "description": "Integer microseconds for the start of the flow connection", - "type": "number" - }, - "flowActivationTime": { - "description": "time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800", - "type": "string" - }, - "flowDeactivatedBy": { - "description": "Endpoint deactivating the flow", - "type": "string" - }, - "flowDeactivationEpoch": { - "description": "Time for the start of the flow connection, in integer UTC epoch time aka UNIX time", - "type": "number" - }, - "flowDeactivationMicrosec": { - "description": "Integer microseconds for the start of the flow connection", - "type": "number" - }, - "flowDeactivationTime": { - "description": "Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800", - "type": "string" - }, - "flowStatus": { - "description": "connection status at reporting time as a working / inactive / failed indicator value", - "type": "string" - }, - "gtpConnectionStatus": { - "description": "Current connection state at reporting time", - "type": "string" - }, - "gtpTunnelStatus": { - "description": "Current tunnel state at reporting time", - "type": "string" - }, - "ipTosCountList": { - "description": "array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow", - "type": "array", - "items": { - "type": "array", - "items": [ - { - "type": "string" - }, - { - "type": "number" - } - ] - } - }, - "ipTosList": { - "description": "Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255'", - "type": "array", - "items": { - "type": "string" - } - }, - "largePacketRtt": { - "description": "large packet round trip time", - "type": "number" - }, - "largePacketThreshold": { - "description": "large packet threshold being applied", - "type": "number" - }, - "maxPacketDelayVariation": { - "description": "Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets", - "type": "number" - }, - "maxReceiveBitRate": { - "description": "maximum receive bit rate", - "type": "number" - }, - "maxTransmitBitRate": { - "description": "maximum transmit bit rate", - "type": "number" - }, - "mobileQciCosCountList": { - "description": "array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow", - "type": "array", - "items": { - "type": "array", - "items": [ - { - "type": "string" - }, - { - "type": "number" - } - ] - } - }, - "mobileQciCosList": { - "description": "Array of unique LTE QCI or UMTS class-of-service values observed in the flow", - "type": "array", - "items": { - "type": "string" - } - }, - "numActivationFailures": { - "description": "Number of failed activation requests, as observed by the reporting node", - "type": "number" - }, - "numBitErrors": { - "description": "number of errored bits", - "type": "number" - }, - "numBytesReceived": { - "description": "number of bytes received, including retransmissions", - "type": "number" - }, - "numBytesTransmitted": { - "description": "number of bytes transmitted, including retransmissions", - "type": "number" - }, - "numDroppedPackets": { - "description": "number of received packets dropped due to errors per virtual interface", - "type": "number" - }, - "numGtpEchoFailures": { - "description": "Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2", - "type": "number" - }, - "numGtpTunnelErrors": { - "description": "Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1", - "type": "number" - }, - "numHttpErrors": { - "description": "Http error count", - "type": "number" - }, - "numL7BytesReceived": { - "description": "number of tunneled layer 7 bytes received, including retransmissions", - "type": "number" - }, - "numL7BytesTransmitted": { - "description": "number of tunneled layer 7 bytes transmitted, excluding retransmissions", - "type": "number" - }, - "numLostPackets": { - "description": "number of lost packets", - "type": "number" - }, - "numOutOfOrderPackets": { - "description": "number of out-of-order packets", - "type": "number" - }, - "numPacketErrors": { - "description": "number of errored packets", - "type": "number" - }, - "numPacketsReceivedExclRetrans": { - "description": "number of packets received, excluding retransmission", - "type": "number" - }, - "numPacketsReceivedInclRetrans": { - "description": "number of packets received, including retransmission", - "type": "number" - }, - "numPacketsTransmittedInclRetrans": { - "description": "number of packets transmitted, including retransmissions", - "type": "number" - }, - "numRetries": { - "description": "number of packet retries", - "type": "number" - }, - "numTimeouts": { - "description": "number of packet timeouts", - "type": "number" - }, - "numTunneledL7BytesReceived": { - "description": "number of tunneled layer 7 bytes received, excluding retransmissions", - "type": "number" - }, - "roundTripTime": { - "description": "round trip time", - "type": "number" - }, - "tcpFlagCountList": { - "description": "array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow", - "type": "array", - "items": { - "type": "array", - "items": [ - { - "type": "string" - }, - { - "type": "number" - } - ] - } - }, - "tcpFlagList": { - "description": "Array of unique TCP Flags observed in the flow", - "type": "array", - "items": { - "type": "string" - } - }, - "timeToFirstByte": { - "description": "Time in milliseconds between the connection activation and first byte received", - "type": "number" - } - }, - "required": [ - "avgBitErrorRate", - "avgPacketDelayVariation", - "avgPacketLatency", - "avgReceiveThroughput", - "avgTransmitThroughput", - "flowActivationEpoch", - "flowActivationMicrosec", - "flowDeactivationEpoch", - "flowDeactivationMicrosec", - "flowDeactivationTime", - "flowStatus", - "maxPacketDelayVariation", - "numActivationFailures", - "numBitErrors", - "numBytesReceived", - "numBytesTransmitted", - "numDroppedPackets", - "numL7BytesReceived", - "numL7BytesTransmitted", - "numLostPackets", - "numOutOfOrderPackets", - "numPacketErrors", - "numPacketsReceivedExclRetrans", - "numPacketsReceivedInclRetrans", - "numPacketsTransmittedInclRetrans", - "numRetries", - "numTimeouts", - "numTunneledL7BytesReceived", - "roundTripTime", - "timeToFirstByte" - ] - }, - "heartbeatFields": { - "description": "optional field block for fields specific to heartbeat events", - "type": "object", - "properties": { - "additionalFields": { - "description": "additional heartbeat fields if needed", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "heartbeatFieldsVersion": { - "description": "version of the heartbeatFields block", - "type": "number" - }, - "heartbeatInterval": { - "description": "current heartbeat interval in seconds", - "type": "integer" - } - }, - "required": [ - "heartbeatFieldsVersion", - "heartbeatInterval" - ] - }, - "internalHeaderFields": { - "description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources", - "type": "object" - }, - "jsonObject": { - "description": "json object schema, name and other meta-information along with one or more object instances", - "type": "object", - "properties": { - "objectInstances": { - "description": "one or more instances of the jsonObject", - "type": "array", - "items": { - "$ref": "#/definitions/jsonObjectInstance" - } - }, - "objectName": { - "description": "name of the JSON Object", - "type": "string" - }, - "objectSchema": { - "description": "json schema for the object", - "type": "string" - }, - "objectSchemaUrl": { - "description": "Url to the json schema for the object", - "type": "string" - }, - "nfSubscribedObjectName": { - "description": "name of the object associated with the nfSubscriptonId", - "type": "string" - }, - "nfSubscriptionId": { - "description": "identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject", - "type": "string" - } - }, - "required": [ - "objectInstances", - "objectName" - ] - }, - "jsonObjectInstance": { - "description": "meta-information about an instance of a jsonObject along with the actual object instance", - "type": "object", - "properties": { - "objectInstance": { - "description": "an instance conforming to the jsonObject schema", - "type": "object" - }, - "objectInstanceEpochMicrosec": { - "description": "the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds", - "type": "number" - }, - "objectKeys": { - "description": "an ordered set of keys that identifies this particular instance of jsonObject", - "type": "array", - "items": { - "$ref": "#/definitions/key" - } - } - }, - "required": [ - "objectInstance" - ] - }, - "key": { - "description": "tuple which provides the name of a key along with its value and relative order", - "type": "object", - "properties": { - "keyName": { - "description": "name of the key", - "type": "string" - }, - "keyOrder": { - "description": "relative sequence or order of the key with respect to other keys", - "type": "integer" - }, - "keyValue": { - "description": "value of the key", - "type": "string" - } - }, - "required": [ - "keyName" - ] - }, - "latencyBucketMeasure": { - "description": "number of counts falling within a defined latency bucket", - "type": "object", - "properties": { - "countsInTheBucket": { - "type": "number" - }, - "highEndOfLatencyBucket": { - "type": "number" - }, - "lowEndOfLatencyBucket": { - "type": "number" - } - }, - "required": [ - "countsInTheBucket" - ] - }, - "measurementsForVfScalingFields": { - "description": "measurementsForVfScaling fields", - "type": "object", - "properties": { - "additionalFields": { - "description": "additional name-value-pair fields", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "additionalMeasurements": { - "description": "array of named name-value-pair arrays", - "type": "array", - "items": { - "$ref": "#/definitions/namedArrayOfFields" - } - }, - "additionalObjects": { - "description": "array of JSON objects described by name, schema and other meta-information", - "type": "array", - "items": { - "$ref": "#/definitions/jsonObject" - } - }, - "codecUsageArray": { - "description": "array of codecs in use", - "type": "array", - "items": { - "$ref": "#/definitions/codecsInUse" - } - }, - "concurrentSessions": { - "description": "peak concurrent sessions for the VM or VNF over the measurementInterval", - "type": "integer" - }, - "configuredEntities": { - "description": "over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the VNF", - "type": "integer" - }, - "cpuUsageArray": { - "description": "usage of an array of CPUs", - "type": "array", - "items": { - "$ref": "#/definitions/cpuUsage" - } - }, - "diskUsageArray": { - "description": "usage of an array of disks", - "type": "array", - "items": { - "$ref": "#/definitions/diskUsage" - } - }, - "featureUsageArray": { - "description": "array of features in use", - "type": "array", - "items": { - "$ref": "#/definitions/featuresInUse" - } - }, - "filesystemUsageArray": { - "description": "filesystem usage of the VM on which the VNFC reporting the event is running", - "type": "array", - "items": { - "$ref": "#/definitions/filesystemUsage" - } - }, - "latencyDistribution": { - "description": "array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges", - "type": "array", - "items": { - "$ref": "#/definitions/latencyBucketMeasure" - } - }, - "meanRequestLatency": { - "description": "mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running", - "type": "number" - }, - "measurementInterval": { - "description": "interval over which measurements are being reported in seconds", - "type": "number" - }, - "measurementsForVfScalingVersion": { - "description": "version of the measurementsForVfScaling block", - "type": "number" - }, - "memoryUsageArray": { - "description": "memory usage of an array of VMs", - "type": "array", - "items": { - "$ref": "#/definitions/memoryUsage" - } - }, - "numberOfMediaPortsInUse": { - "description": "number of media ports in use", - "type": "integer" - }, - "requestRate": { - "description": "peak rate of service requests per second to the VNF over the measurementInterval", - "type": "number" - }, - "vnfcScalingMetric": { - "description": "represents busy-ness of the VNF from 0 to 100 as reported by the VNFC", - "type": "integer" - }, - "vNicPerformanceArray": { - "description": "usage of an array of virtual network interface cards", - "type": "array", - "items": { - "$ref": "#/definitions/vNicPerformance" - } - } - }, - "required": [ - "measurementInterval", - "measurementsForVfScalingVersion" - ] - }, - "memoryUsage": { - "description": "memory usage of an identified virtual machine", - "type": "object", - "properties": { - "memoryBuffered": { - "description": "kibibytes of temporary storage for raw disk blocks", - "type": "number" - }, - "memoryCached": { - "description": "kibibytes of memory used for cache", - "type": "number" - }, - "memoryConfigured": { - "description": "kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running", - "type": "number" - }, - "memoryFree": { - "description": "kibibytes of physical RAM left unused by the system", - "type": "number" - }, - "memorySlabRecl": { - "description": "the part of the slab that can be reclaimed such as caches measured in kibibytes", - "type": "number" - }, - "memorySlabUnrecl": { - "description": "the part of the slab that cannot be reclaimed even when lacking memory measured in kibibytes", - "type": "number" - }, - "memoryUsed": { - "description": "total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes", - "type": "number" - }, - "vmIdentifier": { - "description": "virtual machine identifier associated with the memory metrics", - "type": "string" - } - }, - "required": [ - "memoryFree", - "memoryUsed", - "vmIdentifier" - ] - }, - "mobileFlowFields": { - "description": "mobileFlow fields", - "type": "object", - "properties": { - "additionalFields": { - "description": "additional mobileFlow fields if needed", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "applicationType": { - "description": "Application type inferred", - "type": "string" - }, - "appProtocolType": { - "description": "application protocol", - "type": "string" - }, - "appProtocolVersion": { - "description": "application protocol version", - "type": "string" - }, - "cid": { - "description": "cell id", - "type": "string" - }, - "connectionType": { - "description": "Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc", - "type": "string" - }, - "ecgi": { - "description": "Evolved Cell Global Id", - "type": "string" - }, - "flowDirection": { - "description": "Flow direction, indicating if the reporting node is the source of the flow or destination for the flow", - "type": "string" - }, - "gtpPerFlowMetrics": { - "$ref": "#/definitions/gtpPerFlowMetrics" - }, - "gtpProtocolType": { - "description": "GTP protocol", - "type": "string" - }, - "gtpVersion": { - "description": "GTP protocol version", - "type": "string" - }, - "httpHeader": { - "description": "HTTP request header, if the flow connects to a node referenced by HTTP", - "type": "string" - }, - "imei": { - "description": "IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device", - "type": "string" - }, - "imsi": { - "description": "IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device", - "type": "string" - }, - "ipProtocolType": { - "description": "IP protocol type e.g., TCP, UDP, RTP...", - "type": "string" - }, - "ipVersion": { - "description": "IP protocol version e.g., IPv4, IPv6", - "type": "string" - }, - "lac": { - "description": "location area code", - "type": "string" - }, - "mcc": { - "description": "mobile country code", - "type": "string" - }, - "mnc": { - "description": "mobile network code", - "type": "string" - }, - "mobileFlowFieldsVersion": { - "description": "version of the mobileFlowFields block", - "type": "number" - }, - "msisdn": { - "description": "MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device", - "type": "string" - }, - "otherEndpointIpAddress": { - "description": "IP address for the other endpoint, as used for the flow being reported on", - "type": "string" - }, - "otherEndpointPort": { - "description": "IP Port for the reporting entity, as used for the flow being reported on", - "type": "integer" - }, - "otherFunctionalRole": { - "description": "Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...", - "type": "string" - }, - "rac": { - "description": "routing area code", - "type": "string" - }, - "radioAccessTechnology": { - "description": "Radio Access Technology e.g., 2G, 3G, LTE", - "type": "string" - }, - "reportingEndpointIpAddr": { - "description": "IP address for the reporting entity, as used for the flow being reported on", - "type": "string" - }, - "reportingEndpointPort": { - "description": "IP port for the reporting entity, as used for the flow being reported on", - "type": "integer" - }, - "sac": { - "description": "service area code", - "type": "string" - }, - "samplingAlgorithm": { - "description": "Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied", - "type": "integer" - }, - "tac": { - "description": "transport area code", - "type": "string" - }, - "tunnelId": { - "description": "tunnel identifier", - "type": "string" - }, - "vlanId": { - "description": "VLAN identifier used by this flow", - "type": "string" - } - }, - "required": [ - "flowDirection", - "gtpPerFlowMetrics", - "ipProtocolType", - "ipVersion", - "mobileFlowFieldsVersion", - "otherEndpointIpAddress", - "otherEndpointPort", - "reportingEndpointIpAddr", - "reportingEndpointPort" - ] - }, - "namedArrayOfFields": { - "description": "an array of name value pairs along with a name for the array", - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "arrayOfFields": { - "description": "array of name value pairs", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - } - }, - "required": [ - "name", - "arrayOfFields" - ] - }, - "otherFields": { - "description": "fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration", - "type": "object", - "properties": { - "hashOfNameValuePairArrays": { - "description": "array of named name-value-pair arrays", - "type": "array", - "items": { - "$ref": "#/definitions/namedArrayOfFields" - } - }, - "jsonObjects": { - "description": "array of JSON objects described by name, schema and other meta-information", - "type": "array", - "items": { - "$ref": "#/definitions/jsonObject" - } - }, - "nameValuePairs": { - "description": "array of name-value pairs", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "otherFieldsVersion": { - "description": "version of the otherFields block", - "type": "number" - } - }, - "required": [ - "otherFieldsVersion" - ] - }, - "requestError": { - "description": "standard request error data structure", - "type": "object", - "properties": { - "messageId": { - "description": "Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception", - "type": "string" - }, - "text": { - "description": "Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1", - "type": "string" - }, - "url": { - "description": "Hyperlink to a detailed error resource e.g., an HTML page for browser user agents", - "type": "string" - }, - "variables": { - "description": "List of zero or more strings that represent the contents of the variables used by the message text", - "type": "string" - } - }, - "required": [ - "messageId", - "text" - ] - }, - "sipSignalingFields": { - "description": "sip signaling fields", - "type": "object", - "properties": { - "additionalInformation": { - "description": "additional sip signaling fields if needed", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "compressedSip": { - "description": "the full SIP request/response including headers and bodies", - "type": "string" - }, - "correlator": { - "description": "this is the same for all events on this call", - "type": "string" - }, - "localIpAddress": { - "description": "IP address on VNF", - "type": "string" - }, - "localPort": { - "description": "port on VNF", - "type": "string" - }, - "remoteIpAddress": { - "description": "IP address of peer endpoint", - "type": "string" - }, - "remotePort": { - "description": "port of peer endpoint", - "type": "string" - }, - "sipSignalingFieldsVersion": { - "description": "version of the sipSignalingFields block", - "type": "number" - }, - "summarySip": { - "description": "the SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc)", - "type": "string" - }, - "vendorVnfNameFields": { - "$ref": "#/definitions/vendorVnfNameFields" - } - }, - "required": [ - "correlator", - "localIpAddress", - "localPort", - "remoteIpAddress", - "remotePort", - "sipSignalingFieldsVersion", - "vendorVnfNameFields" - ] - }, - "stateChangeFields": { - "description": "stateChange fields", - "type": "object", - "properties": { - "additionalFields": { - "description": "additional stateChange fields if needed", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "newState": { - "description": "new state of the entity", - "type": "string", - "enum": [ - "inService", - "maintenance", - "outOfService" - ] - }, - "oldState": { - "description": "previous state of the entity", - "type": "string", - "enum": [ - "inService", - "maintenance", - "outOfService" - ] - }, - "stateChangeFieldsVersion": { - "description": "version of the stateChangeFields block", - "type": "number" - }, - "stateInterface": { - "description": "card or port name of the entity that changed state", - "type": "string" - } - }, - "required": [ - "newState", - "oldState", - "stateChangeFieldsVersion", - "stateInterface" - ] - }, - "suppressedNvPairs": { - "description": "List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling", - "type": "object", - "properties": { - "nvPairFieldName": { - "description": "Name of the field within which are the nvpair names to suppress", - "type": "string" - }, - "suppressedNvPairNames": { - "description": "Array of nvpair names to suppress within the nvpairFieldName", - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "nvPairFieldName", - "suppressedNvPairNames" - ] - }, - "syslogFields": { - "description": "sysLog fields", - "type": "object", - "properties": { - "additionalFields": { - "description": "additional syslog fields if needed provided as name=value delimited by a pipe ‘|’ symbol, for example: 'name1=value1|name2=value2|…'", - "type": "string" - }, - "eventSourceHost": { - "description": "hostname of the device", - "type": "string" - }, - "eventSourceType": { - "description": "type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction", - "type": "string" - }, - "syslogFacility": { - "description": "numeric code from 0 to 23 for facility--see table in documentation", - "type": "integer" - }, - "syslogFieldsVersion": { - "description": "version of the syslogFields block", - "type": "number" - }, - "syslogMsg": { - "description": "syslog message", - "type": "string" - }, - "syslogPri": { - "description": "0-192 combined severity and facility", - "type": "integer" - }, - "syslogProc": { - "description": "identifies the application that originated the message", - "type": "string" - }, - "syslogProcId": { - "description": "a change in the value of this field indicates a discontinuity in syslog reporting", - "type": "number" - }, - "syslogSData": { - "description": "syslog structured data consisting of a structured data Id followed by a set of key value pairs", - "type": "string" - }, - "syslogSdId": { - "description": "0-32 char in format name@number for example ourSDID@32473", - "type": "string" - }, - "syslogSev": { - "description": "numerical Code for severity derived from syslogPri as remaider of syslogPri / 8", - "type": "string", - "enum": [ - "Alert", - "Critical", - "Debug", - "Emergency", - "Error", - "Info", - "Notice", - "Warning" - ] - }, - "syslogTag": { - "description": "msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided", - "type": "string" - }, - "syslogVer": { - "description": "IANA assigned version of the syslog protocol specification - typically 1", - "type": "number" - } - }, - "required": [ - "eventSourceType", - "syslogFieldsVersion", - "syslogMsg", - "syslogTag" - ] - }, - "thresholdCrossingAlertFields": { - "description": "fields specific to threshold crossing alert events", - "type": "object", - "properties": { - "additionalFields": { - "description": "additional threshold crossing alert fields if needed", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "additionalParameters": { - "description": "performance counters", - "type": "array", - "items": { - "$ref": "#/definitions/counter" - } - }, - "alertAction": { - "description": "Event action", - "type": "string", - "enum": [ - "CLEAR", - "CONT", - "SET" - ] - }, - "alertDescription": { - "description": "Unique short alert description such as IF-SHUB-ERRDROP", - "type": "string" - }, - "alertType": { - "description": "Event type", - "type": "string", - "enum": [ - "CARD-ANOMALY", - "ELEMENT-ANOMALY", - "INTERFACE-ANOMALY", - "SERVICE-ANOMALY" - ] - }, - "alertValue": { - "description": "Calculated API value (if applicable)", - "type": "string" - }, - "associatedAlertIdList": { - "description": "List of eventIds associated with the event being reported", - "type": "array", - "items": { - "type": "string" - } - }, - "collectionTimestamp": { - "description": "Time when the performance collector picked up the data; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800", - "type": "string" - }, - "dataCollector": { - "description": "Specific performance collector instance used", - "type": "string" - }, - "elementType": { - "description": "type of network element - internal ATT field", - "type": "string" - }, - "eventSeverity": { - "description": "event severity or priority", - "type": "string", - "enum": [ - "CRITICAL", - "MAJOR", - "MINOR", - "WARNING", - "NORMAL" - ] - }, - "eventStartTimestamp": { - "description": "Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800", - "type": "string" - }, - "interfaceName": { - "description": "Physical or logical port or card (if applicable)", - "type": "string" - }, - "networkService": { - "description": "network name - internal ATT field", - "type": "string" - }, - "possibleRootCause": { - "description": "Reserved for future use", - "type": "string" - }, - "thresholdCrossingFieldsVersion": { - "description": "version of the thresholdCrossingAlertFields block", - "type": "number" - } - }, - "required": [ - "additionalParameters", - "alertAction", - "alertDescription", - "alertType", - "collectionTimestamp", - "eventSeverity", - "eventStartTimestamp", - "thresholdCrossingFieldsVersion" - ] - }, - "vendorVnfNameFields": { - "description": "provides vendor, vnf and vfModule identifying information", - "type": "object", - "properties": { - "vendorName": { - "description": "VNF vendor name", - "type": "string" - }, - "vfModuleName": { - "description": "ASDC vfModuleName for the vfModule generating the event", - "type": "string" - }, - "vnfName": { - "description": "ASDC modelName for the VNF generating the event", - "type": "string" - } - }, - "required": [ - "vendorName" - ] - }, - "vNicPerformance": { - "description": "describes the performance and errors of an identified virtual network interface card", - "type": "object", - "properties": { - "receivedBroadcastPacketsAccumulated": { - "description": "Cumulative count of broadcast packets received as read at the end of the measurement interval", - "type": "number" - }, - "receivedBroadcastPacketsDelta": { - "description": "Count of broadcast packets received within the measurement interval", - "type": "number" - }, - "receivedDiscardedPacketsAccumulated": { - "description": "Cumulative count of discarded packets received as read at the end of the measurement interval", - "type": "number" - }, - "receivedDiscardedPacketsDelta": { - "description": "Count of discarded packets received within the measurement interval", - "type": "number" - }, - "receivedErrorPacketsAccumulated": { - "description": "Cumulative count of error packets received as read at the end of the measurement interval", - "type": "number" - }, - "receivedErrorPacketsDelta": { - "description": "Count of error packets received within the measurement interval", - "type": "number" - }, - "receivedMulticastPacketsAccumulated": { - "description": "Cumulative count of multicast packets received as read at the end of the measurement interval", - "type": "number" - }, - "receivedMulticastPacketsDelta": { - "description": "Count of multicast packets received within the measurement interval", - "type": "number" - }, - "receivedOctetsAccumulated": { - "description": "Cumulative count of octets received as read at the end of the measurement interval", - "type": "number" - }, - "receivedOctetsDelta": { - "description": "Count of octets received within the measurement interval", - "type": "number" - }, - "receivedTotalPacketsAccumulated": { - "description": "Cumulative count of all packets received as read at the end of the measurement interval", - "type": "number" - }, - "receivedTotalPacketsDelta": { - "description": "Count of all packets received within the measurement interval", - "type": "number" - }, - "receivedUnicastPacketsAccumulated": { - "description": "Cumulative count of unicast packets received as read at the end of the measurement interval", - "type": "number" - }, - "receivedUnicastPacketsDelta": { - "description": "Count of unicast packets received within the measurement interval", - "type": "number" - }, - "transmittedBroadcastPacketsAccumulated": { - "description": "Cumulative count of broadcast packets transmitted as read at the end of the measurement interval", - "type": "number" - }, - "transmittedBroadcastPacketsDelta": { - "description": "Count of broadcast packets transmitted within the measurement interval", - "type": "number" - }, - "transmittedDiscardedPacketsAccumulated": { - "description": "Cumulative count of discarded packets transmitted as read at the end of the measurement interval", - "type": "number" - }, - "transmittedDiscardedPacketsDelta": { - "description": "Count of discarded packets transmitted within the measurement interval", - "type": "number" - }, - "transmittedErrorPacketsAccumulated": { - "description": "Cumulative count of error packets transmitted as read at the end of the measurement interval", - "type": "number" - }, - "transmittedErrorPacketsDelta": { - "description": "Count of error packets transmitted within the measurement interval", - "type": "number" - }, - "transmittedMulticastPacketsAccumulated": { - "description": "Cumulative count of multicast packets transmitted as read at the end of the measurement interval", - "type": "number" - }, - "transmittedMulticastPacketsDelta": { - "description": "Count of multicast packets transmitted within the measurement interval", - "type": "number" - }, - "transmittedOctetsAccumulated": { - "description": "Cumulative count of octets transmitted as read at the end of the measurement interval", - "type": "number" - }, - "transmittedOctetsDelta": { - "description": "Count of octets transmitted within the measurement interval", - "type": "number" - }, - "transmittedTotalPacketsAccumulated": { - "description": "Cumulative count of all packets transmitted as read at the end of the measurement interval", - "type": "number" - }, - "transmittedTotalPacketsDelta": { - "description": "Count of all packets transmitted within the measurement interval", - "type": "number" - }, - "transmittedUnicastPacketsAccumulated": { - "description": "Cumulative count of unicast packets transmitted as read at the end of the measurement interval", - "type": "number" - }, - "transmittedUnicastPacketsDelta": { - "description": "Count of unicast packets transmitted within the measurement interval", - "type": "number" - }, - "valuesAreSuspect": { - "description": "Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions", - "type": "string", - "enum": [ - "true", - "false" - ] - }, - "vNicIdentifier": { - "description": "vNic identification", - "type": "string" - } - }, - "required": [ - "valuesAreSuspect", - "vNicIdentifier" - ] - }, - "voiceQualityFields": { - "description": "provides statistics related to customer facing voice products", - "type": "object", - "properties": { - "additionalInformation": { - "description": "additional voice quality fields if needed", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } - }, - "calleeSideCodec": { - "description": "callee codec for the call", - "type": "string" - }, - "callerSideCodec": { - "description": "caller codec for the call", - "type": "string" - }, - "correlator": { - "description": "this is the same for all events on this call", - "type": "string" - }, - "endOfCallVqmSummaries": { - "$ref": "#/definitions/endOfCallVqmSummaries" - }, - "phoneNumber": { - "description": "phone number associated with the correlator", - "type": "string" - }, - "midCallRtcp": { - "description": "Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers", - "type": "string" - }, - "vendorVnfNameFields": { - "$ref": "#/definitions/vendorVnfNameFields" - }, - "voiceQualityFieldsVersion": { - "description": "version of the voiceQualityFields block", - "type": "number" - } - }, - "required": [ - "calleeSideCodec", - "callerSideCodec", - "correlator", - "midCallRtcp", - "vendorVnfNameFields", - "voiceQualityFieldsVersion" - ] - } - } - } - } -} diff --git a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/tca-deploy.input.json b/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/tca-deploy.input.json deleted file mode 100644 index c3faf800..00000000 --- a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/tca-deploy.input.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "spring.data.mongodb.uri": "mongodb://dcae-mongohost/dcae-tcagen2", - "tca.aai.enable_enrichment": true, - "docker-tcagen2_memory_request": "512Mi", - "replicas": 1, - "docker-tcagen2_cpu_limit": "250m", - "tca.aai.username": "DCAE", - "image": "nexus3.onap.org:10001/onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1", - "service_component_name_override": "dcaegen2-tcagen2", - "use_tls": true, - "always_pull_image": true, - "tca.aai.url": "http://aai.onap.svc.cluster.local", - "location_id": "", - "envs": {}, - "tca_handle_in_subscribe_url": "http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/", - "tca_handle_out_publish_url": "http://message-router:3904/events/unauthenticated.TCAGEN2_OUTPUT/", - "external_port_0": 0, - "docker-tcagen2_memory_limit": "512Mi", - "docker-tcagen2_cpu_request": "250m", - "tca.aai.password": "DCAE" -}
\ No newline at end of file diff --git a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/ves-deploy.input.json b/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/ves-deploy.input.json deleted file mode 100644 index d86ff0bc..00000000 --- a/docs/sections/design-components/DCAE-MOD/Sample-Input-Files/ves-deploy.input.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "always_pull_image": true, - "collector.dmaap.streamid": "fault=ves-fault|syslog=ves-syslog|heartbeat=ves-heartbeat|measurementsForVfScaling=ves-measurement|measurement=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|perf3gpp=ves-perf3gpp", - "dcae-ves-collector_cpu_limit": "250m", - "dcae-ves-collector_cpu_request": "250m", - "dcae-ves-collector_memory_limit": "512Mi", - "dcae-ves-collector_memory_request": "512Mi", - "envs": {}, - "external_port_0": 30235, - "external_port_1": 0, - "header.authlist": "sample1,$2a$10$pgjaxDzSuc6XVFEeqvxQ5u90DKJnM/u7TJTcinAlFJVaavXMWf/Zi|userid1,$2a$10$61gNubgJJl9lh3nvQvY9X.x4e5ETWJJ7ao7ZhJEvmfJigov26Z6uq|userid2,$2a$10$G52y/3uhuhWAMy.bx9Se8uzWinmbJa.dlm1LW6bYPdPkkywLDPLiy", - "image": "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4", - "location_id": "", - "replicas": 1, - "service_component_name_override": "dcae-ves-collector-http", - "use_tls": true, - "ves_fault_publish_url": "http://message-router:3904/events/unauthenticated.SEC_FAULT_OUTPUT/", - "ves_heartbeat_publish_url": "http://message-router:3904/events/unauthenticated.SEC_HEARTBEAT_OUTPUT/", - "ves_measurement_publish_url": "http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/", - "ves_mobileflow_publish_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/", - "ves_notification_publish_url": "http://message-router:3904/events/unauthenticated.VES_NOTIFICATION_OUTPUT/", - "ves_other_publish_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/", - "ves_perf3gpp_publish_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/", - "ves_pnfRegistration_publish_url": "http://message-router:3904/events/unauthenticated.VES_PNFREG_OUTPUT/", - "ves_sipsignaling_publish_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/", - "ves_statechange_publish_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/", - "ves_syslog_publish_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/", - "ves_thresholdCrossingAlert_publish_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/", - "ves_voicequality_publish_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/" -}
\ No newline at end of file diff --git a/docs/sections/design-components/blueprint_generator.rst b/docs/sections/design-components/blueprint_generator.rst deleted file mode 100644 index d9f7790f..00000000 --- a/docs/sections/design-components/blueprint_generator.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. _blueprintgenerator: - - -Blueprint Generator -=================== - -What is Blueprint Generator? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The blueprint generator is java-based tool to take a component spec -for a given micro-service and translate that component spec into a -cloudify blueprint yaml file that can be used during deployment in DCAE -Runtime plaform. - -Service components to be deployed as stand-alone -(i.e not part of DCAE service composition flow) can use the blueprint-generator -utility to create deployment yaml. The generated blueprint can be uploaded -to inventory and deployed from Dashboard directly. - - -Steps to run the blueprint generator -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Download the `blueprint generator jar <https://nexus.onap.org/service/local/repositories/releases/content/org/onap/dcaegen2/platform/mod/blueprint-generator-onap-executable/1.7.3/blueprint-generator-onap-executable-1.7.3.jar>`__ file from Nexus - -2. To execute the application, run the following command - - ``java -jar blueprint-generator-onap-executable-1.7.3.jar app ONAP`` - -3. This execution will provide the help, as you have not provided the required flags. - -4. When ready you can run the program again except with the required flags. - -5. OPTIONS - - - -i OR --component-spec: The path of the ONAP Blueprint INPUT JSON SPEC FILE (Required) - - -p OR --blueprint-path: The path of the ONAP Blueprint OUTPUT where it will be saved (Required) - - -n OR --blueprint-name: The NAME of the ONAP Blueprint OUTPUT that will be created (Optional) - - -t OR --imports: The path of the ONAP Blueprint IMPORT FILE (Optional) - - -o OR --service-name-override: The Value used to OVERRIDE the SERVICE NAME of the ONAP Blueprint (Optional) - - -d OR --dmaap-plugin: The option to create an ONAP Blueprint with DMAAP Plugin included (Optional) - -6. An example running this program is shown below - - ``java -jar blueprint-generator-onap-executable-1.7.3.jar app ONAP -p blueprint_output -i ComponentSpecs/TestComponentSpec.json -n TestAppBlueprint`` - - -Extra information ------------------ - -1. The component spec must be compliant with `Component Spec json schema <https://git.onap.org/dcaegen2/platform/plain/mod/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json>`__ - -2. If the flag is marked required then the corresponding values must be provided for blueprint-generator execution - -3. If the flag is identified as optional then it is not mandatory for blueprint-generator execution - -4. If you do not add a -n flag the blueprint name will default to what it is in the component spec - -5. If the directory you specified in the -p flag does not already exist the directory will be created for you - -6. The -t flag will override the default imports set for the blueprints. Below you can see example content of the import file: - -:: - - imports: - - https://www.getcloudify.org/spec/cloudify/4.5.5/types.yaml - - plugin:k8splugin?version=3.6.0 - - plugin:dcaepolicyplugin?version=2.4.0 - - -How to create policy models: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Policy model creation can be done with the same jar as downloaded for the blueprint generation. - -2. Run the same command as the blueprint generator except add a flag ``-type policycreate`` - -3. Options - - - -i: The path to the JSON spec file (required) - - -p: The Output path for all of the models (required) - -4. Example command - - ``java -jar blueprint-generator-onap-executable-1.7.3.jar app ONAP -type policycreate -i componentspec -p OutputPolicyPath`` - - -Extra information ------------------ - -1. Not all component specs will be able to create policy models - -2. Multiple policy model files may be created from a single component spec - - -How to use Blueprint Generator as a Spring library -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To use BlueprintGenerator you need to import the following artifact to your project: - -:: - - <dependency> - <groupId>org.onap.dcaegen2.platform.mod</groupId> - <artifactId>blueprint-generator-onap</artifactId> - <version>1.7.3</version> - </dependency> - -In order to see how to use the library in detail please familiarize yourself with real application: `Blueprint Generator Executable main class <https://git.onap.org/dcaegen2/platform/plain/mod/bpgenerator/onap-executable/src/main/java/org/onap/blueprintgenerator/BlueprintGeneratorMainApplication.java>`__ diff --git a/docs/sections/design-components/component-specification/component-json-schema.rst b/docs/sections/design-components/component-specification/component-json-schema.rst deleted file mode 100644 index a6afcd41..00000000 --- a/docs/sections/design-components/component-specification/component-json-schema.rst +++ /dev/null @@ -1,1176 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. _dcae-component-schema: - -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-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" - }, - "description": { - "type": "string" - }, - "component_type": { - "type": "string", - "enum": [ - "docker", - "cdap" - ] - }, - "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" - } - ] - } - }, - "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" - ] - }, - "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": { - "type": "object", - "properties": { - "node_label": { - "type": "string" - }, - "policy_id": { - "type": "string" - }, - "policy_model_id": { - "type": "string" - } - }, - "required": [ - "policy_id", - "policy_model_id" - ] - } - } - }, - "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" - }, - "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" - ] - }, - "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" - ] - }, - "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" - ] - }, - "publisher_message_router": { - "$ref": "#/definitions/stream_message_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" - ] - }, - "publisher_kafka": { - "$ref": "#/definitions/stream_kafka" - }, - "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" - ] - }, - "subscriber_message_router": { - "$ref": "#/definitions/stream_message_router" - }, - "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" - ] - }, - "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" - }, - "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" - ] - }, - "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" - ] - }, - "caller": { - "type": "object", - "properties": { - "request": { - "$ref": "#/definitions/formatPair" - }, - "response": { - "$ref": "#/definitions/formatPair" - }, - "config_key": { - "type": "string" - } - }, - "required": [ - "request", - "response", - "config_key" - ] - }, - "formatPair": { - "type": "object", - "properties": { - "format": { - "$ref": "#/definitions/name" - }, - "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" - }, - "program_id": { - "type": "string" - } - }, - "required": [ - "program_type", - "program_id" - ] - }, - "auxilary_docker": { - "title": "Docker component specification schema", - "type": "object", - "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" - ] - }, - "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" - ] - }, - "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" - ] - } - } -} diff --git a/docs/sections/design-components/component-specification/component-type-docker.rst b/docs/sections/design-components/component-specification/component-type-docker.rst deleted file mode 100755 index db338cd1..00000000 --- a/docs/sections/design-components/component-specification/component-type-docker.rst +++ /dev/null @@ -1,1624 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - - -.. _component_specification: - -What is Component Specification? -================================ - -This page will discuss categories defined in :any:`component specification schema <dcae-component-schema>` and their usage. - - -Meta Schema Definition ----------------------- - - -The “Meta Schema” implementation defines how component specification -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 -component entry, component type (either ‘cdap’ or ‘docker’) and a -description under “self” object. The meta schema version must be -specified as the value of the “version” key. Then the input schema -itself is described. - -There are four types of schema descriptions objects - jsonschema for -inline standard JSON Schema definitions of JSON inputs, delimitedschema -for delimited data input using a JSON description defined by AT&T, -unstructured for unstructured text, and reference that allows a pointer -to another artifact for a schema. The reference allows for XML and Protocol Buffer schema, -but can be used as a pointer to JSON, Delimited Format, and Unstructured -schemas as well. - -.. _component_metadata: - -Component Metadata ------------------- - -Metadata refers to the properties found under the ``self`` JSON. This -group of properties is used to uniquely identify this component -specification and identify the component that this specification is used -to capture. - -Example: - -:: - - "self": { - "version": "1.0.0", - "name": "yourapp.component.kpi_anomaly", - "description": "Classifies VNF KPI data as anomalous", - "component_type": "docker" - }, - -``self`` Schema: - -+-------------+--------+----------------+ -| Property | Type | Description | -| Name | | | -+=============+========+================+ -| version | string | *Required*. | -| | | Semantic | -| | | version | -| | | for this | -| | | specification | -+-------------+--------+----------------+ -| name | string | *Required*. | -| | | Full | -| | | name of | -| | | this | -| | | component | -| | | which is | -| | | also | -| | | used as | -| | | this | -| | | component's | -| | | catalog | -| | | id. | -+-------------+--------+----------------+ -| description | string | *Required* | -| | | Human-readable | -| | | text | -| | | describing | -| | | the | -| | | component | -| | | and the | -| | | components | -| | | functional | -| | | purpose. | -+-------------+--------+----------------+ -| component_t\| string | *Required* | -| ype | | Identify | -| | | what | -| | | containe\ | -| | | rization | -| | | technolo\ | -| | | gy | -| | | this | -| | | componen\ | -| | | t | -| | | uses: | -| | | *docker* | -| | | or | -| | | *cdap*. | -| | | | -+-------------+--------+----------------+ - -.. _interfaces: - -Interfaces ----------- - -Interfaces are the JSON objects found under the ``streams`` key and the -``services`` key. These are used to describe the interfaces that the -component uses and the interfaces that the component provides. The -description of each interface includes the associated :any:`data -format <data-formats>`. - -Streams -~~~~~~~ - -- The ``streams`` JSON is for specifying data produced for consumption - by other components, and the streams expected to subscribe to that is - produced by other components. These are “fire and forget” type - interfaces where the publisher of a stream does not expect or parse a - response from the subscriber. -- The term ``stream`` here is abstract and neither refers to “CDAP - streams” or “DMaaP feeds”. While a stream is very likely a DMaaP - feed, it could be a direct stream of data being routed via HTTP too. - It abstractly refers to a sequence of data leaving a publisher. -- Streams have anonymous publish/subscribe semantics, which decouples - the production of information from its consumption. Like the component - specification, the data format specification is represented/validated against this - `Data Format json schema <https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/cli.git;a=blob;f=component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json;h=be1568291300305c7adb9a8d244d39f9e6ddadbd;hb=HEAD>`__ -- In general, components are not aware of who they are communicating - with. -- Instead, components that are interested in data, subscribe to the - relevant stream; components that generate data publish to the - relevant stream. -- There can be multiple publishers and subscribers to a stream. Streams - are intended for unidirectional, streaming communication. - -Streams interfaces that implement an HTTP endpoint must support POST. - -Streams are split into: - -+-------------+----+----------+ -| Property | Ty\| Descript\| -| Name | pe | ion | -+=============+====+==========+ -| subscribes | JS\| *Require\| -| | ON | d*. | -| | li\| List of | -| | st | all | -| | | availabl\| -| | | e | -| | | stream | -| | | interfac\| -| | | es | -| | | that | -| | | this | -| | | componen\| -| | | t | -| | | has that | -| | | can be | -| | | used for | -| | | subscrib\| -| | | ing | -+-------------+----+----------+ -| publishes | JS\| *Require\| -| | ON | d*. | -| | li\| List of | -| | st | all | -| | | stream | -| | | interfac\| -| | | es | -| | | that | -| | | this | -| | | componen\| -| | | t | -| | | will | -| | | publish | -| | | onto | -+-------------+----+----------+ - -Subscribes -^^^^^^^^^^ - -Example: - -.. code:: json - - "streams": { - "subscribes": [{ - "format": "dcae.vnf.kpi", - "version": "1.0.0", - "route": "/data", // for CDAP this value is not used - "type": "http" - }], - ... - } - -This describes that ``yourapp.component.kpi_anomaly`` exposes an HTTP -endpoint called ``/data`` which accepts requests that have the data -format of ``dcae.vnf.kpi`` version ``1.0.0``. - -``subscribes`` Schema: - -+-------------+----+--------------------+ -| Property | Ty\| Descript\ | -| Name | pe | ion | -+=============+====+====================+ -| format | st\| *Require\ | -| | ri\| d*. | -| | ng | Data | -| | | format | -| | | id of | -| | | the data | -| | | format | -| | | that is | -| | | used by | -| | | this | -| | | interfac\ | -| | | e | -+-------------+----+--------------------+ -| version | st\| *Require\ | -| | ri\| d*. | -| | ng | Data | -| | | format | -| | | version | -| | | of the | -| | | data | -| | | format | -| | | that is | -| | | used by | -| | | this | -| | | interfac\ | -| | | e | -+-------------+----+--------------------+ -| route | st\| *Require\ | -| | ri\| d | -| | ng | for HTTP | -| | | and data | -| | | router*. | -| | | The HTTP | -| | | route | -| | | that | -| | | this | -| | | interfac\ | -| | | e | -| | | listens | -| | | on | -+-------------+----+--------------------+ -| config_key | st\| *Require\ | -| | ri\| d \ | -| | ng | for \ | -| | | message_router\ | -| | | and data \ | -| | | router*. | -| | | The HTTP | -| | | route | -| | | that | -| | | this | -| | | interfac\ | -| | | e | -| | | listens | -| | | on | -+-------------+----+--------------------+ -| type | st\| *Require\ | -| | ri\| d*. | -| | ng | Type of | -| | | stream: | -| | | ``http`` | -| | | , | -| | | ``message_router`` | -| | | , | -| | | ``data_router`` | -| | | , | -| | | ``kafka`` | -+-------------+----+--------------------+ - -.. _message-router: - -Message router -'''''''''''''' - -Message router subscribers are http clients rather than http services -and performs a http a ``GET`` call. Thus, message router subscribers -description is structured like message router publishers and requires -``config_key``: - -.. code:: json - - "streams": { - "subscribes": [{ - "format": "dcae.some-format", - "version": "1.0.0", - "config_key": "some_format_handle", - "type": "message router" - }], - ... - } - - -.. _data-router: - -Data router -''''''''''' - -Data router subscribers are http or https services that handle ``PUT`` -requests from data router. Developers must provide the ``route`` or url -path/endpoint that is expected to handle data router requests. This will -be used to construct the delivery url needed to register the subscriber -to the provisioned feed. Developers must also provide a ``config_key`` -because there is dynamic configuration information associated with the -feed that the application will need e.g. username and password. See the -page on :any:`DMaaP connection objects <dmaap-data-router>` for more details on -the configuration information. - -Example (not tied to the larger example): - -.. code:: json - - "streams": { - "subscribes": [{ - "config_key": "some-sub-dr", - "format": "sandbox.platform.any", - "route": "/identity", - "type": "data_router", - "version": "0.1.0" - }], - ... - } - -.. _kafka: - -Kafka -'''''''''''''' - -Kafka subscribers are clients fetching data directly from kafka. - -``config_key``: - -.. code:: json - - "streams": { - "subscribes": [{ - "format": "dcae.some-format", - "version": "1.0.0", - "config_key": "some_format_handle", - "type": "kafka" - }], - ... - } - -Publishes -^^^^^^^^^ - -Example: - -.. code:: json - - "streams": { - ... - "publishes": [{ - "format": "yourapp.format.integerClassification", - "version": "1.0.0", - "config_key": "prediction", - "type": "http" - }] - }, - -This describes that ``yourapp.component.kpi_anomaly`` publishes by making -POST requests to streams that support the data format -``yourapp.format.integerClassification`` version ``1.0.0``. - -``publishes`` Schema: - -+-------------+----+--------------------+ -| Property | Ty\| Descript\ | -| Name | pe | ion | -+=============+====+====================+ -| format | st\| *Require\ | -| | ri\| d*. | -| | ng | Data | -| | | format | -| | | id of | -| | | the data | -| | | format | -| | | that is | -| | | used by | -| | | this | -| | | interfac\ | -| | | e | -+-------------+----+--------------------+ -| version | st\| *Require\ | -| | ri\| d*. | -| | ng | Data | -| | | format | -| | | version | -| | | of the | -| | | data | -| | | format | -| | | that is | -| | | used by | -| | | this | -| | | interfac\ | -| | | e | -+-------------+----+--------------------+ -| config_key | st\| *Require\ | -| | ri\| d*. | -| | ng | The JSON | -| | | key in | -| | | the | -| | | generate\ | -| | | d | -| | | applicat | -| | | ion | -| | | configur\ | -| | | ation | -| | | that | -| | | will be | -| | | used to | -| | | pass the | -| | | downstre\ | -| | | am | -| | | componen\ | -| | | t’s | -| | | (the | -| | | subscrib\ | -| | | er’s) | -| | | connecti\ | -| | | on | -| | | informat\ | -| | | ion. | -+-------------+----+--------------------+ -| type | st\| *Require\ | -| | ri\| d*. | -| | ng | Type of | -| | | stream: | -| | | ``http`` | -| | | , | -| | | ``message_router`` | -| | | , | -| | | ``data_router`` | -| | | , | -| | | ``kafka`` | -+-------------+----+--------------------+ - -.. message-router-1: - -Message router -'''''''''''''' - -Message router publishers are http clients of DMaap message_router. -Developers must provide a ``config_key`` because there is dynamic -configuration information associated with the feed that the application -needs to receive e.g. topic url, username, password. See the page on -:any:`DMaaP connection objects <dmaap-message-router>` for more details on -the configuration information. - -Example (not tied to the larger example): - -.. code:: json - - "streams": { - ... - "publishes": [{ - "config_key": "some-pub-mr", - "format": "sandbox.platform.any", - "type": "message_router", - "version": "0.1.0" - }] - } - -.. data-router-1: - -Data router -''''''''''' - -Data router publishers are http clients that make ``PUT`` requests to -data router. Developers must also provide a ``config_key`` because there -is dynamic configuration information associated with the feed that the -application will need to receive e.g. publish url, username, password. -See the page on :any:`DMaaP connection objects <dmaap-data-router>` for more details on -the configuration information. - -Example (not tied to the larger example): - -.. code:: json - - "streams": { - ... - "publishes": [{ - "config_key": "some-pub-dr", - "format": "sandbox.platform.any", - "type": "data_router", - "version": "0.1.0" - }] - } - -.. kafka-1: - -Kafka -'''''''''''''' - -Kafka publishers are clients publishing data directly to kafka. - -``config_key``: - -.. code:: json - - "streams": { - "publishes": [{ - "format": "dcae.some-format", - "version": "1.0.0", - "config_key": "some_format_handle", - "type": "kafka" - }], - ... - } - -Quick Reference -^^^^^^^^^^^^^^^ - -Refer to this :doc:`Quick Reference <streams-grid>` for a -comparison of the Streams ‘Publishes’ and ‘Subscribes’ sections. - -Services -~~~~~~~~ - -- The publish / subscribe model is a very flexible communication - paradigm, but its many-to-many one-way transport is not appropriate - for RPC request / reply interactions, which are often required in a - distributed system. -- Request / reply is done via a Service, which is defined by a pair of - messages: one for the request and one for the reply. - -Services are split into: - -+-------------+----+----------+ -| Property | Ty\| Descript\| -| Name | pe | ion | -+=============+====+==========+ -| calls | JS\| *Require\| -| | ON | d*. | -| | li\| List of | -| | st | all | -| | | service | -| | | interfac\| -| | | es | -| | | that | -| | | this | -| | | componen\| -| | | t | -| | | will | -| | | call | -+-------------+----+----------+ -| provides | JS\| *Require\| -| | ON | d*. | -| | li\| List of | -| | st | all | -| | | service | -| | | interfac\| -| | | es | -| | | that | -| | | this | -| | | componen\| -| | | t | -| | | exposes | -| | | and | -| | | provides | -+-------------+----+----------+ - -Calls -^^^^^ - -The JSON ``services/calls`` is for specifying that the component relies -on an HTTP(S) service—the component sends that service an HTTP request, -and that service responds with an HTTP reply. An example of this is how -string matching (SM) depends on the AAI Broker. SM performs a -synchronous REST call to the AAI broker, providing it the VMNAME of the -VNF, and the AAI Broker responds with additional details about the VNF. -This dependency is expressed via ``services/calls``. In contrast, the -output of string matching (the alerts it computes) is sent directly to -policy as a fire-and-forget interface, so that is an example of a -``stream``. - -Example: - -.. code:: json - - "services": { - "calls": [{ - "config_key": "vnf-db", - "request": { - "format": "dcae.vnf.meta", - "version": "1.0.0" - }, - "response": { - "format": "dcae.vnf.kpi", - "version": "1.0.0" - } - }], - ... - } - -This describes that ``yourapp.component.kpi_anomaly`` will make HTTP -calls to a downstream component that accepts requests of data format -``dcae.vnf.meta`` version ``1.0.0`` and is expecting the response to be -``dcae.vnf.kpi`` version ``1.0.0``. - -``calls`` Schema: - -+-------------+----+----------+ -| Property | Ty\| Descript\| -| Name | pe | ion | -+=============+====+==========+ -| request | JS\| *Require\| -| | ON | d*. | -| | ob\| Descript\| -| | je\| ion | -| | ct | of the | -| | | expected | -| | | request | -| | | for this | -| | | downstre\| -| | | am | -| | | interfac\| -| | | e | -+-------------+----+----------+ -| response | JS\| *Require\| -| | ON | d*. | -| | ob\| Descript\| -| | je\| ion | -| | ct | of the | -| | | expected | -| | | response | -| | | for this | -| | | downstre\| -| | | am | -| | | interfac\| -| | | e | -+-------------+----+----------+ -| config_key | st\| *Require\| -| | ri\| d*. | -| | ng | The JSON | -| | | key in | -| | | the | -| | | generate\| -| | | d | -| | | applicat | -| | | ion | -| | | configur\| -| | | ation | -| | | that | -| | | will be | -| | | used to | -| | | pass the | -| | | downstre\| -| | | am | -| | | componen | -| | | t | -| | | connecti\| -| | | on | -| | | informat\| -| | | ion. | -+-------------+----+----------+ - -The JSON object schema for both ``request`` and ``response``: - -+-------------+----+----------+ -| Property | Ty\| Descript\| -| Name | pe | ion | -+=============+====+==========+ -| format | st\| *Require\| -| | ri\| d*. | -| | ng | Data | -| | | format | -| | | id of | -| | | the data | -| | | format | -| | | that is | -| | | used by | -| | | this | -| | | interfac\| -| | | e | -+-------------+----+----------+ -| version | st\| *Require\| -| | ri\| d*. | -| | ng | Data | -| | | format | -| | | version | -| | | of the | -| | | data | -| | | format | -| | | that is | -| | | used by | -| | | this | -| | | interfac\| -| | | e | -+-------------+----+----------+ - -Provides -^^^^^^^^ - -Example: - -.. code:: json - - "services": { - ... - "provides": [{ - "route": "/score-vnf", - "request": { - "format": "dcae.vnf.meta", - "version": "1.0.0" - }, - "response": { - "format": "yourapp.format.integerClassification", - "version": "1.0.0" - } - }] - }, - -This describes that ``yourapp.component.kpi_anomaly`` provides a service -interface and it is exposed on the ``/score-vnf`` HTTP endpoint. The -endpoint accepts requests that have the data format ``dcae.vnf.meta`` -version ``1.0.0`` and gives back a response of -``yourapp.format.integerClassification`` version ``1.0.0``. - -``provides`` Schema for a Docker component: - -+-------------+----+----------+ -| Property | Ty\| Descript\| -| Name | pe | ion | -+=============+====+==========+ -| request | JS\| *Require\| -| | ON | d*. | -| | ob\| Descript\| -| | je\| ion | -| | ct | of the | -| | | expected | -| | | request | -| | | for this | -| | | interfac\| -| | | e | -+-------------+----+----------+ -| response | JS\| *Require\| -| | ON | d*. | -| | ob\| Descript\| -| | je\| ion | -| | ct | of the | -| | | expected | -| | | response | -| | | for this | -| | | interfac\| -| | | e | -+-------------+----+----------+ -| route | st\| *Require\| -| | ri\| d*. | -| | ng | The HTTP | -| | | route | -| | | that | -| | | this | -| | | interfac\| -| | | e | -| | | listens | -| | | on | -+-------------+----+----------+ - -The JSON object schema for both ``request`` and ``response``: - -+-------------+----+----------+ -| Property | Ty\| Descript\| -| Name | pe | ion | -+=============+====+==========+ -| format | st\| *Require\| -| | ri\| d*. | -| | ng | Data | -| | | format | -| | | id of | -| | | the data | -| | | format | -| | | that is | -| | | used by | -| | | this | -| | | interfac\| -| | | e | -+-------------+----+----------+ -| version | st\| *Require\| -| | ri\| d*. | -| | ng | Data | -| | | format | -| | | version | -| | | of the | -| | | data | -| | | format | -| | | that is | -| | | used by | -| | | this | -| | | interfac\| -| | | e | -+-------------+----+----------+ - -Note, for CDAP, there is a slight variation due to the way CDAP exposes -services: - -:: - - "provides":[ // note this is a list of JSON - { - "request":{ ...}, - "response":{ ...}, - "service_name":"name CDAP service", - "service_endpoint":"greet", // E.g the URL is /services/service_name/methods/service_endpoint - "verb":"GET" // GET, PUT, or POST - } - ] - -``provides`` Schema for a CDAP component: - -+-------------+----+-----------+ -| Property | Ty\| Descript\ | -| Name | pe | ion | -+=============+====+===========+ -| request | JS\| *Require\ | -| | ON | d*. | -| | ob\| Descript\ | -| | je\| ion | -| | ct | of the | -| | | expected | -| | | request | -| | | data | -| | | format | -| | | for this | -| | | interfac\ | -| | | e | -+-------------+----+-----------+ -| response | JS\| *Require\ | -| | ON | d*. | -| | ob\| Descript\ | -| | je\| ion | -| | ct | of the | -| | | expected | -| | | response | -| | | for this | -| | | interfac\ | -| | | e | -+-------------+----+-----------+ -| service_nam\| st\| *Require\ | -| e | ri\| d*. | -| | ng | The CDAP | -| | | service | -| | | name (eg | -| | | “Greetin\ | -| | | g”) | -+-------------+----+-----------+ -| service_end | st\| *Require\ | -| point | ri\| d*. | -| | ng | The CDAP | -| | | service | -| | | endpoint | -| | | for this | -| | | service_n\| -| | | ame | -| | | (eg | -| | | “/greet” | -| | | ) | -+-------------+----+-----------+ -| verb | st\| *Require\ | -| | ri\| d*. | -| | ng | ‘GET’, | -| | | ‘PUT’ or | -| | | ‘POST’ | -+-------------+----+-----------+ - -.. _common-specification-parameters: - -Parameters ----------- - -``parameters`` is where to specify the component’s application -configuration parameters that are not connection information. - -+---------------+------------+----------------------------------+ -| Property Name | Type | Description | -+===============+============+==================================+ -| parameters | JSON array | Each entry is a parameter object | -+---------------+------------+----------------------------------+ - -Parameter object has the following available properties: - -+--------------+----+----------+------+ -| Property | Ty\| Descript\| Defa\| -| Name | pe | ion | ult | -+==============+====+==========+======+ -| name | st\| *Require\| | -| | ri\| d*. | | -| | ng | The | | -| | | property | | -| | | name | | -| | | that | | -| | | will be | | -| | | used as | | -| | | the key | | -| | | in the | | -| | | generate\| | -| | | d | | -| | | config | | -+--------------+----+----------+------+ -| value | an\| *Require\| | -| | y | d*. | | -| | | The | | -| | | default | | -| | | value | | -| | | for the | | -| | | given | | -| | | paramete\| | -| | | r | | -+--------------+----+----------+------+ -| description | st\| *Require\| | -| | ri\| d*. | | -| | ng | Human-re\| | -| | | adable | | -| | | text | | -| | | describi\| | -| | | ng | | -| | | the | | -| | | paramete\| | -| | | r | | -| | | like | | -| | | what its | | -| | | for | | -+--------------+----+----------+------+ -| type | st\| The | | -| | ri\| required | | -| | ng | data | | -| | | type for | | -| | | the | | -| | | paramete\| | -| | | r | | -+--------------+----+----------+------+ -| required | bo\| An | true | -| | ol\| optional | | -| | ea\| key that | | -| | n | declares | | -| | | a | | -| | | paramete\| | -| | | r | | -| | | as | | -| | | required | | -| | | (true) | | -| | | or not | | -| | | (false) | | -+--------------+----+----------+------+ -| constraints | ar\| The | | -| | ra\| optional | | -| | y | list of | | -| | | sequence | | -| | | d | | -| | | constrai\| | -| | | nt | | -| | | clauses | | -| | | for the | | -| | | paramete\| | -| | | r. | | -| | | See | | -| | | below | | -+--------------+----+----------+------+ -| entry_schem\ | st\| The | | -| a | ri\| optional | | -| | ng | key that | | -| | | is used | | -| | | to | | -| | | declare | | -| | | the name | | -| | | of the | | -| | | Datatype | | -| | | definiti\| | -| | | on | | -| | | for | | -| | | entries | | -| | | of set | | -| | | types | | -| | | such as | | -| | | the | | -| | | TOSCA | | -| | | ‘list’ | | -| | | or | | -| | | ‘map’. | | -| | | Only 1 | | -| | | level is | | -| | | supporte\| | -| | | d | | -| | | at this | | -| | | time | | -+--------------+----+----------+------+ -| designer_ed\ | bo\| An | | -| itable | ol\| optional | | -| | ea\| key that | | -| | n | declares | | -| | | a | | -| | | paramete\| | -| | | r | | -| | | to be | | -| | | editable | | -| | | by | | -| | | designer | | -| | | (true) | | -| | | or not | | -| | | (false) | | -+--------------+----+----------+------+ -| sourced_at_d\| bo\| An | | -| eployment | ol\| optional | | -| | ea\| key that | | -| | n | declares | | -| | | a | | -| | | paramete\| | -| | | r’s | | -| | | value to | | -| | | be | | -| | | assigned | | -| | | at | | -| | | deployme\| | -| | | nt | | -| | | time | | -| | | (true) | | -+--------------+----+----------+------+ -| policy_edit\ | bo\| An | | -| able | ol\| optional | | -| | ea\| key that | | -| | n | declares | | -| | | a | | -| | | paramete\| | -| | | r | | -| | | to be | | -| | | editable | | -| | | by | | -| | | policy | | -| | | (true) | | -| | | or not | | -| | | (false) | | -+--------------+----+----------+------+ -| policy_sche\ | ar\| The | | -| ma | ra\| optional | | -| | y | list of | | -| | | schema | | -| | | definiti\| | -| | | ons | | -| | | used for | | -| | | policy. | | -| | | See | | -| | | below | | -+--------------+----+----------+------+ - -Example: - -.. code:: json - - "parameters": [ - { - "name": "threshold", - "value": 0.75, - "description": "Probability threshold to exceed to be anomalous" - } - ] - -Many of the parameter properties have been copied from TOSCA model -property definitions and are to be used for service design composition -and policy creation. See `section 3.5.8 *Property -definition* <http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.1/TOSCA-Simple-Profile-YAML-v1.1.html>`__. - -The property ``constraints`` is a list of objects where each constraint -object: - -+--------------+----+----------+ -| Property | Ty\| Descript\| -| Name | pe | ion | -+==============+====+==========+ -| equal | | Constrai\| -| | | ns | -| | | a | -| | | property | -| | | or | -| | | paramete\| -| | | r | -| | | to a | -| | | value | -| | | equal to | -| | | (‘=’) | -| | | the | -| | | value | -| | | declared | -+--------------+----+----------+ -| greater_tha\ | nu\| Constrai\| -| n | mb\| ns | -| | er | a | -| | | property | -| | | or | -| | | paramete | -| | | r | -| | | to a | -| | | value | -| | | greater | -| | | than | -| | | (‘>’) | -| | | the | -| | | value | -| | | declared | -+--------------+----+----------+ -| greater_or_e\| nu\| Constrai\| -| qual | mb\| ns | -| | er | a | -| | | property | -| | | or | -| | | paramete\| -| | | r | -| | | to a | -| | | value | -| | | greater | -| | | than or | -| | | equal to | -| | | (‘>=’) | -| | | the | -| | | value | -| | | declared | -+--------------+----+----------+ -| less_than | nu\| Constrai\| -| | mb\| ns | -| | er | a | -| | | property | -| | | or | -| | | paramete\| -| | | r | -| | | to a | -| | | value | -| | | less | -| | | than | -| | | (‘<’) | -| | | the | -| | | value | -| | | declared | -+--------------+----+----------+ -| less_or_equ\ | nu\| Constrai\| -| al | mb\| ns | -| | er | a | -| | | property | -| | | or | -| | | paramete\| -| | | r | -| | | to a | -| | | value | -| | | less | -| | | than or | -| | | equal to | -| | | (‘<=’) | -| | | the | -| | | value | -| | | declared | -+--------------+----+----------+ -| valid_value\ | ar\| Constrai\| -| s | ra\| ns | -| | y | a | -| | | property | -| | | or | -| | | paramete\| -| | | r | -| | | to a | -| | | value | -| | | that is | -| | | in the | -| | | list of | -| | | declared | -| | | values | -+--------------+----+----------+ -| length | nu\| Constrai\| -| | mb\| ns | -| | er | the | -| | | property | -| | | or | -| | | paramete\| -| | | r | -| | | to a | -| | | value of | -| | | a given | -| | | length | -+--------------+----+----------+ -| min_length | nu\| Constrai\| -| | mb\| ns | -| | er | the | -| | | property | -| | | or | -| | | paramete\| -| | | r | -| | | to a | -| | | value to | -| | | a | -| | | minimum | -| | | length | -+--------------+----+----------+ -| max_length | nu\| Constrai\| -| | mb\| ns | -| | er | the | -| | | property | -| | | or | -| | | paramete\| -| | | r | -| | | to a | -| | | value to | -| | | a | -| | | maximum | -| | | length | -+--------------+----+----------+ - -``threshold`` is the configuration parameter and will get set to 0.75 -when the configuration gets generated. - -The property ``policy_schema`` is a list of objects where each -policy_schema object: - -+-------------+----+----------+------+ -| Property | Ty\| Descript\| Defa\| -| Name | pe | ion | ult | -+=============+====+==========+======+ -| name | st\| *Require\| | -| | ri\| d*. | | -| | ng | paramete\| | -| | | r | | -| | | name | | -+-------------+----+----------+------+ -| value | st\| default | | -| | ri\| value | | -| | ng | for the | | -| | | paramete\| | -| | | r | | -+-------------+----+----------+------+ -| description | st\| paramete\| | -| | ri\| r | | -| | ng | descript\| | -| | | ion | | -+-------------+----+----------+------+ -| type | en\| *Require\| | -| | um | d*. | | -| | | data | | -| | | type of | | -| | | the | | -| | | paramete\| | -| | | r, | | -| | | ‘string’ | | -| | | , | | -| | | ‘number’ | | -| | | , | | -| | | ‘boolean | | -| | | ’, | | -| | | ‘datetim\| | -| | | e’, | | -| | | ‘list’, | | -| | | or ‘map’ | | -+-------------+----+----------+------+ -| required | bo\| is | true | -| | ol\| paramete\| | -| | ea\| r | | -| | n | required | | -| | | or not? | | -+-------------+----+----------+------+ -| constraints | ar\| The | | -| | ra\| optional | | -| | y | list of | | -| | | sequence\| | -| | | d | | -| | | constrai\| | -| | | nt | | -| | | clauses | | -| | | for the | | -| | | paramete\| | -| | | r. | | -| | | See | | -| | | above | | -+-------------+----+----------+------+ -| entry_schem\| st\| The | | -| a | ri\| optional | | -| | ng | key that | | -| | | is used | | -| | | to | | -| | | declare | | -| | | the name | | -| | | of the | | -| | | Datatype | | -| | | definiti\| | -| | | on | | -| | | for | | -| | | certain | | -| | | types. | | -| | | entry_sc\| | -| | | hema | | -| | | 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, | | -| | | bookean, | | -| | | datetime | | -| | | ), | | -| | | follow | | -| | | with an | | -| | | string | | -| | | to | | -| | | describe | | -| | | the | | -| | | entry | | -+-------------+----+----------+------+ -| | If | | | -| | th\| | | -| | e | | | -| | ty\| | | -| | pe | | | -| | is | | | -| | li\| | | -| | st | | | -| | an\| | | -| | d | | | -| | th\| | | -| | e | | | -| | en\| | | -| | tr\| | | -| | y | | | -| | ty\| | | -| | pe | | | -| | is | | | -| | a | | | -| | ma\| | | -| | p, | | | -| | fo\| | | -| | ll\| | | -| | ow | | | -| | wi\| | | -| | th | | | -| | an | | | -| | ar\| | | -| | ra\| | | -| | y | | | -| | to | | | -| | de\| | | -| | sc\| | | -| | ri\| | | -| | be | | | -| | th\| | | -| | e | | | -| | ke\| | | -| | ys | | | -| | fo\| | | -| | r | | | -| | th\| | | -| | e | | | -| | en\| | | -| | tr\| | | -| | y | | | -| | ma\| | | -| | p | | | -+-------------+----+----------+------+ -| | If | | | -| | th\| | | -| | e | | | -| | ty\| | | -| | pe | | | -| | is | | | -| | li\| | | -| | st | | | -| | an\| | | -| | d | | | -| | th\| | | -| | e | | | -| | en\| | | -| | tr\| | | -| | y | | | -| | ty\| | | -| | pe | | | -| | is | | | -| | a | | | -| | li\| | | -| | st | | | -| | , | | | -| | th\| | | -| | at | | | -| | is | | | -| | no\| | | -| | t | | | -| | cu\| | | -| | rr\| | | -| | en\| | | -| | tl\| | | -| | y | | | -| | su\| | | -| | pp\| | | -| | or\| | | -| | te\| | | -| | d \| | | -+-------------+----+----------+------+ -| | If | | | -| | th\| | | -| | e | | | -| | ty\| | | -| | pe | | | -| | is | | | -| | ma\| | | -| | p, | | | -| | fo\| | | -| | ll\| | | -| | ow | | | -| | wi\| | | -| | th | | | -| | an | | | -| | ar\| | | -| | ay | | | -| | to | | | -| | de\| | | -| | sc\| | | -| | ri\| | | -| | be | | | -| | th\| | | -| | e | | | -| | ke\| | | -| | ys | | | -| | fo\| | | -| | r | | | -| | th\| | | -| | e | | | -| | ma\| | | -| | p | | | -+-------------+----+----------+------+ - - -.. _artifacts: - -Artifacts ---------- - -``artifacts`` contains a list of artifacts associated with this -component. For Docker, this is the full path (including the registry) to -the Docker image. For CDAP, this is the full path to the CDAP jar. - -+---------------+------------+---------------------------------+ -| Property Name | Type | Description | -+===============+============+=================================+ -| artifacts | JSON array | Each entry is a artifact object | -+---------------+------------+---------------------------------+ - -``artifact`` Schema: - -+---------------+--------+--------------------------------------------+ -| Property Name | Type | Description | -+===============+========+============================================+ -| uri | string | *Required*. Uri to the artifact, full path | -+---------------+--------+--------------------------------------------+ -| type | string | *Required*. ``docker image`` or ``jar`` | -+---------------+--------+--------------------------------------------+ - -.. _auxilary: - -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 -~~~~~~~~~~~~ - -Component developers are required to provide a way for the platform to -periodically check the health of their running components. The -details of the definition used by your component is to be provided -through the :any:`Docker auxiliary specification <docker-auxiliary-details>`. - -The information contained in the auxilary_docker field is the Docker component specification schema. Some properties of the docker component specification include - - -healthcheck : Defines the health check that Consul should perform for this component - -log_info : Component specific details for logging, includes the path in the container where logs are written that can also be used for logstash/kibana style reporting. - -ports : Port mapping to be used for Docker containers. Each entry is of the format <container port>:<host port>. - -tls_info : Component information for use of tls certificates, where they will be available, whether or not to use them - -policy : Information for Policy configuration and reconfiguration - -databases: Information about databases the application should connect to - -volumes: Contains information on volume mapping for the docker containers - - -Schema portion: - -.. code:: json - - "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" - }, - "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 - } diff --git a/docs/sections/design-components/component-specification/configuration-grid.rst b/docs/sections/design-components/component-specification/configuration-grid.rst deleted file mode 100755 index 3efb9850..00000000 --- a/docs/sections/design-components/component-specification/configuration-grid.rst +++ /dev/null @@ -1,118 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Configuration Quick Reference
-=============================
-
-Default Values
-^^^^^^^^^^^^^^
-
-The component developer can provide default values for any ``parameter``
-in the component specification. These defaults will be passed to the
-component in its generated configuration.
-
-Overridden/Entered Values
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Depending on the other properties set for the parameter, the default
-value can be overridden at ‘design-time’, ‘deploy-time’ or once the
-microservice is running (‘run-time’).
-
-+--------+--------+--------+--------+------------+
-| | Design\| CLAMP | Policy | Deploy-Time|
-| | -Time | Input | Input | Input |
-| | Input | | | |
-| | | | | |
-+========+========+========+========+============+
-| Descri\| Applie\| Applie\| (not | Applies to |
-| ption | s | s | yet | manually |
-| | to | to | suppor\| deployed |
-| | self-s\| compon\| ted) | services |
-| | ervice | ents | | |
-| | compon\| deploy\| | |
-| | ents | ed | | |
-| | | by | | |
-| | | CLAMP | | |
-+--------+--------+--------+--------+------------+
-| Input | Servic\| CLAMP | Operat\| DevOps |
-| provid\| e | | ions | |
-| ed | Designe| | | |
-| by | r | | | |
-+--------+--------+--------+--------+------------+
-| How it | In the | In the | In the | In the DCAE|
-| is | SDC/MOD| CLAMP | POLICY | Dashboard |
-| provid\| UI | UI | GUI | (or Jenkins|
-| ed | | | | job) |
-+--------+--------+--------+--------+------------+
-| Compon\| ‘desig\| None. | ‘polic\| ‘sourced\ |
-| ent | ner-ed\| Develo\| y_edit\| _at_deploy\|
-| Specif\| itable\| per | able’ | ment’ must |
-| icatio\| ’ | provid\| must | be set to |
-| n | set to | es | be set | ‘true’ |
-| Detail\| ‘true’ | CLAMP | to | |
-| s | | an | ‘true’ | |
-| | | email | and | |
-| | | with | ‘polic\| |
-| | | parame\| y_sche\| |
-| | | ters | ma’ | |
-| | | to be | must | |
-| | | suppor\| be | |
-| | | ted | provid\| |
-| | | | ed | |
-| | | | | |
-| | | | | |
-+--------+--------+--------+--------+------------+
-| Additi\| | | For | |
-| onal | | | Docker | |
-| Info | | | only: | |
-| for | | | In the | |
-| Compon\| | | auxili\| |
-| ent | | | ary | |
-| Develo\| | | sectio\| |
-| per | | | n: | |
-| | | | {“poli\| |
-| | | | cy”: | |
-| | | | {“trig\| |
-| | | | ger_ty\| |
-| | | | pe”: | |
-| | | | “polic\| |
-| | | | y”,“sc\| |
-| | | | ript_p\| |
-| | | | ath”: | |
-| | | | “/opt/\| |
-| | | | app/re\| |
-| | | | config\| |
-| | | | ure.sh | |
-| | | | ”} | |
-| | | | } | |
-| | | | Script | |
-| | | | interf\| |
-| | | | ace | |
-| | | | would | |
-| | | | then | |
-| | | | be | |
-| | | | “/opt/\| |
-| | | | app/re\| |
-| | | | config\| |
-| | | | ure.sh | |
-| | | | ” | |
-| | | | $trigg\| |
-| | | | er_typ\| |
-| | | | e | |
-| | | | $updat\| |
-| | | | ed_pol\| |
-| | | | icy" | |
-| | | | where | |
-| | | | $updat\| |
-| | | | ed_pol\| |
-| | | | icy | |
-| | | | is | |
-| | | | json | |
-| | | | provid\| |
-| | | | ed | |
-| | | | by the | |
-| | | | Policy | |
-| | | | Handle\| |
-| | | | r. | |
-+--------+--------+--------+--------+------------+
-
diff --git a/docs/sections/design-components/component-specification/data-formats.rst b/docs/sections/design-components/component-specification/data-formats.rst deleted file mode 100755 index b0863ca4..00000000 --- a/docs/sections/design-components/component-specification/data-formats.rst +++ /dev/null @@ -1,235 +0,0 @@ -.. 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/component-specification/dmaap-connection-objects.rst b/docs/sections/design-components/component-specification/dmaap-connection-objects.rst deleted file mode 100755 index da368abf..00000000 --- a/docs/sections/design-components/component-specification/dmaap-connection-objects.rst +++ /dev/null @@ -1,218 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. _dmaap-connection-objects:
-
-DMaaP connection objects
-========================
-
-DMaaP Connection objects are generated by the DCAE Platform at runtime
-and passed to the component in its application_configuration
-
-.. _dmaap-message-router:
-
-Message Router
---------------
-
-Publishers and subscribers have the same generated
-``Dmaap Connection Object`` structure. Here’s an example for any given
-config-key: (This is what will be in application_configuration)
-
-.. code:: json
-
- {
- "type": "message_router",
- "aaf_username": "some-user",
- "aaf_password": "some-password",
- "dmaap_info": {
- "client_role": "com.dcae.member",
- "client_id": "1500462518108",
- "location": "mtc00",
- "topic_url": "https://we-are-message-router.us:3905/events/some-topic"
- }
- }
-
-At the top-level:
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| type | string | *Required as input*. Must |
-| | | be ``message_router`` for |
-| | | message router topics |
-+--------------------------------+---------+---------------------------+
-| aaf_username | string | AAF username message |
-| | | router clients use to |
-| | | authenticate with secure |
-| | | topics |
-+--------------------------------+---------+---------------------------+
-| aaf_password | string | AAF password message |
-| | | router clients use to |
-| | | authenticate with secure |
-| | | topics |
-+--------------------------------+---------+---------------------------+
-| dmaap_info | JSON | *Required as input*. |
-| | object | Contains the topic |
-| | | connection details |
-+--------------------------------+---------+---------------------------+
-
-The ``dmaap_info`` object contains:
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| client_role | string | AAF client role that’s |
-| | | requesting publish or |
-| | | subscribe access to the |
-| | | topic |
-+--------------------------------+---------+---------------------------+
-| client_id | string | Client id for given AAF |
-| | | client |
-+--------------------------------+---------+---------------------------+
-| location | string | DCAE location for the |
-| | | publisher or subscriber, |
-| | | used to set up routing |
-+--------------------------------+---------+---------------------------+
-| topic_url | string | *Required as input*. URL |
-| | | for accessing the topic |
-| | | to publish or receive |
-| | | events |
-+--------------------------------+---------+---------------------------+
-
-
-
-.. _dmaap-data-router:
-
-Data Router
------------
-
-Publisher
-~~~~~~~~~
-
-Here’s an example of what the generated ``Dmaap Connection Object`` for
-Data Router Publisher looks like: (This is what will be in
-application_configuration)
-
-.. code:: json
-
- {
- "type": "data_router",
- "dmaap_info": {
- "location": "mtc00",
- "publish_url": "https://we-are-data-router.us/feed/xyz",
- "log_url": "https://we-are-data-router.us/feed/xyz/logs",
- "username": "some-user",
- "password": "some-password",
- "publisher_id": "123456"
- }
- }
-
-At the top-level:
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| type | string | *Required as input*. Must |
-| | | be ``data_router`` for |
-| | | data router feeds |
-+--------------------------------+---------+---------------------------+
-| dmaap_info | JSON | *Required as input*. |
-| | object | Contains the feed |
-| | | connection details |
-+--------------------------------+---------+---------------------------+
-
-The ``dmaap_info`` object contains:
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| location | string | DCAE location for the |
-| | | publisher, used to set up |
-| | | routing |
-+--------------------------------+---------+---------------------------+
-| publish_url | string | *Required as input*. URL |
-| | | to which the publisher |
-| | | makes Data Router publish |
-| | | requests |
-+--------------------------------+---------+---------------------------+
-| log_url | string | URL from which log data |
-| | | for the feed can be |
-| | | obtained |
-+--------------------------------+---------+---------------------------+
-| username | string | Username the publisher |
-| | | uses to authenticate to |
-| | | Data Router |
-+--------------------------------+---------+---------------------------+
-| password | string | Password the publisher |
-| | | uses to authenticate to |
-| | | Data Router |
-+--------------------------------+---------+---------------------------+
-| publisher_id | string | Publisher id in Data |
-| | | Router |
-+--------------------------------+---------+---------------------------+
-
-
-Subscriber
-~~~~~~~~~~
-
-Here’s an example of what the generated ``Dmaap Connection Object`` for
-a Data Router Subscriber looks like: (This is what will be passed in
-application_configuration)
-
-.. code:: json
-
- {
- "type": "data_router",
- "dmaap_info": {
- "location": "mtc00",
- "delivery_url": "https://my-subscriber-app.dcae:8080/target-path",
- "username": "some-user",
- "password": "some-password",
- "subscriber_id": "789012"
- }
- }
-
-At the top-level:
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| type | string | *Required as input*. Must |
-| | | be ``data_router`` for |
-| | | data router feeds |
-+--------------------------------+---------+---------------------------+
-| dmaap_info | JSON | *Required as input*. |
-| | object | Contains the feed |
-| | | connection details |
-+--------------------------------+---------+---------------------------+
-
-The ``dmaap_info`` object contains:
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| location | string | DCAE location for the |
-| | | subscriber, used to set |
-| | | up routing |
-+--------------------------------+---------+---------------------------+
-| delivery_url | string | URL to which the Data |
-| | | Router should deliver |
-| | | files |
-+--------------------------------+---------+---------------------------+
-| username | string | Username Data Router uses |
-| | | to authenticate to the |
-| | | subscriber when |
-| | | delivering files |
-+--------------------------------+---------+---------------------------+
-| password | string | Password Data Router uses |
-| | | to authenticate to the |
-| | | subscriber when |
-| | | delivering files |
-+--------------------------------+---------+---------------------------+
-| subscriber_id | string | Subscriber id in Data |
-| | | Router |
-+--------------------------------+---------+---------------------------+
-
-
-
-
diff --git a/docs/sections/design-components/component-specification/docker-specification.rst b/docs/sections/design-components/component-specification/docker-specification.rst deleted file mode 100755 index eeac1ef8..00000000 --- a/docs/sections/design-components/component-specification/docker-specification.rst +++ /dev/null @@ -1,420 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. _docker-requirements:
-
-Component Spec Requirements
-===========================
-
-The component specification contains the following groups of
-information.
-
-- :any:`Metadata <metadata>`
-- :any:`Interfaces <interfaces>` including the
- associated :any:`Data Formats <data-formats>`
-- :any:`Parameters <common-specification-parameters>`
-- :any:`Auxiliary Details <docker-auxiliary-details>`
-- :any:`List of Artifacts <artifacts>`
-
-.. _docker-auxiliary-details:
-
-Auxiliary Details
------------------
-
-``auxiliary`` contains Docker specific details like health check, port
-mapping, volume mapping and policy reconfiguration script details.
-
-
-+--------------------------------+---------+---------------------------+
-| Name | Type | Description |
-+================================+=========+===========================+
-| healthcheck | JSON | *Required*. Health check |
-| | object | definition details |
-+--------------------------------+---------+---------------------------+
-| ports | JSON | each array item maps a |
-| | array | container port to the |
-| | | host port. See example |
-| | | below. |
-+--------------------------------+---------+---------------------------+
-| volumes | JSON | each array item contains |
-| | array | volume definition of eith\|
-| | | er: host path or config m\|
-| | | ap volume. |
-+--------------------------------+---------+---------------------------+
-| policy | JSON | *Required*. Policy |
-| | array | reconfiguration script |
-| | | details |
-+--------------------------------+---------+---------------------------+
-| tls_info | JSON | *Optional*. Information |
-| | object | about usage of tls certif\|
-| | | icates |
-+--------------------------------+---------+---------------------------+
-
-Health Check Definition
-~~~~~~~~~~~~~~~~~~~~~~~
-
-The platform currently supports http and docker script based health checks.
-
-When choosing a value for interval, consider that too frequent
-healthchecks will put unnecessary load on the platform. If there is a
-problematic resource, then more frequent healthchecks are warranted (eg
-15s or 60s), but as stability increases, so can these values, (eg
-300s).
-
-When choosing a value for timeout, consider that too small a number will
-result in increasing timeout failures, and too large a number will
-result in a delay in the notification of the resource problem. A
-suggestion is to start with 5s and work from there.
-
-http
-^^^^
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| type | string | *Required*. ``http`` |
-+--------------------------------+---------+---------------------------+
-| interval | string | Interval duration in |
-| | | seconds i.e. ``60s`` |
-+--------------------------------+---------+---------------------------+
-| timeout | string | Timeout in seconds i.e. |
-| | | ``5s`` |
-+--------------------------------+---------+---------------------------+
-| endpoint | string | *Required*. GET endpoint |
-| | | provided by the component |
-| | | for checking health |
-+--------------------------------+---------+---------------------------+
-
-Example:
-
-.. code:: json
-
- "auxilary": {
- "healthcheck": {
- "type": "http",
- "interval": "15s",
- "timeout": "1s",
- "endpoint": "/my-health"
- }
- }
-
-docker script example
-^^^^^^^^^^^^^^^^^^^^^
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| type | string | *Required*. ``docker`` |
-+--------------------------------+---------+---------------------------+
-| interval | string | Interval duration in |
-| | | seconds i.e. ``15s`` |
-+--------------------------------+---------+---------------------------+
-| timeout | string | Timeout in seconds i.e. |
-| | | ``1s`` |
-+--------------------------------+---------+---------------------------+
-| script | string | *Required*. Full path of |
-| | | script that exists in the |
-| | | Docker container to be |
-| | | executed |
-+--------------------------------+---------+---------------------------+
-
-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.
-
-Example:
-
-.. code:: json
-
- "auxilary": {
- "healthcheck": {
- "type": "docker",
- "script": "/app/resources/check_health.py",
- "timeout": "30s",
- "interval": "180s"
- }
- }
-
-Ports
-~~~~~
-
-This method of exposing/mapping a local port to a host port is NOT
-RECOMMENDED because of the possibility of port conflicts. If multiple
-instances of a docker container will be running, there definitely will
-be port conflicts. Use at your own risk. (The preferred way to expose a
-port is to do so in the Dockerfile as described
-:any:`here <dcae-cli-docker-ports>`).
-
-.. code:: json
-
- "auxilary": {
- "ports": ["8080:8000"]
- }
-
-In the example above, container port 8080 maps to host port 8000.
-
-Volume Mapping
-~~~~~~~~~~~~~~
-
-.. code:: json
-
- "auxilary": {
- "volumes": [
- {
- "container": {
- "bind": "/tmp/docker.sock",
- "mode": "ro"
- },
- "host": {
- "path": "/var/run/docker.sock"
- }
- },
- {
- "container": {
- "bind": "/tmp/mount_path"
- "mode": "ro"
- },
- "config_volume": {
- "name": "config_map_name"
- }
- }
- ]
- }
-
-At the top-level:
-
-+---------------+-------+-------------------------------------+
-| Property Name | Type | Description |
-+===============+=======+=====================================+
-| volumes | array | Contains container with host/config\|
-| | | _volume objects |
-+---------------+-------+-------------------------------------+
-
-The ``container`` object contains:
-
-
-+-----------------------+-----------------------+-------------------------------+
-| Property Name | Type | Description |
-+=======================+=======================+===============================+
-| bind | string | path to the container |
-| | | volume |
-+-----------------------+-----------------------+-------------------------------+
-| mode | string | ro - indicates |
-| | | read-only volume |
-+-----------------------+-----------------------+-------------------------------+
-| | | w - indicates that |
-| | | the contain can write |
-| | | into the bind mount |
-+-----------------------+-----------------------+-------------------------------+
-
-The ``host`` object contains:
-
-+---------------+--------+-------------------------+
-| Property Name | Type | Description |
-+===============+========+=========================+
-| path | string | path to the host volume |
-+---------------+--------+-------------------------+
-
-The ``config_volume`` object contains:
-
-+---------------+--------+-------------------------+
-| Property Name | Type | Description |
-+===============+========+=========================+
-| name | string | name of config map |
-+---------------+--------+-------------------------+
-
-Here is an example of the minimal JSON with host path volume that must be provided as an input:
-
-.. code:: json
-
- "auxilary": {
- "volumes": [
- {
- "container": {
- "bind": "/tmp/docker.sock"
- },
- "host": {
- "path": "/var/run/docker.sock"
- }
- }
- ]
- }
-
-In the example above, the container volume “/tmp/docker.sock” maps to
-host volume “/var/run/docker.sock”.
-
-Here is an example of the minimal JSON with config map volume that must be provided as an input:
-
-.. code:: json
-
- "auxilary": {
- "volumes": [
- {
- "container": {
- "bind": "/tmp/mount_path"
- },
- "config_volume": {
- "name": "config_map_name"
- }
- }
- ]
- }
-
-In the example above, config map named "config_map_name" is mounted at "/tmp/mount_path".
-
-Policy
-~~~~~~~
-
-Policy changes made in the Policy UI will be provided to the Docker
-component by triggering a script that is defined here.
-
-+--------------------------------+---------+---------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================+
-| reconfigure_type | string | *Required*. Current value |
-| | | supported is ``policy`` |
-+--------------------------------+---------+---------------------------+
-| script_path | string | *Required*. Current value |
-| | | for ‘policy’ |
-| | | reconfigure_type must be |
-| | | “/opt/app/reconfigure.sh” |
-+--------------------------------+---------+---------------------------+
-
-Example:
-
-.. code:: json
-
- "auxilary": {
- "policy": {
- "reconfigure_type": "policy",
- "script_path": "/opt/app/reconfigure.sh"
- }
- }
-
-The docker script interface is as follows: \`/opt/app/reconfigure.sh
-$reconfigure_type {“updated policies”: , “application config”: }
-
-+---------------------+--------------+----------------------------------------+
-| Name | Type | Description |
-+=====================+==============+========================================+
-| reconfigure_type | string | policy |
-+---------------------+--------------+----------------------------------------+
-| updated_policies | json | TBD |
-+---------------------+--------------+----------------------------------------+
-| updated_appl_config | json | complete generated app_config, not |
-| | | fully-resolved, but ``policy-enabled`` |
-| | | parameters have been updated. In order |
-| | | to get the complete updated |
-| | | app_config, the component would have |
-| | | to call ``config-binding-service``. |
-+---------------------+--------------+----------------------------------------+
-
-TLS Info
-~~~~~~~~~~~~~~~~~
-
-TLS Info is used to trigger addition of init containers that can provide main application containers with certificates
-for internal and external communication.
-
-+--------------------------------+---------+---------------------------------------------------------------------------+
-| Property Name | Type | Description |
-+================================+=========+===========================================================================+
-| cert_directory | string | *Required*. Directory where certificates should be created. |
-| | | i.e. ``/opt/app/dcae-certificate`` |
-+--------------------------------+---------+---------------------------------------------------------------------------+
-| use_tls | boolean | *Required*. A boolean that indicates whether server certificates for int\ |
-| | | ernal communication should be added to the main container |
-| | | i.e ``true`` |
-+--------------------------------+---------+---------------------------------------------------------------------------+
-| use_external_tls | boolean | *Optional*. A boolean that indicates whether the component uses OOM Cert\ |
-| | | Service to acquire operator certificate to protect external (between xNFs |
-| | | and ONAP) traffic. For a time being only operator certificate from CMPv2 |
-| | | server is supported. |
-| | | i.e ``true`` |
-+--------------------------------+---------+---------------------------------------------------------------------------+
-
-
-Example:
-
-.. code:: json
-
- "auxilary": {
- "tls_info": {
- "cert_directory": "/opt/app/dcae-certificate",
- "use_tls": true
- "use_external_tls": true,
- }
- },
-
-Docker Component Spec - Complete Example
-----------------------------------------
-
-.. code:: json
-
- {
- "self": {
- "version": "1.0.0",
- "name": "yourapp.component.kpi_anomaly",
- "description": "Classifies VNF KPI data as anomalous",
- "component_type": "docker"
- },
- "streams": {
- "subscribes": [{
- "format": "dcae.vnf.kpi",
- "version": "1.0.0",
- "route": "/data",
- "type": "http"
- }],
- "publishes": [{
- "format": "yourapp.format.integerClassification",
- "version": "1.0.0",
- "config_key": "prediction",
- "type": "http"
- }]
- },
- "services": {
- "calls": [{
- "config_key": "vnf-db",
- "request": {
- "format": "dcae.vnf.meta",
- "version": "1.0.0"
- },
- "response": {
- "format": "dcae.vnf.kpi",
- "version": "1.0.0"
- }
- }],
- "provides": [{
- "route": "/score-vnf",
- "request": {
- "format": "dcae.vnf.meta",
- "version": "1.0.0"
- },
- "response": {
- "format": "yourapp.format.integerClassification",
- "version": "1.0.0"
- }
- }]
- },
- "parameters": [
- {
- "name": "threshold",
- "value": 0.75,
- "description": "Probability threshold to exceed to be anomalous"
- }
- ],
- "auxilary": {
- "healthcheck": {
- "type": "http",
- "interval": "15s",
- "timeout": "1s",
- "endpoint": "/my-health"
- }
- },
- "artifacts": [{
- "uri": "fake.nexus.att.com/dcae/kpi_anomaly:1.0.0",
- "type": "docker image"
- }]
- }
diff --git a/docs/sections/design-components/component-specification/index-component-specification.rst b/docs/sections/design-components/component-specification/index-component-specification.rst deleted file mode 100644 index 76ef2129..00000000 --- a/docs/sections/design-components/component-specification/index-component-specification.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Component Specification -======================= - -.. toctree:: - :maxdepth: 1 - - ./component-type-docker.rst - ./component-json-schema.rst - ./docker-specification.rst - ./dmaap-connection-objects.rst - ./streams-grid.rst - ./configuration-grid.rst
\ No newline at end of file diff --git a/docs/sections/design-components/component-specification/streams-grid.rst b/docs/sections/design-components/component-specification/streams-grid.rst deleted file mode 100755 index 6105e9e1..00000000 --- a/docs/sections/design-components/component-specification/streams-grid.rst +++ /dev/null @@ -1,149 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. _streams-grid:
-
-Streams Formatting Quick Reference
-==================================
-
-Each of the following tables represents an example of a publisher and
-its subscriber, which are of course, different components. This focuses
-on the fields that are ‘different’ for each of these TYPEs, to
-illustrate the relationship between ``config_key``, dmaap connection
-object, and the generated configuration. Some notes on specific
-properties:
-
-- ``config_key`` is an arbitrary string, chosen by the component
- developer. It is returned in the generated configuration where it
- contains specific values for the target connection
-- ``format``, ``version``, and ``type`` properties in the subscriber
- would match these properties in the publisher
-- ``aaf_username`` and ``aaf_password`` may be different between the
- publisher and the subscriber
-
-Using http
-~~~~~~~~~~
-
-*Publishing Component*
-^^^^^^^^^^^^^^^^^^^^^^
-
-+-----------------------------+----------------------------------------+
-| component \ | runtime platform generated config |
-| spec | |
-+=============================+========================================+
-| "streams":{ | "streams_publishes":{ |
-| "publishes":[{ | "prediction":"10.100.1.100:32567/data" |
-| "config_key":"prediction", | |
-| "format":"some-format", | |
-| "type":"http", | |
-| "version":"0.1.0" } | |
-| ]} | |
-+-----------------------------+----------------------------------------+
-
-*Subscribing Component*
-^^^^^^^^^^^^^^^^^^^^^^^
-
-+-----------------------------+----------------------------------------+
-| component | runtime platform generated config |
-| spec | |
-+=============================+========================================+
-| “streams”:{ | "N/A" |
-| "subscribes":[{ | |
-| "route":"/data", | |
-| "format":"some-format", | |
-| "type":"http" | |
-| "version":"0.1.0" } | |
-| ]} | |
-+-----------------------------+----------------------------------------+
-
-Using Message Router
-~~~~~~~~~~~~~~~~~~~~
-
-.. publishing-component-1:
-
-*Publishing Component*
-^^^^^^^^^^^^^^^^^^^^^^
-
-Note: When deploying, this component should be deployed first so satisfy
-downstream dependencies. Refer to the –force option in component ‘run’
-command for more information.
-
-+---------------+------------------------+-----------------------------------------------------------------------------+
-| component \ | Dmaap Connection \ | runtime platform generated \ |
-| spec | Object | config |
-+===============+========================+=============================================================================+
-| “streams”:{ | { “dmaap_info”: | “streams_publishes”:{ |
-| “config_k\| {} \ *Note: For \ | “aaf_username”:“pub-user”, |
-| ey”:“mr_out\ | message router, this \ | “type”:“message_router”, |
-| put”, “t\ | object is identical \ | “topic_url”:"https://we-are-message-router.us:3905/events/some-topic"\ |
-| ype”:“messag\ | for the publisher and \| "streams_subscribes":{...} |
-| e_router”, | the subscriber* | |
-| }]} | | |
-+---------------+------------------------+-----------------------------------------------------------------------------+
-
-*Subscribing Component*
-^^^^^^^^^^^^^^^^^^^^^^^
-
-+---------------+------------------------+-----------------------------------------------------------------------------+
-| component \ | Dmaap Connection \ | runtime platform generated \ |
-| spec | Object | config |
-+===============+========================+=============================================================================+
-| “streams”:{ | { “dmaap_info”: | “streams_publishes”:{…}, |
-| “config_k\| {} \ *Note: For \ | “streams_subscribes”:{ |
-| ey”:“mr_inp\ | message router, this \ | “aaf_username”:“sub-user”, |
-| ut”, “ty\ | object is identical \ | “type”:“message_router”, |
-| pe”:“message\ | for the publisher and \| “topic_url”:“https://we-are-message-router.us:3905/events/some-topic" |
-| _router”, | the subscriber* | |
-| }]} | | |
-+---------------+------------------------+-----------------------------------------------------------------------------+
-
-Using Data Router
-~~~~~~~~~~~~~~~~~
-
-.. publishing-component-2:
-
-*Publishing Component*
-^^^^^^^^^^^^^^^^^^^^^^
-
-+---------------+-----------------------------------------------+-----------------------------------------------+
-| component spec| Dmaap Connection Object | runtime platform generated config |
-+===============+===============================================+===============================================+
-| “streams”:{ | { “dmaap_info”: { | streams_publishes“:{ ”typ\ |
-| “config_key: | “location”: | e“:”data_router“, "location":"mtc00" |
-| “dr_output" | “mtc00”, | , |
-| , "type": | “publish_url”: | "publish_url“: |
-| “data_r\ | "https://we-are-data-router.us/feed/xyz"\ | "http://we-are-data-router.us/feed/xyz" |
-| outer”, }] | , | , |
-| } | “log_url”:\ | "log_url“:\ |
-| | \ | ”https://we-are-data-router.us/feed/xyz/logs" |
-| | "https://we-are-data-router.us/feed/xyz/logs"\| , |
-| | , | ”username“:”pub-user“, |
-| | “username”: | ”publisher_id“:”123456\ |
-| | “pub-user”, | “}}, |
-| | “password”: | ”streams_subscribes“:{ |
-| | “pub-password”, | … } |
-| | “publisher_id”: | |
-| | “123456”}} | |
-+---------------+-----------------------------------------------+-----------------------------------------------+
-
-.. subscribing-component-1:
-
-*Subscribing Component*
-^^^^^^^^^^^^^^^^^^^^^^^
-
-+---------------+---------------------------------------------------+---------------------------------------------------------------------------+
-| component \ | Dmaap Connection \ | runtime platform generated \ |
-| spec | Object | config |
-+===============+===================================================+===========================================================================+
-| “streams”:{ | { “dmaap_info”: | “streams_publishes”:{ … }, |
-| “config_k\| { “location”: | “streams_subscribes”:{ |
-| ey”:“dr_inp\ | “mtc00”, | “type”:“data_router”, |
-| ut”, “ty\ | “delivery_url”: | “location”:“mtc00”, |
-| pe”:“data_ro\ | "https://my-subscriber-app.dcae:8080/target-path"\| “delivery_url”:"https://my-subscriber-app.dcae:8080/target-path"\|
-| uter”, | \ | \ |
-| “route”: | , | , |
-| “/target-pat\ | “password”: | \ |
-| h”} | “sub-password”, | “username”:“sub-user”, |
-| | “subscriber_id”: | |
-| | “789012”}} | “subscriber_id”:“789012”}} |
-+---------------+---------------------------------------------------+---------------------------------------------------------------------------+
diff --git a/docs/sections/design-components/glossary.rst b/docs/sections/design-components/glossary.rst deleted file mode 100644 index b1430e22..00000000 --- a/docs/sections/design-components/glossary.rst +++ /dev/null @@ -1,169 +0,0 @@ - -.. http://creativecommons.org/licenses/by/4.0 - -.. _glossary: - -Glossary -======== - -A&AI - Active and Available Inventory -------------------------------------- -Inventory DB for all network components - - -CLAMP ------ -Non DCAE Platform Component - Controls the input and processing for -Closed Loop services. - - -Closed Loop ------------ -Services designed to monitor and report back to a controlling function -that automatically deals with the event reported without human -interaction. - - - -Cloudify --------- -Open Source application and network orchestration framework, based on -TOSCA used in DCAE to deploy platform and service components from -Cloudify Blueprints. - - -Cloudify Blueprints -------------------- -YAML formatted file used by Cloudify to deploy platform and service -components. Contains all the information needed for installation. - - -Consul ------- -Opensource Platform Component that supports Service Discovery, -Configuration, and Healthcheck. Refer to -`Architecture </architecture/pieces>`__ for more information. - -Component ---------- -Refers to a DCAE service component which is a single micro-service that -is written to be run by the DCAE platform and to be composeable to form -a DCAE service. That composition occurs in the SDC. - - -Config Binding Service ----------------------- -DCAE Platform Component - Service Components use Config Binding Service -to access Consul and retrieve configuration variables. - - -Component Specification ------------------------ -JSON formatted file that fully describes a component and its interfaces - - -Data Format / Data Format Specification ---------------------------------------- -JSON formatted file that fully describes a components input or output - - -Deployment Handler ------------------- -DCAE Platform Component - Receives Input from DTI Handler, and talks to -Cloudify to deploy components. - - -Design-Time ------------ -Refers to when the System Designer uses a design tool to compose services -from components in the catalog. The Designer can provide input to -assign/override defaults for configuration for any parameter with the -property 'designer\_editable' set to 'true'. - - -Deploy-Time ------------ -Refers to when a service is being deployed. This can be done -automatically via the SDC Tool, or manually via the DCAE Dashboard or -CLAMP UI. When manually deployed, DevOps can provide input to -assign/override defaults for configuration for any parameter with the -property 'sourced\_at\_deployment' set to 'true'. - - -Docker ------- -Opensource Platform for development of containerized applications in the -cloud. Many DCAE service components and all DCAE collectors are written -utilizing Docker. - - -Dmaap ------ -AT&T data transportation service platform that supports message-based -topics and file-based feeds. Runs locally at the Edge and Centrally. - - -Inventory ---------- -DCAE Platform Component - Postgres DB containing Cloudify Blueprints for -platform and service components. - - -Policy ------- -Refers to the setting of configuration parameters for a component, by -Operations via the Policy UI. - - -Policy Handler --------------- -DCAE Platform Component that received Policy updates from Policy UI - - -Policy UI ---------- -Non DCAE Component - Policy User Interace where Operations assigns -values to configuraton specified for this. - - -Run-Time --------- -Refers to the when a service is running on the platform. Often used in -conjunction with DTI events which occur at Run-time. - - -SCH - Service Change Handler ----------------------------- -DCAE Platform Component - Receives updates from SDC and updates -Inventory - - -SDC - Service Design and Creation ---------------------------------- -ONAP design catalog for onboarding VNF/PNF packages - - -Self-Service ------------- -Refers to services that are supported by SDC, and that are automatically -installed as a result of a Service Designer's composition and submission -of a service. Only a handful of services are 'self-service' currently. -Most require manual effort to generate the Tosca Model files and -Cloudify Blueprints. - - -Service Component ------------------ -Microservice that provides network monitoring or analytic function on -the DCAE platform. - - -Service -------- -Generally composed of multiple service components, which is deployed to -the DCAE platform. - - -VNF - Virtualized Network Function ----------------------------------- -A network function that runs on one or more virtualized machines. diff --git a/docs/sections/design-components/images/1.png b/docs/sections/design-components/images/1.png Binary files differdeleted file mode 100644 index e734a673..00000000 --- a/docs/sections/design-components/images/1.png +++ /dev/null diff --git a/docs/sections/design-components/images/10.png b/docs/sections/design-components/images/10.png Binary files differdeleted file mode 100644 index 9a7f75ad..00000000 --- a/docs/sections/design-components/images/10.png +++ /dev/null diff --git a/docs/sections/design-components/images/11.png b/docs/sections/design-components/images/11.png Binary files differdeleted file mode 100644 index fe5ed014..00000000 --- a/docs/sections/design-components/images/11.png +++ /dev/null diff --git a/docs/sections/design-components/images/12.png b/docs/sections/design-components/images/12.png Binary files differdeleted file mode 100644 index f2d5a360..00000000 --- a/docs/sections/design-components/images/12.png +++ /dev/null diff --git a/docs/sections/design-components/images/128713731_image2022.png b/docs/sections/design-components/images/128713731_image2022.png Binary files differdeleted file mode 100644 index 0c9356c3..00000000 --- a/docs/sections/design-components/images/128713731_image2022.png +++ /dev/null diff --git a/docs/sections/design-components/images/13.png b/docs/sections/design-components/images/13.png Binary files differdeleted file mode 100644 index c63d1361..00000000 --- a/docs/sections/design-components/images/13.png +++ /dev/null diff --git a/docs/sections/design-components/images/14.png b/docs/sections/design-components/images/14.png Binary files differdeleted file mode 100644 index 5b507b10..00000000 --- a/docs/sections/design-components/images/14.png +++ /dev/null diff --git a/docs/sections/design-components/images/15.png b/docs/sections/design-components/images/15.png Binary files differdeleted file mode 100644 index 1529ef04..00000000 --- a/docs/sections/design-components/images/15.png +++ /dev/null diff --git a/docs/sections/design-components/images/16.png b/docs/sections/design-components/images/16.png Binary files differdeleted file mode 100644 index e3a7e36d..00000000 --- a/docs/sections/design-components/images/16.png +++ /dev/null diff --git a/docs/sections/design-components/images/17.png b/docs/sections/design-components/images/17.png Binary files differdeleted file mode 100644 index 54347d18..00000000 --- a/docs/sections/design-components/images/17.png +++ /dev/null diff --git a/docs/sections/design-components/images/18.png b/docs/sections/design-components/images/18.png Binary files differdeleted file mode 100644 index 150e1c61..00000000 --- a/docs/sections/design-components/images/18.png +++ /dev/null diff --git a/docs/sections/design-components/images/19.png b/docs/sections/design-components/images/19.png Binary files differdeleted file mode 100644 index b578b103..00000000 --- a/docs/sections/design-components/images/19.png +++ /dev/null diff --git a/docs/sections/design-components/images/2.png b/docs/sections/design-components/images/2.png Binary files differdeleted file mode 100644 index 20bd7a01..00000000 --- a/docs/sections/design-components/images/2.png +++ /dev/null diff --git a/docs/sections/design-components/images/20.png b/docs/sections/design-components/images/20.png Binary files differdeleted file mode 100644 index 80f56e92..00000000 --- a/docs/sections/design-components/images/20.png +++ /dev/null diff --git a/docs/sections/design-components/images/21.png b/docs/sections/design-components/images/21.png Binary files differdeleted file mode 100644 index c92a2346..00000000 --- a/docs/sections/design-components/images/21.png +++ /dev/null diff --git a/docs/sections/design-components/images/22.png b/docs/sections/design-components/images/22.png Binary files differdeleted file mode 100644 index bf4f1c02..00000000 --- a/docs/sections/design-components/images/22.png +++ /dev/null diff --git a/docs/sections/design-components/images/23.png b/docs/sections/design-components/images/23.png Binary files differdeleted file mode 100644 index 98fd7970..00000000 --- a/docs/sections/design-components/images/23.png +++ /dev/null diff --git a/docs/sections/design-components/images/24.png b/docs/sections/design-components/images/24.png Binary files differdeleted file mode 100644 index 2784fddf..00000000 --- a/docs/sections/design-components/images/24.png +++ /dev/null diff --git a/docs/sections/design-components/images/25.png b/docs/sections/design-components/images/25.png Binary files differdeleted file mode 100644 index 55464c46..00000000 --- a/docs/sections/design-components/images/25.png +++ /dev/null diff --git a/docs/sections/design-components/images/26.png b/docs/sections/design-components/images/26.png Binary files differdeleted file mode 100644 index 9486bb80..00000000 --- a/docs/sections/design-components/images/26.png +++ /dev/null diff --git a/docs/sections/design-components/images/27.png b/docs/sections/design-components/images/27.png Binary files differdeleted file mode 100644 index 3c0bd2f3..00000000 --- a/docs/sections/design-components/images/27.png +++ /dev/null diff --git a/docs/sections/design-components/images/3.png b/docs/sections/design-components/images/3.png Binary files differdeleted file mode 100644 index 7d1d9df0..00000000 --- a/docs/sections/design-components/images/3.png +++ /dev/null diff --git a/docs/sections/design-components/images/4.png b/docs/sections/design-components/images/4.png Binary files differdeleted file mode 100644 index 69706f63..00000000 --- a/docs/sections/design-components/images/4.png +++ /dev/null diff --git a/docs/sections/design-components/images/5.png b/docs/sections/design-components/images/5.png Binary files differdeleted file mode 100644 index ec158035..00000000 --- a/docs/sections/design-components/images/5.png +++ /dev/null diff --git a/docs/sections/design-components/images/6.png b/docs/sections/design-components/images/6.png Binary files differdeleted file mode 100644 index b3f7e7bc..00000000 --- a/docs/sections/design-components/images/6.png +++ /dev/null diff --git a/docs/sections/design-components/images/7.png b/docs/sections/design-components/images/7.png Binary files differdeleted file mode 100644 index adb8a941..00000000 --- a/docs/sections/design-components/images/7.png +++ /dev/null diff --git a/docs/sections/design-components/images/8.png b/docs/sections/design-components/images/8.png Binary files differdeleted file mode 100644 index e04c60ed..00000000 --- a/docs/sections/design-components/images/8.png +++ /dev/null diff --git a/docs/sections/design-components/images/9.png b/docs/sections/design-components/images/9.png Binary files differdeleted file mode 100644 index c18e9487..00000000 --- a/docs/sections/design-components/images/9.png +++ /dev/null diff --git a/docs/sections/design-components/images/DCAE-Mod-Architecture.png b/docs/sections/design-components/images/DCAE-Mod-Architecture.png Binary files differdeleted file mode 100644 index ce5fca92..00000000 --- a/docs/sections/design-components/images/DCAE-Mod-Architecture.png +++ /dev/null diff --git a/docs/sections/design-components/images/Onboarding-with-DCAE-MOD.png b/docs/sections/design-components/images/Onboarding-with-DCAE-MOD.png Binary files differdeleted file mode 100644 index 4883b65e..00000000 --- a/docs/sections/design-components/images/Onboarding-with-DCAE-MOD.png +++ /dev/null diff --git a/docs/sections/design-components/images/nifi-toolbar-components.png b/docs/sections/design-components/images/nifi-toolbar-components.png Binary files differdeleted file mode 100644 index fa90afef..00000000 --- a/docs/sections/design-components/images/nifi-toolbar-components.png +++ /dev/null diff --git a/docs/sections/design-components/index-onboarding.rst b/docs/sections/design-components/index-onboarding.rst deleted file mode 100644 index 75d7c19d..00000000 --- a/docs/sections/design-components/index-onboarding.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. _designplatform: - - -Design Platform -=============== - -.. toctree:: - :maxdepth: 1 - - ./overview.rst - ./requirements-guidelines.rst - ./blueprint_generator.rst - ./DCAE-MOD/DCAE-MOD-Architecture.rst - ./component-specification/index-component-specification.rst - ./component-specification/data-formats.rst - ./DCAE-MOD/DCAE-MOD-User-Guide.rst - ./glossary.rst -
\ No newline at end of file diff --git a/docs/sections/design-components/overview.rst b/docs/sections/design-components/overview.rst deleted file mode 100755 index 654a0c11..00000000 --- a/docs/sections/design-components/overview.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. _intro:
-
-
-Overview
-========
-
-DCAE components are services that provide a specific functionality and
-are generally written to be composable with other DCAE components,
-although a component can run independently as well. The DCAE platform is
-responsible for running and managing DCAE service components reliably.
-
-The DCAE Design platform aims to provide a common catalog of available DCAE
-Service components, enabling designers to select required
-components to construct and deploy composite flows into DCAE Runtime platform.
-
-Service component/MS to be onboarded and deployed into DCAE platform would
-typically go through the following phases
-
- - Onboarding
- - Design
- - Runtime
-
-DCAE Design Platform supports onboarding and service design through MOD.
-
-
-Onboarding is a process that ensures that the component is compliant
-with the DCAE platform rules. The high level summary of the onboarding process
-is:
-
-1. Defining the :doc:`data formats <data-formats>` if they don’t already
- exist.
-2. Defining the :doc:`component specification <./component-specification/component-specification>`
-3. Validate the component spec schema against
- `Component Spec json schema <https://git.onap.org/dcaegen2/platform/plain/mod/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json>`__
-4. Use :doc:`blueprint-generator tool <./blueprint_generator>` to generate Cloudify blueprint
-5. Test the blueprint generated in DCAE Runtime Environment (using either Dashboard UI or Cloudify cli from bootstrap)
-6. Using :doc:`DCAE-MOD <../DCAE-MOD/DCAE-MOD-User-Guide>` , publish the component and data formats into DCAE-MOD catalog.
- (This step is required if Microservice needs to be deployed part of flow/usecase)
-
-
-A Component requires one or more data formats.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-A component is a software application that performs a function. It
-doesn’t run independently; it depends upon other components. A
-component’s function could require connecting to other components to
-fulfill that function. A component could also be providing its function
-as a service through an interface for other components to use.
-
-A component cannot connect to or be connected with any other component.
-The upstream and downstream components must *speak* the same vocabulary
-or *data format*. The output of an one component must match another
-component’s input. This is necessary for components to function
-correctly and without errors.
-
-The platform requires data formats to ensure that a component will be
-run with other *compatible* components.
-
-Data formats can and should be shared by multiple components.
-
-Each Component requires a component specification.
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The component specification is a JSON artifact that fully specifies the
-component, it’s interfaces, and configuration. It’s standardized for
-CDAP (deprecated) and Docker applications and is validated using a
-:doc:`JSON schema <./component-specification/component-json-schema>`.
-
-The component specification fully specifies all the configuration
-parameters of the component. This is used by the designer and by policy
-(future) to configure the runtime behavior of the component.
-
-The component specification is used to *generate* application
-configuration in a standardized JSON that the platform will make
-available to the component. This application configuration JSON will
-include:
-
-- Parameters that have been assigned values from the component
- specification, policy, and/or the designer
-- Connection details of downstream components
-
-The component specification is transformed by DCAE tooling (explained
-later) into TOSCA models (one for the component, and in the future, one
-for Policy). The TOSCA models then get transformed into Cloudify
-blueprints.
-
-The component specification is used by:
-
-
-- Blueprint Generator - Tool to generate standalone cloudify blueprint
- using component spec. The blueprints can be uploaded into inventory
- using Dashboard and triggered for deployment.
-- MOD Platform - To onboard the microservice and maintain in catalog
- enabling designer to compose new DCAE service flows and distribute
- to DCAE Runtime platform.
-- Policy (future) - TOSCA models are generated from the component
- specification so that operations can create policy models used to
- dynamically configure the component.
-- Runtime platform - The component’s application configuration
- (JSON) is generated from the component specification and will be
- provided to the component at runtime (through ConfigBindingService
- or Consul).
-
-
\ No newline at end of file diff --git a/docs/sections/design-components/requirements-guidelines.rst b/docs/sections/design-components/requirements-guidelines.rst deleted file mode 100644 index 015688fe..00000000 --- a/docs/sections/design-components/requirements-guidelines.rst +++ /dev/null @@ -1,167 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -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. - - -.. _config_binding_service: - -Config Binding Service SDK Integration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -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. - -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>`__ - -Its strongly recommended to use CBS SDK library for consistency across DCAE services to retrieve both static and policy driven configuration. - -Topic Configuration -~~~~~~~~~~~~~~~~~~~ - -With Helm flow integration in MOD, topic generation feature is not supported. - -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** -:: - - "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_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 - - -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 - -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. - - -DCAE SDK -~~~~~~~~ - -DCAE has SDK/libraries which can be used for service components for easy integration. - -- `Java Library <https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/sdk/architecture.html>`__ -- `Python Modules <https://git.onap.org/dcaegen2/utils/tree/onap-dcae-cbs-docker-client>`__ - - - -.. _policy_reconfiguration: - -Policy Reconfiguration ----------------------- - - -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. - -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 -------------- - -Docker images must be pushed to the environment specific Nexus -repository. This requires tagging your build with the full name of you -image which includes the Nexus repository name. - -For ONAP microservices, the components images are expected to pushed into ONAP nexus -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 ------------------------ - -Logging -~~~~~~~ - -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 -~~~ -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/humaninterfaces.rst b/docs/sections/humaninterfaces.rst deleted file mode 100644 index 2dbc04dc..00000000 --- a/docs/sections/humaninterfaces.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Human Interfaces -================ - - -DCAE provides a number of interfaces for users to interact with the DCAE system. - -1. DCAE Bootstrap VM - * The DCAE bootstrap VM accepts ssh connection with the standard access key. - * After ssh into the VM, the DCAE bootstrap docker container can be access via "docker exec" command. - -2. DCAE Cloudify Manager - * The DCAE Cloudify Manager VM accepts ssh connection with the standard access key. The access account is **centos** because this is a CentOS 7 VM. - * The Cloudify Manager GUI can be accessed from http://{{CLOUDIFY_MANAGER_VM_IP}} . - * The standard Cloudify command line CLI as specified here: http://cloudify.co/guide/3.2/cli-general.html . - -3. DCAE Consul Cluster - * The DCAE Consul Cluster VMs accept ssh connection with the standard access key. - * The Consul GUI can be accessed from http://{{ANY_CONSUL_CLUSTER_VM_IP}}:8500 . - * The standard Consul HTTP API as specified here: https://www.consul.io/api/index.html . - * The standard Consul CLI access as specified here: https://www.consul.io/docs/commands/index.html . - -4. DCAE Docket hosts - * The DCAE Docker host VMs accept ssh connection with the standard access key. - * After ssh into the VM, the running docker containers can be access via "docker exec" command. - diff --git a/docs/sections/images/DCAE_Architecture_Slidedeck.pptx b/docs/sections/images/DCAE_Architecture_Slidedeck.pptx Binary files differnew file mode 100644 index 00000000..91839cf8 --- /dev/null +++ b/docs/sections/images/DCAE_Architecture_Slidedeck.pptx diff --git a/docs/sections/images/R12_architecture_diagram.png b/docs/sections/images/R12_architecture_diagram.png Binary files differnew file mode 100644 index 00000000..0559ff48 --- /dev/null +++ b/docs/sections/images/R12_architecture_diagram.png diff --git a/docs/sections/installation_oom.rst b/docs/sections/installation_oom.rst index b4db91bf..766c1f88 100644 --- a/docs/sections/installation_oom.rst +++ b/docs/sections/installation_oom.rst @@ -55,7 +55,6 @@ The dcaegen2-services chart has the following sub-charts: * ``dcae-prh``: deploys the DCAE PNF Registration Handler service. * ``dcae-tcagen2``: deploys the DCAE TCA analytics service. * ``dcae-ves-collector``: deploys the DCAE VES collector service. -* ``dcae-bbs-eventprocessor-ms``: deploys the DCAE BBS Eventprocessor service. * ``dcae-datafile-collector``: deploys the DCAE Datafile collector service. * ``dcae-datalake-admin-ui``: deploys the Datalake Admin UI service. * ``dcae-datalake-des``: deploys the Datalake Data Extraction service. @@ -78,20 +77,6 @@ The dcaegen2-services sub-charts depend on a set of common templates, found unde Information about using the common templates to deploy a microservice can be found in :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`. -The dcaegen2 chart has the following sub-charts: - -* ``dcae-bootstrap``: deploys the DCAE bootstrap service that performs some DCAE initialization and deploys additional DCAE components. -* ``dcae-cloudify-manager``: deploys the DCAE Cloudify Manager instance. -* ``dcae-config-binding-service``: deploys the DCAE config binding service. -* ``dcae-deployment-handler``: deploys the DCAE deployment handler service. -* ``dcae-healthcheck``: deploys the DCAE healthcheck service that provides an API to check the health of all DCAE components. -* ``dcae-policy-handler``: deploys the DCAE policy handler service. -* ``dcae-redis``: deploys the DCAE Redis cluster. -* ``dcae-dashboard``: deploys the DCAE Dashboard for managing DCAE microservices deployments -* ``dcae-servicechange-handler``: deploys the DCAE service change handler service. -* ``dcae-inventory-api``: deploys the DCAE inventory API service. - -These components are by default disabled under ONAP for Jakarta release and charts will be removed next release DCAE Deployment --------------- @@ -259,13 +244,10 @@ uninstall just DCAE, by having the command undeploy the `top_level_release_name` Helm sub-release. Helm will undeploy only the components that were originally deployed using -Helm charts. Components deployed by Cloudify Manager are not deleted by -the Helm operations. - -When uninstalling all of ONAP, it is sufficient to delete the namespace +Helm charts. When uninstalling all of ONAP, it is sufficient to delete the namespace used for the deployment (typically ``onap``) after running the undeploy operation. Deleting the namespace will get rid of any remaining resources -in the namespace, including the components deployed by Cloudify Manager. +in the namespace. To undeploy the DCAE services deployed via Helm (the hv-ves-collector, ves-collector, tcagen2, diff --git a/docs/sections/services/dfc/configuration.rst b/docs/sections/services/dfc/configuration.rst index 1f2b6a48..69375c76 100644 --- a/docs/sections/services/dfc/configuration.rst +++ b/docs/sections/services/dfc/configuration.rst @@ -22,226 +22,71 @@ By default, DFC handles the "PM_MEAS_FILES" change identifier and publishes thes But it can also be configured to handle more/other change identifiers and publish them to more/other feeds. The
configuration of DFC is controlled via a blueprint.
-Blueprint Configuration Explained
-"""""""""""""""""""""""""""""""""
-
-For the communication with the Message Router, the user must provide the **host name**, **port**, and **protocol** of
-the DMaaP Message router.
-
-.. code-block:: yaml
- :emphasize-lines: 2,6,10
-
- inputs:
- dmaap_mr_host:
- type: string
- description: dmaap messagerouter host
- default: message-router.onap.svc.cluster.local
- dmaap_mr_port:
- type: integer
- description: dmaap messagerouter port
- default: 3904
- dmaap_mr_protocol:
- type: string
- description: dmaap messagerouter protocol
- default: "http"
The user can also specify which version of DFC to use.
.. code-block:: yaml
- :emphasize-lines: 2
- inputs:
- tag_version:
- type: string
- description: DFC image tag/version
- default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.0"
+ image: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.9.0
The user can also enable secure communication with the DMaaP Message Router.
.. code-block:: yaml
- :emphasize-lines: 2
-
- inputs:
- secureEnableCert:
- type: boolean
- description: enable certificate based connection with DMaap
- default: false
-
-DFC can handle multiple change identifiers. For each change identifier/feed combination the user must provide the
-**change identifier**, **feed name**, and **feed location**.
-
-**Note!** The **feed name** provided should be used by the consumer/s to set up the subscription to the feed.
-
-The **feed name** and **feed location** are defined as inputs for the user to provide.
-
-.. code-block:: yaml
- :emphasize-lines: 2,6
-
- inputs:
- feed0_name:
- type: string
- description: The name of the feed the files will be published to. Should be used by the subscriber.
- default: "bulk_pm_feed"
- feed0_location:
- type: string
- description: The location of the feed.
- default: "loc00"
-The **feed name** shall be used in the definition of the feed for the DMaaP plugin under the "**node_templates**"
-section under a tag for the internal "**feed identifier**" for the feed (feed0 in the example).
+ dmaap.security.enableDmaapCertAuth: true
-.. code-block:: yaml
- :emphasize-lines: 1,5
+DFC can handle multiple stream identifiers. For each stream identifier/feed combination the user must provide the
+** stream identifier**, **feed name**, and **feed location**.
- feed0:
- type: ccsdk.nodes.Feed
- properties:
- feed_name:
- get_input: feed0_name
- useExisting: true
+**Note!** The **feed name** provided should be used by the consumer/s to set up the subscription to the feed.
-The **feed location** shall be used under the **streams_publishes** section under a tag for the internal
-"**feed identifier**" for the feed.
+The **stream identifier** shall be defined as an item under the **streams_publishes** tag in the "**applicationConfig**"
+section.
.. code-block:: yaml
- :emphasize-lines: 2,4
-
- streams_publishes:
- - name: feed0
- location:
- get_input: feed0_location
- type: data_router
-The **change identifier** shall be defined as an item under the **streams_publishes** tag in the "**application_config**"
-section. Under this tag the internal "**feed identifier**" for the feed shall also be added to get the
+ :emphasize-lines: 2,6
+ applicationConfig:
+ streams_publishes:
+ PM_MEAS_FILES:
+ dmaap_info:
+ publisher_id: ${DR_FILES_PUBLISHER_ID_0}
+ location: loc00
+ log_url: ${DR_LOG_URL_0}
+ publish_url: ${DR_FILES_PUBLISHER_URL_0}
+ username: ${DR_USERNAME}
+ password: ${DR_PASSWORD}
+ type: data_router
+ streams_subscribes:
+ dmaap_subscriber:
+ dmaap_info:
+ topic_url: "http://message-router:3904/events/unauthenticated.VES_NOTIFICATION_OUTPUT"
+ type: message_router
+
+
+
+Under this tag the internal "**feed identifier**" for the feed shall also be added to get the
info about the feed substituted in by CBS (that's what the <<>> tags are for).
-.. code-block:: yaml
- :emphasize-lines: 4,5
-
- application_config:
- service_calls: []
- streams_publishes:
- PM_MEAS_FILES:
- dmaap_info: <<feed0>>
- type: data_router
-
-And, lastly, to set up the publication relationship for the feed, the "**feed identifier**" must be added to the
-"**relationships**" section of the blueprint.
-
-.. code-block:: yaml
- :emphasize-lines: 3
-
- relationships:
- - type: ccsdk.relationships.publish_files
- target: feed0
-
-Sample blueprint configuration
-""""""""""""""""""""""""""""""
-
-The format of the blueprint configuration that drives all behavior of DFC is probably best described using an example.
-The blueprint below configures DFC to handle the two feeds shown in the picture above.
+The **feed name** and **feed location** are defined as inputs for the user to provide in helm chart values.yaml. An example snapshot on default configuration is provided below.
.. code-block:: yaml
+
+ # DataRouter Feed Configuration
+ drFeedConfig:
+ - feedName: bulk_pm_feed
+ owner: dcaecm
+ feedVersion: "0.0"
+ asprClassification: unclassified
+ feedDescription: DFC Feed Creation
+
+ # DataRouter Publisher Configuration
+ drPubConfig:
+ - feedName: bulk_pm_feed
+ username: ${DR_USERNAME}
+ userpwd: ${DR_PASSWORD}
+ dcaeLocationName: loc00
- inputs:
- dmaap_mr_host:
- type: string
- description: dmaap messagerouter host
- default: message-router.onap.svc.cluster.local
- dmaap_mr_port:
- type: integer
- description: dmaap messagerouter port
- default: 3904
- dmaap_mr_protocol:
- type: string
- description: dmaap messagerouter protocol
- default: "http"
- tag_version:
- type: string
- description: DFC image tag/version
- default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.0"
- replicas:
- type: integer
- description: number of instances
- default: 1
- secureEnableCert:
- type: boolean
- description: enable certificate based connection with DMaap
- default: false
- envs:
- default: {}
- feed0_name:
- type: string
- description: The name of the feed the files will be published to. Should be used by the subscriber.
- default: "bulk_pm_feed"
- feed0_location:
- type: string
- description: The location of the feed.
- default: "loc00"
- feed1_name:
- type: string
- description: The name of the feed the files will be published to. Should be used by the subscriber.
- default: "log_feed"
- feed1_location:
- type: string
- description: The location of the feed.
- default: "loc00"
- node_templates:
- datafile-collector:
- type: dcae.nodes.ContainerizedServiceComponentUsingDmaap
- interfaces:
- cloudify.interfaces.lifecycle:
- start:
- inputs:
- envs:
- get_input: envs
- properties:
- application_config:
- service_calls: []
- dmaap.security.enableDmaapCertAuth: { get_input: secureEnableCert }
- streams_subscribes:
- dmaap_subscriber:
- dmaap_info:
- topic_url:
- { concat: [{ get_input: dmaap_mr_protocol },"://",{ get_input: dmaap_mr_host },
- ":",{ get_input: dmaap_mr_port },"/events/unauthenticated.VES_NOTIFICATION_OUTPUT/OpenDcae-c12/C12"]}
- streams_publishes:
- PM_MEAS_FILES:
- dmaap_info: <<feed0>>
- type: data_router
- LOG_FILES:
- dmaap_info: <<feed1>>
- type: data_router
- image:
- get_input: tag_version
- service_component_type: datafile-collector
- streams_publishes:
- - name: feed0
- location:
- get_input: feed0_location
- type: data_router
- - name: feed1
- location:
- get_input: feed1_location
- type: data_router
- relationships:
- - type: ccsdk.relationships.publish_files
- target: feed0
- - type: ccsdk.relationships.publish_files
- target: feed1
- feed0:
- type: ccsdk.nodes.Feed
- properties:
- feed_name:
- get_input: feed0_name
- useExisting: true
- feed1:
- type: ccsdk.nodes.Feed
- properties:
- feed_name:
- get_input: feed1_name
- useExisting: true
.. _strict_host_checking_config:
diff --git a/docs/sections/services/dfc/delivery.rst b/docs/sections/services/dfc/delivery.rst index a24b0201..b193bf30 100644 --- a/docs/sections/services/dfc/delivery.rst +++ b/docs/sections/services/dfc/delivery.rst @@ -9,9 +9,9 @@ Docker Container DFC is delivered as a docker container. The latest released version can be downloaded from nexus:
- ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2``
+ ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:latest``
-For another version, it is possible to replace the tag '1.2.2' with any version that seems suitable. Available images
+For released version, it is possible to replace the tag 'latest' with any release version that seems suitable. Available images
are visible following this `link`_.
.. _link: https://nexus3.onap.org/#browse/search=keyword%3D*collectors.datafile*
@@ -24,6 +24,7 @@ It is possible to clone the Gerrit repository of DFC at this `link <https://gerrit.onap.org/r/#/admin/projects/dcaegen2/collectors/datafile>`__.
Choose your preferred settings (ssh, http or https, with or without hook) and run the command in your terminal.
-If using Cloudify to deploy DFC, the blueprints are needed, and can be found `here`_.
+DFC deployment is handled through Helm charts under OOM repository `here`_.
+
+.. _here: https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/dcaegen2-services/components/dcae-datafile-collector
-.. _here: https://gerrit.onap.org/r/gitweb?p=dcaegen2/collectors/datafile.git;a=blob;f=datafile-app-server/dpo/blueprints/k8s-datafile.yaml;h=cae953085ab00570ea6dd9600c7a7a83e33e3249;hb=HEAD
diff --git a/docs/sections/services/kpi-computation-ms/configuration.rst b/docs/sections/services/kpi-computation-ms/configuration.rst index 59fe784c..269fd16a 100644 --- a/docs/sections/services/kpi-computation-ms/configuration.rst +++ b/docs/sections/services/kpi-computation-ms/configuration.rst @@ -4,7 +4,7 @@ Configuration ============= -KPI Computation MS expects to be able to fetch configuration directly from consul service in following JSON format: +KPI Computation MS expects to be able to fetch configuration in following JSON format: .. code-block:: json { @@ -39,4 +39,5 @@ KPI Computation MS expects to be able to fetch configuration directly from consu "dmaap.server": ["message-router"] } -During ONAP OOM/Kubernetes deployment this configuration is created from KPI Computation MS Cloudify blueprint. +During ONAP OOM/Kubernetes deployment this configuration is created from Helm chart based on properties defined under **applicationConfig** section. + diff --git a/docs/sections/services/mapper/installation-helm.rst b/docs/sections/services/mapper/installation-helm.rst new file mode 100644 index 00000000..d15a7376 --- /dev/null +++ b/docs/sections/services/mapper/installation-helm.rst @@ -0,0 +1,143 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. _ves-mapper-installation-helm: + + +Helm Installation +================= + +The Mapper microservice can be deployed using helm charts in the oom repository. + + +Deployment steps +~~~~~~~~~~~~~~~~ + +- Default app config values can be updated in oom/kubernetes/dcaegen2-services/components/dcae-ves-mapper/values.yaml. + +- Make the chart and deploy using the following command: + + .. code-block:: bash + + cd oom/kubernetes/ + make dcaegen2-services + helm install dev-dcaegen2-services dcaegen2-services --namespace <namespace> --set global.masterPassword=<password> + +- To deploy only Mapper: + + .. code-block:: bash + + helm install dev-dcae-ves-mapper dcaegen2-services/components/dcae-ves-mapper --namespace <namespace> --set global.masterPassword=<password> + +- To Uninstall + + .. code-block:: bash + + helm uninstall dev-dcae-ves-mapper + +Application Configurations +-------------------------- + +Supported configuration modifiable in HELM charts under **applicationConfig** section. + +.. code-block:: yaml + + applicationConfig: + app_preferences: + collectors: + - identifier: notification-id + mapping-files: + - defaultMappingFile-rcc-notification: "<?xml version='1.0' encoding='UTF-8'?><smooks-resource-list + xmlns='http://www.milyn.org/xsd/smooks-1.1.xsd' xmlns:jb='http://www.milyn.org/xsd/smooks/javabean-1.4.xsd' + xmlns:json='http://www.milyn.org/xsd/smooks/json-1.1.xsd'><json:reader rootName='vesevent' + keyWhitspaceReplacement='-'><json:keyMap><json:key from='date&time' to='date-and-time' + /></json:keyMap></json:reader><jb:bean class='org.onap.dcaegen2.ves.domain.ves70.VesEvent' + beanId='vesEvent' createOnElement='vesevent'><jb:wiring property='event' beanIdRef='event' + /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves70.Event' beanId='event' + createOnElement='vesevent'><jb:wiring property='commonEventHeader' beanIdRef='commonEventHeader' + /><jb:wiring property='pnfRegistrationFields' beanIdRef='pnfRegistrationFields' + /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader' + beanId='commonEventHeader' createOnElement='vesevent'><jb:expression property='version'>org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Version._4_0_1</jb:expression><jb:expression + property='eventType'>'pnfRegistration'</jb:expression><jb:expression property='vesEventListenerVersion'>org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.VesEventListenerVersion._7_0_1</jb:expression><jb:expression + property='eventId' execOnElement='vesevent'>'registration_'+commonEventHeader.ts1</jb:expression><jb:expression + property='reportingEntityName'>'VESMapper'</jb:expression><jb:expression property='domain'>org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Domain.PNF_REGISTRATION</jb:expression><jb:expression + property='eventName' execOnElement='vesevent'>commonEventHeader.domain</jb:expression><jb:value + property='sequence' data='0' default='0' decoder='Long' /><jb:expression property='lastEpochMicrosec' + execOnElement='vesevent'>commonEventHeader.ts1</jb:expression><jb:expression + property='startEpochMicrosec' execOnElement='vesevent'>commonEventHeader.ts1</jb:expression><jb:expression + property='priority'>org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Priority.NORMAL</jb:expression><jb:expression + property='sourceName' execOnElement='vesevent'>pnfRegistrationFields.vendorName+'-'+pnfRegistrationFields.serialNumber</jb:expression></jb:bean><jb:bean + class='org.onap.dcaegen2.ves.domain.ves70.PnfRegistrationFields' beanId='pnfRegistrationFields' + createOnElement='vesevent'><jb:expression property='pnfRegistrationFieldsVersion'>org.onap.dcaegen2.ves.domain.ves70.PnfRegistrationFields.PnfRegistrationFieldsVersion._2_0</jb:expression><jb:value + property='serialNumber' data='pnfRegistration/serialNumber' /><jb:value property='lastServiceDate' + data='pnfRegistration/lastServiceDate' /><jb:value property='manufactureDate' + data='pnfRegistration/manufactureDate' /><jb:value property='modelNumber' + data='pnfRegistration/modelNumber' /><jb:value property='oamV4IpAddress' data='pnfRegistration/oamV4IpAddress' + /><jb:value property='oamV6IpAddress' data='pnfRegistration/oamV6IpAddress' + /><jb:value property='softwareVersion' data='pnfRegistration/softwareVersion' + /><jb:value property='unitFamily' data='pnfRegistration/unitFamily' /><jb:value + property='unitType' data='pnfRegistration/unitType' /><jb:value property='vendorName' + data='pnfRegistration/vendorName' /><jb:wiring property='additionalFields' + beanIdRef='alarmAdditionalInformation' /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves70.AlarmAdditionalInformation' + beanId='alarmAdditionalInformation' createOnElement='vesevent'><jb:wiring + property='additionalProperties' beanIdRef='additionalFields2' /></jb:bean><jb:bean + beanId='additionalFields2' class='java.util.HashMap' createOnElement='vesevent/pnfRegistration/additionalFields'><jb:value + data='pnfRegistration/additionalFields/*'/></jb:bean></smooks-resource-list>" + stream_publisher: ves-pnfRegistration + stream_subscriber: rcc-notification + - identifier: notify OID + mapping-files: + - defaultMappingFile-snmp-notification: "<?xml version='1.0' encoding='UTF-8'?><smooks-resource-list + xmlns='http://www.milyn.org/xsd/smooks-1.1.xsd' xmlns:jb='http://www.milyn.org/xsd/smooks/javabean-1.4.xsd' + xmlns:json='http://www.milyn.org/xsd/smooks/json-1.1.xsd'><json:reader rootName='vesevent' + keyWhitspaceReplacement='-'><json:keyMap><json:key from='date&time' to='date-and-time' + /></json:keyMap></json:reader><jb:bean class='org.onap.dcaegen2.ves.domain.ves54.VesEvent' + beanId='vesEvent' createOnElement='vesevent'><jb:wiring property='event' beanIdRef='event' + /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves54.Event' beanId='event' + createOnElement='vesevent'><jb:wiring property='commonEventHeader' beanIdRef='commonEventHeader' + /><jb:wiring property='faultFields' beanIdRef='faultFields' /></jb:bean><jb:bean + class='org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader' beanId='commonEventHeader' + createOnElement='vesevent'><jb:expression property='version'>'3.0'</jb:expression><jb:expression + property='eventType'>'FaultField'</jb:expression><jb:expression property='eventId' + execOnElement='vesevent'>'XXXX'</jb:expression><jb:expression property='reportingEntityName'>'VESMapper'</jb:expression><jb:expression + property='domain'>org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader.Domain.FAULT</jb:expression><jb:expression + property='eventName' execOnElement='vesevent'>commonEventHeader.domain</jb:expression><jb:value + property='sequence' data='0' default='0' decoder='Long' /><jb:value property='lastEpochMicrosec' + data='#/time-received' /><jb:value property='startEpochMicrosec' data='#/time-received' + /><jb:expression property='priority'>org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader.Priority.NORMAL</jb:expression><jb:expression + property='sourceName'>'VesAdapter'</jb:expression></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves54.FaultFields' + beanId='faultFields' createOnElement='vesevent'><jb:value property='faultFieldsVersion' + data='2.0' default='2.0' decoder='Double' /><jb:value property='alarmCondition' + data='#/trap-category' /><jb:expression property='specificProblem'>'SNMP Fault'</jb:expression><jb:expression + property='vfStatus'>org.onap.dcaegen2.ves.domain.ves54.FaultFields.VfStatus.ACTIVE</jb:expression><jb:expression + property='eventSeverity'>org.onap.dcaegen2.ves.domain.ves54.FaultFields.EventSeverity.MINOR</jb:expression><jb:wiring + property='alarmAdditionalInformation' beanIdRef='alarmAdditionalInformationroot' + /></jb:bean><jb:bean class='java.util.ArrayList' beanId='alarmAdditionalInformationroot' + createOnElement='vesevent'><jb:wiring beanIdRef='alarmAdditionalInformation' + /></jb:bean><jb:bean class='org.onap.dcaegen2.ves.domain.ves54.AlarmAdditionalInformation' + beanId='alarmAdditionalInformation' createOnElement='varbinds/element'><jb:value + property='name' data='#/varbind_oid' /><jb:value property='value' data='#/varbind_value' + /></jb:bean></smooks-resource-list>" + stream_publisher: ves-fault + stream_subscriber: snmp-notification + streams_publishes: + ves-fault: + dmaap_info: + topic_url: http://message-router:3904/events/unauthenticated.SEC_FAULT_OUTPUT + type: message_router + ves-pnfRegistration: + dmaap_info: + topic_url: http://message-router:3904/events/unauthenticated.VES_PNFREG_OUTPUT + type: message_router + streams_subscribes: + rcc-notification: + dmaap_info: + topic_url: http://message-router:3904/events/unauthenticated.DCAE_RCC_OUTPUT + type: message_router + snmp-notification: + dmaap_info: + topic_url: http://message-router:3904/events/unauthenticated.ONAP-COLLECTOR-SNMPTRAP + type: message_router + +The location of the configuration file should be set in ``CBS_CLIENT_CONFIG_PATH`` env, for example: + + ``CBS_CLIENT_CONFIG_PATH: /app-config-input/application_config.yaml`` diff --git a/docs/sections/services/mapper/installation.rst b/docs/sections/services/mapper/installation.rst deleted file mode 100644 index af4189fe..00000000 --- a/docs/sections/services/mapper/installation.rst +++ /dev/null @@ -1,89 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. _mapper-installation: - - - -Installation -============ - -**Deployment Prerequisite/dependencies** - -VES-Mapper can be deployed individually though it will throw errors if it can't reach to DMaaP instance's APIs. To test it functionally, DMaaP is the only required prerequisite outside DCAE. As VES-Mapper is integrated with Consul / CBS, it fetches the initial configuration from Consul. - -**Blueprint/model/image** - -VES-Mapper blueprint is available @ -https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-ves-mapper.yaml?h=guilin - -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>`_ - - - - -**1.To Run via blueprint** - -*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`` 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. - -*c. Upload the blueprint in the DCAE's Cloudify instance* - -For this step, DCAE's Cloudify instance should be in running state. Transfer blueprint file in DCAE bootstrap POD under /blueprints directory. Log-in to the DCAE bootstrap POD's main container. - -.. note:: - For doing this, we should run the below commands - - * To get the bootstrap pod name, run this: kubectl get pods -n onap | grep bootstrap - * To transfer blueprint file in bootstrap pod, run this: kubectl cp <source file path> <bootstrap pod>:/blueprints -n onap - * To login to bootstrap pod name, run this: kubectl exec -it <bootstrap pod> bash -n onap - -.. note:: - Verify the below versions before validate blueprint - - * The version of the plugin used is different from "cfy plugins list", update the blueprint import to match. - * If the tag_version under inputs is old, update with the latest - -Validate blueprint - - ``cfy blueprints validate /blueprints/k8s-ves-mapper.yaml`` - -Use following command for validated blueprint to upload: - - ``cfy blueprints upload -b ves-mapper /blueprints/k8s-ves-mapper.yaml`` - -*d. Create the Deployment* -After VES-Mapper's validated blueprint is uploaded, create Cloudify Deployment by following command - - ``cfy deployments create -b ves-mapper ves-mapper`` - -*e. Deploy the component by using following command* - - ``cfy executions start -d ves-mapper install`` - -To undeploy running ves-mapper, follow the below steps - -*a. cfy uninstall ves-mapper -f* - -.. note:: - The deployment uninstall will also delete the blueprint. In some case you might notice 400 error reported indicating active deployment exist such as below. - - Ex: An error occurred on the server: 400: Can't delete deployment ves-mapper - There are running or queued executions for this deployment. Running executions ids: d89fdd0c-8e12-4dfa-ba39-a6187fcf2f18 - -*b. In that case, cancel the execution ID then run uninstall as below* - -.. code-block:: bash - - cfy executions cancel <Running executions ID> - cfy uninstall ves-mapper - -**2.To run on standalone mode** - -Though this is not a preferred way, to run VES-Mapper container on standalone mode using local configuration file carried in the docker image, following docker run command can be used. - - ``docker run -d nexus3.onap.org:10003/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.1.0`` - diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst index 46a73f2c..2fd89a70 100644 --- a/docs/sections/services/pm-mapper/configuration.rst +++ b/docs/sections/services/pm-mapper/configuration.rst @@ -1,6 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2022 Nokia. All rights reserved. +.. Copyright (c) 2023 AT&T Intellectual Property. All rights reserved. + Configuration and Performance ============================= @@ -16,33 +18,6 @@ In order to parallel processing, new configuration env has been introduced: - PROCESSING_THREADS_COUNT (optional, default value: number of threads available to JVM) - allows to specify number of threads that will be used for files processing. - -Envs should be specified in section "envs:" in blueprint. Example part of blueprint configuration: - -:: - - ... - pm-mapper: - type: dcae.nodes.ContainerizedServiceComponentUsingDmaap - interfaces: - cloudify.interfaces.lifecycle: - create: - inputs: - ports: - - '8443:0' - - '8081:0' - envs: - PROCESSING_LIMIT_RATE: "1" - THREADS_MULTIPLIER: "2" - PROCESSING_THREADS_COUNT: "3" - relationships: - - type: dcaegen2.relationships.subscribe_to_files - target: pm-feed - - type: dcaegen2.relationships.publish_events - target: pm-topic - ... - - .. _pm_mapper_disable_tls: Disable TLS diff --git a/docs/sections/services/prh/authorization.rst b/docs/sections/services/prh/authorization.rst index 6bf712e1..d1fb8f2d 100644 --- a/docs/sections/services/prh/authorization.rst +++ b/docs/sections/services/prh/authorization.rst @@ -51,7 +51,7 @@ PRH identity and certificate data | It's the DCAEGEN2 responsibility to generate certificate for dcae identity and provide it to the collector. | | PRH by default expects that the volume ``tls-info`` is being mounted under path ``/opt/app/prh/etc/cert``. -| It's the component/collector responsibility to provide necessary inputs in Cloudify blueprint to get the volume mounted. +| It's the component/collector responsibility to provide necessary inputs in Helm charts to get the volume mounted. | See :doc:`../../tls_enablement` for detailed information. | | PRH is using four files from ``tls-info`` DCAE volume (``cert.jks, jks.pass, trust.jks, trust.pass``). diff --git a/docs/sections/services/prh/configuration.rst b/docs/sections/services/prh/configuration.rst index 9f449cb8..5bdc423c 100644 --- a/docs/sections/services/prh/configuration.rst +++ b/docs/sections/services/prh/configuration.rst @@ -66,4 +66,4 @@ PRH fetches configuration directly from CBS service in the following JSON format } } -The configuration is created from PRH Cloudify blueprint by specifying **application_config** node during ONAP OOM/Kubernetes deployment. +The configuration is created from PRH helm charts by specifying **applicationConfig** during ONAP OOM/Kubernetes deployment. diff --git a/docs/sections/services/prh/installation.rst b/docs/sections/services/prh/installation.rst index 3334025b..eea0d3b6 100644 --- a/docs/sections/services/prh/installation.rst +++ b/docs/sections/services/prh/installation.rst @@ -3,8 +3,8 @@ .. _prh-installation: -Installation -============ +Docker Installation +=================== The following docker-compose-yaml file shows a default configuration. The file can be run using `docker compose up` command: @@ -65,4 +65,93 @@ Heartbeat: http://<container_address>:8100/heartbeat or https://<container_addre Start prh: http://<container_address>:8100/start or https://<container_address>:8433/start -Stop prh: http://<container_address>:8100/stopPrh or https://<container_address>:8433/stopPrh
\ No newline at end of file +Stop prh: http://<container_address>:8100/stopPrh or https://<container_address>:8433/stopPrh + + + +Helm Installation +================= + +The PRH microservice can be deployed using helm charts in the oom repository. + + +Deployment steps +~~~~~~~~~~~~~~~~ + +- Default app config values can be updated in oom/kubernetes/dcaegen2-services/components/dcae-prh/values.yaml. + +- Make the chart and deploy using the following command: + + .. code-block:: bash + + cd oom/kubernetes/ + make dcaegen2-services + helm install dev-dcaegen2-services dcaegen2-services --namespace <namespace> --set global.masterPassword=<password> + +- To deploy only PRH: + + .. code-block:: bash + + helm install dev-dcae-prh dcaegen2-services/components/dcae-prh --namespace <namespace> --set global.masterPassword=<password> + +- To Uninstall + + .. code-block:: bash + + helm uninstall dev-dcae-prh + +Application Configurations +-------------------------- + +Supported configuration modifiable in HELM charts under **applicationConfig** section. + +.. code-block:: yaml + + applicationConfig: + dmaap.dmaapConsumerConfiguration.dmaapContentType: "application/json" + dmaap.dmaapConsumerConfiguration.consumerId: "c12" + dmaap.dmaapConsumerConfiguration.consumerGroup: "OpenDCAE-c12" + dmaap.dmaapConsumerConfiguration.timeoutMs: -1 + dmaap.dmaapProducerConfiguration.dmaapContentType: "application/json" + dmaap.dmaapUpdateProducerConfiguration.dmaapContentType: "application/json" + aai.aaiClientConfiguration.pnfUrl: http://aai-internal.onap.svc.cluster.local:80/aai/v23/network/pnfs/pnf + aai.aaiClientConfiguration.baseUrl: http://aai-internal.onap.svc.cluster.local:80/aai/v23 + aai.aaiClientConfiguration.aaiHost: aai-internal.onap.svc.cluster.local + aai.aaiClientConfiguration.aaiHostPortNumber: 80 + aai.aaiClientConfiguration.aaiProtocol: "http" + aai.aaiClientConfiguration.aaiUserName: ${AAI_USER} + aai.aaiClientConfiguration.aaiUserPassword: ${AAI_PASSWORD} + aai.aaiClientConfiguration.aaiIgnoreSslCertificateErrors: true + aai.aaiClientConfiguration.aaiBasePath: "/aai/v23" + aai.aaiClientConfiguration.aaiPnfPath: "/network/pnfs/pnf" + aai.aaiClientConfiguration.aaiServiceInstancePath: "/business/customers/customer/{{customer}}/service-subscriptions/service-subscription/{{serviceType}}/service-instances/service-instance/{{serviceInstanceId}}" + aai.aaiClientConfiguration.aaiHeaders: + X-FromAppId: "prh" + X-TransactionId: "9999" + Accept: "application/json" + Real-Time: "true" + Authorization: ${AUTH_HDR} + security.trustStorePath: "/opt/app/prh/etc/cert/trust.jks" + security.trustStorePasswordPath: "/opt/app/prh/etc/cert/trust.pass" + security.keyStorePath: "/opt/app/prh/etc/cert/cert.jks" + security.keyStorePasswordPath: "/opt/app/prh/etc/cert/jks.pass" + security.enableAaiCertAuth: false + security.enableDmaapCertAuth: false + streams_publishes: + pnf-update: + type: "message_router" + dmaap_info: + topic_url: http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.PNF_UPDATE + pnf-ready: + type: "message_router" + dmaap_info: + topic_url: http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.PNF_READY + streams_subscribes: + ves-reg-output: + type: "message_router" + dmaap_info: + topic_url: http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.VES_PNFREG_OUTPUT + +The location of the configuration file should be set in ``CBS_CLIENT_CONFIG_PATH`` env, for example: + + ``CBS_CLIENT_CONFIG_PATH: /app-config-input/application_config.yaml`` diff --git a/docs/sections/services/restconf/installation-helm.rst b/docs/sections/services/restconf/installation-helm.rst new file mode 100644 index 00000000..ee32252e --- /dev/null +++ b/docs/sections/services/restconf/installation-helm.rst @@ -0,0 +1,72 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. _restconf-installation-helm: + + +Helm Installation +================= + +The RESTConf microservice can be deployed using helm charts in the oom repository. + + +Deployment steps +~~~~~~~~~~~~~~~~ + +- Default app config values can be updated in oom/kubernetes/dcaegen2-services/components/dcae-restconf/values.yaml. + +- Make the chart and deploy using the following command: + + .. code-block:: bash + + cd oom/kubernetes/ + make dcaegen2-services + helm install dev-dcaegen2-services dcaegen2-services --namespace <namespace> --set global.masterPassword=<password> + +- To deploy only RESTConf: + + .. code-block:: bash + + helm install dev-dcae-restconf dcaegen2-services/components/dcae-restconf --namespace <namespace> --set global.masterPassword=<password> + +- To Uninstall + + .. code-block:: bash + + helm uninstall dev-dcae-restconf + +Application Configurations +-------------------------- + +Supported configuration modifiable in HELM charts under **applicationConfig** section. + +.. code-block:: yaml + + applicationConfig: + collector.rcc.appDescription: DCAE RestConf Collector Application + collector.rcc.appName: dcae-rcc + collector.rcc.dmaap.streamid: notification=device-registration + collector.rcc.inputQueue.maxPending: '8096' + tomcat.maxthreads: '200' + collector.rcc.service.port: '8080' + collector.rcc.service.secure.port: '0' + collector.rcc.service.secure.port: '8687' + collector.rcc.keystore.file.location: /opt/app/dcae-certificate/cert.jks + collector.rcc.keystore.passwordfile: /opt/app/dcae-certificate/jks.pass + collector.rcc.keystore.alias: dynamically generated + collector.rcc.truststore.file.location: /opt/app/dcae-certificate/trust.jks + collector.rcc.truststore.passwordfile: /opt/app/dcae-certificate/trust.pass + collector.keystore.file.location: /opt/app/dcae-certificate/external/cert.jks + collector.keystore.passwordfile: /opt/app/dcae-certificate/external/jks.pass + collector.header.authflag: '0' + collector.header.authlist: sample1,c2FtcGxlMQ== + collector.rcc.service.secure.clientauth: '0' + streams_publishes: + device-registration: + dmaap_info: + topic_url: http://message-router:3904/events/unauthenticated.DCAE_RCC_OUTPUT + type: message_router + rcc_policy: '[{"controller_name":"AccessM&C","controller_restapiUrl":"172.30.0.55:26335","controller_restapiUser":"${CONTROLLER_USERNAME}","controller_restapiPassword":"${CONTROLLER_PASSWORD}","controller_accessTokenUrl":"/rest/plat/smapp/v1/oauth/token","controller_accessTokenFile":"./etc/access-token.json","controller_accessTokenMethod":"put","controller_subsMethod":"post","controller_subscriptionUrl":"/restconf/v1/operations/huawei-nce-notification-action:establish-subscription","controller_disableSsl":"true","event_details":[{"event_name":"ONT_registration","event_description":"ONTregistartionevent","event_sseventUrlEmbed":"true","event_sseventsField":"output.url","event_sseventsUrl":"null","event_subscriptionTemplate":"./etc/ont_registartion_subscription_template.json","event_unSubscriptionTemplate":"./etc/ont_registartion_unsubscription_template.json","event_ruleId":"12345678","modifyData":"true","modifyMethod": "modifyOntEvent","userData": "remote_id=AC9.0234.0337;svlan=100;cvlan=10;"}]}]' + +The location of the configuration file should be set in ``CBS_CLIENT_CONFIG_PATH`` env, for example: + + ``CBS_CLIENT_CONFIG_PATH: /app-config-input/application_config.yaml`` diff --git a/docs/sections/services/restconf/installation.rst b/docs/sections/services/restconf/installation.rst deleted file mode 100644 index 344decc3..00000000 --- a/docs/sections/services/restconf/installation.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. _restconf-installation: - - -Installation -============ - -Standalone docker run command - .. code-block:: bash - - docker run onap/org.onap.dcaegen2.collectors.restconfcollector - -For the current release, RESTConf collector will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation. - - -Steps to deploy are shown below - -- Enter the Bootstrap POD using kubectl - - .. note:: - For doing this, follow the below steps - - * First get the bootstrap pod name by running run this: kubectl get pods -n onap | grep bootstrap - * Then login to bootstrap pod by running this: kubectl exec -it <bootstrap pod> bash -n onap - -- Validate blueprint - .. note:: - Verify that the version of the plugin used should match with "cfy plugins list" and use an explicit URL to the plugin YAML file if needed in the blueprint. - - .. code-block:: bash - - cfy blueprints validate /blueprints/k8s-restconf.yaml -- Upload validated blueprint - .. code-block:: bash - - - cfy blueprints upload -b restconfcollector /blueprints/k8s-restconf.yaml -- Create deployment - .. code-block:: bash - - - cfy deployments create -b restconfcollector restconfcollector -- Deploy blueprint - .. code-block:: bash - - - cfy executions start -d restconfcollector install - -To undeploy restconfcollector, steps are shown below - -- Uninstall running restconfcollector and delete deployment - .. code-block:: bash - - - cfy uninstall restconfcollector -- Delete blueprint - .. code-block:: bash - - - cfy blueprints delete restconfcollector diff --git a/docs/sections/services/slice-analysis-ms/slice_analysis_ms_overview.rst b/docs/sections/services/slice-analysis-ms/slice_analysis_ms_overview.rst index 8cdf70da..3f9d6ecd 100644 --- a/docs/sections/services/slice-analysis-ms/slice_analysis_ms_overview.rst +++ b/docs/sections/services/slice-analysis-ms/slice_analysis_ms_overview.rst @@ -1,5 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0
- International License. http://creativecommons.org/licenses/by/4.0
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
.. _docs_slice_analysis_ms_overview:
@@ -10,9 +10,7 @@ The architecture below depicts the Slice Analysis MS as a part of DCAE. Slice Analysis MS provides runtime configuration feature since Kohn Version.
-Unlike the SON-Handler MS, which passes runtime configuration through Policy - Policy Handler - Cloudify Manager - Consul Cluster - CBS - SONHandler, the Slice Analysis MS provides a lighter and easier way to send runtime configurations in seconds.
-
-For the Slice Analysis MS, there is a CBS thread running that will continually fetch the latest policies from the XCAML PDP engine. So if you want to pass runtime configuration, you can format your configuration contents in the form of an XCAML policy, then push it into the XCAML PDP engine. The Slice Analysis MS will get updated within seconds.
+For the Slice Analysis MS, there is a CBS thread running that will continually fetch the latest policies from the XCAML PDP engine via sidecar. So if you want to pass runtime configuration, you can format your configuration contents in the form of an XCAML policy, then push it into the XCAML PDP engine. The Slice Analysis MS will get updated within seconds.
The internal architecture of Slice Analysis MS is shown below.
diff --git a/docs/sections/services/ves-http/stnd-defined-validation.rst b/docs/sections/services/ves-http/stnd-defined-validation.rst index 9e6f2992..6449922e 100644 --- a/docs/sections/services/ves-http/stnd-defined-validation.rst +++ b/docs/sections/services/ves-http/stnd-defined-validation.rst @@ -82,60 +82,6 @@ The mapping and schema files content can be changed by editing a proper config m Config maps are defined in the `OOM <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/dcaegen2-services/resources/external>`_ repository and are installed with dcaegen2-services module. -Properties configuration via Cloudify -------------------------------------- - -Collector.properties content may be overridden when deploying VES Collector via Cloudify. To keep VES settings -consistent listed above properties has been updated in the VES Collector Cloudify blueprint (in blueprints/k8s-ves.yaml -file under dcaegen2/platform/blueprints project) and in componentspec file (in dpo/spec/vescollector-componentspec.json -file in VES project) which may be used for generation of VES Collector Cloudify blueprints in some scenarios. - -The following table shows new stndDefined related properties added to VES Collector Cloudify blueprint. These properties -represent fields from collector.properties file, but also contain configuration of DMaaP topic URLs used for stndDefined -events routing. It has been specified in the table which of these properties may be configured via inputs during -blueprint deployment. - -**NOTE**: Keep in mind that some properties may use relative path. It is relative to default VES Collector context which -is: */opt/app/VESCollector/*. Final path of etc. *collector.externalSchema.schemasLocation* will be: -*/opt/app/VESCollector/etc/externalRepo/*. Setting absolute path to these properties is also acceptable and won't -generate error. - -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| Property name | Input? | Type | Default value | -+==============================================+========+=========+===============================================================================================================+ -| collector.externalSchema.checkflag | Yes | Integer | 1 | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| collector.externalSchema.mappingFileLocation | Yes | String | ./etc/externalRepo/schema-map.json | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| collector.externalSchema.schemasLocation | Yes | String | ./etc/externalRepo/ | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| event.externalSchema.schemaRefPath | No | String | $.event.stndDefinedFields.schemaReference | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| event.externalSchema.stndDefinedDataPath | No | String | $.event.stndDefinedFields.data | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| ves_3gpp_fault_supervision_publish_url | Yes | String | http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.SEC_3GPP_FAULTSUPERVISION_OUTPUT | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| ves_3gpp_provisioning_publish_url | Yes | String | http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.SEC_3GPP_PROVISIONING_OUTPUT | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| ves_3gpp_hearbeat_publish_url | Yes | String | http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.SEC_3GPP_HEARTBEAT_OUTPUT | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ -| ves_3gpp_performance_assurance_publish_url | Yes | String | http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.SEC_3GPP_PERFORMANCEASSURANCE_OUTPUT | -+----------------------------------------------+--------+---------+---------------------------------------------------------------------------------------------------------------+ - -Config maps with app properties via Helm ----------------------------------------- - -When deploying VES collector via deacgen2-services Helm chart, application properties can be changed by editing the corresponding config map. - - -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| Config map name | Description | -+======================================================+=====================================================================================================+ -| dcae-ves-collector-application-config-configmap | Defines a content of the /app-config/application_config.yaml file. | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ -| dcae-ves-collector-filebeat-configmap | Defines a content of the /usr/share/filebeat/filebeat.yml file. | -+------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ - Properties configuration via Helm chart overrides ------------------------------------------------- diff --git a/docs/sections/services/ves-hv/architecture.rst b/docs/sections/services/ves-hv/architecture.rst index e71bf6a3..4634f131 100644 --- a/docs/sections/services/ves-hv/architecture.rst +++ b/docs/sections/services/ves-hv/architecture.rst @@ -7,7 +7,7 @@ High-level architecture of HV-VES ================================= HV-VES Collector is a part of DCAEGEN2. Its goal is to collect data from xNF (PNF/VNF) and put the data on a given Kafka topic. -High Volume Collector is deployed with DCAEGEN2 via OOM Helm charts and Cloudify blueprints. +High Volume Collector is deployed with DCAEGEN2 via OOM Helm charts. Input messages come from TCP interface and Wire Transfer Protocol. Each frame includes Google Protocol Buffers (GPB) encoded payload. Based on information provided in CommonEventHeader, domain messages are validated and published to specific Kafka topic. diff --git a/docs/sections/services/ves-hv/installation.rst b/docs/sections/services/ves-hv/installation.rst deleted file mode 100644 index 4b7eb238..00000000 --- a/docs/sections/services/ves-hv/installation.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. _installation: - -HV-VES Cloudify Installation -============================ - -Starting from ONAP/Honolulu release, HV-VES is installed with a DCAEGEN2-Services Helm charts. -This installation mechanism is convenient, but it doesn`t support all HV-VES features (e.g. CMP v2 certificates, and IPv4/IPv6 dual stack networking). This description demonstrates, how to deploy HV-VES collector using Cloudify orchestrator. - -Setting insecure mode for testing ---------------------------------- - -HV-VES application is configured by default to use TLS/SSL encryption on TCP connection. - -Accessing bootstrap container with Kubernetes command line tool ---------------------------------------------------------------- - -To find bootstrap pod, execute the following command: - -:: - - kubectl -n <onap namespace> get pods | grep bootstrap - -To run command line in bootstrap pod, execute: - -:: - - kubectl -n <onap namespace> exec -it <bootstrap-pod-name> bash - - -Install HV-VES collector using Cloudify blueprint inputs ---------------------------------------------------------- - -1. If You have a running HV-VES instance, uninstall HV-VES and delete current deployment: - -:: - - cfy executions start -d hv-ves uninstall - cfy deployments delete hv-ves - -2. Create new deployment with inputs from yaml file (available by default in bootstrap container): - -:: - - cfy deployments create -b hv-ves -i inputs/k8s-hv_ves-inputs.yaml hv-ves - -In order to disable the TLS security, override the 'secuirty_ssl_disable' value in the deloyment: - -:: - - cfy deployments create -b hv-ves -i inputs/k8s-hv_ves-inputs.yaml -i security_ssl_disable=True hv-ves - -To verify inputs, You can execute: - -:: - - cfy deployments inputs hv-ves - -3. Install HV-VES deployment: - -:: - - cfy executions start -d hv-ves install - - -Using external TLS certificates obtained using CMP v2 protocol --------------------------------------------------------------- - -In order to use the X.509 certificates obtained from the CMP v2 server (so called "operator`s certificates"), refer to the following description: - -.. toctree:: - :maxdepth: 1 - - Enabling TLS with external x.509 certificates <../../tls_enablement> diff --git a/docs/sections/services/ves-hv/run-time-configuration.rst b/docs/sections/services/ves-hv/run-time-configuration.rst index 830ed664..4da0b10d 100644 --- a/docs/sections/services/ves-hv/run-time-configuration.rst +++ b/docs/sections/services/ves-hv/run-time-configuration.rst @@ -48,7 +48,4 @@ For more information, see :ref:`supported_domains`. Providing configuration during OOM deployment --------------------------------------------- -The configuration is created from HV-VES Cloudify blueprint by specifying **application_config** node during ONAP OOM/Kubernetes deployment. Example of the node specification: - -.. literalinclude:: resources/blueprint-snippet.yaml - :language: yaml +The configuration is created from HV-VES Helm charts defined under **applicationConfig** during ONAP OOM/Kubernetes deployment. diff --git a/docs/sections/services/ves-hv/troubleshooting.rst b/docs/sections/services/ves-hv/troubleshooting.rst index 36510355..c7b6a291 100644 --- a/docs/sections/services/ves-hv/troubleshooting.rst +++ b/docs/sections/services/ves-hv/troubleshooting.rst @@ -213,7 +213,6 @@ They can be changed by specifying ``security.keys.trustStore`` or ``security.key For testing purposes there is possibility to use plain TCP protocol. In order to do this navigate with your browser to consul-ui service and than pick KEY/VALUE tab. Select dcae-hv-ves-collector and change ``security.sslDisable`` to true. Update of configuration should let start TCP server without SSL/TLS configured. -In order to disable TLS/SSL by overriding Cloudify blueprint inputs, see :ref:`running_insecure`. ==== diff --git a/docs/sections/user_guide.rst b/docs/sections/user_guide.rst deleted file mode 100644 index f985fc31..00000000 --- a/docs/sections/user_guide.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. _userguide: - -User Guide -========== - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ./design-components/DCAE-MOD/DCAE-MOD-User-Guide.rst -
\ No newline at end of file |
