Skip to main content

VKPR keycloak install

Description​

Install Keycloak into cluster. For more information about Keycloak, click here.

Commands​

Interactive inputs:

  vkpr keycloak install [flags]

Non-interactive without setting values or using VKPR Values:

  vkpr keycloak install --default
Info

If the VKPR dont identify any postgresql installed in the cluster, he will install to use with keycloak.

Argument Reference​

Flags​

  --default          Use to automatically fill inputs with default values
  --dry_run          Simulate an install
  --domain           Set the application address
  --secure           Using HTTPS in the application
  --HA               Specifies if the application will have High Availability
  --admin_user       Specifies the Super Admin username
  --admin_password   Specifies the Super Admin password
  --ssl              Specifies if the keycloak will be using internal SSL certificates
  --crt_file         Specifies the keycloak .crt file path
  --key_file         Specifies the keycloak .key file path

Values File​

Globals​

The following arguments are supported by the globals:

  • domain - (Required) Define the domain used by the application. The default is localhost.
  • secure - (Required) Specifies if the services from the application will expose HTTPS ports inside the cluster. The default is false.
  • namespace - (Optional) Define where the application will be provisioned. The default is vkpr.
  • ingressClassName - (Optional) Define which ingress controller will expose the application. The default is nginx.

Local​

The following arguments are supported:

  • enabled - (Optional) Enables the installation if performed with the command vkpr apply.
  • namespace - (Optional) Define where the application will be provisioned. The default is vkpr.
  • ingressClassName - (Optional) Define which ingress controller will expose the application. The default is nginx.
  • HA - (Optional) Specifies if the application will have High Availability. The default is false.
  • metrics - (Optional) Specifies if the application will expose your metrics. The default is false.
  • adminUser - (Required) Specify the keycloak admin password. The default is admin.
  • adminPassword - (Required) Specify the keycloak admin password. The default is vkpr123
  • openid
    • grafana
      • enabled - (Optional) Enable realm creation in Keycloak for Grafana. The default is false.
      • clientSecret - Specifies the Client Secret from Client ID used. The default is a random UUID.
      • identityProviders - Specifies which IdP will use. Allowed Values: Google, Github
    • kong
      • enabled - (Optional) Enable realm creation in Keycloak for Kong Manager. The default is false.
      • clientSecret - Specifies the Client Secret from Client ID used. The default is a random UUID.
      • identityProviders - Specifies which IdP will use. Allowed Values: Google, Github
  • ssl
    • enabled - (Optional) Enable the manual certificate into ingress. The default is false.
    • crt - Specify the certificate path.
    • key - Specify the key path.
    • secretName - (Optional) Specifies if the content from the application will be storage in a volume.
  • helmArgs - (Optional) Used when you need to change some value or add a new value to the helm values used by the formula.
caution

Using helmArgs the application may behave in a way that VKPR may not be used in the best way it was designed. Use it when you know what you're doing

Environment values​

The following variables are supported:

  • ingressClassName - VKPR_ENV_KEYCLOAK_INGRESS_CLASS_NAME
  • namespace - VKPR_ENV_KEYCLOAK_NAMESPACE
  • HA - VKPR_ENV_KEYCLOAK_HA
  • metrics - VKPR_ENV_KEYCLOAK_METRICS
  • adminUser - VKPR_ENV_KEYCLOAK_ADMIN_USER
  • adminPassword - VKPR_ENV_KEYCLOAK_ADMIN_PASSWORD
  • ssl
    • enabled - VKPR_ENV_KEYCLOAK_SSL
    • crt - VKPR_ENV_KEYCLOAK_CERTIFICATE
    • key - VKPR_ENV_KEYCLOAK_KEY
    • secretName - VKPR_ENV_KEYCLOAK_SSL_SECRET
  • openid
    • grafana
      • enabled - VKPR_ENV_KEYCLOAK_OPENID_GRAFANA
      • clientSecret - VKPR_ENV_KEYCLOAK_OPENID_GRAFANA_CLIENTSECRET
      • identityProviders - VKPR_ENV_KEYCLOAK_OPENID_GRAFANA_IDENTITY_PROVIDERS
    • kong
      • enabled - VKPR_ENV_KEYCLOAK_OPENID_KONG
      • clientSecret - VKPR_ENV_KEYCLOAK_OPENID_KONG_CLIENTSECRET
      • identityProviders - VKPR_ENV_KEYCLOAK_OPENID_KONG_IDENTITY_PROVIDERS

Setting Postgresql credentials​

Postgresql​

  rit set credential --provider="postgres" --fields="password" --values="your-password"
About the Formula

Chart Version: 14.1.0
Application Version: v21.0.2
Helm Chart: bitnami/keycloak

See Also​