| shivasubedi | 3d1579c | 2021-09-13 16:43:20 +0100 | [diff] [blame] | 1 | .. 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 | |
| DylanB95EST | 7f1fa6d | 2021-10-11 16:33:29 +0100 | [diff] [blame^] | 9 | DMI-Plugin Deployment |
| shivasubedi | 3d1579c | 2021-09-13 16:43:20 +0100 | [diff] [blame] | 10 | ##################### |
| 11 | |
| shivasubedi | 3d1579c | 2021-09-13 16:43:20 +0100 | [diff] [blame] | 12 | .. toctree:: |
| niamhcore | 2be4663 | 2021-10-07 15:43:13 +0100 | [diff] [blame] | 13 | :maxdepth: 1 |
| 14 | |
| 15 | Deployment |
| 16 | ========== |
| 17 | |
| 18 | Refer to `CPS Deployment <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_ |
| DylanB95EST | 7f1fa6d | 2021-10-11 16:33:29 +0100 | [diff] [blame^] | 19 | page for deployment documentation related to DMI-Plugin and all CPS components. |
| niamhcore | 2be4663 | 2021-10-07 15:43:13 +0100 | [diff] [blame] | 20 | |
| DylanB95EST | 7f1fa6d | 2021-10-11 16:33:29 +0100 | [diff] [blame^] | 21 | Additional DMI-Plugin Core Customisations |
| niamhcore | 2be4663 | 2021-10-07 15:43:13 +0100 | [diff] [blame] | 22 | ========================================= |
| 23 | |
| 24 | Application Properties |
| 25 | ---------------------- |
| 26 | |
| 27 | The following table lists properties that can be specified as helm chart |
| 28 | values 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. | | |
| 37 | | | See also `Credentials Retrieval <https://docs.onap.org/projects/onap-cps/en/latest/deployment.html>`_ | | |
| 38 | +---------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------+ |
| 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 | |
| DylanB95EST | 7f1fa6d | 2021-10-11 16:33:29 +0100 | [diff] [blame^] | 54 | DMI-Plugin Docker Installation |
| niamhcore | 2be4663 | 2021-10-07 15:43:13 +0100 | [diff] [blame] | 55 | ============================== |
| 56 | |
| 57 | 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 |
| 58 | services. |
| 59 | Latest instructions are covered in the `README <https://github.com/onap/cps-ncmp-dmi-plugin/blob/master/docker-compose/README.md>`_ |