Spring Cloud Configuration Server - Spring Cloud Kubernetes
Spring Cloud Kubernetes
provides implementations of well known Spring Cloud interfaces allowing developers
to build and run Spring Cloud applications on Kubernetes, and take advantage of configuration management
features in Kubernetes such as ConfigMap
s and Secret
s.
Support is provided via the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-configuration-cloud-kubernetes</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-configuration-cloud-kubernetes:${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-support-configuration-cloud-kubernetes"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here 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-support-configuration-cloud-kubernetes"
}
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Third Party
- Notes
spring.cloud.kubernetes.config.enable-api=true
CAS Property:
|
1 |
spring.cloud.kubernetes.config.enable-api=true |
1
spring:
cloud:
kubernetes:
config:
enable-api: "true"
1
java -Dspring.cloud.kubernetes.config.enable-api="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_ENABLE_API="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.enable-api="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.enabled=true
Enable the ConfigMap property source locator.
How can I configure this property?
CAS Property: spring.cloud.kubernetes.config.enabled
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.
.properties
files:
1
spring.cloud.kubernetes.config.enabled=true
1
spring:
cloud:
kubernetes:
config:
enabled: "true"
1
java -Dspring.cloud.kubernetes.config.enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.fail-fast=false
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.fail-fast
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.
.properties
files:
1
spring.cloud.kubernetes.config.fail-fast=...
1
spring:
cloud:
kubernetes:
config:
fail-fast: "..."
1
java -Dspring.cloud.kubernetes.config.fail-fast="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_FAIL_FAST="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.fail-fast="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.include-profile-specific-sources=true
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.include-profile-specific-sources
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.
.properties
files:
1
spring.cloud.kubernetes.config.include-profile-specific-sources=true
1
spring:
cloud:
kubernetes:
config:
include-profile-specific-sources: "true"
1
java -Dspring.cloud.kubernetes.config.include-profile-specific-sources="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_INCLUDE_PROFILE_SPECIFIC_SOURCES="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.include-profile-specific-sources="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.labels=
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.labels
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.
.properties
files:
1
spring.cloud.kubernetes.config.labels=...
1
spring:
cloud:
kubernetes:
config:
labels: "..."
1
java -Dspring.cloud.kubernetes.config.labels="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_LABELS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.labels="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.name=
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.name
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.
.properties
files:
1
spring.cloud.kubernetes.config.name=...
1
spring:
cloud:
kubernetes:
config:
name: "..."
1
java -Dspring.cloud.kubernetes.config.name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.namespace=
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.namespace
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.
.properties
files:
1
spring.cloud.kubernetes.config.namespace=...
1
spring:
cloud:
kubernetes:
config:
namespace: "..."
1
java -Dspring.cloud.kubernetes.config.namespace="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_NAMESPACE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.namespace="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.paths=
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.paths
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.
.properties
files:
1
spring.cloud.kubernetes.config.paths=...
1
spring:
cloud:
kubernetes:
config:
paths: "..."
1
java -Dspring.cloud.kubernetes.config.paths="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_PATHS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.paths="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.retry=
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.retry
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.
.properties
files:
1
spring.cloud.kubernetes.config.retry=...
1
spring:
cloud:
kubernetes:
config:
retry: "..."
1
java -Dspring.cloud.kubernetes.config.retry="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_RETRY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.retry="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.sources=
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.sources
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.
.properties
files:
1
spring.cloud.kubernetes.config.sources=...
1
spring:
cloud:
kubernetes:
config:
sources: "..."
1
java -Dspring.cloud.kubernetes.config.sources="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_SOURCES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.sources="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.config.use-name-as-prefix=false
org.springframework.cloud.kubernetes.commons.config.ConfigMapConfigProperties.
CAS Property: spring.cloud.kubernetes.config.use-name-as-prefix
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.
.properties
files:
1
spring.cloud.kubernetes.config.use-name-as-prefix=...
1
spring:
cloud:
kubernetes:
config:
use-name-as-prefix: "..."
1
java -Dspring.cloud.kubernetes.config.use-name-as-prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_CONFIG_USE_NAME_AS_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.config.use-name-as-prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.enable-api=false
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.enable-api
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.enable-api=...
1
spring:
cloud:
kubernetes:
secrets:
enable-api: "..."
1
java -Dspring.cloud.kubernetes.secrets.enable-api="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_ENABLE_API="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.enable-api="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.enabled=true
Enable the Secrets property source locator.
How can I configure this property?
CAS Property: spring.cloud.kubernetes.secrets.enabled
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.enabled=true
1
spring:
cloud:
kubernetes:
secrets:
enabled: "true"
1
java -Dspring.cloud.kubernetes.secrets.enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.fail-fast=false
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.fail-fast
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.fail-fast=...
1
spring:
cloud:
kubernetes:
secrets:
fail-fast: "..."
1
java -Dspring.cloud.kubernetes.secrets.fail-fast="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_FAIL_FAST="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.fail-fast="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.include-profile-specific-sources=true
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.include-profile-specific-sources
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.include-profile-specific-sources=true
1
spring:
cloud:
kubernetes:
secrets:
include-profile-specific-sources: "true"
1
java -Dspring.cloud.kubernetes.secrets.include-profile-specific-sources="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_INCLUDE_PROFILE_SPECIFIC_SOURCES="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.include-profile-specific-sources="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.labels=
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.labels
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.labels=...
1
spring:
cloud:
kubernetes:
secrets:
labels: "..."
1
java -Dspring.cloud.kubernetes.secrets.labels="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_LABELS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.labels="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.name=
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.name
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.name=...
1
spring:
cloud:
kubernetes:
secrets:
name: "..."
1
java -Dspring.cloud.kubernetes.secrets.name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.namespace=
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.namespace
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.namespace=...
1
spring:
cloud:
kubernetes:
secrets:
namespace: "..."
1
java -Dspring.cloud.kubernetes.secrets.namespace="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_NAMESPACE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.namespace="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.paths=
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.paths
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.paths=...
1
spring:
cloud:
kubernetes:
secrets:
paths: "..."
1
java -Dspring.cloud.kubernetes.secrets.paths="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_PATHS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.paths="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.retry=
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.retry
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.retry=...
1
spring:
cloud:
kubernetes:
secrets:
retry: "..."
1
java -Dspring.cloud.kubernetes.secrets.retry="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_RETRY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.retry="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.sources=
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.sources
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.sources=...
1
spring:
cloud:
kubernetes:
secrets:
sources: "..."
1
java -Dspring.cloud.kubernetes.secrets.sources="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_SOURCES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.sources="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.kubernetes.secrets.use-name-as-prefix=false
org.springframework.cloud.kubernetes.commons.config.SecretsConfigProperties.
CAS Property: spring.cloud.kubernetes.secrets.use-name-as-prefix
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.
.properties
files:
1
spring.cloud.kubernetes.secrets.use-name-as-prefix=...
1
spring:
cloud:
kubernetes:
secrets:
use-name-as-prefix: "..."
1
java -Dspring.cloud.kubernetes.secrets.use-name-as-prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export SPRING_CLOUD_KUBERNETES_SECRETS_USE_NAME_AS_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --spring.cloud.kubernetes.secrets.use-name-as-prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
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.
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, specially 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.