Skip to main content

Helm Functions

In addition to standard Helm chart functions we add the following for the QuickCase chart:

Naming convention

Any custom functions are available and namespaced as follows:

  • quickcase - these are considered globally accessible and stored in appropriate template files such as _oidc.tpl
  • app-name - these are considered application specific (even though they would be available globally). These are stored in app-name/_app_name.tpl or similar.

OIDC functions

quickcase.oidc.uris.env

Provides the URIs used by the OIDC providers. Applications deployed with this function will have these environment variables set:

  • QUICKCASE_OIDC_JWKSETURI
  • QUICKCASE_OIDC_LOGINURI
  • QUICKCASE_OIDC_LOGOUTURI
  • QUICKCASE_OIDC_TOKENURI
  • QUICKCASE_OIDC_USERINFOURI
  • QUICKCASE_OIDC_OPENIDSCOPE

quickcase.oidc.claims.env

Sets various claim variables for use by the QuickCase OIDC library. The following environment variables are set:

  • QUICKCASE_OIDC_CLAIMS_PREFIX
  • QUICKCASE_OIDC_CLAIMS_NAMES_SUB
  • QUICKCASE_OIDC_CLAIMS_NAMES_NAME
  • QUICKCASE_OIDC_CLAIMS_NAMES_EMAIL
  • QUICKCASE_OIDC_CLAIMS_NAMES_ROLES
  • QUICKCASE_OIDC_CLAIMS_NAMES_ORGANISATIONS
  • QUICKCASE_OIDC_CLAIMS_NAMES_DEFAULTJURISDICTION
  • QUICKCASE_OIDC_CLAIMS_NAMES_DEFAULTCASETYPE
  • QUICKCASE_OIDC_CLAIMS_NAMES_DEFAULTSTATE

quickcase.oidc.env

Wraps quickcase.oidc.uris.env and quickcase.oidc.claims.env into a single function for applications that need to consume both.

quickcase.oidc.urlParams (internal)

Used internally for QUICKCASE_OIDC_LOGINURI and QUICKCASE_OIDC_LOGOUTURI to provide any URL parameters.

Database functions

Provides functions to easily configure access to the databases.

quickcase.store.datasourceUrl

Constructs a JDBC datasource URL from database settings supplied to the function.

Parameters:

  1. The datastore being used either:

    • .Values.store.cases or
    • .Values.store.definitions.

Output:

  • JDBC URL