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.

Consul Server Discovery Service

HashiCorp Consul has multiple components, but as a whole, it is a tool for discovering and configuring services in your infrastructure. It provides key features:

Service Discovery: Clients of Consul can provide a service, such as api or mysql, and other clients can use Consul to discover providers of a given service. Using either DNS or HTTP, applications can easily find the services they depend upon.
Health Checking: Consul clients can provide any number of health checks, either associated with a given service (“is the webserver returning 200 OK”), or with the local node (“is memory utilization below 90%”). This information can be used by an operator to monitor cluster health, and it is used by the service discovery components to route traffic away from unhealthy hosts.
KV Store: Applications can make use of Consul’s hierarchical key/value store for any number of purposes, including dynamic configuration, feature flagging, coordination, leader election, and more. The simple HTTP API makes it easy to use.
Multi Datacenter: Consul supports multiple datacenters out of the box. This means users of Consul do not have to worry about building additional layers of abstraction to grow to multiple regions.

CAS provides a Consul-enabled service discovery server that is based on Spring Cloud Consul and bootstrapped via Spring Cloud.

Installation

To run the Consul discovery server, please see this guide for installation instructions. A simple Consul installation may be run as consul agent -dev -ui
Look for a suitable and relevant ready-made Docker image via docker search consul.

When deployed and assuming default settings, the Consul dashboard would be available at: http://localhost:8500/ui.

Note that a Consul Agent client must be available to all CAS server nodes. By default, the agent client is expected to be at localhost:8500. See the Agent documentation for specifics on how to start an Agent client.

CAS Discovery Service Clients

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:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-consul-client</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-consul-client:${project.'cas.version'}"

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

dependencies {
    implementation "org.apereo.cas:cas-server-support-consul-client"
}

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-consul-client"
}

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

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

_{The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

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

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.config.discovery.enabled=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    config: 
      discovery: 
        enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.config.discovery.enabled="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as 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.

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONFIG_DISCOVERY_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.config.discovery.enabled="..."

The above example assumes that the CAS web application is packaged as 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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.config.discovery.service-id=configserver

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    config: 
      discovery: 
        service-id: "configserver"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.config.discovery.service-id="configserver" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONFIG_DISCOVERY_SERVICE_ID="configserver"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.config.discovery.service-id="configserver"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.acl-token=

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.acl-token=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        acl-token: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.acl-token="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_ACL_TOKEN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.acl-token="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.data-key=data

If format is Format.PROPERTIES or Format.YAML then the following field is used as key to look up consul for configuration.

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.data-key=data

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        data-key: "data"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.data-key="data" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_DATA_KEY="data"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.data-key="data"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.default-context=application

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.default-context=application

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        default-context: "application"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.default-context="application" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_DEFAULT_CONTEXT="application"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.default-context="application"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.enabled=true

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.fail-fast=true

Throw exceptions during config lookup if true, otherwise, log warnings.

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.fail-fast=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        fail-fast: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.fail-fast="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_FAIL_FAST="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.fail-fast="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.format=key-value

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.format=key-value

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        format: "key-value"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.format="key-value" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_FORMAT="key-value"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.format="key-value"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.name=

Alternative to spring.application.name to use in looking up values in consul KV.

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.name=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.prefix=

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.prefix=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        prefix: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.prefix="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_PREFIX="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.prefix="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is WARNINGwith a replacement setting: spring.cloud.consul.config.prefixes.

spring.cloud.consul.config.prefixes=

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.prefixes=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        prefixes: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.prefixes="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_PREFIXES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.prefixes="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.profile-separator=,

org.springframework.cloud.consul.config.ConsulConfigProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.profile-separator=,

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        profile-separator: ","

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.profile-separator="," -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_PROFILE_SEPARATOR=","

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.profile-separator=","

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.watch.delay=1000

The value of the fixed delay for the watch in millis. Defaults to 1000.

org.springframework.cloud.consul.config.ConsulConfigProperties$Watch.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.watch.delay=1000

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        watch: 
          delay: "1000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.watch.delay="1000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_WATCH_DELAY="1000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.watch.delay="1000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.watch.enabled=true

If the watch is enabled. Defaults to true.

org.springframework.cloud.consul.config.ConsulConfigProperties$Watch.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.watch.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        watch: 
          enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.watch.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_WATCH_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.watch.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.config.watch.wait-time=55

The number of seconds to wait (or block) for watch query, defaults to 55. Needs to be less than default ConsulClient (defaults to 60). To increase ConsulClient timeout create a ConsulClient bean with a custom ConsulRawClient with a custom HttpClient.

org.springframework.cloud.consul.config.ConsulConfigProperties$Watch.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.config.watch.wait-time=55

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      config: 
        watch: 
          wait-time: "55"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.config.watch.wait-time="55" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_CONFIG_WATCH_WAIT_TIME="55"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.config.watch.wait-time="55"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.acl-token=

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.acl-token=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        acl-token: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.acl-token="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_ACL_TOKEN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.acl-token="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.catalog-services-watch-delay=1000

The delay between calls to watch consul catalog in millis, default is 1000.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.catalog-services-watch-delay=1000

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        catalog-services-watch-delay: "1000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.catalog-services-watch-delay="1000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_CATALOG_SERVICES_WATCH_DELAY="1000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.catalog-services-watch-delay="1000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.catalog-services-watch-timeout=2

The number of seconds to block while watching consul catalog, default is 2.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.catalog-services-watch-timeout=2

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        catalog-services-watch-timeout: "2"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.catalog-services-watch-timeout="2" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_CATALOG_SERVICES_WATCH_TIMEOUT="2"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.catalog-services-watch-timeout="2"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.consistency-mode=default

Consistency mode for health service request.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.consistency-mode=default

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        consistency-mode: "default"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.consistency-mode="default" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_CONSISTENCY_MODE="default"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.consistency-mode="default"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.datacenters=

Map of serviceId's -> datacenter to query for in server list. This allows looking up services in another datacenters.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.datacenters=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        datacenters: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.datacenters="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_DATACENTERS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.datacenters="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.default-query-tag=

Tag to query for in service list if one is not listed in serverListQueryTags. Multiple tags can be specified with a comma separated value.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.default-query-tag=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        default-query-tag: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.default-query-tag="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_DEFAULT_QUERY_TAG="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.default-query-tag="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.default-zone-metadata-name=zone

Service instance zone comes from metadata. This allows changing the metadata tag name.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.default-zone-metadata-name=zone

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        default-zone-metadata-name: "zone"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.default-zone-metadata-name="zone" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_DEFAULT_ZONE_METADATA_NAME="zone"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.default-zone-metadata-name="zone"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.deregister=true

Disable automatic de-registration of service in consul.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.deregister=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        deregister: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.deregister="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_DEREGISTER="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.deregister="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.enable-tag-override=

Enable tag override for the registered service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.enable-tag-override=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        enable-tag-override: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.enable-tag-override="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_ENABLE_TAG_OVERRIDE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.enable-tag-override="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.enabled=true

Is service discovery enabled?

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.fail-fast=true

Throw exceptions during service registration if true, otherwise, log warnings (defaults to true).

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.fail-fast=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        fail-fast: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.fail-fast="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_FAIL_FAST="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.fail-fast="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.health-check-critical-timeout=

Timeout to deregister services critical for longer than timeout (e.g. 30m). Requires consul version 7.x or higher.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.health-check-critical-timeout=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        health-check-critical-timeout: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.health-check-critical-timeout="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEALTH_CHECK_CRITICAL_TIMEOUT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.health-check-critical-timeout="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.health-check-headers=

Headers to be applied to the Health Check calls.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.health-check-headers=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        health-check-headers: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.health-check-headers="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEALTH_CHECK_HEADERS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.health-check-headers="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.health-check-interval=10s

How often to perform the health check (e.g. 10s), defaults to 10s.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.health-check-interval=10s

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        health-check-interval: "10s"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.health-check-interval="10s" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEALTH_CHECK_INTERVAL="10s"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.health-check-interval="10s"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.health-check-path=/actuator/health

Alternate server path to invoke for health checking.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.health-check-path=/actuator/health

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        health-check-path: "/actuator/health"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.health-check-path="/actuator/health" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEALTH_CHECK_PATH="/actuator/health"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.health-check-path="/actuator/health"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.health-check-timeout=

Timeout for health check (e.g. 10s).

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.health-check-timeout=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        health-check-timeout: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.health-check-timeout="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEALTH_CHECK_TIMEOUT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.health-check-timeout="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.health-check-tls-skip-verify=

Skips certificate verification during service checks if true, otherwise runs certificate verification.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.health-check-tls-skip-verify=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        health-check-tls-skip-verify: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.health-check-tls-skip-verify="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEALTH_CHECK_TLS_SKIP_VERIFY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.health-check-tls-skip-verify="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.health-check-url=

Custom health check url to override default.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.health-check-url=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        health-check-url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.health-check-url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEALTH_CHECK_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.health-check-url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.heartbeat.actuator-health-group=

The actuator health group to use (null for the root group) when determining system health via Actuator.

org.springframework.cloud.consul.discovery.HeartbeatProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.heartbeat.actuator-health-group=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        heartbeat: 
          actuator-health-group: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.heartbeat.actuator-health-group="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEARTBEAT_ACTUATOR_HEALTH_GROUP="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.heartbeat.actuator-health-group="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.heartbeat.enabled=false

org.springframework.cloud.consul.discovery.HeartbeatProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.heartbeat.enabled=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        heartbeat: 
          enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.heartbeat.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEARTBEAT_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.heartbeat.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.heartbeat.interval-ratio=

org.springframework.cloud.consul.discovery.HeartbeatProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.heartbeat.interval-ratio=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        heartbeat: 
          interval-ratio: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.heartbeat.interval-ratio="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEARTBEAT_INTERVAL_RATIO="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.heartbeat.interval-ratio="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure=false

org.springframework.cloud.consul.discovery.HeartbeatProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        heartbeat: 
          reregister-service-on-failure: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.heartbeat.reregister-service-on-failure="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEARTBEAT_REREGISTER_SERVICE_ON_FAILURE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.heartbeat.ttl=30s

org.springframework.cloud.consul.discovery.HeartbeatProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.heartbeat.ttl=30s

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        heartbeat: 
          ttl: "30s"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.heartbeat.ttl="30s" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEARTBEAT_TTL="30s"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.heartbeat.ttl="30s"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.heartbeat.use-actuator-health=true

Whether or not to take the current system health (as reported via the Actuator Health endpoint) into account when reporting the application status to the Consul TTL check. Actuator Health endpoint also has to be available to the application.

org.springframework.cloud.consul.discovery.HeartbeatProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.heartbeat.use-actuator-health=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        heartbeat: 
          use-actuator-health: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.heartbeat.use-actuator-health="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HEARTBEAT_USE_ACTUATOR_HEALTH="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.heartbeat.use-actuator-health="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.hostname=

Hostname to use when accessing server.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.hostname=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        hostname: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.hostname="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_HOSTNAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.hostname="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.include-hostname-in-instance-id=false

Whether hostname is included into the default instance id when registering service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.include-hostname-in-instance-id=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        include-hostname-in-instance-id: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.include-hostname-in-instance-id="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_INCLUDE_HOSTNAME_IN_INSTANCE_ID="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.include-hostname-in-instance-id="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.instance-group=

Service instance group.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.instance-group=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        instance-group: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.instance-group="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_INSTANCE_GROUP="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.instance-group="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.instance-id=

Unique service instance id.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.instance-id=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        instance-id: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.instance-id="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_INSTANCE_ID="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.instance-id="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.instance-zone=

Service instance zone.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.instance-zone=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        instance-zone: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.instance-zone="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_INSTANCE_ZONE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.instance-zone="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.ip-address=

IP address to use when accessing service (must also set preferIpAddress to use).

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.ip-address=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        ip-address: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.ip-address="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_IP_ADDRESS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.ip-address="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.lifecycle.enabled=true

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties$Lifecycle.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.lifecycle.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        lifecycle: 
          enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.lifecycle.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_LIFECYCLE_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.lifecycle.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.management-enable-tag-override=

Enable tag override for the registered management service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.management-enable-tag-override=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        management-enable-tag-override: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.management-enable-tag-override="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_MANAGEMENT_ENABLE_TAG_OVERRIDE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.management-enable-tag-override="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.management-metadata=

Metadata to use when registering management service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.management-metadata=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        management-metadata: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.management-metadata="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_MANAGEMENT_METADATA="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.management-metadata="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.management-port=

Port to register the management service under (defaults to management port).

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.management-port=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        management-port: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.management-port="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_MANAGEMENT_PORT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.management-port="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.management-suffix=management

Suffix to use when registering management service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.management-suffix=management

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        management-suffix: "management"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.management-suffix="management" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_MANAGEMENT_SUFFIX="management"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.management-suffix="management"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.management-tags=

Tags to use when registering management service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.management-tags=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        management-tags: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.management-tags="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_MANAGEMENT_TAGS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.management-tags="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.metadata=

Metadata to use when registering service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.metadata=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        metadata: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.metadata="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_METADATA="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.metadata="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.order=0

Order of the discovery client used by `CompositeDiscoveryClient` for sorting available clients.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.order=0

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        order: "0"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.order="0" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_ORDER="0"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.order="0"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.port=

Port to register the service under (defaults to listening port).

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.port=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        port: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.port="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_PORT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.port="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.prefer-agent-address=false

Source of how we will determine the address to use.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.prefer-agent-address=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        prefer-agent-address: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.prefer-agent-address="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_PREFER_AGENT_ADDRESS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.prefer-agent-address="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.prefer-ip-address=false

Use ip address rather than hostname during registration.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.prefer-ip-address=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        prefer-ip-address: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.prefer-ip-address="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_PREFER_IP_ADDRESS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.prefer-ip-address="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.query-passing=false

Add the 'passing` parameter to /v1/health/service/serviceName. This pushes health check passing to the server.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.query-passing=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        query-passing: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.query-passing="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_QUERY_PASSING="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.query-passing="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.register=true

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.register=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        register: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.register="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_REGISTER="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.register="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.register-health-check=true

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.register-health-check=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        register-health-check: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.register-health-check="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_REGISTER_HEALTH_CHECK="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.register-health-check="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.scheme=http

Whether to register an http or https service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.scheme=http

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        scheme: "http"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.scheme="http" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_SCHEME="http"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.scheme="http"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.server-list-query-tags=

Map of serviceId's -> tag to query for in server list. This allows filtering services by one more tags. Multiple tags can be specified with a comma separated value.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.server-list-query-tags=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        server-list-query-tags: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.server-list-query-tags="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_SERVER_LIST_QUERY_TAGS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.server-list-query-tags="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.service-name=

Service name.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.service-name=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        service-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.service-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_SERVICE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.service-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.discovery.tags=

Tags to use when registering service.

org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.discovery.tags=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      discovery: 
        tags: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.discovery.tags="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_DISCOVERY_TAGS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.discovery.tags="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.enabled=true

Is spring cloud consul enabled.

org.springframework.cloud.consul.ConsulProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.host=localhost

Consul agent hostname. Defaults to 'localhost'.

org.springframework.cloud.consul.ConsulProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.host=localhost

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      host: "localhost"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.host="localhost" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_HOST="localhost"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.host="localhost"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.path=

Custom path if consul is under non-root.

org.springframework.cloud.consul.ConsulProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.path=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.port=8500

Consul agent port. Defaults to '8500'.

org.springframework.cloud.consul.ConsulProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.port=8500

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      port: "8500"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.port="8500" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_PORT="8500"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.port="8500"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.retry.enabled=true

If consul retry is enabled.

org.springframework.cloud.consul.RetryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.retry.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      retry: 
        enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.retry.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_RETRY_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.retry.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.retry.initial-interval=1000

Initial retry interval in milliseconds.

org.springframework.cloud.consul.RetryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.retry.initial-interval=1000

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      retry: 
        initial-interval: "1000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.retry.initial-interval="1000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_RETRY_INITIAL_INTERVAL="1000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.retry.initial-interval="1000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.retry.max-attempts=6

Maximum number of attempts.

org.springframework.cloud.consul.RetryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.retry.max-attempts=6

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      retry: 
        max-attempts: "6"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.retry.max-attempts="6" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_RETRY_MAX_ATTEMPTS="6"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.retry.max-attempts="6"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.retry.max-interval=2000

Maximum interval for backoff.

org.springframework.cloud.consul.RetryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.retry.max-interval=2000

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      retry: 
        max-interval: "2000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.retry.max-interval="2000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_RETRY_MAX_INTERVAL="2000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.retry.max-interval="2000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.retry.multiplier=1.1

Multiplier for next interval.

org.springframework.cloud.consul.RetryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.retry.multiplier=1.1

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      retry: 
        multiplier: "1.1"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.retry.multiplier="1.1" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_RETRY_MULTIPLIER="1.1"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.retry.multiplier="1.1"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.ribbon.enabled=true

Enables Consul and Ribbon integration.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.ribbon.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      ribbon: 
        enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.ribbon.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_RIBBON_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.ribbon.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.scheme=

Consul agent scheme (HTTP/HTTPS). If there is no scheme in address - client will use HTTP.

org.springframework.cloud.consul.ConsulProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.scheme=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      scheme: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.scheme="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_SCHEME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.scheme="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.service-registry.auto-registration.enabled=true

Enables Consul Service Registry Auto-registration.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.service-registry.auto-registration.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      service-registry: 
        auto-registration: 
          enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.service-registry.auto-registration.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_SERVICE_REGISTRY_AUTO_REGISTRATION_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.service-registry.auto-registration.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.service-registry.enabled=true

Enables Consul Service Registry functionality.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.service-registry.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      service-registry: 
        enabled: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.service-registry.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_SERVICE_REGISTRY_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.service-registry.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.tls.certificate-password=

Password to open the certificate.

org.springframework.cloud.consul.ConsulProperties$TLSConfig.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.tls.certificate-password=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      tls: 
        certificate-password: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.tls.certificate-password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_TLS_CERTIFICATE_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.tls.certificate-password="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.tls.certificate-path=

File path to the certificate.

org.springframework.cloud.consul.ConsulProperties$TLSConfig.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.tls.certificate-path=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      tls: 
        certificate-path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.tls.certificate-path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_TLS_CERTIFICATE_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.tls.certificate-path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.tls.key-store-instance-type=

Type of key framework to use.

org.springframework.cloud.consul.ConsulProperties$TLSConfig.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.tls.key-store-instance-type=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      tls: 
        key-store-instance-type: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.tls.key-store-instance-type="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_TLS_KEY_STORE_INSTANCE_TYPE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.tls.key-store-instance-type="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.tls.key-store-password=

Password to an external keystore.

org.springframework.cloud.consul.ConsulProperties$TLSConfig.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.tls.key-store-password=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      tls: 
        key-store-password: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.tls.key-store-password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_TLS_KEY_STORE_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.tls.key-store-password="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

spring.cloud.consul.tls.key-store-path=

Path to an external keystore.

org.springframework.cloud.consul.ConsulProperties$TLSConfig.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

spring.cloud.consul.tls.key-store-path=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    consul: 
      tls: 
        key-store-path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dspring.cloud.consul.tls.key-store-path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export SPRING_CLOUD_CONSUL_TLS_KEY_STORE_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --spring.cloud.consul.tls.key-store-path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# Flag to indicate that config server discovery is enabled (config server URL will be looked up via discovery).
# spring.cloud.config.discovery.enabled=false

# Service id to locate config server.
# spring.cloud.config.discovery.service-id=configserver

# 
# spring.cloud.consul.config.acl-token=

# If format is Format.PROPERTIES or Format.YAML then the following field is used as key to look up consul for configuration.
# spring.cloud.consul.config.data-key=data

# 
# spring.cloud.consul.config.default-context=application

# 
# spring.cloud.consul.config.enabled=true

# Throw exceptions during config lookup if true, otherwise, log warnings.
# spring.cloud.consul.config.fail-fast=true

# 
# spring.cloud.consul.config.format=key-value

# Alternative to spring.application.name to use in looking up values in consul KV.
# spring.cloud.consul.config.name=

# 
# spring.cloud.consul.config.prefix=

# 
# spring.cloud.consul.config.prefixes=

# 
# spring.cloud.consul.config.profile-separator=,

# The value of the fixed delay for the watch in millis.
# spring.cloud.consul.config.watch.delay=1000

# If the watch is enabled.
# spring.cloud.consul.config.watch.enabled=true

# The number of seconds to wait (or block) for watch query, defaults to 55.
# spring.cloud.consul.config.watch.wait-time=55

# 
# spring.cloud.consul.discovery.acl-token=

# The delay between calls to watch consul catalog in millis, default is 1000.
# spring.cloud.consul.discovery.catalog-services-watch-delay=1000

# The number of seconds to block while watching consul catalog, default is 2.
# spring.cloud.consul.discovery.catalog-services-watch-timeout=2

# Consistency mode for health service request.
# spring.cloud.consul.discovery.consistency-mode=default

# Map of serviceId's -> datacenter to query for in server list.
# spring.cloud.consul.discovery.datacenters=

# Tag to query for in service list if one is not listed in serverListQueryTags.
# spring.cloud.consul.discovery.default-query-tag=

# Service instance zone comes from metadata.
# spring.cloud.consul.discovery.default-zone-metadata-name=zone

# Disable automatic de-registration of service in consul.
# spring.cloud.consul.discovery.deregister=true

# Enable tag override for the registered service.
# spring.cloud.consul.discovery.enable-tag-override=

# Is service discovery enabled?
# spring.cloud.consul.discovery.enabled=true

# Throw exceptions during service registration if true, otherwise, log warnings (defaults to true).
# spring.cloud.consul.discovery.fail-fast=true

# Timeout to deregister services critical for longer than timeout (e.g. 30m).
# spring.cloud.consul.discovery.health-check-critical-timeout=

# Headers to be applied to the Health Check calls.
# spring.cloud.consul.discovery.health-check-headers=

# How often to perform the health check (e.g. 10s), defaults to 10s.
# spring.cloud.consul.discovery.health-check-interval=10s

# Alternate server path to invoke for health checking.
# spring.cloud.consul.discovery.health-check-path=/actuator/health

# Timeout for health check (e.g. 10s).
# spring.cloud.consul.discovery.health-check-timeout=

# Skips certificate verification during service checks if true, otherwise runs certificate verification.
# spring.cloud.consul.discovery.health-check-tls-skip-verify=

# Custom health check url to override default.
# spring.cloud.consul.discovery.health-check-url=

# The actuator health group to use (null for the root group) when determining system health via Actuator.
# spring.cloud.consul.discovery.heartbeat.actuator-health-group=

# 
# spring.cloud.consul.discovery.heartbeat.enabled=false

# 
# spring.cloud.consul.discovery.heartbeat.interval-ratio=

# 
# spring.cloud.consul.discovery.heartbeat.reregister-service-on-failure=false

# 
# spring.cloud.consul.discovery.heartbeat.ttl=30s

# Whether or not to take the current system health (as reported via the Actuator Health endpoint) into account when reporting the application status to the Consul TTL check.
# spring.cloud.consul.discovery.heartbeat.use-actuator-health=true

# Hostname to use when accessing server.
# spring.cloud.consul.discovery.hostname=

# Whether hostname is included into the default instance id when registering service.
# spring.cloud.consul.discovery.include-hostname-in-instance-id=false

# Service instance group.
# spring.cloud.consul.discovery.instance-group=

# Unique service instance id.
# spring.cloud.consul.discovery.instance-id=

# Service instance zone.
# spring.cloud.consul.discovery.instance-zone=

# IP address to use when accessing service (must also set preferIpAddress to use).
# spring.cloud.consul.discovery.ip-address=

# 
# spring.cloud.consul.discovery.lifecycle.enabled=true

# Enable tag override for the registered management service.
# spring.cloud.consul.discovery.management-enable-tag-override=

# Metadata to use when registering management service.
# spring.cloud.consul.discovery.management-metadata=

# Port to register the management service under (defaults to management port).
# spring.cloud.consul.discovery.management-port=

# Suffix to use when registering management service.
# spring.cloud.consul.discovery.management-suffix=management

# Tags to use when registering management service.
# spring.cloud.consul.discovery.management-tags=

# Metadata to use when registering service.
# spring.cloud.consul.discovery.metadata=

# Order of the discovery client used by `CompositeDiscoveryClient` for sorting available clients.
# spring.cloud.consul.discovery.order=0

# Port to register the service under (defaults to listening port).
# spring.cloud.consul.discovery.port=

# Source of how we will determine the address to use.
# spring.cloud.consul.discovery.prefer-agent-address=false

# Use ip address rather than hostname during registration.
# spring.cloud.consul.discovery.prefer-ip-address=false

# Add the 'passing` parameter to /v1/health/service/serviceName.
# spring.cloud.consul.discovery.query-passing=false

# Register as a service in consul.
# spring.cloud.consul.discovery.register=true

# Register health check in consul.
# spring.cloud.consul.discovery.register-health-check=true

# Whether to register an http or https service.
# spring.cloud.consul.discovery.scheme=http

# Map of serviceId's -> tag to query for in server list.
# spring.cloud.consul.discovery.server-list-query-tags=

# Service name.
# spring.cloud.consul.discovery.service-name=

# Tags to use when registering service.
# spring.cloud.consul.discovery.tags=

# Is spring cloud consul enabled.
# spring.cloud.consul.enabled=true

# Consul agent hostname.
# spring.cloud.consul.host=localhost

# Custom path if consul is under non-root.
# spring.cloud.consul.path=

# Consul agent port.
# spring.cloud.consul.port=8500

# If consul retry is enabled.
# spring.cloud.consul.retry.enabled=true

# Initial retry interval in milliseconds.
# spring.cloud.consul.retry.initial-interval=1000

# Maximum number of attempts.
# spring.cloud.consul.retry.max-attempts=6

# Maximum interval for backoff.
# spring.cloud.consul.retry.max-interval=2000

# Multiplier for next interval.
# spring.cloud.consul.retry.multiplier=1.1

# Enables Consul and Ribbon integration.
# spring.cloud.consul.ribbon.enabled=true

# Consul agent scheme (HTTP/HTTPS).
# spring.cloud.consul.scheme=

# Enables Consul Service Registry Auto-registration.
# spring.cloud.consul.service-registry.auto-registration.enabled=true

# Enables Consul Service Registry functionality.
# spring.cloud.consul.service-registry.enabled=true

# Password to open the certificate.
# spring.cloud.consul.tls.certificate-password=

# File path to the certificate.
# spring.cloud.consul.tls.certificate-path=

# Type of key framework to use.
# spring.cloud.consul.tls.key-store-instance-type=

# Password to an external keystore.
# spring.cloud.consul.tls.key-store-password=

# Path to an external keystore.
# spring.cloud.consul.tls.key-store-path=

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.

Note

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.

Troubleshooting

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.springframework.cloud.consul" level="debug" additivity="false">
  <AppenderRef ref="casConsole"/>
  <AppenderRef ref="casFile"/>
</Logger>