summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/restconf
diff options
context:
space:
mode:
authorVijay Venkatesh Kumar <vv770d@att.com>2023-03-02 18:43:34 -0500
committerVijay Venkatesh Kumar <vv770d@att.com>2023-03-03 10:05:15 -0500
commita6f72a8f1c7bd93ca5916cd73d4226208ff469d3 (patch)
tree84acba64b6bf83c818fa07cdd72ed2181e112ccc /docs/sections/services/restconf
parent74d53a77e5d74c921cfbc034a01f2cbf08e102a4 (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/restconf')
-rw-r--r--docs/sections/services/restconf/installation-helm.rst72
-rw-r--r--docs/sections/services/restconf/installation.rst61
2 files changed, 72 insertions, 61 deletions
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