r8s
Security & Identity

keycloak

Keycloak identity and access management operator

@r8s/crds/keycloak

keycloaksecret provider

Declared Operator

⚙

keycloak-operator

version 24.0.0

Components (2)

01

Keycloak

Render a Keycloak (k8s.keycloak.org/v2alpha1) exactly as defined by its CRD.


import { KeycloakComponent } from '@r8s/crds/keycloak'

<KeycloakComponent
  metadata={{ name: 'keycloak', namespace: 'default' }}
  spec={{
    instances: 1,
    hostname: { hostname: 'auth.example.com' },
    proxy: { headers: 'xforwarded' },
  }}
/>
"additionalOptions"AdditionalOptionsItem[]Optional—

Configuration of the Keycloak server. expressed as a keys (reference: https://www.keycloak.org/server/all-config) and values that can be either direct values or references to secrets.

"cache"CacheOptional—

In this section you can configure Keycloak's cache

"db"DbOptional—

In this section you can find all properties related to connect to a database.

"features"FeaturesOptional—

In this section you can configure Keycloak features, which should be enabled/disabled.

"hostname"HostnameOptional—

In this section you can configure Keycloak hostname and related properties.

"http"HttpOptional—

In this section you can configure Keycloak features related to HTTP and HTTPS

"image"stringOptional—

Custom Keycloak image to be used.

"imagePullSecrets"ImagePullSecretsItem[]Optional—

Secret(s) that might be used when pulling an image from a private container image registry or repository.

"ingress"IngressOptional—

The deployment is, by default, exposed through a basic ingress. You can change this behaviour by setting the enabled property to false.

"instances"numberOptional—

Number of Keycloak instances in HA mode. Default is 1.

"proxy"ProxyOptional—

In this section you can configure Keycloak's reverse proxy setting

"resources"ResourcesOptional—

Compute Resources required by Keycloak container

"startOptimized"booleanOptional—

Set to force the behavior of the --optimized flag for the start command. If left unspecified the operator will assume custom images have already been augmented.

"transaction"TransactionOptional—

In this section you can find all properties related to the settings of transaction behavior.

"truststores"RecordOptional—

In this section you can configure Keycloak truststores.

"unsupported"UnsupportedOptional—

In this section you can configure podTemplate advanced features, not production-ready, and not supported settings. Use at your own risk and open an issue with your use-case if you don't find an alternative way.

02

KeycloakRealmImport

Render a KeycloakRealmImport (k8s.keycloak.org/v2alpha1) exactly as defined by its CRD.

"keycloakCRName"stringRequired—

The name of the Keycloak CR to reference, in the same namespace.

"realm"RealmRequired—

The RealmRepresentation to import into Keycloak.

"resources"ResourcesOptional—

Compute Resources required by Keycloak container. If not specified, the value is inherited from the Keycloak CR.

←All packages