APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Hazelcast Ticket Registry - Kubernetes Auto Discovery

This hazelcast discovery plugin provides the possibility to lookup IP addresses of other members by resolving those requests against a Kubernetes Service Discovery system.

This module supports two different options of resolving against the discovery registry:

  • A request to the REST API
  • DNS Lookup against a given headless DNS service name

See this link for more info.

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-hazelcast-discovery-kubernetes</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-hazelcast-discovery-kubernetes:${project.'cas.version'}"





1
2
3
4
5
6
7
8
9



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

dependencies {
    implementation "org.apereo.cas:cas-server-support-hazelcast-discovery-kubernetes"
}





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-hazelcast-discovery-kubernetes"
}

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

cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.api-retriesDefines the number of retries to Kubernetes API.
3

Defines the number of retries to Kubernetes API. Defaults to: 3.

Type
Integer
Default
3
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.api-tokenDefines an oauth token for the kubernetes client to access the kubernetes REST API.
no default

Defines an oauth token for the kubernetes client to access the kubernetes REST API. Defaults to reading the token from the auto-injected file at: /var/run/secrets/kubernetes.io/serviceaccount/token.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.ca-certificateCA Authority certificate from Kubernetes Master.
no default

CA Authority certificate from Kubernetes Master. Defaults to reading the certificate from the auto-injected file at: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.kubernetes-masterDefines an alternative address for the kubernetes master.
no default

Defines an alternative address for the kubernetes master. Defaults to: https://kubernetes.default.svc

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.namespaceDefines the namespace of the application POD through the Service Discovery REST API of Kubernetes.
no default

Defines the namespace of the application POD through the Service Discovery REST API of Kubernetes.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.pod-label-nameDefines the pod label to lookup through the Service Discovery REST API of Kubernetes.
no default

Defines the pod label to lookup through the Service Discovery REST API of Kubernetes.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.pod-label-valueDefines the pod label value to lookup through the Service Discovery REST API of Kubernetes.
no default

Defines the pod label value to lookup through the Service Discovery REST API of Kubernetes.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.resolve-not-ready-addressesDefines if not ready addresses should be evaluated to be discovered on startup.
false

Defines if not ready addresses should be evaluated to be discovered on startup.

Type
Boolean
Default
false
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.service-dnsDefines the DNS service lookup domain.
no default

Defines the DNS service lookup domain. This is defined as something similar to my-svc.my-namespace.svc.cluster.local.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.service-dns-timeoutDefines the DNS service lookup timeout in seconds.
-1

Defines the DNS service lookup timeout in seconds. Defaults to 5 secs.

Type
Integer
Default
-1
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.service-label-nameDefines the service label to lookup through the Service Discovery REST API of Kubernetes.
no default

Defines the service label to lookup through the Service Discovery REST API of Kubernetes.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.service-label-valueDefines the service label value to lookup through the Service Discovery REST API of Kubernetes.
no default

Defines the service label value to lookup through the Service Discovery REST API of Kubernetes.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.service-nameDefines the service name of the POD to lookup through the Service Discovery REST API of Kubernetes.
no default

Defines the service name of the POD to lookup through the Service Discovery REST API of Kubernetes.

Type
String
Default
none
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.service-portIf specified with a value greater than 0, its value defines the endpoint port of the service (overriding the default).
0

If specified with a value greater than 0, its value defines the endpoint port of the service (overriding the default).

Type
Integer
Default
0
Defined by
HazelcastKubernetesDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.kubernetes.use-node-name-as-external-addressDefines if the node name should be used as external address, instead of looking up the external IP using the /nodes resource.
false

Defines if the node name should be used as external address, instead of looking up the external IP using the /nodes resource. Default is false.

Type
Boolean
Default
false
Defined by
HazelcastKubernetesDiscoveryProperties

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.

:information_source: 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.