X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeployment.rst;h=7dd4494f277c845b16b263840f9d95d80745a103;hb=f16b9614298e7f0a820435f2dab2a856b487bf45;hp=46160c4f768d5bf75e16fc430b674deb65b1f765;hpb=41897f6465b534eaac4b960bba6f4491ea4d9d15;p=cps.git diff --git a/docs/deployment.rst b/docs/deployment.rst index 46160c4f7..7dd4494f2 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -157,8 +157,10 @@ To get a listing of the cps-core Pods, run the following command: dev-cps-core-postgres-primary-f7766d46c-s9d5b 1/1 Running 0 24h dev-cps-core-postgres-replica-84659d68f9-6qnt4 1/1 Running 0 24h +.. note:: + The CPS Service will have to be restarted each time a change is made to a configurable property. -Additional Cps-Core Customizations +Additional CPS-Core Customizations ================================== The following table lists some properties that can be specified as Helm chart @@ -181,14 +183,6 @@ Any spring supported property can be configured by providing in ``config.additio | | | | | | See also :ref:`cps_common_credentials_retrieval`. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.dmiPluginUserName | User name used by cps-core to authenticate themselves for using ncmp-dmi-plugin service. | ``dmiuser`` | -+---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.dmiPluginUserPassword | Internal password used by cps-core to connect to ncmp-dmi-plugin service. | Not defined | -| | | | -| | If not defined, the password is generated when deploying the application. | | -| | | | -| | See also :ref:`cps_common_credentials_retrieval`. | | -+---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | postgres.config.pgUserName | Internal user name used by cps-core to connect to its own database. | ``cps`` | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | postgres.config.pgUserPassword | Internal password used by cps-core to connect to its own database. | Not defined | @@ -203,26 +197,29 @@ Any spring supported property can be configured by providing in ``config.additio | logging.level | Logging level set in cps-core | info | | | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka hostname and port | ``message-router-kafka:9092`` | +| config.useStrimziKafka | If targeting a custom kafka cluster, ie useStrimziKakfa: false, the config.eventPublisher.spring.kafka | true | +| | values must be set. | | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.eventPublisher. | Kafka hostname and port | ``:9092`` | | spring.kafka.bootstrap-servers | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | config.eventPublisher. | Kafka consumer client id | ``cps-core`` | | spring.kafka.consumer.client-id | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.publisher. | Kafka security protocol. | ``PLAINTEXT`` | +| config.eventPublisher. | Kafka security protocol. | ``SASL_PLAINTEXT`` | | spring.kafka.security.protocol | Some possible values are: | | | | | | | | * ``PLAINTEXT`` | | | | * ``SASL_PLAINTEXT``, for authentication | | | | * ``SASL_SSL``, for authentication and encryption | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.publisher. | Kafka security SASL mechanism. Required for SASL_PLAINTEXT and SASL_SSL protocols. | Not defined | +| config.eventPublisher. | Kafka security SASL mechanism. Required for SASL_PLAINTEXT and SASL_SSL protocols. | Not defined | | spring.kafka.properties. | Some possible values are: | | | sasl.mechanism | | | | | * ``PLAIN``, for PLAINTEXT | | | | * ``SCRAM-SHA-512``, for SSL | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.publisher. | Kafka security SASL JAAS configuration. Required for SASL_PLAINTEXT and SASL_SSL protocols. | Not defined | +| config.eventPublisher. | Kafka security SASL JAAS configuration. Required for SASL_PLAINTEXT and SASL_SSL protocols. | Not defined | | spring.kafka.properties. | Some possible values are: | | | sasl.jaas.config | | | | | * ``org.apache.kafka.common.security.plain.PlainLoginModule required username="..." password="...";``, | | @@ -230,18 +227,18 @@ Any spring supported property can be configured by providing in ``config.additio | | * ``org.apache.kafka.common.security.scram.ScramLoginModule required username="..." password="...";``, | | | | for SSL | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.publisher. | Kafka security SASL SSL store type. Required for SASL_SSL protocol. | Not defined | +| config.eventPublisher. | Kafka security SASL SSL store type. Required for SASL_SSL protocol. | Not defined | | spring.kafka.ssl.trust-store-type | Some possible values are: | | | | | | | | * ``JKS`` | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.publisher. | Kafka security SASL SSL store file location. Required for SASL_SSL protocol. | Not defined | +| config.eventPublisher. | Kafka security SASL SSL store file location. Required for SASL_SSL protocol. | Not defined | | spring.kafka.ssl.trust-store-location | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.publisher. | Kafka security SASL SSL store password. Required for SASL_SSL protocol. | Not defined | +| config.eventPublisher. | Kafka security SASL SSL store password. Required for SASL_SSL protocol. | Not defined | | spring.kafka.ssl.trust-store-password | | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.publisher. | Kafka security SASL SSL broker hostname identification verification. Required for SASL_SSL protocol. | Not defined | +| config.eventPublisher. | Kafka security SASL SSL broker hostname identification verification. Required for SASL_SSL protocol. | Not defined | | spring.kafka.properties. | Possible value is: | | | ssl.endpoint.identification.algorithm | | | | | * ``""``, empty string to disable | | @@ -284,6 +281,22 @@ Any spring supported property can be configured by providing in ``config.additio | maximumPoolSize | including both idle and in-use connections. | | +---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +Additional CPS-NCMP Customizations +================================== ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.dmiPluginUserName | User name used by cps-core to authenticate themselves for using ncmp-dmi-plugin service. | ``dmiuser`` | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.dmiPluginUserPassword | Internal password used by cps-core to connect to ncmp-dmi-plugin service. | Not defined | +| | | | +| | If not defined, the password is generated when deploying the application. | | +| | | | +| | See also :ref:`cps_common_credentials_retrieval`. | | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ +| config.timers.advised-modules-sync | Specifies the delay in milliseconds in which the module sync watch dog will wake again after finishing. | ``30000`` | +| .sleep-time-ms | | | +| | | | ++---------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ + CPS-Core Docker Installation ============================