WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
Eureka Server Discovery Service
Eureka is a REST-based service that is primarily used for locating services for the purpose of load balancing and failover of middle-tier servers. Eureka provides both a discovery server and also support for clients which would be the individual CAS servers themselves in the pool. The server can be configured and deployed to be highly available, with each server replicating state about the registered services to the others.
CAS provides a Eureka-enabled service discovery integration that is based on Spring Cloud Netflix and bootstrapped via Spring Cloud.
Each individual CAS server is given the ability to auto-register itself with the discovery server, provided configuration is made available to instruct the CAS server how to locate and connect to the discover server service.
Support is added by including the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-eureka-client</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-eureka-client:${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-eureka-client"
}
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-eureka-client"
}
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
eureka.client.allow-redirects=false
Indicates whether server can redirect a client request to a backup server/cluster. If set to false, the server will handle the request directly, If set to true, it may send HTTP redirect to the client, with a new server location.
CAS Property:
|
1 |
eureka.client.allow-redirects=... |
1
eureka:
client:
allow-redirects: "..."
1
java -Deureka.client.allow-redirects="..." -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 EUREKA_CLIENT_ALLOW_REDIRECTS="..."
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 --eureka.client.allow-redirects="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.availability-zones=
Gets the list of availability zones (used in AWS data centers) for the region in which this instance resides. The changes are effective at runtime at the next registry fetch cycle as specified by registryFetchIntervalSeconds.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.availability-zones
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
eureka.client.availability-zones=...
1
eureka:
client:
availability-zones: "..."
1
java -Deureka.client.availability-zones="..." -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 EUREKA_CLIENT_AVAILABILITY_ZONES="..."
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 --eureka.client.availability-zones="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.backup-registry-impl=
Gets the name of the implementation which implements BackupRegistry to fetch the registry information as a fallback option for only the first time when the eureka client starts. This may be needed for applications which needs additional resiliency for registry information without which it cannot operate.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.backup-registry-impl
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
eureka.client.backup-registry-impl=...
1
eureka:
client:
backup-registry-impl: "..."
1
java -Deureka.client.backup-registry-impl="..." -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 EUREKA_CLIENT_BACKUP_REGISTRY_IMPL="..."
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 --eureka.client.backup-registry-impl="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.cache-refresh-executor-exponential-back-off-bound=10
Cache refresh executor exponential back off related property. It is a maximum multiplier value for retry delay, in case where a sequence of timeouts occurred.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.cache-refresh-executor-exponential-back-off-bound
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
eureka.client.cache-refresh-executor-exponential-back-off-bound=10
1
eureka:
client:
cache-refresh-executor-exponential-back-off-bound: "10"
1
java -Deureka.client.cache-refresh-executor-exponential-back-off-bound="10" -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 EUREKA_CLIENT_CACHE_REFRESH_EXECUTOR_EXPONENTIAL_BACK_OFF_BOUND="10"
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 --eureka.client.cache-refresh-executor-exponential-back-off-bound="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.cache-refresh-executor-thread-pool-size=2
The thread pool size for the cacheRefreshExecutor to initialise with.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.cache-refresh-executor-thread-pool-size
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
eureka.client.cache-refresh-executor-thread-pool-size=2
1
eureka:
client:
cache-refresh-executor-thread-pool-size: "2"
1
java -Deureka.client.cache-refresh-executor-thread-pool-size="2" -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 EUREKA_CLIENT_CACHE_REFRESH_EXECUTOR_THREAD_POOL_SIZE="2"
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 --eureka.client.cache-refresh-executor-thread-pool-size="2"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.client-data-accept=
EurekaAccept name for client data accept.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.client-data-accept
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
eureka.client.client-data-accept=...
1
eureka:
client:
client-data-accept: "..."
1
java -Deureka.client.client-data-accept="..." -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 EUREKA_CLIENT_CLIENT_DATA_ACCEPT="..."
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 --eureka.client.client-data-accept="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.decoder-name=
This is a transient config and once the latest codecs are stable, can be removed (as there will only be one).
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.decoder-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
eureka.client.decoder-name=...
1
eureka:
client:
decoder-name: "..."
1
java -Deureka.client.decoder-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 EUREKA_CLIENT_DECODER_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 --eureka.client.decoder-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.disable-delta=false
Indicates whether the eureka client should disable fetching of delta and should rather resort to getting the full registry information. Note that the delta fetches can reduce the traffic tremendously, because the rate of change with the eureka server is normally much lower than the rate of fetches. The changes are effective at runtime at the next registry fetch cycle as specified by registryFetchIntervalSeconds
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.disable-delta
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
eureka.client.disable-delta=...
1
eureka:
client:
disable-delta: "..."
1
java -Deureka.client.disable-delta="..." -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 EUREKA_CLIENT_DISABLE_DELTA="..."
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 --eureka.client.disable-delta="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.dollar-replacement=_-
Get a replacement string for Dollar sign $
during serializing/deserializing information in eureka server.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.dollar-replacement
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
eureka.client.dollar-replacement=_-
1
eureka:
client:
dollar-replacement: "_-"
1
java -Deureka.client.dollar-replacement="_-" -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 EUREKA_CLIENT_DOLLAR_REPLACEMENT="_-"
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 --eureka.client.dollar-replacement="_-"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.enabled=true
Flag to indicate that the Eureka client is enabled.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.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
eureka.client.enabled=true
1
eureka:
client:
enabled: "true"
1
java -Deureka.client.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 EUREKA_CLIENT_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 --eureka.client.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.encoder-name=
This is a transient config and once the latest codecs are stable, can be removed (as there will only be one).
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.encoder-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
eureka.client.encoder-name=...
1
eureka:
client:
encoder-name: "..."
1
java -Deureka.client.encoder-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 EUREKA_CLIENT_ENCODER_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 --eureka.client.encoder-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.escape-char-replacement=__
Get a replacement string for underscore sign _
during serializing/ deserializing information in eureka server.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.escape-char-replacement
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
eureka.client.escape-char-replacement=__
1
eureka:
client:
escape-char-replacement: "__"
1
java -Deureka.client.escape-char-replacement="__" -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 EUREKA_CLIENT_ESCAPE_CHAR_REPLACEMENT="__"
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 --eureka.client.escape-char-replacement="__"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-connection-idle-timeout-seconds=30
Indicates how much time (in seconds) that the HTTP connections to eureka server can stay idle before it can be closed. In the AWS environment, it is recommended that the values is 30 seconds or less, since the firewall cleans up the connection information after a few mins leaving the connection hanging in limbo.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-connection-idle-timeout-seconds
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
eureka.client.eureka-connection-idle-timeout-seconds=30
1
eureka:
client:
eureka-connection-idle-timeout-seconds: "30"
1
java -Deureka.client.eureka-connection-idle-timeout-seconds="30" -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 EUREKA_CLIENT_EUREKA_CONNECTION_IDLE_TIMEOUT_SECONDS="30"
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 --eureka.client.eureka-connection-idle-timeout-seconds="30"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-server-connect-timeout-seconds=5
Indicates how long to wait (in seconds) before a connection to eureka server needs to timeout. Note that the connections in the client are pooled by HttpClient
and this setting affects the actual connection creation and also the wait time to get the connection from the pool.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-server-connect-timeout-seconds
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
eureka.client.eureka-server-connect-timeout-seconds=5
1
eureka:
client:
eureka-server-connect-timeout-seconds: "5"
1
java -Deureka.client.eureka-server-connect-timeout-seconds="5" -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 EUREKA_CLIENT_EUREKA_SERVER_CONNECT_TIMEOUT_SECONDS="5"
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 --eureka.client.eureka-server-connect-timeout-seconds="5"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-server-d-n-s-name=
Gets the DNS name to be queried to get the list of eureka servers.This information is not required if the contract returns the service urls by implementing serviceUrls. The DNS mechanism is used when useDnsForFetchingServiceUrls is set to true and the eureka client expects the DNS to configured a certain way so that it can fetch changing eureka servers dynamically. The changes are effective at runtime.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-server-d-n-s-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
eureka.client.eureka-server-d-n-s-name=...
1
eureka:
client:
eureka-server-d-n-s-name: "..."
1
java -Deureka.client.eureka-server-d-n-s-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 EUREKA_CLIENT_EUREKA_SERVER_D_N_S_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 --eureka.client.eureka-server-d-n-s-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-server-port=
Gets the port to be used to construct the service url to contact eureka server when the list of eureka servers come from the DNS.This information is not required if the contract returns the service urls eurekaServerServiceUrls(String). The DNS mechanism is used when useDnsForFetchingServiceUrls is set to true and the eureka client expects the DNS to configured a certain way so that it can fetch changing eureka servers dynamically. The changes are effective at runtime.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-server-port
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
eureka.client.eureka-server-port=...
1
eureka:
client:
eureka-server-port: "..."
1
java -Deureka.client.eureka-server-port="..." -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 EUREKA_CLIENT_EUREKA_SERVER_PORT="..."
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 --eureka.client.eureka-server-port="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-server-read-timeout-seconds=8
Indicates how long to wait (in seconds) before a read from eureka server needs to timeout.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-server-read-timeout-seconds
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
eureka.client.eureka-server-read-timeout-seconds=8
1
eureka:
client:
eureka-server-read-timeout-seconds: "8"
1
java -Deureka.client.eureka-server-read-timeout-seconds="8" -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 EUREKA_CLIENT_EUREKA_SERVER_READ_TIMEOUT_SECONDS="8"
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 --eureka.client.eureka-server-read-timeout-seconds="8"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-server-total-connections=200
Gets the total number of connections that is allowed from eureka client to all eureka servers.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-server-total-connections
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
eureka.client.eureka-server-total-connections=200
1
eureka:
client:
eureka-server-total-connections: "200"
1
java -Deureka.client.eureka-server-total-connections="200" -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 EUREKA_CLIENT_EUREKA_SERVER_TOTAL_CONNECTIONS="200"
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 --eureka.client.eureka-server-total-connections="200"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-server-total-connections-per-host=50
Gets the total number of connections that is allowed from eureka client to a eureka server host.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-server-total-connections-per-host
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
eureka.client.eureka-server-total-connections-per-host=50
1
eureka:
client:
eureka-server-total-connections-per-host: "50"
1
java -Deureka.client.eureka-server-total-connections-per-host="50" -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 EUREKA_CLIENT_EUREKA_SERVER_TOTAL_CONNECTIONS_PER_HOST="50"
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 --eureka.client.eureka-server-total-connections-per-host="50"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-server-u-r-l-context=
Gets the URL context to be used to construct the service url to contact eureka server when the list of eureka servers come from the DNS. This information is not required if the contract returns the service urls from eurekaServerServiceUrls. The DNS mechanism is used when useDnsForFetchingServiceUrls is set to true and the eureka client expects the DNS to configured a certain way so that it can fetch changing eureka servers dynamically. The changes are effective at runtime.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-server-u-r-l-context
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
eureka.client.eureka-server-u-r-l-context=...
1
eureka:
client:
eureka-server-u-r-l-context: "..."
1
java -Deureka.client.eureka-server-u-r-l-context="..." -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 EUREKA_CLIENT_EUREKA_SERVER_U_R_L_CONTEXT="..."
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 --eureka.client.eureka-server-u-r-l-context="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.eureka-service-url-poll-interval-seconds=300
Indicates how often(in seconds) to poll for changes to eureka server information. Eureka servers could be added or removed and this setting controls how soon the eureka clients should know about it.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.eureka-service-url-poll-interval-seconds
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
eureka.client.eureka-service-url-poll-interval-seconds=300
1
eureka:
client:
eureka-service-url-poll-interval-seconds: "300"
1
java -Deureka.client.eureka-service-url-poll-interval-seconds="300" -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 EUREKA_CLIENT_EUREKA_SERVICE_URL_POLL_INTERVAL_SECONDS="300"
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 --eureka.client.eureka-service-url-poll-interval-seconds="300"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.fetch-registry=true
Indicates whether this client should fetch eureka registry information from eureka server.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.fetch-registry
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
eureka.client.fetch-registry=true
1
eureka:
client:
fetch-registry: "true"
1
java -Deureka.client.fetch-registry="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 EUREKA_CLIENT_FETCH_REGISTRY="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 --eureka.client.fetch-registry="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.fetch-remote-regions-registry=
Comma separated list of regions for which the eureka registry information will be fetched. It is mandatory to define the availability zones for each of these regions as returned by availabilityZones. Failing to do so, will result in failure of discovery client startup.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.fetch-remote-regions-registry
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
eureka.client.fetch-remote-regions-registry=...
1
eureka:
client:
fetch-remote-regions-registry: "..."
1
java -Deureka.client.fetch-remote-regions-registry="..." -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 EUREKA_CLIENT_FETCH_REMOTE_REGIONS_REGISTRY="..."
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 --eureka.client.fetch-remote-regions-registry="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.filter-only-up-instances=true
Indicates whether to get the applications after filtering the applications for instances with only InstanceStatus UP states.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.filter-only-up-instances
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
eureka.client.filter-only-up-instances=true
1
eureka:
client:
filter-only-up-instances: "true"
1
java -Deureka.client.filter-only-up-instances="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 EUREKA_CLIENT_FILTER_ONLY_UP_INSTANCES="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 --eureka.client.filter-only-up-instances="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.g-zip-content=true
Indicates whether the content fetched from eureka server has to be compressed whenever it is supported by the server. The registry information from the eureka server is compressed for optimum network traffic.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.g-zip-content
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
eureka.client.g-zip-content=true
1
eureka:
client:
g-zip-content: "true"
1
java -Deureka.client.g-zip-content="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 EUREKA_CLIENT_G_ZIP_CONTENT="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 --eureka.client.g-zip-content="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.healthcheck.enabled=true
Enables the Eureka health check handler.
How can I configure this property?
CAS Property: eureka.client.healthcheck.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
eureka.client.healthcheck.enabled=true
1
eureka:
client:
healthcheck:
enabled: "true"
1
java -Deureka.client.healthcheck.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 EUREKA_CLIENT_HEALTHCHECK_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 --eureka.client.healthcheck.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.heartbeat-executor-exponential-back-off-bound=10
Heartbeat executor exponential back off related property. It is a maximum multiplier value for retry delay, in case where a sequence of timeouts occurred.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.heartbeat-executor-exponential-back-off-bound
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
eureka.client.heartbeat-executor-exponential-back-off-bound=10
1
eureka:
client:
heartbeat-executor-exponential-back-off-bound: "10"
1
java -Deureka.client.heartbeat-executor-exponential-back-off-bound="10" -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 EUREKA_CLIENT_HEARTBEAT_EXECUTOR_EXPONENTIAL_BACK_OFF_BOUND="10"
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 --eureka.client.heartbeat-executor-exponential-back-off-bound="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.heartbeat-executor-thread-pool-size=2
The thread pool size for the heartbeatExecutor to initialise with.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.heartbeat-executor-thread-pool-size
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
eureka.client.heartbeat-executor-thread-pool-size=2
1
eureka:
client:
heartbeat-executor-thread-pool-size: "2"
1
java -Deureka.client.heartbeat-executor-thread-pool-size="2" -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 EUREKA_CLIENT_HEARTBEAT_EXECUTOR_THREAD_POOL_SIZE="2"
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 --eureka.client.heartbeat-executor-thread-pool-size="2"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.initial-instance-info-replication-interval-seconds=40
Indicates how long initially (in seconds) to replicate instance info to the eureka server.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.initial-instance-info-replication-interval-seconds
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
eureka.client.initial-instance-info-replication-interval-seconds=40
1
eureka:
client:
initial-instance-info-replication-interval-seconds: "40"
1
java -Deureka.client.initial-instance-info-replication-interval-seconds="40" -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 EUREKA_CLIENT_INITIAL_INSTANCE_INFO_REPLICATION_INTERVAL_SECONDS="40"
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 --eureka.client.initial-instance-info-replication-interval-seconds="40"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.instance-info-replication-interval-seconds=30
Indicates how often(in seconds) to replicate instance changes to be replicated to the eureka server.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.instance-info-replication-interval-seconds
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
eureka.client.instance-info-replication-interval-seconds=30
1
eureka:
client:
instance-info-replication-interval-seconds: "30"
1
java -Deureka.client.instance-info-replication-interval-seconds="30" -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 EUREKA_CLIENT_INSTANCE_INFO_REPLICATION_INTERVAL_SECONDS="30"
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 --eureka.client.instance-info-replication-interval-seconds="30"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.jersey.enabled=true
Enables the use of JerseyClient for Eureka HTTP Client.
How can I configure this property?
CAS Property: eureka.client.jersey.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
eureka.client.jersey.enabled=true
1
eureka:
client:
jersey:
enabled: "true"
1
java -Deureka.client.jersey.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 EUREKA_CLIENT_JERSEY_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 --eureka.client.jersey.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.log-delta-diff=false
Indicates whether to log differences between the eureka server and the eureka client in terms of registry information. Eureka client tries to retrieve only delta changes from eureka server to minimize network traffic. After receiving the deltas, eureka client reconciles the information from the server to verify it has not missed out some information. Reconciliation failures could happen when the client has had network issues communicating to server.If the reconciliation fails, eureka client gets the full registry information. While getting the full registry information, the eureka client can log the differences between the client and the server and this setting controls that. The changes are effective at runtime at the next registry fetch cycle as specified by registryFetchIntervalSecondsr
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.log-delta-diff
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
eureka.client.log-delta-diff=...
1
eureka:
client:
log-delta-diff: "..."
1
java -Deureka.client.log-delta-diff="..." -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 EUREKA_CLIENT_LOG_DELTA_DIFF="..."
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 --eureka.client.log-delta-diff="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.on-demand-update-status-change=true
If set to true, local status updates via ApplicationInfoManager will trigger on-demand (but rate limited) register/updates to remote eureka servers.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.on-demand-update-status-change
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
eureka.client.on-demand-update-status-change=true
1
eureka:
client:
on-demand-update-status-change: "true"
1
java -Deureka.client.on-demand-update-status-change="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 EUREKA_CLIENT_ON_DEMAND_UPDATE_STATUS_CHANGE="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 --eureka.client.on-demand-update-status-change="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.order=0
Order of the discovery client used by `CompositeDiscoveryClient` for sorting available clients.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.order
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
eureka.client.order=0
1
eureka:
client:
order: "0"
1
java -Deureka.client.order="0" -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 EUREKA_CLIENT_ORDER="0"
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 --eureka.client.order="0"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.prefer-same-zone-eureka=true
Indicates whether or not this instance should try to use the eureka server in the same zone for latency and/or other reason. Ideally eureka clients are configured to talk to servers in the same zone The changes are effective at runtime at the next registry fetch cycle as specified by registryFetchIntervalSeconds
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.prefer-same-zone-eureka
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
eureka.client.prefer-same-zone-eureka=true
1
eureka:
client:
prefer-same-zone-eureka: "true"
1
java -Deureka.client.prefer-same-zone-eureka="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 EUREKA_CLIENT_PREFER_SAME_ZONE_EUREKA="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 --eureka.client.prefer-same-zone-eureka="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.property-resolver=
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.property-resolver
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
eureka.client.property-resolver=...
1
eureka:
client:
property-resolver: "..."
1
java -Deureka.client.property-resolver="..." -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 EUREKA_CLIENT_PROPERTY_RESOLVER="..."
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 --eureka.client.property-resolver="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.proxy-host=
Gets the proxy host to eureka server if any.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.proxy-host
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
eureka.client.proxy-host=...
1
eureka:
client:
proxy-host: "..."
1
java -Deureka.client.proxy-host="..." -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 EUREKA_CLIENT_PROXY_HOST="..."
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 --eureka.client.proxy-host="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.proxy-password=
Gets the proxy password if any.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.proxy-password
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
eureka.client.proxy-password=...
1
eureka:
client:
proxy-password: "..."
1
java -Deureka.client.proxy-password="..." -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 EUREKA_CLIENT_PROXY_PASSWORD="..."
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 --eureka.client.proxy-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.proxy-port=
Gets the proxy port to eureka server if any.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.proxy-port
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
eureka.client.proxy-port=...
1
eureka:
client:
proxy-port: "..."
1
java -Deureka.client.proxy-port="..." -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 EUREKA_CLIENT_PROXY_PORT="..."
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 --eureka.client.proxy-port="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.proxy-user-name=
Gets the proxy user name if any.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.proxy-user-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
eureka.client.proxy-user-name=...
1
eureka:
client:
proxy-user-name: "..."
1
java -Deureka.client.proxy-user-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 EUREKA_CLIENT_PROXY_USER_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 --eureka.client.proxy-user-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.refresh.enable=true
Determines whether the EurekaClient instance can be refreshed or not(If disabled none of the Eureka client properties will be refreshable).
How can I configure this property?
CAS Property: eureka.client.refresh.enable
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
eureka.client.refresh.enable=true
1
eureka:
client:
refresh:
enable: "true"
1
java -Deureka.client.refresh.enable="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 EUREKA_CLIENT_REFRESH_ENABLE="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 --eureka.client.refresh.enable="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.region=us-east-1
Gets the region (used in AWS datacenters) where this instance resides.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.region
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
eureka.client.region=us-east-1
1
eureka:
client:
region: "us-east-1"
1
java -Deureka.client.region="us-east-1" -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 EUREKA_CLIENT_REGION="us-east-1"
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 --eureka.client.region="us-east-1"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.register-with-eureka=true
Indicates whether or not this instance should register its information with eureka server for discovery by others. In some cases, you do not want your instances to be discovered whereas you just want do discover other instances.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.register-with-eureka
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
eureka.client.register-with-eureka=true
1
eureka:
client:
register-with-eureka: "true"
1
java -Deureka.client.register-with-eureka="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 EUREKA_CLIENT_REGISTER_WITH_EUREKA="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 --eureka.client.register-with-eureka="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.registry-fetch-interval-seconds=30
Indicates how often(in seconds) to fetch the registry information from the eureka server.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.registry-fetch-interval-seconds
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
eureka.client.registry-fetch-interval-seconds=30
1
eureka:
client:
registry-fetch-interval-seconds: "30"
1
java -Deureka.client.registry-fetch-interval-seconds="30" -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 EUREKA_CLIENT_REGISTRY_FETCH_INTERVAL_SECONDS="30"
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 --eureka.client.registry-fetch-interval-seconds="30"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.registry-refresh-single-vip-address=
Indicates whether the client is only interested in the registry information for a single VIP.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.registry-refresh-single-vip-address
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
eureka.client.registry-refresh-single-vip-address=...
1
eureka:
client:
registry-refresh-single-vip-address: "..."
1
java -Deureka.client.registry-refresh-single-vip-address="..." -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 EUREKA_CLIENT_REGISTRY_REFRESH_SINGLE_VIP_ADDRESS="..."
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 --eureka.client.registry-refresh-single-vip-address="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.rest-template-timeout.connect-request-timeout=180000
org.springframework.cloud.netflix.eureka.RestTemplateTimeoutProperties.
CAS Property: eureka.client.rest-template-timeout.connect-request-timeout
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
eureka.client.rest-template-timeout.connect-request-timeout=180000
1
eureka:
client:
rest-template-timeout:
connect-request-timeout: "180000"
1
java -Deureka.client.rest-template-timeout.connect-request-timeout="180000" -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 EUREKA_CLIENT_REST_TEMPLATE_TIMEOUT_CONNECT_REQUEST_TIMEOUT="180000"
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 --eureka.client.rest-template-timeout.connect-request-timeout="180000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.rest-template-timeout.connect-timeout=180000
Default values are set to 180000, in keeping with RequestConfig
and SocketConfig
defaults.
org.springframework.cloud.netflix.eureka.RestTemplateTimeoutProperties.
CAS Property: eureka.client.rest-template-timeout.connect-timeout
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
eureka.client.rest-template-timeout.connect-timeout=180000
1
eureka:
client:
rest-template-timeout:
connect-timeout: "180000"
1
java -Deureka.client.rest-template-timeout.connect-timeout="180000" -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 EUREKA_CLIENT_REST_TEMPLATE_TIMEOUT_CONNECT_TIMEOUT="180000"
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 --eureka.client.rest-template-timeout.connect-timeout="180000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.rest-template-timeout.socket-timeout=180000
org.springframework.cloud.netflix.eureka.RestTemplateTimeoutProperties.
CAS Property: eureka.client.rest-template-timeout.socket-timeout
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
eureka.client.rest-template-timeout.socket-timeout=180000
1
eureka:
client:
rest-template-timeout:
socket-timeout: "180000"
1
java -Deureka.client.rest-template-timeout.socket-timeout="180000" -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 EUREKA_CLIENT_REST_TEMPLATE_TIMEOUT_SOCKET_TIMEOUT="180000"
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 --eureka.client.rest-template-timeout.socket-timeout="180000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.restclient.enabled=false
Enables the use of RestClient for Eureka HTTP Client.
How can I configure this property?
CAS Property: eureka.client.restclient.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
eureka.client.restclient.enabled=...
1
eureka:
client:
restclient:
enabled: "..."
1
java -Deureka.client.restclient.enabled="..." -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 EUREKA_CLIENT_RESTCLIENT_ENABLED="..."
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 --eureka.client.restclient.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.restclient.timeout.connect-request-timeout=180000
org.springframework.cloud.netflix.eureka.RestClientTimeoutProperties.
CAS Property: eureka.client.restclient.timeout.connect-request-timeout
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
eureka.client.restclient.timeout.connect-request-timeout=180000
1
eureka:
client:
restclient:
timeout:
connect-request-timeout: "180000"
1
java -Deureka.client.restclient.timeout.connect-request-timeout="180000" -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 EUREKA_CLIENT_RESTCLIENT_TIMEOUT_CONNECT_REQUEST_TIMEOUT="180000"
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 --eureka.client.restclient.timeout.connect-request-timeout="180000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.restclient.timeout.connect-timeout=180000
Default values are set to 180000, in keeping with RequestConfig
and SocketConfig
defaults.
org.springframework.cloud.netflix.eureka.RestClientTimeoutProperties.
CAS Property: eureka.client.restclient.timeout.connect-timeout
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
eureka.client.restclient.timeout.connect-timeout=180000
1
eureka:
client:
restclient:
timeout:
connect-timeout: "180000"
1
java -Deureka.client.restclient.timeout.connect-timeout="180000" -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 EUREKA_CLIENT_RESTCLIENT_TIMEOUT_CONNECT_TIMEOUT="180000"
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 --eureka.client.restclient.timeout.connect-timeout="180000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.restclient.timeout.socket-timeout=180000
org.springframework.cloud.netflix.eureka.RestClientTimeoutProperties.
CAS Property: eureka.client.restclient.timeout.socket-timeout
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
eureka.client.restclient.timeout.socket-timeout=180000
1
eureka:
client:
restclient:
timeout:
socket-timeout: "180000"
1
java -Deureka.client.restclient.timeout.socket-timeout="180000" -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 EUREKA_CLIENT_RESTCLIENT_TIMEOUT_SOCKET_TIMEOUT="180000"
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 --eureka.client.restclient.timeout.socket-timeout="180000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.service-url=
Map of availability zone to list of fully qualified URLs to communicate with eureka server. Each value can be a single URL or a comma separated list of alternative locations. Typically the eureka server URLs carry protocol,host,port,context and version information if any. Example: https://ec2-256-156-243-129.compute-1.amazonaws.com:7001/eureka/ The changes are effective at runtime at the next service url refresh cycle as specified by eurekaServiceUrlPollIntervalSeconds.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.service-url
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
eureka.client.service-url=...
1
eureka:
client:
service-url: "..."
1
java -Deureka.client.service-url="..." -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 EUREKA_CLIENT_SERVICE_URL="..."
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 --eureka.client.service-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.should-enforce-registration-at-init=false
Indicates whether the client should enforce registration during initialization. Defaults to false.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.should-enforce-registration-at-init
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
eureka.client.should-enforce-registration-at-init=...
1
eureka:
client:
should-enforce-registration-at-init: "..."
1
java -Deureka.client.should-enforce-registration-at-init="..." -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 EUREKA_CLIENT_SHOULD_ENFORCE_REGISTRATION_AT_INIT="..."
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 --eureka.client.should-enforce-registration-at-init="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.should-unregister-on-shutdown=true
Indicates whether the client should explicitly unregister itself from the remote server on client shutdown.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.should-unregister-on-shutdown
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
eureka.client.should-unregister-on-shutdown=true
1
eureka:
client:
should-unregister-on-shutdown: "true"
1
java -Deureka.client.should-unregister-on-shutdown="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 EUREKA_CLIENT_SHOULD_UNREGISTER_ON_SHUTDOWN="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 --eureka.client.should-unregister-on-shutdown="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.tls.enabled=
org.springframework.cloud.configuration.TlsProperties.
CAS Property: eureka.client.tls.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
eureka.client.tls.enabled=...
1
eureka:
client:
tls:
enabled: "..."
1
java -Deureka.client.tls.enabled="..." -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 EUREKA_CLIENT_TLS_ENABLED="..."
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 --eureka.client.tls.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.tls.key-password=
org.springframework.cloud.configuration.TlsProperties.
CAS Property: eureka.client.tls.key-password
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
eureka.client.tls.key-password=...
1
eureka:
client:
tls:
key-password: "..."
1
java -Deureka.client.tls.key-password="..." -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 EUREKA_CLIENT_TLS_KEY_PASSWORD="..."
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 --eureka.client.tls.key-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.tls.key-store=
org.springframework.cloud.configuration.TlsProperties.
CAS Property: eureka.client.tls.key-store
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
eureka.client.tls.key-store=...
1
eureka:
client:
tls:
key-store: "..."
1
java -Deureka.client.tls.key-store="..." -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 EUREKA_CLIENT_TLS_KEY_STORE="..."
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 --eureka.client.tls.key-store="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.tls.key-store-password=
org.springframework.cloud.configuration.TlsProperties.
CAS Property: eureka.client.tls.key-store-password
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
eureka.client.tls.key-store-password=...
1
eureka:
client:
tls:
key-store-password: "..."
1
java -Deureka.client.tls.key-store-password="..." -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 EUREKA_CLIENT_TLS_KEY_STORE_PASSWORD="..."
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 --eureka.client.tls.key-store-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.tls.key-store-type=
org.springframework.cloud.configuration.TlsProperties.
CAS Property: eureka.client.tls.key-store-type
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
eureka.client.tls.key-store-type=...
1
eureka:
client:
tls:
key-store-type: "..."
1
java -Deureka.client.tls.key-store-type="..." -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 EUREKA_CLIENT_TLS_KEY_STORE_TYPE="..."
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 --eureka.client.tls.key-store-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.tls.trust-store=
org.springframework.cloud.configuration.TlsProperties.
CAS Property: eureka.client.tls.trust-store
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
eureka.client.tls.trust-store=...
1
eureka:
client:
tls:
trust-store: "..."
1
java -Deureka.client.tls.trust-store="..." -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 EUREKA_CLIENT_TLS_TRUST_STORE="..."
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 --eureka.client.tls.trust-store="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.tls.trust-store-password=
org.springframework.cloud.configuration.TlsProperties.
CAS Property: eureka.client.tls.trust-store-password
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
eureka.client.tls.trust-store-password=...
1
eureka:
client:
tls:
trust-store-password: "..."
1
java -Deureka.client.tls.trust-store-password="..." -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 EUREKA_CLIENT_TLS_TRUST_STORE_PASSWORD="..."
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 --eureka.client.tls.trust-store-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.tls.trust-store-type=
org.springframework.cloud.configuration.TlsProperties.
CAS Property: eureka.client.tls.trust-store-type
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
eureka.client.tls.trust-store-type=...
1
eureka:
client:
tls:
trust-store-type: "..."
1
java -Deureka.client.tls.trust-store-type="..." -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 EUREKA_CLIENT_TLS_TRUST_STORE_TYPE="..."
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 --eureka.client.tls.trust-store-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.use-dns-for-fetching-service-urls=false
Indicates whether the eureka client should use the DNS mechanism to fetch a list of eureka servers to talk to. When the DNS name is updated to have additional servers, that information is used immediately after the eureka client polls for that information as specified in eurekaServiceUrlPollIntervalSeconds. Alternatively, the service urls can be returned serviceUrls, but the users should implement their own mechanism to return the updated list in case of changes. The changes are effective at runtime.
org.springframework.cloud.netflix.eureka.EurekaClientConfigBean.
CAS Property: eureka.client.use-dns-for-fetching-service-urls
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
eureka.client.use-dns-for-fetching-service-urls=...
1
eureka:
client:
use-dns-for-fetching-service-urls: "..."
1
java -Deureka.client.use-dns-for-fetching-service-urls="..." -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 EUREKA_CLIENT_USE_DNS_FOR_FETCHING_SERVICE_URLS="..."
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 --eureka.client.use-dns-for-fetching-service-urls="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
eureka.client.webclient.enabled=false
Enables the use of WebClient for Eureka HTTP Client.
How can I configure this property?
CAS Property: eureka.client.webclient.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
eureka.client.webclient.enabled=...
1
eureka:
client:
webclient:
enabled: "..."
1
java -Deureka.client.webclient.enabled="..." -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 EUREKA_CLIENT_WEBCLIENT_ENABLED="..."
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 --eureka.client.webclient.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.config.discovery.enabled=false
Flag to indicate that config server discovery is enabled (config server URL will be looked up via discovery).
org.springframework.cloud.config.client.ConfigClientProperties$Discovery.
CAS Property: spring.cloud.config.discovery.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.config.discovery.enabled=...
1
spring:
cloud:
config:
discovery:
enabled: "..."
1
java -Dspring.cloud.config.discovery.enabled="..." -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_CONFIG_DISCOVERY_ENABLED="..."
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.config.discovery.enabled="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
spring.cloud.config.discovery.service-id=configserver
Service id to locate config server.
org.springframework.cloud.config.client.ConfigClientProperties$Discovery.
CAS Property: spring.cloud.config.discovery.service-id
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.config.discovery.service-id=configserver
1
spring:
cloud:
config:
discovery:
service-id: "configserver"
1
java -Dspring.cloud.config.discovery.service-id="configserver" -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_CONFIG_DISCOVERY_SERVICE_ID="configserver"
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.config.discovery.service-id="configserver"
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.
Authentication
Support for HTTP basic authentication will be automatically added if one of Eureka server URLs
in the configuration has credentials embedded in it (curl style, like http://user:password@localhost:8761/eureka
).
Troubleshooting
To enable additional logging, configure the log4j configuration file to add the following levels:
1
2
3
4
5
6
7
8
<Logger name="org.springframework.cloud" level="debug" additivity="false">
<AppenderRef ref="casConsole"/>
<AppenderRef ref="casFile"/>
</Logger>
<Logger name="com.netflix" level="debug" additivity="false">
<AppenderRef ref="casConsole"/>
<AppenderRef ref="casFile"/>
</Logger>