CosmosDb Service Registry
Stores registered service data in an Azure CosmosDb instance.
Usage
This feature is deprecated and is scheduled to be removed in the future.
Support is enabled by adding the following module into the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-cosmosdb-service-registry</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-cosmosdb-service-registry:${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-cosmosdb-service-registry"
}
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-cosmosdb-service-registry"
}
Configuration
The following settings and properties are available from the CAS configuration catalog:
cas.service-registry.cosmos-db.containerCollection to store CAS service definitions.
CasCosmosDbServiceRegistryCollection to store CAS service definitions.
cas.service-registry.cosmos-db.databaseDatabase name.
Database name.
cas.service-registry.cosmos-db.keyDocument Db master key.
Document Db master key.
cas.service-registry.cosmos-db.uriDocument Db host address (i.e.
Document Db host address (i.e. https://localhost:8081).
cas.service-registry.cosmos-db.consistency-levelDocument Db consistency level.
SESSION-
STRONG: Linearizability -
SESSION: Consistent Prefix. Monotonic reads, monotonic writes, read-your-writes, write-follows-reads -
EVENTUAL: Out of order reads -
BOUNDED_STALENESS: Consistent Prefix. Reads lag behind writes by k prefixes or t interval -
CONSISTENT_PREFIX: Updates returned are some prefix of all the updates, with no gaps
cas.service-registry.cosmos-db.create-containerWhether collections should be created on startup.
falseWhether collections should be created on startup.
cas.service-registry.cosmos-db.database-throughputThe max auto scale throughput.
4000The max auto scale throughput.
cas.service-registry.cosmos-db.endpoint-discovery-enabledSets the flag to enable endpoint discovery for geo-replicated database accounts.
trueSets the flag to enable endpoint discovery for geo-replicated database accounts. When EnableEndpointDiscovery is true, the SDK will automatically discover the current write and read regions to ensure requests are sent to the correct region based on the capability of the region and the user's preference.
cas.service-registry.cosmos-db.indexing-modeSpecifies the supported indexing modes in the Azure Cosmos DB database service.
NONE-
CONSISTENT: Index is updated synchronously with a create or update operation. With consistent indexing, query behavior is the same as the default consistency level for the collection. The index is always kept up to date with the data. -
LAZY: Index is updated asynchronously with respect to a create or update operation. With lazy indexing, queries are eventually consistent. The index is updated when the collection is idle. -
NONE: No index is provided. Setting IndexingMode to "None" drops the index. Use this if you don't want to maintain the index for a document collection, to save the storage cost or improve the write throughput. Your queries will degenerate to scans of the entire collection.
cas.service-registry.cosmos-db.max-retry-attempts-on-throttled-requestsSets the maximum number of retries in the case where the request fails because the service has applied rate limiting on the client.
4Sets the maximum number of retries in the case where the request fails because the service has applied rate limiting on the client.
When a client is sending requests faster than the allowed rate, the service will return HttpStatusCode 429 (Too Many Request) to throttle the client. The current implementation in the SDK will then wait for the amount of time the service tells it to wait and retry after the time has elapsed.
The default value is 4. This means in the case where the request is throttled, the same request will be issued for a maximum of 5 times to the server before an error is returned to the application.
cas.service-registry.cosmos-db.max-retry-wait-timeSets the maximum retry time in seconds.
PT10SSets the maximum retry time in seconds. When a request fails due to a throttle error, the service sends back a response that contains a value indicating the client should not retry before the time period has elapsed (Retry-After). The MaxRetryWaitTime flag allows the application to set a maximum wait time for all retry attempts. If the cumulative wait time exceeds the MaxRetryWaitTime, the SDK will stop retrying and return the error to the application.
cas.service-registry.cosmos-db.modeControls the connection mode.
GATEWAYGATEWAY and DIRECT. -
GATEWAY: HTTPS over REST. Java HTTPS stack (Apache HttpClient). Generally robust. Limited bulk support. Works with HTTP proxies. Uses Java’s trust store + hostname verifier. -
DIRECT: Custom binary protocol over TCP (RNTBD). Netty (manual TLS/SSL context and connections). Highly efficient, but sensitive to connection issues. Does not support HTTP proxies. Uses Netty TLS.
cas.service-registry.cosmos-db.preferred-regionsSets the preferred regions for geo-replicated database accounts.
Sets the preferred regions for geo-replicated database accounts. For example, "East US" as the preferred region. When EnableEndpointDiscovery is true and PreferredRegions is non-empty, the SDK will prefer to use the regions in the container in the order they are specified to perform operations.
cas.service-registry.cosmos-db.user-agent-suffixSets the value of the user-agent suffix.
Sets the value of the user-agent suffix.
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.
Troubleshooting
To enable additional logging, configure the log4j configuration file to add the following levels:
1
2
3
4
<Logger name="com.azure.cosmos" level="debug" additivity="false">
<AppenderRef ref="casConsole"/>
<AppenderRef ref="casFile"/>
</Logger>
Auto Initialization
Upon startup and configuration permitting, the registry is able to auto initialize itself from default JSON service definitions available to CAS. See this guide for more info.