CAS Spring Boot Administration
CAS takes advantage of Spring Boot Admin to manage and monitor its internal state visually. As a Spring Boot Admin client, CAS registers itself with the Spring Boot Admin server over HTTP and reports back its status and health to the server’s web interface.
Spring Boot Admin Server
The Spring Boot Admin web application server is part of the CAS server via a dedicated extension module. Support is added by including the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-bootadmin</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-bootadmin:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-bootadmin"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references are included automatically and are listed for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-bootadmin"
}
Secure EndpointsNote that the admin server's API endpoints MUST be secured. It is also best to run both the Admin server and the registering CAS server node under HTTPS, specially if credentials are used to authenticate into endpoints.
Once deployed, the Spring Boot Admin dashboard is available under the /sba context path.
To learn more about options, please see this guide.
The following settings and properties are available from the CAS configuration catalog:
spring.boot.admin.server.enabledEnable Spring Boot Admin Server Default: true
trueEnable Spring Boot Admin Server Default: true
Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
Note
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Spring Boot Admin Client
Each individual CAS server is given the ability to auto-register itself with the Spring Boot Admin server, provided configuration is made available to instruct the CAS server how to locate and connect to the admin server.
Note that CAS server’s actuator endpoints are by default secured. In order to allow secure communication between the CAS server and the Spring Boot Admin server, please see guide.
The following settings and properties are available from the CAS configuration catalog:
spring.boot.admin.client.api-pathThe admin rest-apis path.
instancesThe admin rest-apis path.
spring.boot.admin.client.auto-deregistrationEnable automatic deregistration on shutdown If not set it defaults to true if an active CloudPlatform is present;
Enable automatic deregistration on shutdown If not set it defaults to true if an active CloudPlatform is present;
spring.boot.admin.client.auto-registrationEnable automatic registration when the application is ready.
trueEnable automatic registration when the application is ready.
spring.boot.admin.client.connect-timeoutConnect timeout for the registration.
5000msConnect timeout for the registration.
spring.boot.admin.client.enabledEnable Spring Admin Client.
trueEnable Spring Admin Client.
spring.boot.admin.client.instance.health-urlClient-health-URL to register with.
Client-health-URL to register with. Inferred at runtime, can be overridden in case the reachable URL is different (e.g. Docker). Must be unique all services registry.
spring.boot.admin.client.instance.management-base-urlBase url for computing the management-url to register with.
Base url for computing the management-url to register with. The path is inferred at runtime, and appended to the base url.
spring.boot.admin.client.instance.management-urlManagement-url to register with.
Management-url to register with. Inferred at runtime, can be overridden in case the reachable URL is different (e.g. Docker).
spring.boot.admin.client.instance.metadataMetadata that should be associated with this application
Metadata that should be associated with this application
spring.boot.admin.client.instance.nameName to register with.
spring-boot-applicationName to register with. Defaults to ${spring.application.name}
spring.boot.admin.client.instance.prefer-ipShould the registered urls be built with server.address or with hostname.
falseShould the registered urls be built with server.address or with hostname. @deprecated Use serviceHostType instead.
spring.boot.admin.client.instance.service-base-urlBase url for computing the service-url to register with.
Base url for computing the service-url to register with. The path is inferred at runtime, and appended to the base url.
spring.boot.admin.client.instance.service-host-typeShould the registered urls be built with server.address or with hostname.
canonical-host-nameShould the registered urls be built with server.address or with hostname.
spring.boot.admin.client.instance.service-pathPath for computing the service-url to register with.
Path for computing the service-url to register with. If not specified, defaults to "/"
spring.boot.admin.client.instance.service-urlClient-service-URL register with.
Client-service-URL register with. Inferred at runtime, can be overridden in case the reachable URL is different (e.g. Docker).
spring.boot.admin.client.passwordPassword for basic authentication on admin server
Password for basic authentication on admin server
spring.boot.admin.client.periodTime interval the registration is repeated
10000msTime interval the registration is repeated
spring.boot.admin.client.read-timeoutRead timeout (in ms) for the registration.
5000msRead timeout (in ms) for the registration.
spring.boot.admin.client.register-onceEnable registration against one or all admin servers
trueEnable registration against one or all admin servers
spring.boot.admin.client.urlThe admin server urls to register at
The admin server urls to register at
spring.boot.admin.client.usernameUsername for basic authentication on admin server
Username for basic authentication on admin server
Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
Note
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Security
Accessing the Spring Boot Admin Server will by default require a form-based user authentication. The credentials used to access this feature are those presented by Spring Security configuration:
The following settings and properties are available from the CAS configuration catalog:
spring.security.user.nameDefault user name.
userDefault user name.
spring.security.user.passwordPassword for the default user name.
Password for the default user name.
spring.security.user.rolesGranted roles for the default user name.
Granted roles for the default user name.
Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
Note
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Additional points to consider:
- Spring Boot Admin Server will reach out to CAS actuator endpoints to parse and present data. As CAS actuator endpoints require authenticated access, Spring Boot Admin Server is configured by default to use the same credentials used to protected actuator endpoints.
- CAS server acting as a Spring Boot Admin client will reach out to the Spring Boot Admin Server to auto-register itself and report status updates. Such requests and API calls re by default configured to use the same security mechanism and credentials.
- CAS server can act both as a Spring Boot Admin Server or a client of the Spring Boot Admin Server. Each CAS server deployment can be individually tuned to turn off client/service functionality as needed. For example, in a clustered CAS deployment the primary CAS server node might act as both Spring Boot Admin Server and Client, while all other secondary nodes may simply be a client of the primary CAS (Spring Boot Admin) server.
Troubleshooting
To enable additional logging, modify the logging configuration file to add the following:
1
2
<Logger name="de.codecentric.boot" level="debug" />
<Logger name="org.springframework.web.reactive" level="debug" />