Configuration

The ECR 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.

General service configuration

ECR uses a standard Spring Boot server.port property to configure the port to expose the REST API at.

server:
  port: <unsigned short integer>   # Server port used to expose the REST API at

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. Alternatively, the application-specific configuration can be sourced from Kaa Tekton. See the Tekton configuration section to find out how to configure such integration.

kaa:
  applications:
    <application 1 name>:                     # Kaa application name
      endpoint-configuration:           
        schema-required: <boolean>            # Whether an endpoint configuration schema is required for the application
        schema:                               # Endpoint configuration schema per application
      versions: 
        <application 1 version 1 name>:       # Kaa application version name
           endpointConfigurationSchema:       # Endpoint configuration schema per application version name

Tekton

ECR supports integration with Kaa Tekton for centralized application configuration management. The below configuration options set up the integration interface.

kaa:
  tekton:
    enabled: <boolean>    # Enables Tekton integration. False by default. Also can be set with the KAA_TEKTON_ENABLED environment variable.
    url: <string>         # URL of the Tekton service. "http://tekton" by default. Also can be set with the KAA_TEKTON_URL environment variable.
  scmp.consumer:
    provider.service-instance.name: <string>  # Service instance name of the Tekton service. "tekton" by default. Also can be set with the KAA_SCMP_CONSUMER_PROVIDER_SERVICE_INSTANCE_NAME environment variable. 

Endpoint register interface

Use the below parameters to configure the REST-based endpoint register interface ECR uses to validate that EP ID exists and to listen to EP unregistered events.

kaa:
  ecr:
    ep-register:
      base-url: <URL>                  # Base URL of the endpoint register REST API
      service-instance:
        name: <service instance name>  # Instance name of the endpoint register

Configuration data transport interface

Use the following options to configure the configuration data transport interface.

kaa:
  ecr:
    configuration-consumer:
      service-instance:
        name: <service instance name>  # Name of the configuration data consumer service instance ECR will subscribe to.

Data persistence interface

ECR uses Spring Data MongoDB configuration. Refer to the corresponding documentation for the list of supported configuration options.

Note that for security reasons username and password must be sourced from the environment variables.

NATS

The below parameters configure ECR’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
  request-timeout: <unsigned integer>                  # How long to wait for a response message (in msec). Default is 10000.
  concurrency:
    max-threads: <unsigned integer>                    # The maximum number of threads to read and process incoming messages. Default is 50.
    core-pool-size: <unsigned integer>                 # The number of threads to keep in the pool, even if they are idle. Default is 3.
    keep-alive-time-millis: <unsigned integer>         # When the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating. Default is 10000.

Authentication, authorization, and multi-tenancy

Authentication and authorization is handled within the scope of a given Kaa tenant. Each tenant has a separate OAuth 2.0 issuer, managed by [the Kaa Tenant Manager][Tenant Manager]. When multi-tenancy is disabled, all authentication and authorization is conducted in the default system tenant (“kaa”).

ECR security is controlled with the following configuration options (for security reasons it is advised to set these via environment variables).

kaa:
  security:
    enabled: <boolean>       # Enables authentication and authorization. False by default.
    issuer: 
      public-url: <string>   # OAuth 2.0 issuer public URL for the system tenant ("kaa").
      private-url: <string>  # OAuth 2.0 issuer private URL for the system tenant ("kaa").
    client-id: <string>      # Client ID for making requests in the system tenant scope.
    client-secret: <string>  # Client secret for making requests in the system tenant scope.

    multitenancy:
      enabled: <boolean>    # Enables multitenancy via integration with the Kaa Tenant Manager. Only effective when kaa.security.enabled is set to true. False by default.
      tenant-manager:
        url: <string>       # URL of the Kaa Tenant Manager that provides security configurations for tenants. "http://tenant-manager" by default.

Authorization disabling

It is possible to disable authorization on ECR’s REST API endpoints. In such a case only authentication will be applied.

The below parameter disables authorization.

kaa:
  security:  
    authz:
      disabled: <boolean>  # Disables authorization.

NOTE Authorization disabling may significantly improve ECR’s REST API response time depending on the particular REST API endpoint since it disables the permission evaluation on the resource server.

Management

ECR 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, ECR 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, ECR 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

server:
  port: 80

kaa:
  ecr:
    ep-register:
      base-url: http://epr
      service-instance:
        name: epr
    configuration-consumer:
      service-instance:
        name: cmx
  security:
    oauth.client:
      enabled: false          

nats:
  urls: nats://nats:4222
  requestTimeout: 10000
  concurrency:
    max-threads: 50
    core-pool-size: 3
    keep-alive-time-millis: 10000

management:
  server:
    port: 8080
  endpoint:
    health:
      enabled: true
      show-details: always
      status:
        http-mapping:
          UNKNOWN: SERVICE_UNAVAILABLE
    shutdown:
      enabled: true
    metrics:
      enabled: true
  endpoints:
    web:
      base-path: /
      exposure:
        include: info,health,metrics
        
spring:
  data:
    mongodb:
      database: ecr
      uri: mongodb://mongodb:27017/ecr
      username: ${mongodb.username:}
      password: ${mongodb.password:password}
      threads-allowed-to-block-for-connection-multiplier: 5
      connections-per-host: 100
      max-wait-time: 120000
      connection-timeout: 5000
      socket-timeout: 0