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/services | |
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/services')
17 files changed, 368 insertions, 528 deletions
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`. ==== |