Git Service Registry

This registry reads services definitions from remote or local git repositories. Service definition files are expected to be either JSON or YAML files. The contents of the repository is pulled at defined intervals and changes to service definitions are committed and pushed to the defined remotes.

Support is enabled by adding the following module into the overlay:

implementation "org.apereo.cas:cas-server-support-git-service-registry:${project.'cas.version'}"
<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-git-service-registry</artifactId>
  <version>${cas.version}</version>
</dependency>
dependencyManagement {
  imports {
    mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
  }
}

dependencies {  
  implementation "org.apereo.cas:cas-server-support-git-service-registry"
}

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 is not strictly necessary in the end-user CAS configuration, because a default value may be assigned or the feature in question may not be immediately intended for use. You may want to own the setting and update it assigned value, assuming the intended feature controlled by the setting is utilized.

  • cas.service-registry.git.active-branch=master
  • The branch to checkout and activate.

  • cas.service-registry.git.branches-to-clone=master
  • If the repository is to be cloned, this will allow the list of branches to be fetched separated by commas.

  • cas.service-registry.git.repository-url=
  • The address of the git repository. Could be a URL or a file-system path.

    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.

  • cas.service-registry.git.clear-existing-identities=false
  • When establishing an ssh session, determine if default identities loaded on the machine should be excluded/removed and identity should only be limitd to those loaded from given keys.

  • cas.service-registry.git.group-by-type=true
  • Determine whether service definitions in the git repository should be located/stored in groups and separate folder structures based on the service type. @see #getRootDirectory()

  • cas.service-registry.git.password=
  • Password used to access or push to the repository.

  • cas.service-registry.git.private-key-passphrase=
  • Password for the SSH private key.

  • cas.service-registry.git.push-changes=false
  • Decide whether changes should be pushed back into the remote repository.

  • cas.service-registry.git.root-directory=
  • Root directory in the git repository structure to track service definition files. This might be most useful if the git repository is tasked with other types of files and configurations and allowing a separate root directory for service definitions provide a clean separation between services files and everything else. This setting may work in concert with #isGroupByType(). If left blank, the root folder of the git repository itself is used as the root directory for service definitions.

  • cas.service-registry.git.sign-commits=false
  • Whether or not commits should be signed.

  • cas.service-registry.git.ssh-session-password=
  • As with using SSH with public keys, an SSH session with ssh://user@example.com/repo.git must be specified to use password-secured SSH connections.

  • cas.service-registry.git.strict-host-key-checking=true
  • Whether on not to turn on strict host key checking. true will be "yes", false will be "no", "ask" not supported.

  • cas.service-registry.git.timeout=PT10S
  • Timeout for git operations such as push and pull in seconds.

  • cas.service-registry.git.username=
  • Username used to access or push to the repository.


    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. Over time and with community contributions, the accuracy and volume of the documentation should improve over time.

    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 below 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. When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.S ettings 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. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. 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.

    Time Unit of Measure

    All CAS settings that deal with time units, unless noted otherwise, should support the duration syntax for full clarity on unit of measure: PT20S, PT15M, PT10H, PT6D, P2DT3H4M.

    No Interference!

    Be careful to not manually modify the state of the git repository directory that is cloned on the local server. By doing so, you risk interfering with CAS' own service management processes and ultimately may end up corrupting the state of the git repository.

    The service registry is also able to auto detect changes as it will pull changes from defined remotes periodically. It will monitor changes to recognize file additions, removals and updates and will auto-refresh CAS so changes may happen instantly.