- Service configuration structure
- Built-in configuration profiles
WARNING: This service is deprecated and will be removed in the platform version 1.2.0. Use the CEX instead.
The RCI 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
RCI uses a standard Spring Boot
server.port property to configure the port to expose the REST API at.
The service-specific configuration properties are located under
server: port: <port> # Server port is used to expose the REST API at kaa: rci: commands: read-timeout: <timeout> # Read timeout is used for connection termination in case of command invocation suspension
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 RCI 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
Command invocation interface
Use the below parameters to configure the NATS-based command invocation interface RCI uses to invoke commands on.
kaa: rci: command-invocation-agent: service-instance: name: <service instance name> # Instance name of command invocation agent.
The below parameters configure RCI’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
RCI monitoring and management implementation is based on the Spring Boot Actuator. Refer to the corresponding documentation for the list of supported configuration options.
Authentication and authorization
RCI REST API protection is controlled with the following configuration options:
security: ignored: <value> # Controls authentication and authorization on REST API endpoints. # Possible values: '/**' to disable security or 'none' to enable. oauth2: client: clientId: <clientId> # Client ID on whose behalf the requests will be made. clientSecret: <secret> # Client secret on whose behalf the requests will be made. accessTokenUri: <URI> # An OAuth2-compliant Token Endpoint for obtaining tokens via the 'Implicit Flow', # 'Direct Grants', or 'Client Grants'. # E.g. "https://your-url-to-auth-server/auth/realms/realm-a/protocol/openid-connect/token" resourceUri: <URI> # An UMA-compliant Resource Registration Endpoint which resource servers can use # to manage their protected resources and scopes. # E.g. "https://your-url-to-auth-server/auth/realms/realm-a/authz/protection/resource_set" resource: userInfoUri: <URI> # URL endpoint for the User Info service described in the OIDC specification. # E.g. "https://your-url-to-auth-server/auth/realms/realm-a/protocol/openid-connect/userinfo"
Built-in configuration profiles
For your convenience, RCI 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.
server: port: 80 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 kaa: rci: command-invocation-agent: service-instance: name: cex commands: read-timeout: 3000