blob: 0d7b1031dffb617e032f3f9b2fd5d3363090f2d9 [file] [log] [blame]
shivasubedi3d1579c2021-09-13 16:43:20 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright (C) 2021 Nordix Foundation
4
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _deployment:
7
8
DylanB95EST7f1fa6d2021-10-11 16:33:29 +01009DMI-Plugin Deployment
shivasubedi3d1579c2021-09-13 16:43:20 +010010#####################
11
shivasubedi3d1579c2021-09-13 16:43:20 +010012.. toctree::
niamhcore2be46632021-10-07 15:43:13 +010013 :maxdepth: 1
14
15Deployment
16==========
17
ToineSiebelinkb84eea22021-10-21 13:37:33 +010018Refer to :ref:`CPS-Deployment<onap-cps:deployment>`
DylanB95EST7f1fa6d2021-10-11 16:33:29 +010019page for deployment documentation related to DMI-Plugin and all CPS components.
niamhcore2be46632021-10-07 15:43:13 +010020
DylanB95EST7f1fa6d2021-10-11 16:33:29 +010021Additional DMI-Plugin Core Customisations
niamhcore2be46632021-10-07 15:43:13 +010022=========================================
23
24Application Properties
25----------------------
26
27The following table lists properties that can be specified as helm chart
28values to configure for the application being deployed. This list is not exhaustive.
29
30+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
31| Property | Description | Default Value |
32+=======================================+=============================================================================================================+=================================================+
33| config.appUserName | User name used by the DMI-Plugin to authenticate users for the REST APIs that it exposes. | ``ncmpuser`` |
34+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
35| config.appUserPassword | Password used by the DMI-Plugin to authenticate users for the REST APIs that it exposes. | Not defined |
36| | If not defined, the password is generated when deploying the application. | |
ToineSiebelinkb84eea22021-10-21 13:37:33 +010037| | See also :ref:`CPS Credentials Retrieval<onap-cps:cps_common_credentials_retrieval>` | |
niamhcore2be46632021-10-07 15:43:13 +010038+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
39| config.dmiServiceName | DMI-Plugin hostname and port. | Not defined |
40+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
41| config.cpsCore.username | Internal user name used by DMI-Plugin to connect to the CPS-Core service. | ``cpsuser`` |
42+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
43| config.cpsCore.password | Internal password used by DMI-Plugin to connect to CPS-Core service. | Not defined |
44+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
45| config.sdnc.url | SDNC host name and port. | ``http://sdnc:8181`` |
46+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
47| config.sdnc.username | Internal user name used by DMI-Plugin to connect to the SDNC. | ``admin`` |
48+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
49| config.sdnc.Password | Internal password used by DMI-Plugin to connect to the SDNC. | ``Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U`` |
50+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
51| config.sdnc.topologyId | SDNC topology Id. | ``topology-netconf`` |
52+---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+
53
DylanB95EST7f1fa6d2021-10-11 16:33:29 +010054DMI-Plugin Docker Installation
niamhcore2be46632021-10-07 15:43:13 +010055==============================
56
57DMI-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
58services.
ToineSiebelinkb84eea22021-10-21 13:37:33 +010059Latest instructions are covered in the `README <https://github.com/onap/cps-ncmp-dmi-plugin/blob/master/docker-compose/README.md>`_