summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/pm-mapper
diff options
context:
space:
mode:
authorVijay Venkatesh Kumar <vv770d@att.com>2022-10-26 13:49:38 -0400
committerVijay Venkatesh Kumar <vv770d@att.com>2022-10-26 13:50:12 -0400
commit39479a850807e840ff08d1fcf4b01a04ba334e05 (patch)
tree2c8b20629a4f36c5efba7a61510bce3669b736d7 /docs/sections/services/pm-mapper
parentdcfec1a95f0a4f605ac64833b59e39a0b584daa9 (diff)
DCAE Kohn rls note updates
Third pass Removed all cloudify install steps + Misc fixes for issues noted on https://gerrit.onap.org/r/c/dcaegen2/+/131680 Change-Id: I825717d7ef42cc7b008c613956ca20b8393f5366 Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Issue-ID: DCAEGEN2-3236 Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
Diffstat (limited to 'docs/sections/services/pm-mapper')
-rw-r--r--docs/sections/services/pm-mapper/index.rst1
-rw-r--r--docs/sections/services/pm-mapper/installation.rst62
2 files changed, 0 insertions, 63 deletions
diff --git a/docs/sections/services/pm-mapper/index.rst b/docs/sections/services/pm-mapper/index.rst
index d8834b18..97712762 100644
--- a/docs/sections/services/pm-mapper/index.rst
+++ b/docs/sections/services/pm-mapper/index.rst
@@ -13,7 +13,6 @@
./architecture.rst
./delivery.rst
./logging.rst
- ./installation.rst
./installation-helm.rst
./configuration.rst
./troubleshooting.rst
diff --git a/docs/sections/services/pm-mapper/installation.rst b/docs/sections/services/pm-mapper/installation.rst
deleted file mode 100644
index cf7f972e..00000000
--- a/docs/sections/services/pm-mapper/installation.rst
+++ /dev/null
@@ -1,62 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. _pm-mapper-installation:
-
-Cloudify Installation
-=====================
-
-PM mapper is a microservice that will be configured and instantiated through Cloudify Manager, either through the user
-interface or the command line tool. During instantiation, the PM Mapper will fetch its configuration through the Config Binding Service. Steps to deploy using the CLI tool are shown below.
-
-Deployment Prerequisite/dependencies
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
- - DCAE and DMaaP pods should be up and running.
- - DMaaP Bus Controller post install jobs should have completed successfully (executed as part of an OOM install).
- - Make sure that cfy is installed and configured to work with the Cloudify deployment.
-
-Deployment steps
-^^^^^^^^^^^^^^^^
-
-Enter the Cloudify Manager kuberenetes pod
-
- - Download the PM Mapper blueprint onto the pod, this can be found in:
-
- https://git.onap.org/dcaegen2/services/pm-mapper/tree/dpo/blueprints/k8s-pm-mapper.yaml
-
- - Create inputs.yaml
-
- Configuration of the service consists of generating an inputs file (YAML) which will be used as part of the
- Cloudify install. The PM-Mapper blueprints were designed with sane defaults for the majority of the fields.
- Below you will find some examples of fields which can be configured, and some of the fields
- which must be configured. The full list of configurable parameters can be seen within the blueprint file under
- "inputs".
-
- .. csv-table::
- :widths: auto
- :delim: ;
- :header: Property , Sample Value , Description , Required
-
- client_id ; dcae@dcae.onap.org ; Information about the AAF user must be provided to enable publishing to authenticated topics. ; Yes
- client_password ; <dcae_password> ; This is the password for the given user e.g. The <dcae_password> is dcae@dcae.onap.org's password. ; Yes
- enable_http ; true ; By default, the PM-Mapper will only allow inbound queries over HTTPS. However, it is possible to configure it to enable HTTP also. ; No
- tag_version ; nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:1.0.1 ; The tag of the Docker image will be used when deploying the PM-Mapper. ; No
- pm-mapper-filter ; {"filters": [{"pmDefVsn":"targetVersion", "nfType":"targetNodeType", "vendor":"targetVendor","measTypes":["targetMeasType"]}]} ; The default behavior of the PM-Mapper is to map all measType in the received PM XML files, however, it's possible to provide filtering configuration which will reduce the VES event to the counters that the designer has expressed interest in. ; No
-
- Example inputs.yaml
-
- .. code-block:: yaml
-
- client_id: dcae@dcae.onap.org
- client_password: <dcae_password>
- enable_http: false
- tag_version: nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.pm-mapper:latest
- pm-mapper-filter: {"filters": []}
-
-
-
- - Create deployment
-
- .. code-block:: bash
-
- cfy install --blueprint-id pm-mapper --deployment-id pm-mapper -i inputs.yaml k8s-pm-mapper.yaml