Configuration
The KDCA loads configuration data from a file (typically backed by a Kubernetes config map). If the service is unable to retrieve the configuration data, it will not start. Refer to the configuration for details.
Service configuration structure
The recommended configuration format is YAML. The below sections describe the officially supported configuration options that influence various aspects of the service functionality. The service may support options other than the ones listed below, but those are not a part of the public API and may be changed or deleted at any time.
Data samples transmitter
Use the following options to configure the data samples transmission interface
kaa:
kdca:
data-transmitters:
dstp-transmitters:
service-instance:
# Name of the data samples transmission service instance kdca will subscribe to.
name: <service instance name>
For further details explore Spring Boot Kafka configuration properties.
Kaa applications
Many Kaa services can be configured for different behavior depending on the application version of the endpoint the processed data relates to.
This is called appversion-specific behavior and is handled in service configurations under kaa.applications
. Despite KDCA currently does not support any appversion-specific configurations, it uses the application and appversion names to validate the API calls and protocols data.
kaa:
applications:
<application 1 name>: # Kaa application name
versions:
<application 1 version 1 name>: # Kaa application version name
Kafka
Use the following options to specify destination Kafka topic which KDCA will use for publishing data samples to.
spring:
kafka:
producer:
bootstrap-servers: <bootstrap servers list> # A comma-separated list of Kafka brokers.
retries: <num of retries> # When greater than zero, enables retrying of failed sends.
template:
default-topic: <topic> # Kafka topic to produce data samples to.
admin:
fail-fast: <boolean> # Whether to fail fast if the broker is not available on startup.
NATS
The below parameters configure KDCA’s connection to NATS.
NOTE For security, reasons NATS username and password are sourced from the environment variables.
nats:
urls: <comma separated list of URL> # NATS connection URLs
Management
KDCA monitoring and management implementation is based on the Spring Boot Actuator. Refer to the corresponding documentation for the list of supported configuration options.
Logging
By default, KDCA uses Spring Boot logging configuration with logback for logging. Refer to the corresponding documentation for the list of supported configuration options.
Built-in configuration profiles
For your convenience, KDCA comes with a default built-in configuration profile.
Built-in profile is optimized for a Kubernetes-based production deployment. It does not define any Kaa applications—you have to configure those for any specific Kaa-based solution.
Default
nats:
urls: nats://nats:4222
management:
server:
port: 8080
endpoint:
shutdown:
enabled: true
endpoints:
web:
base-path: /
spring:
jackson:
default-property-inclusion: NON_NULL
time-zone: GMT
serialization:
WRITE_DATES_AS_TIMESTAMPS: false
deserialization:
FAIL_ON_UNKNOWN_PROPERTIES: false
kafka:
producer:
bootstrap-servers: kafka:9092
value-serializer: org.springframework.kafka.support.serializer.JsonSerializer
key-serializer: org.springframework.kafka.support.serializer.JsonSerializer
admin:
fail-fast: true
kaa:
kdca:
data-transmitters:
dstp-transmitters:
service-instance:
name: dcx