summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorefiacor <fiachra.corcoran@est.tech>2022-03-15 11:26:46 +0000
committerefiacor <fiachra.corcoran@est.tech>2022-03-15 11:26:57 +0000
commitb869181fae9a688fa517ecb43a30b8331b82ccdc (patch)
tree8d0b8e1f5606041dbf7264fe213f0d78f590312a /docs
parente1f41c3e6591b572a75021f4b51538f8fdbfc88d (diff)
[STRIMZI] Add strimzi kafka notes
Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: Id85d2708bdb2eb1ddfaa72740a5a9df5599f298b Issue-ID: DMAAP-1681
Diffstat (limited to 'docs')
-rw-r--r--docs/architecture.rst4
-rw-r--r--docs/deployment.rst19
2 files changed, 13 insertions, 10 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst
index 26a8c63b52..acde1b1cae 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -61,9 +61,9 @@ Configuration Persistence Service provides the following interfaces.
* - CPS-E-04
- Change Notification
- - Kafka is used as the event messaging system
- - running instance is supplied independently from ONAP DMaaP component or any Kafka instance deployed from ONAP
+ - running instance is supplied independently from any Kafka instance deployed from ONAP
- published events contain Timestamp, Dataspace, Schema set, Anchor and JSON Data Payload
- - DMaaP
+ - Kafka
* - CPS-E-05
- xNF Data Access
- - read xNF data
diff --git a/docs/deployment.rst b/docs/deployment.rst
index 2f68a64ee1..6f450c1230 100644
--- a/docs/deployment.rst
+++ b/docs/deployment.rst
@@ -201,26 +201,29 @@ exhaustive.
| 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 | ``<kafka-bootstrap>: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="...";``, | |
@@ -228,18 +231,18 @@ exhaustive.
| | * ``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 | |