diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.rst | 4 | ||||
| -rw-r--r-- | docs/cps-path.rst | 5 | ||||
| -rw-r--r-- | docs/deployment.rst | 19 |
3 files changed, 17 insertions, 11 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/cps-path.rst b/docs/cps-path.rst index e8a75d9cf0..fba21f38c6 100644 --- a/docs/cps-path.rst +++ b/docs/cps-path.rst @@ -234,12 +234,15 @@ leaf-conditions - ``//categories[@name="Kids"]`` - ``//categories[@name='Kids']`` - ``//categories[@code='1']/books/book[@title='Dune' and @price=5]`` - + - ``//categories[@code=1]`` **Limitations** - Only the last list or container can be queried leaf values. Any ancestor list will have to be referenced by its key name-value pair(s). - Multiple attributes can only be combined using ``and``. ``or`` and bracketing is not supported. - Only leaves can be used, leaf-list are not supported. - Only string and integer values are supported, boolean and float values are not supported. + - The key should be supplied with correct data type for it to be queried from DB. In the last example above the attribute code is of type + Integer so the cps query will not work if the value is passed as string. + eg: ``//categories[@code="1"]`` or ``//categories[@code='1']`` will not work because the key attribute code is treated a string. **Notes** - For performance reasons it does not make sense to query using key leaf as attribute. If the key value is known it is better to execute a get request with the complete xpath. diff --git a/docs/deployment.rst b/docs/deployment.rst index 46160c4f76..06e1ddcc08 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -203,26 +203,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 | ``<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="...";``, | | @@ -230,18 +233,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 | | |