KeycloakComponent
keycloak.hostzero.com / v1beta1
apiVersion: keycloak.hostzero.com/v1beta1
kind: KeycloakComponent
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
KeycloakComponentSpec defines the desired state of KeycloakComponent
clusterRealmRef object
ClusterRealmRef is a reference to a ClusterKeycloakRealm for top-level components
One of realmRef, clusterRealmRef, or parentComponentRef must be specified
name
string required
Name of the cluster-scoped resource
configSecretRef object
ConfigSecretRef is a reference to a Kubernetes Secret whose data entries
are merged into definition.config before syncing to Keycloak. Each secret
value is wrapped as a single-element list to match ComponentRepresentation
config (map[string][]string). Secret values take precedence over values
specified inline in definition.config.
name
string required
Name of the Kubernetes Secret in the same namespace as the CR
configSecretRefs []object
ConfigSecretRefs maps individual Secret keys to config keys in
definition.config, for Secrets whose key names differ from Keycloak's
(e.g. cert-manager's tls.key -> privateKey). Each value is injected as a
single-element list. A config key that is already set, inline or via
configSecretRef, cannot also be set here.
configKey
string required
ConfigKey is the target key in definition.config
minLength:
1
key
string required
Key is the key within the Secret that holds the value
minLength:
1
secretName
string required
SecretName is the name of the Kubernetes Secret in the same namespace
minLength:
1
definition
object required
Definition contains the Keycloak ComponentRepresentation. Set the component
name via spec.name.
name
string required
Name is the component name in Keycloak. Immutable once set. The
providerType is set in spec.definition.
minLength:
1parentComponentRef object
ParentComponentRef is a reference to a parent KeycloakComponent in the same
namespace for sub-components, e.g. an LDAP mapper under its user federation
provider. The parent's Keycloak ID is injected as definition.parentId and
the realm is derived from the parent chain, so realmRef and clusterRealmRef
must not be set alongside it. Mutually exclusive with definition.parentId
and immutable.
One of realmRef, clusterRealmRef, or parentComponentRef must be specified
name
string required
Name of the resource
realmRef object
RealmRef is a reference to a KeycloakRealm for top-level components
One of realmRef, clusterRealmRef, or parentComponentRef must be specified
name
string required
Name of the resource
status object
KeycloakComponentStatus defines the observed state of KeycloakComponent
componentID
string
ComponentID is the Keycloak internal component ID
componentName
string
ComponentName is the component name in Keycloak
conditions []object
Conditions represent the latest available observations
lastTransitionTime
string required
lastTransitionTime is the last time the condition transitioned from one status to another.
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
format:
date-time
message
string required
message is a human readable message indicating details about the transition.
This may be an empty string.
maxLength:
32768
observedGeneration
integer
observedGeneration represents the .metadata.generation that the condition was set based upon.
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
with respect to the current state of the instance.
format:
int64minimum:
0
reason
string required
reason contains a programmatic identifier indicating the reason for the condition's last transition.
Producers of specific condition types may define expected values and meanings for this field,
and whether the values are considered a guaranteed API.
The value should be a CamelCase string.
This field may not be empty.
pattern:
^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$minLength:
1maxLength:
1024
status
string required
status of the condition, one of True, False, Unknown.
enum:
True, False, Unknown
type
string required
type of condition in CamelCase or in foo.example.com/CamelCase.
pattern:
^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$maxLength:
316instance object
Instance contains the resolved instance reference
clusterInstanceRef
string
ClusterInstanceRef is the name of the cluster instance
instanceRef
string
InstanceRef is the name of the namespaced instance
lastAppliedDefinitionHash
string
LastAppliedDefinitionHash is a hash of the last successfully applied
definition (after secret merging). Keycloak masks secret config values
on read, so this is the only way to detect that the desired secret
changed and must be pushed.
message
string
Message contains additional information
observedGeneration
integer
ObservedGeneration is the generation of the spec that was last processed
format:
int64
providerType
string
ProviderType is the component provider type
ready
boolean required
Ready indicates if the component is ready
realm object
Realm contains the resolved realm reference
clusterRealmRef
string
ClusterRealmRef is the name of the cluster realm
realmRef
string
RealmRef is the name of the namespaced realm
resourcePath
string
ResourcePath is the Keycloak API path for this component
status
string
Status is a human-readable status message
No matches. Try .spec.clusterRealmRef for an exact path