APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Configuration Server - Spring Cloud

CAS is able to use an external and central configuration server to obtain state and settings. The configuration server provides a very abstract way for CAS (and all of its other clients) to obtain settings from a variety of sources, such as file system, git or svn repositories, MongoDb databases, Vault, etc. The beauty of this solution is that to the CAS web application server, it matters not where settings come from and it has no knowledge of the underlying property sources. It talks to the configuration server to locate settings and move on.

:information_source: Configuration Security

This is a very good strategy to ensure configuration settings are not scattered around various deployment environments leading to a more secure deployment. The configuration server need not be exposed to the outside world, and it can safely and secure be hidden behind firewalls, etc allowing access to only authorized clients such as the CAS server web application.

A full comprehensive guide is provided by the Spring Cloud project.

Spring Cloud Configuration Server Overlay

The configuration server itself, similar to CAS, can be deployed using the CAS Initializr.



1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-webapp-config-server</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-webapp-config-server:${project.'cas.version'}"





1
2
3
4
5
6
7
8
9



dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-webapp-config-server"
}





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-webapp-config-server"
}

In addition to the strategies outlined here, the configuration server may load CAS settings and properties via the following order and mechanics:

  1. Profile-specific application properties outside of your packaged web application (application-{profile}.properties|yml)
  2. Profile-specific application properties packaged inside your jar (application-{profile}.properties|yml)
  3. Application properties outside of your packaged jar (application.properties|yml).
  4. Application properties packaged inside your jar (application.properties|yml).

The configuration and behavior of the configuration server is also controlled by its own src/main/resources/bootstrap.properties file. By default, it runs under port 8888 at /casconfigserver inside an embedded Apache Tomcat server whose endpoints are protected with basic authentication where the default credentials are casuser and an auto-generated password defined in src/main/resources/application.properties.

Furthermore, by default it runs under a native profile described below.

The following endpoints are secured and exposed by the configuration server:

Parameter Description
/encrypt Accepts a POST to encrypt CAS configuration settings.
/decrypt Accepts a POST to decrypt CAS configuration settings.
/actuator/refresh Accepts a POST and attempts to refresh the internal state of configuration server.
/actuator/env Accepts a GET and describes all configuration sources of the configuration server.
/actuator/cas/default Describes what the configuration server knows about the default settings profile.
/actuator/cas/native Describes what the configuration server knows about the native settings profile.

Once you have the configuration server deployed and assuming the credentials used to secure the configuration server match the example below, you can observe the collection of settings via:



1



curl -u casuser:Mellon https://config.server.url:8888/casconfigserver/cas/native

Assuming actuator endpoints are enabled in the configuration, you can also observe the collection of property sources that provide settings to the configuration server:



1



curl -u casuser:Mellon https://config.server.url:8888/casconfigserver/actuator/env
:information_source: Actuator Endpoints

Remember that actuator endpoints typically are prefixed with /actuator.

Actuator Endpoints

The following endpoints are provided by CAS:

health
Third-party endpoint2 operationsExposed by default
casConfig
CAS endpoint5 operationsNot exposed by default
base path /cas/actuator/
1

Turn the endpoints on and expose them over the web. One entry covers every operation. By default only info, health and status are exposed.



1
2
3



management.endpoint.health.access=UNRESTRICTED
management.endpoint.casConfig.access=UNRESTRICTED
management.endpoints.web.exposure.include=health,casConfig

Endpoints may be mapped to other paths. For example, to serve health at healthcheck:



1



management.endpoints.web.path-mapping.health=healthcheck

The following settings and properties are available from the CAS configuration catalog:

spring.cloud.config.server.health.accept-empty
false
Third party
Type
Boolean
Default
false
Defined by
ConfigServerHealthIndicator
spring.cloud.config.server.health.down-health-status
no default
Third party
Type
String
Default
none
Defined by
ConfigServerHealthIndicator
spring.cloud.config.server.health.repositories
no default
Third party
Type
Map<String,ConfigServerHealthIndicator.Repository>
Default
none
Defined by
ConfigServerHealthIndicator

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

Spring Cloud Configuration Server Clients

To let the CAS server web application (or any other client for that matter) talk to the configuration server, the following settings need to be applied to CAS’ own src/main/resources/bootstrap.properties file. The properties to configure the CAS server web application as the client of the configuration server must necessarily be read in before the rest of the application’s configuration is read from the configuration server, during the bootstrap phase.

The following settings and properties are available from the CAS configuration catalog:

spring.cloud.config.allow-overrideFlag to indicate that #isOverrideSystemProperties() systemPropertiesOverride can be used.
true
Third party

Flag to indicate that #isOverrideSystemProperties() systemPropertiesOverride can be used. Set to false to prevent users from changing the default accidentally. Default true.

Type
Boolean
Default
true
Defined by
PropertySourceBootstrapProperties
spring.cloud.config.charsetThe charset to read the resource from the config server.
UTF-8
Third party

The charset to read the resource from the config server.

Type
Charset
Default
UTF-8
Defined by
ConfigClientProperties
spring.cloud.config.discovery.enabledFlag to indicate that config server discovery is enabled (config server URL will be looked up via discovery).
false
Third party

Flag to indicate that config server discovery is enabled (config server URL will be looked up via discovery).

Type
Boolean
Default
false
Defined by
ConfigClientProperties$Discovery
spring.cloud.config.discovery.service-idService id to locate config server.
configserver
Third party

Service id to locate config server.

Type
String
Default
configserver
Defined by
ConfigClientProperties$Discovery
spring.cloud.config.enabledFlag to say that remote configuration is enabled.
true
Third party

Flag to say that remote configuration is enabled. Default true;

Type
Boolean
Default
true
Defined by
ConfigClientProperties
spring.cloud.config.fail-fastFlag to indicate that failure to connect to the server is fatal (default false).
false
Third party

Flag to indicate that failure to connect to the server is fatal (default false).

Type
Boolean
Default
false
Defined by
ConfigClientProperties
spring.cloud.config.headersAdditional headers used to create the client request.
no default
Third party

Additional headers used to create the client request.

Type
Map<String,String>
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.initialize-on-context-refreshFlag to initialize bootstrap configuration on context refresh event.
false
Third party

Flag to initialize bootstrap configuration on context refresh event. Default false.

Type
Boolean
Default
false
Defined by
PropertySourceBootstrapProperties
spring.cloud.config.labelThe label name to use to pull remote configuration properties.
no default
Third party

The label name to use to pull remote configuration properties. The default is set on the server (generally "main" for a git based server).

Type
String
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.media-typeThe Accept header media type to send to config server.
no default
Third party

The Accept header media type to send to config server.

Type
String
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.monitor.endpoint.path
no default
Third partyDeprecated
Type
String
Default
none
Deprecation
WARNING, replaced by spring.cloud.config.server.monitor.endpoint.path
spring.cloud.config.multiple-uri-strategyThe strategy to use when call to server fails and there are multiple URLs configured on the uri property (default MultipleUriStrategy#ALWAYS ).
always
Third party

The strategy to use when call to server fails and there are multiple URLs configured on the uri property (default MultipleUriStrategy#ALWAYS).

Type
ConfigClientProperties.MultipleUriStrategy
Default
always
Defined by
ConfigClientProperties
spring.cloud.config.nameName of application used to fetch remote properties.
no default
Third party

Name of application used to fetch remote properties.

Type
String
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.override-noneFlag to indicate that when #setAllowOverride(boolean) allowOverride is true, external properties should take lowest priority and should not override any existing property sources (including local config files).
false
Third party

Flag to indicate that when #setAllowOverride(boolean) allowOverride is true, external properties should take lowest priority and should not override any existing property sources (including local config files). Default false. This will only have an effect when using config first bootstrap.

Type
Boolean
Default
false
Defined by
PropertySourceBootstrapProperties
spring.cloud.config.override-system-propertiesFlag to indicate that the external properties should override system properties.
true
Third party

Flag to indicate that the external properties should override system properties. Default true.

Type
Boolean
Default
true
Defined by
PropertySourceBootstrapProperties
spring.cloud.config.passwordThe password to use (HTTP Basic) when contacting the remote server.
no default
Third party

The password to use (HTTP Basic) when contacting the remote server.

Type
String
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.profileThe default profile to use when fetching remote configuration (comma-separated).
default
Third party

The default profile to use when fetching remote configuration (comma-separated). Default is "default".

Type
String
Default
default
Defined by
ConfigClientProperties
spring.cloud.config.request-connect-timeouttimeout on waiting to connect to the Config Server.
no default
Third party

timeout on waiting to connect to the Config Server.

Type
Integer
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.request-read-timeouttimeout on waiting to read data from the Config Server.
no default
Third party

timeout on waiting to read data from the Config Server.

Type
Integer
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.retry.initial-intervalInitial retry interval in milliseconds.
1000
Third party

Initial retry interval in milliseconds.

Type
Long
Default
1000
Defined by
RetryProperties
spring.cloud.config.retry.max-attemptsMaximum number of attempts.
6
Third party

Maximum number of attempts.

Type
Integer
Default
6
Defined by
RetryProperties
spring.cloud.config.retry.max-intervalMaximum interval for backoff.
2000
Third party

Maximum interval for backoff.

Type
Long
Default
2000
Defined by
RetryProperties
spring.cloud.config.retry.multiplierMultiplier for next interval.
1.1
Third party

Multiplier for next interval.

Type
Double
Default
1.1
Defined by
RetryProperties
spring.cloud.config.retry.use-random-policyUse a random exponential backoff policy.
false
Third party

Use a random exponential backoff policy.

Type
Boolean
Default
false
Defined by
RetryProperties
spring.cloud.config.send-all-labelsIf set to true the client will send all labels to the server instead of sending one at a time.
false
Third party

If set to true the client will send all labels to the server instead of sending one at a time. Support for this would require a config server version of 4.2.0 or higher.

Type
Boolean
Default
false
Defined by
ConfigClientProperties
spring.cloud.config.send-stateFlag to indicate whether to send state.
true
Third party

Flag to indicate whether to send state. Default true.

Type
Boolean
Default
true
Defined by
ConfigClientProperties
spring.cloud.config.server.accept-emptyFlag to indicate that If HTTP 404 needs to be sent if Application is not Found.
true
Third party

Flag to indicate that If HTTP 404 needs to be sent if Application is not Found.

Type
Boolean
Default
true
Defined by
ConfigServerProperties
spring.cloud.config.server.aws-secretsmanager.default-labelThe default staging label to be used to fetch the secret values.
no default
Third party

The default staging label to be used to fetch the secret values. If unset, an active version of the secret will be fetched (AWSCURRENT).

Type
String
Default
none
Defined by
AwsSecretsManagerEnvironmentProperties
spring.cloud.config.server.aws-secretsmanager.endpointThe endpoint to be used by AWS Secrets Manager client.
no default
Third party

The endpoint to be used by AWS Secrets Manager client. This can be used to specify an alternate endpoint for the API requests.

Type
String
Default
none
Defined by
AwsSecretsManagerEnvironmentProperties
spring.cloud.config.server.aws-secretsmanager.ignore-labelDo not set staging label when fetching the secret values.
false
Third party

Do not set staging label when fetching the secret values.

Type
Boolean
Default
false
Defined by
AwsSecretsManagerEnvironmentProperties
spring.cloud.config.server.aws-secretsmanager.orderThe order of the environment repository.
no default
Third party

The order of the environment repository.

Type
Integer
Default
none
Defined by
AwsSecretsManagerEnvironmentProperties
spring.cloud.config.server.aws-secretsmanager.originPrefix which indicates the origin of the property.
aws:secrets:
Third party

Prefix which indicates the origin of the property. Defaults to "aws:secrets:".

Type
String
Default
aws:secrets:
Defined by
AwsSecretsManagerEnvironmentProperties
spring.cloud.config.server.aws-secretsmanager.prefixPrefix indicating first level for every property loaded from AWS Secrets Manager.
no default
Third party

Prefix indicating first level for every property loaded from AWS Secrets Manager. Value must start with a forward slash followed by a valid path segment or be empty. Defaults to "/secret".

Type
String
Default
none
Defined by
AwsSecretsManagerEnvironmentProperties
spring.cloud.config.server.aws-secretsmanager.profile-separatorString that separates profile from the application name.
-
Third party

String that separates profile from the application name.

Type
String
Default
-
Defined by
AwsSecretsManagerEnvironmentProperties
spring.cloud.config.server.aws-secretsmanager.regionThe region to be used by AWS Secrets Manager client.
no default
Third party

The region to be used by AWS Secrets Manager client.

Type
String
Default
none
Defined by
AwsSecretsManagerEnvironmentProperties
spring.cloud.config.server.awsparamstore.decrypt-valuesFlag to indicate the retrieval of all AWS parameters in a hierarchy with their value decrypted.
true
Third party

Flag to indicate the retrieval of all AWS parameters in a hierarchy with their value decrypted. Defaults to "true".

Type
Boolean
Default
true
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awsparamstore.endpointThe service endpoint to be used by the AWS Parameter Store client.
no default
Third party

The service endpoint to be used by the AWS Parameter Store client.

Type
String
Default
none
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awsparamstore.max-resultsThe maximum number of items to return for an AWS Parameter Store API call.
10
Third party

The maximum number of items to return for an AWS Parameter Store API call. Defaults to "10".

Type
Integer
Default
10
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awsparamstore.orderThe order of the environment repository.
no default
Third party

The order of the environment repository.

Type
Integer
Default
none
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awsparamstore.originPrefix indicating the property's origin.
aws:ssm:parameter:
Third party

Prefix indicating the property's origin. Defaults to "aws:ssm:parameter:".

Type
String
Default
aws:ssm:parameter:
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awsparamstore.prefixPrefix indicating first level for every property loaded from the AWS Parameter Store.
no default
Third party

Prefix indicating first level for every property loaded from the AWS Parameter Store. Value must start with a forward slash followed by one or more valid path segments or be empty. Defaults to "/config".

Type
String
Default
none
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awsparamstore.profile-separatorString that separates an appended profile from the context name.
-
Third party

String that separates an appended profile from the context name. Note that an AWS parameter name can only contain dots, dashes and underscores next to alphanumeric characters. Defaults to "-".

Type
String
Default
-
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awsparamstore.recursiveFlag to indicate the retrieval of all AWS parameters within a hierarchy.
true
Third party

Flag to indicate the retrieval of all AWS parameters within a hierarchy. Defaults to "true".

Type
Boolean
Default
true
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awsparamstore.regionThe region to be used by the AWS Parameter Store client.
no default
Third party

The region to be used by the AWS Parameter Store client.

Type
String
Default
none
Defined by
AwsParameterStoreEnvironmentProperties
spring.cloud.config.server.awss3.bucketName of the S3 bucket that contains config.
no default
Third party

Name of the S3 bucket that contains config.

Type
String
Default
none
Defined by
AwsS3EnvironmentProperties
spring.cloud.config.server.awss3.endpointAdds the ability to override the baseUrl of the s3 client.
no default
Third party

Adds the ability to override the baseUrl of the s3 client.

Type
String
Default
none
Defined by
AwsS3EnvironmentProperties
spring.cloud.config.server.awss3.order
no default
Third party
Type
Integer
Default
none
Defined by
AwsS3EnvironmentProperties
spring.cloud.config.server.awss3.regionAWS region that contains config.
no default
Third party

AWS region that contains config.

Type
String
Default
none
Defined by
AwsS3EnvironmentProperties
spring.cloud.config.server.awss3.search-pathsList of directory paths to search for profiles in the bucket.
no default
Third party

List of directory paths to search for profiles in the bucket. Analogous to #searchPaths in Git backend.

Type
List<String>
Default
none
Defined by
AwsS3EnvironmentProperties
spring.cloud.config.server.awss3.use-directory-layoutUse application name as intermediate directory.
false
Third party

Use application name as intermediate directory. Analogous to #searchPaths from Git backend.

Type
Boolean
Default
false
Defined by
AwsS3EnvironmentProperties
spring.cloud.config.server.bootstrapFlag indicating that the config server should initialize its own Environment with properties from the remote repository.
false
Third party

Flag indicating that the config server should initialize its own Environment with properties from the remote repository. Off by default because it delays startup but can be useful when embedding the server in another application.

Type
Boolean
Default
false
Defined by
ConfigServerProperties
spring.cloud.config.server.credhub.ca-cert-files
no default
Third party
Type
String[]
Default
none
Defined by
ClientOptions
spring.cloud.config.server.credhub.connection-timeout
no default
Third party
Type
Duration
Default
none
Defined by
ClientOptions
spring.cloud.config.server.credhub.default-labelThe default label to be used when is not provided by client applications.
master
Third party

The default label to be used when is not provided by client applications.

Type
String
Default
master
Defined by
CredhubEnvironmentProperties
spring.cloud.config.server.credhub.oauth2.registration-id
no default
Third party
Type
String
Default
none
Defined by
CredHubProperties$OAuth2
spring.cloud.config.server.credhub.order
no default
Third party
Type
Integer
Default
none
Defined by
CredhubEnvironmentProperties
spring.cloud.config.server.credhub.pathThe common base path for credentials in CredHub.
no default
Third party

The common base path for credentials in CredHub. It is empty by default.

Type
String
Default
none
Defined by
CredhubEnvironmentProperties
spring.cloud.config.server.credhub.read-timeout
no default
Third party
Type
Duration
Default
none
Defined by
ClientOptions
spring.cloud.config.server.credhub.url
no default
Third party
Type
String
Default
none
Defined by
CredHubProperties
spring.cloud.config.server.default-application-nameDefault application name when incoming requests do not have a specific one.
application
Third party

Default application name when incoming requests do not have a specific one.

Type
String
Default
application
Defined by
ConfigServerProperties
spring.cloud.config.server.default-labelDefault repository label when incoming requests do not have a specific label.
no default
Third party

Default repository label when incoming requests do not have a specific label.

Type
String
Default
none
Defined by
ConfigServerProperties
spring.cloud.config.server.default-profileDefault application profile when incoming requests do not have a specific one.
default
Third party

Default application profile when incoming requests do not have a specific one.

Type
String
Default
default
Defined by
ConfigServerProperties
spring.cloud.config.server.enabledFlag indicating config server is enabled.
true
Third party

Flag indicating config server is enabled.

Type
Boolean
Default
true
Defined by
ConfigServerProperties
spring.cloud.config.server.encrypt.enabledEnable decryption of environment properties before sending to client.
true
Third party

Enable decryption of environment properties before sending to client.

Type
Boolean
Default
true
Defined by
ConfigServerProperties$Encrypt
spring.cloud.config.server.encrypt.plain-text-encryptEnable decryption of environment properties served by plain text endpoint org.springframework.cloud.config.server.resource.ResourceController .
false
Third party

Enable decryption of environment properties served by plain text endpoint org.springframework.cloud.config.server.resource.ResourceController.

Type
Boolean
Default
false
Defined by
ConfigServerProperties$Encrypt
spring.cloud.config.server.fail-on-composite-errorFlag indicating that if there are any errors reading properties from a subordinate environment repository in a composite environment repository, then the entire composite read should fail.
true
Third party

Flag indicating that if there are any errors reading properties from a subordinate environment repository in a composite environment repository, then the entire composite read should fail. Useful when set to false when a Vault repository is in the composite to allow clients to still read properties from other repositories without providing a valid Vault token. Defaults to true, resulting in a failure on any error.

Type
Boolean
Default
true
Defined by
ConfigServerProperties
spring.cloud.config.server.gcp-parameter-manager.application-label
application
Third party
Type
String
Default
application
Defined by
GoogleParameterManagerEnvironmentProperties
spring.cloud.config.server.gcp-parameter-manager.default-label
main
Third party
Type
String
Default
main
Defined by
GoogleParameterManagerEnvironmentProperties
spring.cloud.config.server.gcp-parameter-manager.location
global
Third party
Type
String
Default
global
Defined by
GoogleParameterManagerEnvironmentProperties
spring.cloud.config.server.gcp-parameter-manager.order
no default
Third party
Type
Integer
Default
none
Defined by
GoogleParameterManagerEnvironmentProperties
spring.cloud.config.server.gcp-parameter-manager.profile-label
profile
Third party
Type
String
Default
profile
Defined by
GoogleParameterManagerEnvironmentProperties
spring.cloud.config.server.gcp-parameter-manager.project-id
no default
Third party
Type
String
Default
none
Defined by
GoogleParameterManagerEnvironmentProperties
spring.cloud.config.server.gcp-secret-manager.allowed-project-idsWhen token-mandatory is false : only these project IDs may be used with client-supplied X-Project-ID .
no default
Third party

When token-mandatory is false: only these project IDs may be used with client-supplied X-Project-ID. When empty, client-supplied project IDs are rejected. When token-mandatory is true, this list is ignored for the header; use X-Config-Token permission checks instead.

Type
List<String>
Default
none
Defined by
GoogleSecretManagerEnvironmentProperties
spring.cloud.config.server.gcp-secret-manager.application-label
application
Third party
Type
String
Default
application
Defined by
GoogleSecretManagerEnvironmentProperties
spring.cloud.config.server.gcp-secret-manager.order
no default
Third party
Type
Integer
Default
none
Defined by
GoogleSecretManagerEnvironmentProperties
spring.cloud.config.server.gcp-secret-manager.profile-label
profile
Third party
Type
String
Default
profile
Defined by
GoogleSecretManagerEnvironmentProperties
spring.cloud.config.server.gcp-secret-manager.project-idUsed when X-Project-ID is absent and the metadata server is unavailable (for example local development).
no default
Third party

Used when X-Project-ID is absent and the metadata server is unavailable (for example local development). Not validated against #allowedProjectIds.

Type
String
Default
none
Defined by
GoogleSecretManagerEnvironmentProperties
spring.cloud.config.server.gcp-secret-manager.service-account
no default
Third party
Type
String
Default
none
Defined by
GoogleSecretManagerEnvironmentProperties
spring.cloud.config.server.gcp-secret-manager.token-mandatory
true
Third party
Type
Boolean
Default
true
Defined by
GoogleSecretManagerEnvironmentProperties
spring.cloud.config.server.gcp-secret-manager.version
1
Third party
Type
Integer
Default
1
Defined by
GoogleSecretManagerEnvironmentProperties
spring.cloud.config.server.git.azure.identity.client-idClient ID of the Azure managed identity used for Azure DevOps authentication.
no default
Third party

Client ID of the Azure managed identity used for Azure DevOps authentication.

Type
String
Default
none
Defined by
JGitEnvironmentProperties$AzureProperties$Identity
spring.cloud.config.server.git.azure.identity.managed-identity-enabledWhether managed identity authentication is enabled for Azure DevOps repositories.
false
Third party

Whether managed identity authentication is enabled for Azure DevOps repositories.

Type
Boolean
Default
false
Defined by
JGitEnvironmentProperties$AzureProperties$Identity
spring.cloud.config.server.git.basedirBase directory for local working copy of repository.
no default
Third party

Base directory for local working copy of repository.

Type
File
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.clone-on-startFlag to indicate that the repository should be cloned on startup (not on demand).
false
Third party

Flag to indicate that the repository should be cloned on startup (not on demand). Generally leads to slower startup but faster first query.

Type
Boolean
Default
false
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.clone-submodulesFlag to indicate that the submodules in the repository should be cloned.
false
Third party

Flag to indicate that the submodules in the repository should be cloned.

Type
Boolean
Default
false
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.continue-on-multiple-label-failureFlag to indicate whether to continue on multiple label failure.
false
Third party

Flag to indicate whether to continue on multiple label failure. Defaults to false.

Type
Boolean
Default
false
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.default-labelThe default label to be used with the remote repository.
no default
Third party

The default label to be used with the remote repository.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.delete-untracked-branchesFlag to indicate that the branch should be deleted locally if it's origin tracked branch was removed.
false
Third party

Flag to indicate that the branch should be deleted locally if it's origin tracked branch was removed.

Type
Boolean
Default
false
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.force-pullFlag to indicate that the repository should force pull.
false
Third party

Flag to indicate that the repository should force pull. If true discard any local changes and take from remote repository.

Type
Boolean
Default
false
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.host-keyValid SSH host key.
no default
Third party

Valid SSH host key. Must be set if hostKeyAlgorithm is also set.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.host-key-algorithmOne of ssh-dss, ssh-rsa, ssh-ed25519, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521.
no default
Third party

One of ssh-dss, ssh-rsa, ssh-ed25519, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Must be set if hostKey is also set.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.ignore-local-ssh-settingsIf true, use property-based instead of file-based SSH config.
false
Third party

If true, use property-based instead of file-based SSH config.

Type
Boolean
Default
false
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.known-hosts-fileLocation of custom .known_hosts file.
no default
Third party

Location of custom .known_hosts file.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.orderThe order of the environment repository.
no default
Third party

The order of the environment repository.

Type
Integer
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.passphrasePassphrase for unlocking your ssh private key.
no default
Third party

Passphrase for unlocking your ssh private key.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.passwordPassword for authentication with remote repository.
no default
Third party

Password for authentication with remote repository.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.preferred-authenticationsOverride server authentication method order.
no default
Third party

Override server authentication method order. This should allow for evading login prompts if server has keyboard-interactive authentication before the publickey method.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.private-keyValid SSH private key.
no default
Third party

Valid SSH private key. Must be set if ignoreLocalSshSettings is true and Git URI is SSH format.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.proxyHTTP proxy configuration.
no default
Third party

HTTP proxy configuration.

Type
Map<ProxyHostProperties.ProxyForScheme,ProxyHostProperties>
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.refresh-rateTime (in seconds) between refresh of the git repository.
0
Third party

Time (in seconds) between refresh of the git repository.

Type
Integer
Default
0
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.reposMap of repository identifier to location and other properties.
no default
Third party

Map of repository identifier to location and other properties.

Type
Map<String,MultipleJGitEnvironmentProperties.PatternMatchingJGitEnvironmentProperties>
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.search-pathsSearch paths to use within local working copy.
no default
Third party

Search paths to use within local working copy. By default searches only the root.

Type
String[]
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.skip-ssl-validationFlag to indicate that SSL certificate validation should be bypassed when communicating with a repository served over an HTTPS connection.
false
Third party

Flag to indicate that SSL certificate validation should be bypassed when communicating with a repository served over an HTTPS connection.

Type
Boolean
Default
false
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.strict-host-key-checkingIf false, ignore errors with host key.
true
Third party

If false, ignore errors with host key.

Type
Boolean
Default
true
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.timeoutTimeout (in seconds) for obtaining HTTP or SSH connection (if applicable), defaults to 5 seconds.
5
Third party

Timeout (in seconds) for obtaining HTTP or SSH connection (if applicable), defaults to 5 seconds.

Type
Integer
Default
5
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.try-master-branchTo maintain compatibility we will try the master branch in addition to main when we try to fetch the default branch.
true
Third party

To maintain compatibility we will try the master branch in addition to main when we try to fetch the default branch.

Type
Boolean
Default
true
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.uriURI of remote repository.
no default
Third party

URI of remote repository.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.git.usernameUsername for authentication with remote repository.
no default
Third party

Username for authentication with remote repository.

Type
String
Default
none
Defined by
MultipleJGitEnvironmentProperties
spring.cloud.config.server.health.accept-empty
false
Third party
Type
Boolean
Default
false
Defined by
ConfigServerHealthIndicator
spring.cloud.config.server.health.down-health-status
no default
Third party
Type
String
Default
none
Defined by
ConfigServerHealthIndicator
spring.cloud.config.server.health.repositories
no default
Third party
Type
Map<String,ConfigServerHealthIndicator.Repository>
Default
none
Defined by
ConfigServerHealthIndicator
spring.cloud.config.server.jdbc.default-label
master
Third party
Type
String
Default
master
Defined by
JdbcEnvironmentProperties
spring.cloud.config.server.jdbc.enabledFlag to indicate that JDBC environment repository configuration is enabled.
true
Third party

Flag to indicate that JDBC environment repository configuration is enabled.

Type
Boolean
Default
true
Defined by
JdbcEnvironmentProperties
spring.cloud.config.server.jdbc.fail-on-errorFlag to determine how to handle query exceptions.
true
Third party

Flag to determine how to handle query exceptions.

Type
Boolean
Default
true
Defined by
JdbcEnvironmentProperties
spring.cloud.config.server.jdbc.order
no default
Third party
Type
Integer
Default
none
Defined by
JdbcEnvironmentProperties
spring.cloud.config.server.jdbc.sqlSQL used to query database for keys and values.
SELECT "KEY", "VALUE" from PROPERTIES where APPLICATION=? and PROFILE=? and LABEL=?
Third party

SQL used to query database for keys and values.

Type
String
Default
SELECT "KEY", "VALUE" from PROPERTIES where APPLICATION=? and PROFILE=? and LABEL=?
Defined by
JdbcEnvironmentProperties
spring.cloud.config.server.jdbc.sql-without-profileSQL used to query database for keys and values when profile is null.
SELECT "KEY", "VALUE" from PROPERTIES where APPLICATION=? and PROFILE is null and LABEL=?
Third party

SQL used to query database for keys and values when profile is null.

Type
String
Default
SELECT "KEY", "VALUE" from PROPERTIES where APPLICATION=? and PROFILE is null and LABEL=?
Defined by
JdbcEnvironmentProperties
spring.cloud.config.server.mongodb.collectionName of the MongoDB collection to query for configuration properties.
properties
Third party

Name of the MongoDB collection to query for configuration properties.

Type
String
Default
properties
Defined by
MongoDbEnvironmentProperties
spring.cloud.config.server.mongodb.default-labelDefault label to use if none is specified.
master
Third party

Default label to use if none is specified.

Type
String
Default
master
Defined by
MongoDbEnvironmentProperties
spring.cloud.config.server.mongodb.enabledFlag to indicate that MongoDB environment repository configuration is enabled.
true
Third party

Flag to indicate that MongoDB environment repository configuration is enabled.

Type
Boolean
Default
true
Defined by
MongoDbEnvironmentProperties
spring.cloud.config.server.mongodb.fail-on-errorFlag to determine how to handle query exceptions.
true
Third party

Flag to determine how to handle query exceptions.

Type
Boolean
Default
true
Defined by
MongoDbEnvironmentProperties
spring.cloud.config.server.mongodb.orderOrder of the MongoDB environment repository.
no default
Third party

Order of the MongoDB environment repository.

Type
Integer
Default
none
Defined by
MongoDbEnvironmentProperties
spring.cloud.config.server.monitor.bitbucket.enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$Bitbucket
spring.cloud.config.server.monitor.bitbucket.validation-enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$Bitbucket
spring.cloud.config.server.monitor.bitbucket.webhook-secret
no default
Third party
Type
String
Default
none
Defined by
MonitorConfigurationProperties$Bitbucket
spring.cloud.config.server.monitor.endpoint.path
/monitor
Third party
Type
String
Default
/monitor
Defined by
MonitorConfigurationProperties$Endpoint
spring.cloud.config.server.monitor.gitea.enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$Gitea
spring.cloud.config.server.monitor.gitea.validation-enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$Gitea
spring.cloud.config.server.monitor.gitea.webhook-secret
no default
Third party
Type
String
Default
none
Defined by
MonitorConfigurationProperties$Gitea
spring.cloud.config.server.monitor.gitee.enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$Gitee
spring.cloud.config.server.monitor.gitee.validation-enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$Gitee
spring.cloud.config.server.monitor.gitee.webhook-secret
no default
Third party
Type
String
Default
none
Defined by
MonitorConfigurationProperties$Gitee
spring.cloud.config.server.monitor.github.enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$GitHub
spring.cloud.config.server.monitor.github.validation-enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$GitHub
spring.cloud.config.server.monitor.github.webhook-secret
no default
Third party
Type
String
Default
none
Defined by
MonitorConfigurationProperties$GitHub
spring.cloud.config.server.monitor.gitlab.enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$GitLab
spring.cloud.config.server.monitor.gitlab.validation-enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$GitLab
spring.cloud.config.server.monitor.gitlab.webhook-secret
no default
Third party
Type
String
Default
none
Defined by
MonitorConfigurationProperties$GitLab
spring.cloud.config.server.monitor.gogs.enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$Gogs
spring.cloud.config.server.monitor.gogs.validation-enabled
true
Third party
Type
Boolean
Default
true
Defined by
MonitorConfigurationProperties$Gogs
spring.cloud.config.server.monitor.gogs.webhook-secret
no default
Third party
Type
String
Default
none
Defined by
MonitorConfigurationProperties$Gogs
spring.cloud.config.server.monitor.http.endpoints
no default
Third party
Type
Map<String,String>
Default
none
Defined by
MonitorConfigurationProperties$Http
spring.cloud.config.server.monitor.max-dashesUpper bound on the number of dash-separated segments processed when guessing a service name from a notification path.
20
Third party

Upper bound on the number of dash-separated segments processed when guessing a service name from a notification path. Prevents a long, heavily dashed path from producing an unbounded number of candidate service names (and refresh events).

Type
Integer
Default
20
Defined by
MonitorConfigurationProperties
spring.cloud.config.server.native.add-label-locationsFlag to determine whether label locations should be added.
true
Third party

Flag to determine whether label locations should be added.

Type
Boolean
Default
true
Defined by
NativeEnvironmentProperties
spring.cloud.config.server.native.default-label
master
Third party
Type
String
Default
master
Defined by
NativeEnvironmentProperties
spring.cloud.config.server.native.fail-on-errorFlag to determine how to handle exceptions during decryption (default false).
false
Third party

Flag to determine how to handle exceptions during decryption (default false).

Type
Boolean
Default
false
Defined by
NativeEnvironmentProperties
spring.cloud.config.server.native.order
no default
Third party
Type
Integer
Default
none
Defined by
NativeEnvironmentProperties
spring.cloud.config.server.native.search-locationsLocations to search for configuration files.
no default
Third party

Locations to search for configuration files. Defaults to the same as a Spring Boot app so [classpath:/,classpath:/config/,file:./,file:./config/].

Type
String[]
Default
none
Defined by
NativeEnvironmentProperties
spring.cloud.config.server.native.versionVersion string to be reported for native repository.
no default
Third party

Version string to be reported for native repository.

Type
String
Default
none
Defined by
NativeEnvironmentProperties
spring.cloud.config.server.overridesExtra map for a property source to be sent to all clients unconditionally.
no default
Third party

Extra map for a property source to be sent to all clients unconditionally.

Type
Map<String,String>
Default
none
Defined by
ConfigServerProperties
spring.cloud.config.server.prefixPrefix for configuration resource paths (default is empty).
no default
Third party

Prefix for configuration resource paths (default is empty). Useful when embedding in another application when you don't want to change the context path or servlet path.

Type
String
Default
none
Defined by
ConfigServerProperties
spring.cloud.config.server.redis.order
no default
Third party
Type
Integer
Default
none
Defined by
RedisEnvironmentProperties
spring.cloud.config.server.reverse-location-orderBy default the location order we use in GenericResourceRepository is the order in which they are listed.
false
Third party

By default the location order we use in GenericResourceRepository is the order in which they are listed. Prior to Hoxton.SR11 the order used to be reverse. If this property is set to true then we will reverse ther order like it used to be prior to Hoxton.SR11.

Type
Boolean
Default
false
Defined by
ConfigServerProperties
spring.cloud.config.server.strip-document-from-yamlFlag to indicate that YAML documents that are text or collections (not a map) should be returned in "native" form.
true
Third party

Flag to indicate that YAML documents that are text or collections (not a map) should be returned in "native" form.

Type
Boolean
Default
true
Defined by
ConfigServerProperties
spring.cloud.config.server.svn.basedirBase directory for local working copy of repository.
no default
Third party

Base directory for local working copy of repository.

Type
File
Default
none
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.continue-on-multiple-label-failureFlag to indicate whether to continue on multiple label failure.
false
Third party

Flag to indicate whether to continue on multiple label failure. Defaults to false.

Type
Boolean
Default
false
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.default-labelThe default label to be used with the remote repository.
no default
Third party

The default label to be used with the remote repository.

Type
String
Default
none
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.orderThe order of the environment repository.
no default
Third party

The order of the environment repository.

Type
Integer
Default
none
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.passphrasePassphrase for unlocking your ssh private key.
no default
Third party

Passphrase for unlocking your ssh private key.

Type
String
Default
none
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.passwordPassword for authentication with remote repository.
no default
Third party

Password for authentication with remote repository.

Type
String
Default
none
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.search-pathsSearch paths to use within local working copy.
no default
Third party

Search paths to use within local working copy. By default searches only the root.

Type
String[]
Default
none
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.strict-host-key-checkingReject incoming SSH host keys from remote servers not in the known host list.
true
Third party

Reject incoming SSH host keys from remote servers not in the known host list.

Type
Boolean
Default
true
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.uriURI of remote repository.
no default
Third party

URI of remote repository.

Type
String
Default
none
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.svn.usernameUsername for authentication with remote repository.
no default
Third party

Username for authentication with remote repository.

Type
String
Default
none
Defined by
SvnKitEnvironmentProperties
spring.cloud.config.server.vault.app-role.app-role-pathMount path of the AppRole authentication backend.
approle
Third party

Mount path of the AppRole authentication backend.

Type
String
Default
approle
Defined by
VaultEnvironmentProperties$AppRoleProperties
spring.cloud.config.server.vault.app-role.roleName of the role, optional, used for pull-mode.
no default
Third party

Name of the role, optional, used for pull-mode.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AppRoleProperties
spring.cloud.config.server.vault.app-role.role-idThe RoleId.
no default
Third party

The RoleId.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AppRoleProperties
spring.cloud.config.server.vault.app-role.secret-idThe SecretId.
no default
Third party

The SecretId.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AppRoleProperties
spring.cloud.config.server.vault.authentication
no default
Third party
Type
VaultEnvironmentProperties.AuthenticationMethod
Default
none
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.aws-ec2.aws-ec2-pathMount path of the AWS-EC2 authentication backend.
aws-ec2
Third party

Mount path of the AWS-EC2 authentication backend.

Type
String
Default
aws-ec2
Defined by
VaultEnvironmentProperties$AwsEc2Properties
spring.cloud.config.server.vault.aws-ec2.identity-documentURL of the AWS-EC2 PKCS7 identity document.
http://169.254.169.254/latest/dynamic/instance-identity/pkcs7
Third party

URL of the AWS-EC2 PKCS7 identity document.

Type
String
Default
http://169.254.169.254/latest/dynamic/instance-identity/pkcs7
Defined by
VaultEnvironmentProperties$AwsEc2Properties
spring.cloud.config.server.vault.aws-ec2.nonceNonce used for AWS-EC2 authentication.
no default
Third party

Nonce used for AWS-EC2 authentication. An empty nonce defaults to nonce generation.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AwsEc2Properties
spring.cloud.config.server.vault.aws-ec2.roleName of the role, optional.
no default
Third party

Name of the role, optional.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AwsEc2Properties
spring.cloud.config.server.vault.aws-iam.aws-pathMount path of the AWS authentication backend.
aws
Third party

Mount path of the AWS authentication backend.

Type
String
Default
aws
Defined by
VaultEnvironmentProperties$AwsIamProperties
spring.cloud.config.server.vault.aws-iam.endpoint-uriSTS server URI.
no default
Third party

STS server URI. @since 2.2

Type
URI
Default
none
Defined by
VaultEnvironmentProperties$AwsIamProperties
spring.cloud.config.server.vault.aws-iam.roleName of the role, optional.
no default
Third party

Name of the role, optional. Defaults to the friendly IAM name if not set.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AwsIamProperties
spring.cloud.config.server.vault.aws-iam.server-nameName of the server used to set X-Vault-AWS-IAM-Server-ID header in the headers of login requests.
no default
Third party

Name of the server used to set X-Vault-AWS-IAM-Server-ID header in the headers of login requests.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AwsIamProperties
spring.cloud.config.server.vault.azure-msi.azure-pathMount path of the Azure MSI authentication backend.
azure
Third party

Mount path of the Azure MSI authentication backend.

Type
String
Default
azure
Defined by
VaultEnvironmentProperties$AzureMsiProperties
spring.cloud.config.server.vault.azure-msi.identity-token-serviceURI to the Azure MSI Identity Service.
no default
Third party

URI to the Azure MSI Identity Service.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AzureMsiProperties
spring.cloud.config.server.vault.azure-msi.metadata-serviceURI to the Azure MSI Metadata Service.
no default
Third party

URI to the Azure MSI Metadata Service.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AzureMsiProperties
spring.cloud.config.server.vault.azure-msi.roleName of the role.
no default
Third party

Name of the role.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$AzureMsiProperties
spring.cloud.config.server.vault.backendVault backend.
secret
Third party

Vault backend. Defaults to secret.

Type
String
Default
secret
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.default-keyThe key in vault shared by all applications.
application
Third party

The key in vault shared by all applications. Defaults to application. Set to empty to disable.

Type
String
Default
application
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.default-label
main
Third party
Type
String
Default
main
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.enable-labelFlag to indicate that the repository should use 'label' as well as 'application-name' and 'profile', for vault secrets.
false
Third party

Flag to indicate that the repository should use 'label' as well as 'application-name' and 'profile', for vault secrets. By default, the vault secrets are expected to be in 'application-name,profile' path. When this flag enabled, they are expected to be in 'application-name,profile,label' path. To maintain compatibility this flag is not enabled by default.

Type
Boolean
Default
false
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.full-key-pathInclude the full key path in the PropertySource name.
false
Third party

Include the full key path in the PropertySource name. Defaults to false

Type
Boolean
Default
false
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.gcp-gce.gcp-pathMount path of the Kubernetes authentication backend.
gcp
Third party

Mount path of the Kubernetes authentication backend.

Type
String
Default
gcp
Defined by
VaultEnvironmentProperties$GcpGceProperties
spring.cloud.config.server.vault.gcp-gce.roleName of the role against which the login is being attempted.
no default
Third party

Name of the role against which the login is being attempted.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$GcpGceProperties
spring.cloud.config.server.vault.gcp-gce.service-accountOptional service account id.
no default
Third party

Optional service account id. Using the default id if left unconfigured.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$GcpGceProperties
spring.cloud.config.server.vault.gcp-iam.credentials.encoded-keyThe base64 encoded contents of an OAuth2 account private key in JSON format.
no default
Third party

The base64 encoded contents of an OAuth2 account private key in JSON format.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$GcpCredentials
spring.cloud.config.server.vault.gcp-iam.credentials.locationLocation of the OAuth2 credentials private key.
no default
Third party

Location of the OAuth2 credentials private key.

Since this is a Resource, the private key can be in a multitude of locations, such as a local file system, classpath, URL, etc.

Type
Resource
Default
none
Defined by
VaultEnvironmentProperties$GcpCredentials
spring.cloud.config.server.vault.gcp-iam.gcp-pathMount path of the Kubernetes authentication backend.
gcp
Third party

Mount path of the Kubernetes authentication backend.

Type
String
Default
gcp
Defined by
VaultEnvironmentProperties$GcpIamProperties
spring.cloud.config.server.vault.gcp-iam.jwt-validityValidity of the JWT token.
15m
Third party

Validity of the JWT token.

Type
Duration
Default
15m
Defined by
VaultEnvironmentProperties$GcpIamProperties
spring.cloud.config.server.vault.gcp-iam.project-idOverrides the GCP project Id.
no default
Third party

Overrides the GCP project Id.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$GcpIamProperties
spring.cloud.config.server.vault.gcp-iam.roleName of the role against which the login is being attempted.
no default
Third party

Name of the role against which the login is being attempted.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$GcpIamProperties
spring.cloud.config.server.vault.gcp-iam.service-account-idOverrides the GCP service account Id.
no default
Third party

Overrides the GCP service account Id.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$GcpIamProperties
spring.cloud.config.server.vault.hostVault host.
127.0.0.1
Third party

Vault host. Defaults to 127.0.0.1.

Type
String
Default
127.0.0.1
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.kubernetes.kubernetes-pathMount path of the Kubernetes authentication backend.
kubernetes
Third party

Mount path of the Kubernetes authentication backend.

Type
String
Default
kubernetes
Defined by
VaultEnvironmentProperties$KubernetesProperties
spring.cloud.config.server.vault.kubernetes.roleName of the role against which the login is being attempted.
no default
Third party

Name of the role against which the login is being attempted.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$KubernetesProperties
spring.cloud.config.server.vault.kubernetes.service-account-token-filePath to the service account token file.
/var/run/secrets/kubernetes.io/serviceaccount/token
Third party

Path to the service account token file.

Type
String
Default
/var/run/secrets/kubernetes.io/serviceaccount/token
Defined by
VaultEnvironmentProperties$KubernetesProperties
spring.cloud.config.server.vault.kv-versionValue to indicate which version of Vault kv backend is used.
1
Third party

Value to indicate which version of Vault kv backend is used. Defaults to 1.

Type
Integer
Default
1
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.namespaceThe value of the Vault X-Vault-Namespace header.
no default
Third party

The value of the Vault X-Vault-Namespace header. Defaults to null. This a Vault Enterprise feature only.

Type
String
Default
none
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.order
no default
Third party
Type
Integer
Default
none
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.path-to-keyKV2 API required "data" after "mount-path".
no default
Third party

KV2 API required "data" after "mount-path". There could be folder/path structure, where the keys/applications are grouped. This property is the path after mount-path, under which application(s) are located (appended after "data") Default value is blank, which means all grouped applications are located right under the mount-path

Type
String
Default
none
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.pcf.instance-certificatePath to the instance certificate (PEM).
no default
Third party

Path to the instance certificate (PEM). Defaults to CF_INSTANCE_CERT env variable.

Type
Resource
Default
none
Defined by
VaultEnvironmentProperties$PcfProperties
spring.cloud.config.server.vault.pcf.instance-keyPath to the instance key (PEM).
no default
Third party

Path to the instance key (PEM). Defaults to CF_INSTANCE_KEY env variable.

Type
Resource
Default
none
Defined by
VaultEnvironmentProperties$PcfProperties
spring.cloud.config.server.vault.pcf.pcf-pathMount path of the Kubernetes authentication backend.
pcf
Third party

Mount path of the Kubernetes authentication backend.

Type
String
Default
pcf
Defined by
VaultEnvironmentProperties$PcfProperties
spring.cloud.config.server.vault.pcf.roleName of the role against which the login is being attempted.
no default
Third party

Name of the role against which the login is being attempted.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$PcfProperties
spring.cloud.config.server.vault.portVault port.
8200
Third party

Vault port. Defaults to 8200.

Type
Integer
Default
8200
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.profile-separatorVault profile separator.
,
Third party

Vault profile separator. Defaults to comma.

Type
String
Default
,
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.proxyHTTP proxy configuration.
no default
Third party

HTTP proxy configuration.

Type
Map<ProxyHostProperties.ProxyForScheme,ProxyHostProperties>
Default
none
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.schemeVault scheme.
http
Third party

Vault scheme. Defaults to http.

Type
String
Default
http
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.skip-ssl-validationFlag to indicate that SSL certificate validation should be bypassed when communicating with a repository served over an HTTPS connection.
false
Third party

Flag to indicate that SSL certificate validation should be bypassed when communicating with a repository served over an HTTPS connection.

Type
Boolean
Default
false
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.ssl.cert-auth-pathMount path of the TLS cert authentication backend.
cert
Third party

Mount path of the TLS cert authentication backend.

Type
String
Default
cert
Defined by
VaultEnvironmentProperties$Ssl
spring.cloud.config.server.vault.ssl.key-storeTrust store that holds certificates and private keys.
no default
Third party

Trust store that holds certificates and private keys.

Type
Resource
Default
none
Defined by
VaultEnvironmentProperties$Ssl
spring.cloud.config.server.vault.ssl.key-store-passwordPassword used to access the key store.
no default
Third party

Password used to access the key store.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$Ssl
spring.cloud.config.server.vault.ssl.trust-storeTrust store that holds SSL certificates.
no default
Third party

Trust store that holds SSL certificates.

Type
Resource
Default
none
Defined by
VaultEnvironmentProperties$Ssl
spring.cloud.config.server.vault.ssl.trust-store-passwordPassword used to access the trust store.
no default
Third party

Password used to access the trust store.

Type
String
Default
none
Defined by
VaultEnvironmentProperties$Ssl
spring.cloud.config.server.vault.timeoutTimeout (in seconds) for obtaining HTTP connection, defaults to 5 seconds.
5
Third party

Timeout (in seconds) for obtaining HTTP connection, defaults to 5 seconds.

Type
Integer
Default
5
Defined by
VaultEnvironmentProperties
spring.cloud.config.server.vault.tokenStatic vault token.
no default
Third party

Static vault token. Required if #authentication is TOKEN.

Type
String
Default
none
Defined by
VaultEnvironmentProperties
spring.cloud.config.tlsTLS properties.
no default
Third party

TLS properties.

Type
TlsProperties
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.tokenSecurity Token passed thru to underlying environment repository.
no default
Third party

Security Token passed thru to underlying environment repository.

Type
String
Default
none
Defined by
ConfigClientProperties
spring.cloud.config.uriThe URI of the remote server (default http://localhost:8888).
["http://localhost:8888"]
Third party

The URI of the remote server (default http://localhost:8888).

Type
String[]
Default
["http://localhost:8888"]
Defined by
ConfigClientProperties
spring.cloud.config.usernameThe username to use (HTTP Basic) when contacting the remote server.
no default
Third party

The username to use (HTTP Basic) when contacting the remote server.

Type
String
Default
none
Defined by
ConfigClientProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Hibernate & JDBC

Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.

cas.jdbc.gen-ddlWhether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.
true

Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.

Type
Boolean
Default
true
Defined by
DatabaseProperties
cas.jdbc.physical-table-namesIndicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database.
no default

Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default.

Type
Map<String,String>
Default
none
Defined by
DatabaseProperties
cas.jdbc.show-sqlWhether SQL queries should be displayed in the console/logs.
false

Whether SQL queries should be displayed in the console/logs.

Type
Boolean
Default
false
Defined by
DatabaseProperties
Notes on configuration

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

:information_source: Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

Remember that configuration server serves property sources from /{name}/{profile}/{label} to applications, where the default bindings in the client app are the following:



1
2
3



"name" = ${spring.application.name}
"profile" = ${spring.profiles.active}
"label" = "master"

All of them can be overridden by setting spring.cloud.config.* (where * is name, profile or label). The “label” is useful for rolling back to previous versions of configuration; with the default Config Server implementation it can be a git label, branch name or commit id. Label can also be provided as a comma-separated list, in which case the items in the list are tried on-by-one until one succeeds. This can be useful when working on a feature branch, for instance, when you might want to align the config label with your branch, but make it optional (e.g. spring.cloud.config.label=myfeature,develop).

To lean more about how CAS allows you to reload configuration changes, please review this guide.

Spring Cloud Configuration Server Sources

Various configuration profiles exist to determine how configuration server should retrieve properties and settings.

The cloud configuration modules provided above may also be used verbatim inside a CAS server overlay. Remember that the primary objective for these modules is to retrieve settings and properties from a source. While they are mostly and primarily useful when activated inside the Spring Cloud Configuration server and can be set to honor profiles and such, they nonetheless may also be used inside a CAS server overlay directly to fetch settings from a source while running in standalone mode. In such scenarios, all sources of configuration regardless of format or syntax will work alongside each other to retrieve settings and you can certainly mix and match as you see fit.

Spring Cloud Configuration Server Composite Sources

In some scenarios you may wish to pull configuration data from multiple environment repositories. To do this just enable multiple profiles in your configuration server’s application properties or YAML file. If, for example, you want to pull configuration data from a Git repository as well as a SVN repository you would set the following properties for your configuration server.



1
2
3
4
5
6
7
8
9
10
11
12



spring:
  profiles:
    active: git, svn
  cloud:
    config:
      server:
        svn:
          uri: file:///path/to/svn/repo
          order: 2
        git:
          uri: file:///path/to/git/repo
          order: 1

In addition to each repo specifying a URI, you can also specify an order property. The order property allows you to specify the priority order for all your repositories. The lower the numerical value of the order property the higher priority it will have. The priority order of a repository will help resolve any potential conflicts between repositories that contain values for the same properties.

Spring Cloud Configuration Server Property Overrides

The configuration server has an “overrides” feature that allows the operator to provide configuration properties to all applications that cannot be accidentally changed by the application using the normal change events and hooks. To declare overrides add a map of name-value pairs to spring.cloud.config.server.overrides.

For example:



1
2
3
4
5
6



spring:
  cloud:
    config:
      server:
        overrides:
          foo: bar

This will cause the CAS server (as the client of the configuration server) to read foo=bar independent of its own configuration.