CPS Temporal Deployment
Deployment
Refer to CPS-Deployment page for deployment documentation related to CPS Temporal and all CPS components.
Once CPS Temporal is successfully deployed and running 2 pods are started, one for running the service and another one for running the database instance:
NAME READY STATUS RESTARTS AGE
cps-temporal-d4cf495b9-bbn7b 1/1 Running 0 8h
cps-temporal-db-0 1/1 Running 0 8h
Configuration
Application Properties
The following table lists some properties that can be specified as Helm chart values to configure the application to be deployed. This list is not exhaustive.
Property |
Description |
Default Value |
---|---|---|
config.appUserName |
User name used by CPS Temporal service to configure the authentication for REST API it exposes. This is the user name to be used by CPS Temporal REST clients to authenticate themselves. |
|
config.appUserPassword |
Password used by CPS Temporal service to configure the authentication for REST API it exposes. This is the password to be used by CPS Temporal REST clients to authenticate themselves. If not defined, the password is generated when deploying the application. See also CPS Credentials Retrieval |
Not defined |
timescaledb.config.pgUserName |
Internal user name used bt CPS Temporal to connect to its own database. |
|
timescaledb.config.pgUserPassword |
Internal password used bt CPS Temporal to connect to its own database. If not defined, the password is generated when deploying the application. See also Credentials section. |
Not defined |
config.eventConsumption. spring.kafka.bootstrap-servers |
Kafka hostname and port |
|
config.eventConsumption. spring.kafka.consumer.group-id |
Kafka consumer group id |
|
config.eventConsumption. app.listener.data-updated.topic |
Kafka topic to listen to |
|
config.eventConsumption. spring.kafka.security.protocol |
Kafka security protocol. Some possible values are:
|
|
config.eventConsumption. spring.kafka.properties. sasl.mechanism |
Kafka security SASL mechanism. Required for SASL_PLAINTEXT and SASL_SSL protocols. Some possible values are:
|
Not defined |
config.eventConsumption. spring.kafka.properties. sasl.jaas.config |
Kafka security SASL JAAS configuration. Required for SASL_PLAINTEXT and SASL_SSL protocols. Some possible values are:
|
Not defined |
config.eventConsumption. spring.kafka.ssl.trust-store-type |
Kafka security SASL SSL store type. Required for SASL_SSL protocol. Some possible values are:
|
Not defined |
config.eventConsumption. spring.kafka.ssl.trust-store-location |
Kafka security SASL SSL store file location. Required for SASL_SSL protocol. |
Not defined |
config.eventConsumption. spring.kafka.ssl.trust-store-password |
Kafka security SASL SSL store password. Required for SASL_SSL protocol. |
Not defined |
config.eventConsumption. spring.kafka.properties. ssl.endpoint.identification.algorithm |
Kafka security SASL SSL broker hostname identification verification. Required for SASL_SSL protocol. Possible value is:
|
Not defined |
config.additional. app.query.response.max-page-size |
Maximum number of elements that can be retrieved by a single REST API query request using pagination feature. |
|
config.additional. spring.datasource.hikari. maximumPoolSize |
Maximum number of database connections in the connection pool. |
|
Credentials
- Once the deployment is completed, refer to CPS Credentials Retrieval
for more information related to credentials retrieval.
Running With Docker
For development purposes, CPS Temporal can be ran on any environment using Docker. Refer to README.md and docker-compose.yml files for more details.