The most recent patch for this version is 26.2.1.  Learn more

Skip to main content
Version: 26.2

Configure ADS

All ADS configuration goes in deployment.yaml (or as environment variables). This file defines every parameter ADS needs at startup: the authorization domain and authentication method, logging, caching, and instance identity.

ADS reads deployment.yaml once at startup. To apply changes, stop the service, edit the file, and restart.

note

ADS is built on the Spring BootOpens in a new tab framework, which exposes many configuration properties beyond those covered here. Only properties explicitly documented in this guide are supported. Axiomatics assumes no responsibility for the use of any other Spring Boot configuration options.

License​

ADS requires a valid license file provided separately by Axiomatics.

info

This is mandatory. ADS does not start without a valid license file.

Set the license property in deployment.yaml to the path or URL of your license file:

license: file:<path_to_file>/axiomatics_ADS.license

Supported path formats​

FormatDescription
dir/axiomatics_ADS.licenseRelative path on the file system
/dir/axiomatics_ADS.licenseAbsolute path on the file system
classpath:/axiomatics_ADS.licenseFile on the classpath

License expiration warning​

ADS logs a warning as the license approaches its expiration date. By default, the warning appears 30 days before expiry. To adjust the lead time, set licenseExpirationWarning in deployment.yaml:

licenseExpirationWarning: 30 days

The time unit is case-sensitive. Accepted values are days, day, and d.

Service ports​

ADS listens on a single configurable port for all endpoints: both evaluation and administration. The default is 8080.

To use a different port, set server.port in deployment.yaml:

server:
port: <custom_port>

If you need management endpoints (health, metrics) to listen on a separate port from evaluation endpoints, configure management.server.port:

management:
server:
port: <custom_management_port>
info

When management.server.port is not set, management endpoints share server.port.

To enable HTTPS, you also need to configure TLS. See Configure TLS for instructions.

Full property reference​

For a complete index of every supported property, see Configuration schema reference.

In this section​

PageWhat it covers
Configure authorization domainsPoint ADS at a domain file, configure reload intervals, and handle startup retries
Configure authenticationBasic auth, JWT token auth, and OAuth2 client credentials for ADS endpoints
Configure TLSOne-way TLS, mutual TLS (mTLS), attribute connector TLS, and JVM truststore
Configure cachingLocal and distributed attribute caching, replication modes, and cache override
Configure loggingLog levels, audit log format, and Logback configuration
Configure the instance IDSet a stable or prefixed identity for metrics and log correlation
Environment variablesOverride any deployment.yaml property using environment variables