APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

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

Hazelcast Ticket Registry - AWS EC2 Auto Discovery

Hazelcast support in CAS may handle EC2 auto-discovery automatically. It is useful when you do not want to provide or you cannot provide the list of possible IP addresses for the members of the cluster. You optionally also have the ability to specify partitioning group that would be zone aware. When using the zone-aware configuration, backups are created in the other AZs. Each zone will be accepted as one partition group. Using the AWS Discovery capability requires that you turn off and disable multicast and TCP/IP config in the CAS settings, which should be done automatically by CAS at runtime.

Support is enabled by the following module:

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-aws</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-hazelcast-discovery-aws:${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-aws"
}





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-aws"
}

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

cas.ticket.registry.hazelcast.cluster.discovery.aws.access-keyAWS access key.
no default
Required

AWS access key.

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.secret-keyAWS secret key.
no default
Required

AWS secret key.

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.clusterECS cluster short name or ARN; default is the current cluster.
no default

ECS cluster short name or ARN; default is the current cluster.

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.connection-timeout-secondsThe maximum amount of time Hazelcast will try to connect to a well known member before giving up.
5

The maximum amount of time Hazelcast will try to connect to a well known member before giving up. Setting this value too low could mean that a member is not able to connect to a cluster. Setting the value too high means that member startup could slow down because of longer timeouts (for example, when a well known member is not up). Increasing this value is recommended if you have many IPs listed and the members cannot properly build up the cluster. Its default value is 5.

Type
Integer
Default
5
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.familyFilter to look only for ECS tasks with the given family name; mutually exclusive with #getServiceName() .
no default

Filter to look only for ECS tasks with the given family name; mutually exclusive with #getServiceName().

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.host-headerHost header. i.e.
no default

Host header. i.e. ec2.amazonaws.com. The URL that is the entry point for a web service.

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.iam-roleIf you do not want to use access key and secret key, you can specify iam-role.
no default

If you do not want to use access key and secret key, you can specify iam-role. Hazelcast fetches your credentials by using your IAM role. This setting only affects deployments on Amazon EC2. If you are deploying CAS in an Amazon ECS environment, the role should not be specified. The role is fetched from the task definition that is assigned to run CAS.

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.portHazelcast port.
-1

Hazelcast port. Typically may be set to 5701. You can set searching for other ports rather than 5701 if you've members on different ports.

Type
Integer
Default
-1
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.regionAWS region. i.e.
us-east-1

AWS region. i.e. us-east-1. The region where your members are running.

Type
String
Default
us-east-1
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.security-group-nameIf a security group is configured, only instances within that security group are selected.
no default

If a security group is configured, only instances within that security group are selected.

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.service-nameFilter to look only for ECS tasks from the given service; mutually exclusive with #getFamily() .
no default

Filter to look only for ECS tasks from the given service; mutually exclusive with #getFamily().

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.tag-keyIf a tag key/value is set, only instances with that tag key/value will be selected.
no default

If a tag key/value is set, only instances with that tag key/value will be selected.

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties
cas.ticket.registry.hazelcast.cluster.discovery.aws.tag-valueIf a tag key/value is set, only instances with that tag key/value will be selected.
no default

If a tag key/value is set, only instances with that tag key/value will be selected.

Type
String
Default
none
Defined by
HazelcastAwsDiscoveryProperties

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.