summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorniamhcore <niamh.core@est.tech>2021-10-07 15:43:13 +0100
committerniamhcore <niamh.core@est.tech>2021-10-11 15:19:58 +0100
commit2be46632693349d635a86eb5f12593a2b0a261f7 (patch)
tree999b183deaf40dd678eda0443364f09616fc87f4 /docs
parent6d76bfb77802e4526a267a033f812128528a2aa1 (diff)
Update Deployment Section of DMI Plugin
Update DMI Plugin Deployment page for Istanbul release Issue-ID: CPS-627 Change-Id: If2d02c689ddf28ae5f14229fe74b00ffcc8d7215 Signed-off-by: DylanB95EST <dylan.byrne@est.tech> Signed-off-by: niamhcore <niamh.core@est.tech>
Diffstat (limited to 'docs')
-rw-r--r--docs/deployment.rst50
1 files changed, 47 insertions, 3 deletions
diff --git a/docs/deployment.rst b/docs/deployment.rst
index 0f53898b..d8431139 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -9,7 +9,51 @@
DMI Plugin Deployment
#####################
-.. warning:: draft
-
.. toctree::
- :maxdepth: 1 \ No newline at end of file
+ :maxdepth: 1
+
+Deployment
+==========
+
+Refer to `CPS Deployment <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_
+page for deployment documentation related to DMI Plugin and all CPS components.
+
+Additional DMI Plugin Core Customisations
+=========================================
+
+Application Properties
+----------------------
+
+The following table lists properties that can be specified as helm chart
+values to configure for the application being deployed. This list is not exhaustive.
+
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| Property | Description | Default Value |
++=======================================+=============================================================================================================+=================================================+
+| config.appUserName | User name used by the DMI-Plugin to authenticate users for the REST APIs that it exposes. | ``ncmpuser`` |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| config.appUserPassword | Password used by the DMI-Plugin to authenticate users for the REST APIs that it exposes. | Not defined |
+| | If not defined, the password is generated when deploying the application. | |
+| | See also `Credentials Retrieval <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_ | |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| config.dmiServiceName | DMI-Plugin hostname and port. | Not defined |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| config.cpsCore.username | Internal user name used by DMI-Plugin to connect to the CPS-Core service. | ``cpsuser`` |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| config.cpsCore.password | Internal password used by DMI-Plugin to connect to CPS-Core service. | Not defined |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| config.sdnc.url | SDNC host name and port. | ``http://sdnc:8181`` |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| config.sdnc.username | Internal user name used by DMI-Plugin to connect to the SDNC. | ``admin`` |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| config.sdnc.Password | Internal password used by DMI-Plugin to connect to the SDNC. | ``Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U`` |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+| config.sdnc.topologyId | SDNC topology Id. | ``topology-netconf`` |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
+
+DMI Plugin Docker Installation
+==============================
+
+DMI-Plugin can also be installed in a docker environment. Latest `docker-compose <https://github.com/onap/cps-ncmp-dmi-plugin/blob/master/docker-compose/docker-compose.yml>`_ is included in the repo to start all the relevant
+services.
+Latest instructions are covered in the `README <https://github.com/onap/cps-ncmp-dmi-plugin/blob/master/docker-compose/README.md>`_ \ No newline at end of file