Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the keycloak v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=keycloak.org
Package v1alpha1 contains API Schema definitions for the keycloak v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=keycloak.org
Index ¶
- Constants
- Variables
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- func UpdateStatusSecondaryResources(secondaryResources map[string][]string, kind string, resourceName string) map[string][]string
- type AuthenticationExecutionInfo
- type AuthenticatorConfig
- type BackupStatusPhase
- type FederatedIdentity
- type Keycloak
- type KeycloakAPIClient
- type KeycloakAPIPasswordReset
- type KeycloakAPIRealm
- type KeycloakAPIUser
- type KeycloakAWSSpec
- type KeycloakBackup
- type KeycloakBackupList
- type KeycloakBackupSpec
- type KeycloakBackupStatus
- type KeycloakClient
- type KeycloakClientList
- type KeycloakClientSpec
- type KeycloakClientStatus
- type KeycloakCredential
- type KeycloakExternalAccess
- type KeycloakExternalDatabase
- type KeycloakIdentityProvider
- type KeycloakList
- type KeycloakProtocolMapper
- type KeycloakRealm
- type KeycloakRealmList
- type KeycloakRealmSpec
- type KeycloakRealmStatus
- type KeycloakSpec
- type KeycloakStatus
- type KeycloakUser
- type KeycloakUserList
- type KeycloakUserRole
- type KeycloakUserSpec
- type KeycloakUserStatus
- type RedirectorIdentityProviderOverride
- type StatusPhase
- type TokenResponse
Constants ¶
const (
UserFinalizer = "user.cleanup"
)
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "keycloak.org", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
Types ¶
type AuthenticationExecutionInfo ¶
type AuthenticationExecutionInfo struct {
// Authentication Execution Info Alias.
// +optional
Alias string `json:"alias,omitempty"`
// Authentication Execution Info Config.
// +optional
AuthenticationConfig string `json:"authenticationConfig,omitempty"`
// True if Authentication Flow is enabled.
// +optional
AuthenticationFlow bool `json:"authenticationFlow,omitempty"`
// True if Authentication Execution Info is configurable.
// +optional
Configurable bool `json:"configurable,omitempty"`
// Authentication Execution Info Display Name.
// +optional
DisplayName string `json:"displayName,omitempty"`
// Authentication Execution Info Flow ID.
// +optional
FlowID string `json:"flowId,omitempty"`
// Authentication Execution Info ID.
// +optional
ID string `json:"id,omitempty"`
// Authentication Execution Info Index.
// +optional
Index int32 `json:"index,omitempty"`
// Authentication Execution Info Level.
// +optional
Level int32 `json:"level,omitempty"`
// Authentication Execution Info Provider ID.
// +optional
ProviderID string `json:"providerId,omitempty"`
// Authentication Execution Info Requirement.
// +optional
Requirement string `json:"requirement,omitempty"`
// Authentication Execution Info Requirement Choices.
// +optional
RequirementChoices []string `json:"requirementChoices,omitempty"`
}
func (*AuthenticationExecutionInfo) DeepCopy ¶
func (in *AuthenticationExecutionInfo) DeepCopy() *AuthenticationExecutionInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticationExecutionInfo.
func (*AuthenticationExecutionInfo) DeepCopyInto ¶
func (in *AuthenticationExecutionInfo) DeepCopyInto(out *AuthenticationExecutionInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AuthenticatorConfig ¶
type AuthenticatorConfig struct {
// Authenticator Config Alias.
// +optional
Alias string `json:"alias,omitempty"`
// Authenticator config.
// +optional
Config map[string]string `json:"config,omitempty"`
// Authenticator ID.
// +optional
ID string `json:"id,omitempty"`
}
func (*AuthenticatorConfig) DeepCopy ¶
func (in *AuthenticatorConfig) DeepCopy() *AuthenticatorConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthenticatorConfig.
func (*AuthenticatorConfig) DeepCopyInto ¶
func (in *AuthenticatorConfig) DeepCopyInto(out *AuthenticatorConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupStatusPhase ¶
type BackupStatusPhase string
var ( BackupPhaseNone BackupStatusPhase BackupPhaseReconciling BackupStatusPhase = "reconciling" BackupPhaseCreated BackupStatusPhase = "created" BackupPhaseRestored BackupStatusPhase = "restored" BackupPhaseFailing BackupStatusPhase = "failing" )
type FederatedIdentity ¶
type FederatedIdentity struct {
// Federated Identity Provider.
// +optional
IdentityProvider string `json:"identityProvider,omitempty"`
// Federated Identity User ID.
// +optional
UserID string `json:"userId,omitempty"`
// Federated Identity User Name.
// +optional
UserName string `json:"userName,omitempty"`
}
func (*FederatedIdentity) DeepCopy ¶
func (in *FederatedIdentity) DeepCopy() *FederatedIdentity
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FederatedIdentity.
func (*FederatedIdentity) DeepCopyInto ¶
func (in *FederatedIdentity) DeepCopyInto(out *FederatedIdentity)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Keycloak ¶
type Keycloak struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KeycloakSpec `json:"spec,omitempty"`
Status KeycloakStatus `json:"status,omitempty"`
}
Keycloak is the Schema for the keycloaks API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:path=keycloaks,scope=Namespaced
func (*Keycloak) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Keycloak.
func (*Keycloak) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Keycloak) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Keycloak) UpdateStatusSecondaryResources ¶
type KeycloakAPIClient ¶
type KeycloakAPIClient struct {
// Client ID. If not specified, automatically generated.
// +optional
ID string `json:"id,omitempty"`
// Client ID.
// +kubebuilder:validation:Required
ClientID string `json:"clientId"`
// Client name.
// +optional
Name string `json:"name,omitempty"`
// Surrogate Authentication Required option.
// +optional
SurrogateAuthRequired bool `json:"surrogateAuthRequired,omitempty"`
// Client enabled flag.
// +optional
Enabled bool `json:"enabled,omitempty"`
// What Client authentication type to use.
// +optional
ClientAuthenticatorType string `json:"clientAuthenticatorType,omitempty"`
// Client Secret. The Operator will automatically create a Secret based on this value.
// +optional
Secret string `json:"secret,omitempty"`
// Application base URL.
// +optional
BaseURL string `json:"baseUrl,omitempty"`
// Application Admin URL.
// +optional
AdminURL string `json:"adminUrl,omitempty"`
// Application root URL.
// +optional
RootURL string `json:"rootUrl,omitempty"`
// Client description.
// +optional
Description string `json:"description,omitempty"`
// Default Client roles.
// +optional
DefaultRoles []string `json:"defaultRoles,omitempty"`
// A list of valid Redirection URLs.
// +optional
RedirectUris []string `json:"redirectUris,omitempty"`
// A list of valid Web Origins.
// +optional
WebOrigins []string `json:"webOrigins,omitempty"`
// Not Before setting.
// +optional
NotBefore int `json:"notBefore,omitempty"`
// True if a client supports only Bearer Tokens.
// +optional
BearerOnly bool `json:"bearerOnly,omitempty"`
// True if Consent Screen is required.
// +optional
ConsentRequired bool `json:"consentRequired,omitempty"`
// True if Standard flow is enabled.
// +optional
StandardFlowEnabled bool `json:"standardFlowEnabled,omitempty"`
// True if Implicit flow is enabled.
// +optional
ImplicitFlowEnabled bool `json:"implicitFlowEnabled,omitempty"`
// True if Direct Grant is enabled.
// +optional
DirectAccessGrantsEnabled bool `json:"directAccessGrantsEnabled,omitempty"`
// True if Service Accounts are enabled.
// +optional
ServiceAccountsEnabled bool `json:"serviceAccountsEnabled,omitempty"`
// True if this is a public Client.
// +optional
PublicClient bool `json:"publicClient,omitempty"`
// True if this client supports Front Channel logout.
// +optional
FrontchannelLogout bool `json:"frontchannelLogout,omitempty"`
// Protocol used for this Client.
// +optional
Protocol string `json:"protocol,omitempty"`
// Client Attributes.
// +optional
Attributes map[string]string `json:"attributes,omitempty"`
// True if Full Scope is allowed.
// +optional
FullScopeAllowed bool `json:"fullScopeAllowed,omitempty"`
// Node registration timeout.
// +optional
NodeReRegistrationTimeout int `json:"nodeReRegistrationTimeout,omitempty"`
// Protocol Mappers.
// +optional
ProtocolMappers []KeycloakProtocolMapper `json:"protocolMappers,omitempty"`
// True to use a Template Config.
// +optional
UseTemplateConfig bool `json:"useTemplateConfig,omitempty"`
// True to use Template Scope.
// +optional
UseTemplateScope bool `json:"useTemplateScope,omitempty"`
// True to use Template Mappers.
// +optional
UseTemplateMappers bool `json:"useTemplateMappers,omitempty"`
// Access options.
// +optional
Access map[string]bool `json:"access,omitempty"`
}
func (*KeycloakAPIClient) DeepCopy ¶
func (in *KeycloakAPIClient) DeepCopy() *KeycloakAPIClient
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakAPIClient.
func (*KeycloakAPIClient) DeepCopyInto ¶
func (in *KeycloakAPIClient) DeepCopyInto(out *KeycloakAPIClient)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakAPIPasswordReset ¶
type KeycloakAPIPasswordReset struct {
// Password Reset Type.
// +optional
Type string `json:"type"`
// Password Reset Value.
// +optional
Value string `json:"value"`
// True if this Password Reset object is temporary.
// +optional
Temporary bool `json:"temporary"`
}
func (*KeycloakAPIPasswordReset) DeepCopy ¶
func (in *KeycloakAPIPasswordReset) DeepCopy() *KeycloakAPIPasswordReset
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakAPIPasswordReset.
func (*KeycloakAPIPasswordReset) DeepCopyInto ¶
func (in *KeycloakAPIPasswordReset) DeepCopyInto(out *KeycloakAPIPasswordReset)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakAPIRealm ¶
type KeycloakAPIRealm struct {
// +kubebuilder:validation:Required
// +optional
ID string `json:"id"`
// Realm name.
// +kubebuilder:validation:Required
Realm string `json:"realm"`
// Realm enabled flag.
// +optional
Enabled bool `json:"enabled"`
// Realm display name.
// +optional
DisplayName string `json:"displayName"`
// A set of Keycloak Users.
// +optional
Users []*KeycloakAPIUser `json:"users,omitempty"`
// A set of Keycloak Clients.
// +optional
Clients []*KeycloakAPIClient `json:"clients,omitempty"`
// A set of Identity Providers.
// +optional
IdentityProviders []*KeycloakIdentityProvider `json:"identityProviders,omitempty"`
// A set of Event Listeners.
// +optional
EventsListeners []string `json:"eventsListeners,omitempty"`
}
func (*KeycloakAPIRealm) DeepCopy ¶
func (in *KeycloakAPIRealm) DeepCopy() *KeycloakAPIRealm
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakAPIRealm.
func (*KeycloakAPIRealm) DeepCopyInto ¶
func (in *KeycloakAPIRealm) DeepCopyInto(out *KeycloakAPIRealm)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakAPIUser ¶
type KeycloakAPIUser struct {
// User ID.
// +optional
ID string `json:"id,omitempty"`
// User Name.
// +optional
UserName string `json:"username,omitempty"`
// First Name.
// +optional
FirstName string `json:"firstName,omitempty"`
// Last Name.
// +optional
LastName string `json:"lastName,omitempty"`
// Email.
// +optional
Email string `json:"email,omitempty"`
// True if email has already been verified.
// +optional
EmailVerified bool `json:"emailVerified,omitempty"`
// User enabled flag.
// +optional
Enabled bool `json:"enabled,omitempty"`
// A set of Realm Roles.
// +optional
RealmRoles []string `json:"realmRoles,omitempty"`
// A set of Client Roles.
// +optional
ClientRoles map[string][]string `json:"clientRoles,omitempty"`
// A set of Required Actions.
// +optional
RequiredActions []string `json:"requiredActions,omitempty"`
// A set of Groups.
// +optional
Groups []string `json:"groups,omitempty"`
// A set of Federated Identities.
// +optional
FederatedIdentities []FederatedIdentity `json:"federatedIdentities,omitempty"`
// A set of Credentials.
// +optional
Credentials []KeycloakCredential `json:"credentials,omitempty"`
}
func (*KeycloakAPIUser) DeepCopy ¶
func (in *KeycloakAPIUser) DeepCopy() *KeycloakAPIUser
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakAPIUser.
func (*KeycloakAPIUser) DeepCopyInto ¶
func (in *KeycloakAPIUser) DeepCopyInto(out *KeycloakAPIUser)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakAWSSpec ¶
type KeycloakAWSSpec struct {
// If provided, the database backup will be encrypted.
// Provides a secret name used for encrypting database data.
// The secret needs to be in the following form:
//
// apiVersion: v1
// kind: Secret
// metadata:
// name: <Secret name>
// type: Opaque
// stringData:
// GPG_PUBLIC_KEY: <GPG Public Key>
// GPG_TRUST_MODEL: <GPG Trust Model>
// GPG_RECIPIENT: <GPG Recipient>
//
// For more information, please refer to the Operator documentation.
// +optional
EncryptionKeySecretName string `json:"encryptionKeySecretName,omitempty"`
// Provides a secret name used for connecting to AWS S3 Service.
// The secret needs to be in the following form:
//
// apiVersion: v1
// kind: Secret
// metadata:
// name: <Secret name>
// type: Opaque
// stringData:
// AWS_S3_BUCKET_NAME: <S3 Bucket Name>
// AWS_ACCESS_KEY_ID: <AWS Access Key ID>
// AWS_SECRET_ACCESS_KEY: <AWS Secret Key>
//
// For more information, please refer to the Operator documentation.
// +kubebuilder:validation:Required
CredentialsSecretName string `json:"credentialsSecretName,omitempty"`
// If specified, it will be used as a schedule for creating a CronJob
// +optional
Schedule string `json:"schedule,omitempty"`
}
KeycloakAWSSpec defines the desired state of KeycloakBackupSpec +k8s:openapi-gen=true
func (*KeycloakAWSSpec) DeepCopy ¶
func (in *KeycloakAWSSpec) DeepCopy() *KeycloakAWSSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakAWSSpec.
func (*KeycloakAWSSpec) DeepCopyInto ¶
func (in *KeycloakAWSSpec) DeepCopyInto(out *KeycloakAWSSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakBackup ¶
type KeycloakBackup struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KeycloakBackupSpec `json:"spec,omitempty"`
Status KeycloakBackupStatus `json:"status,omitempty"`
}
KeycloakBackup is the Schema for the keycloakbackups API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:path=keycloakbackups,scope=Namespaced
func (*KeycloakBackup) DeepCopy ¶
func (in *KeycloakBackup) DeepCopy() *KeycloakBackup
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakBackup.
func (*KeycloakBackup) DeepCopyInto ¶
func (in *KeycloakBackup) DeepCopyInto(out *KeycloakBackup)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakBackup) DeepCopyObject ¶
func (in *KeycloakBackup) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*KeycloakBackup) UpdateStatusSecondaryResources ¶
func (i *KeycloakBackup) UpdateStatusSecondaryResources(kind string, resourceName string)
type KeycloakBackupList ¶
type KeycloakBackupList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KeycloakBackup `json:"items"`
}
KeycloakBackupList contains a list of KeycloakBackup
func (*KeycloakBackupList) DeepCopy ¶
func (in *KeycloakBackupList) DeepCopy() *KeycloakBackupList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakBackupList.
func (*KeycloakBackupList) DeepCopyInto ¶
func (in *KeycloakBackupList) DeepCopyInto(out *KeycloakBackupList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakBackupList) DeepCopyObject ¶
func (in *KeycloakBackupList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeycloakBackupSpec ¶
type KeycloakBackupSpec struct {
// Controls automatic restore behavior.
// Currently not implemented.
//
// In the future this will be used to trigger automatic restore for a given KeycloakBackup.
// Each backup will correspond to a single snapshot of the database (stored either in a
// Persistent Volume or AWS). If a user wants to restore it, all he/she needs to do is to
// change this flag to true.
// Potentially, it will be possible to restore a single backup multiple times.
// +optional
Restore bool `json:"restore,omitempty"`
// If provided, an automatic database backup will be created on AWS S3 instead of
// a local Persistent Volume. If this property is not provided - a local
// Persistent Volume backup will be chosen.
// +optional
AWS KeycloakAWSSpec `json:"aws,omitempty"`
}
KeycloakBackupSpec defines the desired state of KeycloakBackup +k8s:openapi-gen=true
func (*KeycloakBackupSpec) DeepCopy ¶
func (in *KeycloakBackupSpec) DeepCopy() *KeycloakBackupSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakBackupSpec.
func (*KeycloakBackupSpec) DeepCopyInto ¶
func (in *KeycloakBackupSpec) DeepCopyInto(out *KeycloakBackupSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakBackupStatus ¶
type KeycloakBackupStatus struct {
// Current phase of the operator.
Phase BackupStatusPhase `json:"phase"`
// Human-readable message indicating details about current operator phase or error.
Message string `json:"message"`
// True if all resources are in a ready state and all work is done.
Ready bool `json:"ready"`
// A map of all the secondary resources types and names created for this CR. e.g "Deployment": [ "DeploymentName1", "DeploymentName2" ]
SecondaryResources map[string][]string `json:"secondaryResources,omitempty"`
}
KeycloakBackupStatus defines the observed state of KeycloakBackup +k8s:openapi-gen=true
func (*KeycloakBackupStatus) DeepCopy ¶
func (in *KeycloakBackupStatus) DeepCopy() *KeycloakBackupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakBackupStatus.
func (*KeycloakBackupStatus) DeepCopyInto ¶
func (in *KeycloakBackupStatus) DeepCopyInto(out *KeycloakBackupStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakClient ¶
type KeycloakClient struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KeycloakClientSpec `json:"spec,omitempty"`
Status KeycloakClientStatus `json:"status,omitempty"`
}
KeycloakClient is the Schema for the keycloakclients API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:path=keycloakclients,scope=Namespaced
func (*KeycloakClient) DeepCopy ¶
func (in *KeycloakClient) DeepCopy() *KeycloakClient
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakClient.
func (*KeycloakClient) DeepCopyInto ¶
func (in *KeycloakClient) DeepCopyInto(out *KeycloakClient)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakClient) DeepCopyObject ¶
func (in *KeycloakClient) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*KeycloakClient) UpdateStatusSecondaryResources ¶
func (i *KeycloakClient) UpdateStatusSecondaryResources(kind string, resourceName string)
type KeycloakClientList ¶
type KeycloakClientList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KeycloakClient `json:"items"`
}
KeycloakClientList contains a list of KeycloakClient
func (*KeycloakClientList) DeepCopy ¶
func (in *KeycloakClientList) DeepCopy() *KeycloakClientList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakClientList.
func (*KeycloakClientList) DeepCopyInto ¶
func (in *KeycloakClientList) DeepCopyInto(out *KeycloakClientList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakClientList) DeepCopyObject ¶
func (in *KeycloakClientList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeycloakClientSpec ¶
type KeycloakClientSpec struct {
// Selector for looking up KeycloakRealm Custom Resources.
// +kubebuilder:validation:Required
RealmSelector *metav1.LabelSelector `json:"realmSelector"`
// Keycloak Client REST object.
// +kubebuilder:validation:Required
Client *KeycloakAPIClient `json:"client"`
}
KeycloakClientSpec defines the desired state of KeycloakClient +k8s:openapi-gen=true
func (*KeycloakClientSpec) DeepCopy ¶
func (in *KeycloakClientSpec) DeepCopy() *KeycloakClientSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakClientSpec.
func (*KeycloakClientSpec) DeepCopyInto ¶
func (in *KeycloakClientSpec) DeepCopyInto(out *KeycloakClientSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakClientStatus ¶
type KeycloakClientStatus struct {
// Current phase of the operator.
Phase StatusPhase `json:"phase"`
// Human-readable message indicating details about current operator phase or error.
Message string `json:"message"`
// True if all resources are in a ready state and all work is done.
Ready bool `json:"ready"`
// A map of all the secondary resources types and names created for this CR. e.g "Deployment": [ "DeploymentName1", "DeploymentName2" ]
SecondaryResources map[string][]string `json:"secondaryResources,omitempty"`
}
KeycloakClientStatus defines the observed state of KeycloakClient +k8s:openapi-gen=true
func (*KeycloakClientStatus) DeepCopy ¶
func (in *KeycloakClientStatus) DeepCopy() *KeycloakClientStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakClientStatus.
func (*KeycloakClientStatus) DeepCopyInto ¶
func (in *KeycloakClientStatus) DeepCopyInto(out *KeycloakClientStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakCredential ¶
type KeycloakCredential struct {
// Credential Type.
// +optional
Type string `json:"type,omitempty"`
// Credential Value.
// +optional
Value string `json:"value,omitempty"`
// True if this credential object is temporary.
// +optional
Temporary bool `json:"temporary,omitempty"`
}
func (*KeycloakCredential) DeepCopy ¶
func (in *KeycloakCredential) DeepCopy() *KeycloakCredential
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakCredential.
func (*KeycloakCredential) DeepCopyInto ¶
func (in *KeycloakCredential) DeepCopyInto(out *KeycloakCredential)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakExternalAccess ¶
type KeycloakExternalAccess struct {
// If set to true, the Operator will create an Ingress or a Route
// pointing to Keycloak.
Enabled bool `json:"enabled,omitempty"`
}
func (*KeycloakExternalAccess) DeepCopy ¶
func (in *KeycloakExternalAccess) DeepCopy() *KeycloakExternalAccess
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakExternalAccess.
func (*KeycloakExternalAccess) DeepCopyInto ¶
func (in *KeycloakExternalAccess) DeepCopyInto(out *KeycloakExternalAccess)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakExternalDatabase ¶
type KeycloakExternalDatabase struct {
// If set to true, the Operator will use an external database.
// pointing to Keycloak.
Enabled bool `json:"enabled,omitempty"`
}
func (*KeycloakExternalDatabase) DeepCopy ¶
func (in *KeycloakExternalDatabase) DeepCopy() *KeycloakExternalDatabase
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakExternalDatabase.
func (*KeycloakExternalDatabase) DeepCopyInto ¶
func (in *KeycloakExternalDatabase) DeepCopyInto(out *KeycloakExternalDatabase)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakIdentityProvider ¶
type KeycloakIdentityProvider struct {
// Identity Provider Alias.
// +optional
Alias string `json:"alias,omitempty"`
// Identity Provider Display Name.
// +optional
DisplayName string `json:"displayName,omitempty"`
// Identity Provider Internal ID.
// +optional
InternalID string `json:"internalId,omitempty"`
// Identity Provider ID.
// +optional
ProviderID string `json:"providerId,omitempty"`
// Identity Provider enabled flag.
// +optional
Enabled bool `json:"enabled,omitempty"`
// Identity Provider Trust Email.
// +optional
TrustEmail bool `json:"trustEmail,omitempty"`
// Identity Provider Store to Token.
// +optional
StoreToken bool `json:"storeToken,omitempty"`
// Adds Read Token role when creating this Identity Provider.
// +optional
AddReadTokenRoleOnCreate bool `json:"addReadTokenRoleOnCreate,omitempty"`
// Identity Provider First Broker Login Flow Alias.
// +optional
FirstBrokerLoginFlowAlias string `json:"firstBrokerLoginFlowAlias,omitempty"`
// Identity Provider Post Broker Login Flow Alias.
// +optional
PostBrokerLoginFlowAlias string `json:"postBrokerLoginFlowAlias,omitempty"`
// Identity Provider Link Only setting.
// +optional
LinkOnly bool `json:"linkOnly,omitempty"`
// Identity Provider config.
// +optional
Config map[string]string `json:"config,omitempty"`
}
func (*KeycloakIdentityProvider) DeepCopy ¶
func (in *KeycloakIdentityProvider) DeepCopy() *KeycloakIdentityProvider
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakIdentityProvider.
func (*KeycloakIdentityProvider) DeepCopyInto ¶
func (in *KeycloakIdentityProvider) DeepCopyInto(out *KeycloakIdentityProvider)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakList ¶
type KeycloakList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Keycloak `json:"items"`
}
KeycloakList contains a list of Keycloak
func (*KeycloakList) DeepCopy ¶
func (in *KeycloakList) DeepCopy() *KeycloakList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakList.
func (*KeycloakList) DeepCopyInto ¶
func (in *KeycloakList) DeepCopyInto(out *KeycloakList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakList) DeepCopyObject ¶
func (in *KeycloakList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeycloakProtocolMapper ¶
type KeycloakProtocolMapper struct {
// Protocol Mapper ID.
// +optional
ID string `json:"id,omitempty"`
// Protocol Mapper Name.
// +optional
Name string `json:"name,omitempty"`
// Protocol to use.
// +optional
Protocol string `json:"protocol,omitempty"`
// Protocol Mapper to use
// +optional
ProtocolMapper string `json:"protocolMapper,omitempty"`
// True if Consent Screen is required.
// +optional
ConsentRequired bool `json:"consentRequired,omitempty"`
// Text to use for displaying Consent Screen.
// +optional
ConsentText string `json:"consentText,omitempty"`
// Config options.
// +optional
Config map[string]string `json:"config,omitempty"`
}
func (*KeycloakProtocolMapper) DeepCopy ¶
func (in *KeycloakProtocolMapper) DeepCopy() *KeycloakProtocolMapper
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakProtocolMapper.
func (*KeycloakProtocolMapper) DeepCopyInto ¶
func (in *KeycloakProtocolMapper) DeepCopyInto(out *KeycloakProtocolMapper)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakRealm ¶
type KeycloakRealm struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KeycloakRealmSpec `json:"spec,omitempty"`
Status KeycloakRealmStatus `json:"status,omitempty"`
}
KeycloakRealm is the Schema for the keycloakrealms API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:path=keycloakrealms,scope=Namespaced
func (*KeycloakRealm) DeepCopy ¶
func (in *KeycloakRealm) DeepCopy() *KeycloakRealm
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakRealm.
func (*KeycloakRealm) DeepCopyInto ¶
func (in *KeycloakRealm) DeepCopyInto(out *KeycloakRealm)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakRealm) DeepCopyObject ¶
func (in *KeycloakRealm) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*KeycloakRealm) UpdateStatusSecondaryResources ¶
func (i *KeycloakRealm) UpdateStatusSecondaryResources(kind string, resourceName string)
type KeycloakRealmList ¶
type KeycloakRealmList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KeycloakRealm `json:"items"`
}
KeycloakRealmList contains a list of KeycloakRealm
func (*KeycloakRealmList) DeepCopy ¶
func (in *KeycloakRealmList) DeepCopy() *KeycloakRealmList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakRealmList.
func (*KeycloakRealmList) DeepCopyInto ¶
func (in *KeycloakRealmList) DeepCopyInto(out *KeycloakRealmList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakRealmList) DeepCopyObject ¶
func (in *KeycloakRealmList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeycloakRealmSpec ¶
type KeycloakRealmSpec struct {
// Selector for looking up Keycloak Custom Resources.
// +kubebuilder:validation:Required
InstanceSelector *metav1.LabelSelector `json:"instanceSelector,omitempty"`
// Keycloak Realm REST object.
// +kubebuilder:validation:Required
Realm *KeycloakAPIRealm `json:"realm"`
// A list of overrides to the default Realm behavior.
// +listType=map
RealmOverrides []*RedirectorIdentityProviderOverride `json:"realmOverrides,omitempty"`
}
KeycloakRealmSpec defines the desired state of KeycloakRealm +k8s:openapi-gen=true
func (*KeycloakRealmSpec) DeepCopy ¶
func (in *KeycloakRealmSpec) DeepCopy() *KeycloakRealmSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakRealmSpec.
func (*KeycloakRealmSpec) DeepCopyInto ¶
func (in *KeycloakRealmSpec) DeepCopyInto(out *KeycloakRealmSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakRealmStatus ¶
type KeycloakRealmStatus struct {
// Current phase of the operator.
Phase StatusPhase `json:"phase"`
// Human-readable message indicating details about current operator phase or error.
Message string `json:"message"`
// True if all resources are in a ready state and all work is done.
Ready bool `json:"ready"`
// A map of all the secondary resources types and names created for this CR. e.g "Deployment": [ "DeploymentName1", "DeploymentName2" ]
SecondaryResources map[string][]string `json:"secondaryResources,omitempty"`
// TODO
LoginURL string `json:"loginURL"`
}
KeycloakRealmStatus defines the observed state of KeycloakRealm +k8s:openapi-gen=true
func (*KeycloakRealmStatus) DeepCopy ¶
func (in *KeycloakRealmStatus) DeepCopy() *KeycloakRealmStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakRealmStatus.
func (*KeycloakRealmStatus) DeepCopyInto ¶
func (in *KeycloakRealmStatus) DeepCopyInto(out *KeycloakRealmStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakSpec ¶
type KeycloakSpec struct {
// A list of extensions, where each one is a URL to a JAR files that will be deployed in Keycloak.
// +listType=set
// +optional
Extensions []string `json:"extensions,omitempty"`
// Number of Keycloak instances in HA mode. Default is 1.
// +optional
// +kubebuilder:default=1
Instances int `json:"instances,omitempty"`
// Controls external Ingress/Route settings.
// +optional
ExternalAccess KeycloakExternalAccess `json:"externalAccess,omitempty"`
// Controls external database settings.
// Using an external database requires providing a secret containing credentials
// as well as connection details. Here's an example of such secret:
//
// apiVersion: v1
// kind: Secret
// metadata:
// name: keycloak-db-secret
// namespace: keycloak
// stringData:
// POSTGRES_DATABASE: <Database Name>
// POSTGRES_EXTERNAL_ADDRESS: <External Database IP or URL (resolvable by K8s)>
// POSTGRES_EXTERNAL_PORT: <External Database Port>
// # Strongly recommended to use <'Keycloak CR Name'-postgresql>
// POSTGRES_HOST: <Database Service Name>
// POSTGRES_PASSWORD: <Database Password>
// # Required for AWS Backup functionality
// POSTGRES_SUPERUSER: true
// POSTGRES_USERNAME: <Database Username>
// type: Opaque
//
// Both POSTGRES_EXTERNAL_ADDRESS and POSTGRES_EXTERNAL_PORT are specifically required for creating
// connection to the external database. The secret name is created using the following convention:
// <Custom Resource Name>-db-secret
//
// For more information, please refer to the Operator documentation.
// +optional
ExternalDatabase KeycloakExternalDatabase `json:"externalDatabase,omitempty"`
// Profile used for controlling Operator behavior. Default is empty.
// +optional
Profile string `json:"profile,omitempty"`
}
KeycloakSpec defines the desired state of Keycloak +k8s:openapi-gen=true
func (*KeycloakSpec) DeepCopy ¶
func (in *KeycloakSpec) DeepCopy() *KeycloakSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakSpec.
func (*KeycloakSpec) DeepCopyInto ¶
func (in *KeycloakSpec) DeepCopyInto(out *KeycloakSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakStatus ¶
type KeycloakStatus struct {
// Current phase of the operator.
Phase StatusPhase `json:"phase"`
// Human-readable message indicating details about current operator phase or error.
Message string `json:"message"`
// True if all resources are in a ready state and all work is done.
Ready bool `json:"ready"`
// A map of all the secondary resources types and names created for this CR. e.g "Deployment": [ "DeploymentName1", "DeploymentName2" ]
SecondaryResources map[string][]string `json:"secondaryResources,omitempty"`
// Version of Keycloak or RHSSO running on the cluster
Version string `json:"version"`
// Service IP and Port for in-cluster access to the keycloak instance
InternalURL string `json:"internalURL"`
// The secret where the admin credentials are to be found
CredentialSecret string `json:"credentialSecret"`
}
KeycloakStatus defines the observed state of Keycloak +k8s:openapi-gen=true
func (*KeycloakStatus) DeepCopy ¶
func (in *KeycloakStatus) DeepCopy() *KeycloakStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakStatus.
func (*KeycloakStatus) DeepCopyInto ¶
func (in *KeycloakStatus) DeepCopyInto(out *KeycloakStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakUser ¶
type KeycloakUser struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KeycloakUserSpec `json:"spec,omitempty"`
Status KeycloakUserStatus `json:"status,omitempty"`
}
KeycloakUser is the Schema for the keycloakusers API +k8s:openapi-gen=true +kubebuilder:subresource:status +kubebuilder:resource:path=keycloakusers,scope=Namespaced
func (*KeycloakUser) DeepCopy ¶
func (in *KeycloakUser) DeepCopy() *KeycloakUser
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakUser.
func (*KeycloakUser) DeepCopyInto ¶
func (in *KeycloakUser) DeepCopyInto(out *KeycloakUser)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakUser) DeepCopyObject ¶
func (in *KeycloakUser) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeycloakUserList ¶
type KeycloakUserList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []KeycloakUser `json:"items"`
}
KeycloakUserList contains a list of KeycloakUser
func (*KeycloakUserList) DeepCopy ¶
func (in *KeycloakUserList) DeepCopy() *KeycloakUserList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakUserList.
func (*KeycloakUserList) DeepCopyInto ¶
func (in *KeycloakUserList) DeepCopyInto(out *KeycloakUserList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*KeycloakUserList) DeepCopyObject ¶
func (in *KeycloakUserList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type KeycloakUserRole ¶
type KeycloakUserRole struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
Composite bool `json:"composite,omitempty"`
ClientRole bool `json:"clientRole,omitempty"`
ContainerID string `json:"containerId,omitempty"`
}
func (*KeycloakUserRole) DeepCopy ¶
func (in *KeycloakUserRole) DeepCopy() *KeycloakUserRole
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakUserRole.
func (*KeycloakUserRole) DeepCopyInto ¶
func (in *KeycloakUserRole) DeepCopyInto(out *KeycloakUserRole)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakUserSpec ¶
type KeycloakUserSpec struct {
// Selector for looking up KeycloakRealm Custom Resources.
// +kubebuilder:validation:Required
RealmSelector *metav1.LabelSelector `json:"realmSelector,omitempty"`
// Keycloak User REST object.
// +kubebuilder:validation:Required
User KeycloakAPIUser `json:"user"`
}
KeycloakUserSpec defines the desired state of KeycloakUser +k8s:openapi-gen=true
func (*KeycloakUserSpec) DeepCopy ¶
func (in *KeycloakUserSpec) DeepCopy() *KeycloakUserSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakUserSpec.
func (*KeycloakUserSpec) DeepCopyInto ¶
func (in *KeycloakUserSpec) DeepCopyInto(out *KeycloakUserSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type KeycloakUserStatus ¶
type KeycloakUserStatus struct {
// Current phase of the operator.
Phase StatusPhase `json:"phase"`
// Human-readable message indicating details about current operator phase or error.
Message string `json:"message"`
}
KeycloakUserStatus defines the observed state of KeycloakUser +k8s:openapi-gen=true
func (*KeycloakUserStatus) DeepCopy ¶
func (in *KeycloakUserStatus) DeepCopy() *KeycloakUserStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KeycloakUserStatus.
func (*KeycloakUserStatus) DeepCopyInto ¶
func (in *KeycloakUserStatus) DeepCopyInto(out *KeycloakUserStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RedirectorIdentityProviderOverride ¶
type RedirectorIdentityProviderOverride struct {
// Identity Provider to be overridden.
// +optional
IdentityProvider string `json:"identityProvider,omitempty"`
// Flow to be overridden.
// +optional
ForFlow string `json:"forFlow,omitempty"`
}
func (*RedirectorIdentityProviderOverride) DeepCopy ¶
func (in *RedirectorIdentityProviderOverride) DeepCopy() *RedirectorIdentityProviderOverride
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RedirectorIdentityProviderOverride.
func (*RedirectorIdentityProviderOverride) DeepCopyInto ¶
func (in *RedirectorIdentityProviderOverride) DeepCopyInto(out *RedirectorIdentityProviderOverride)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type StatusPhase ¶
type StatusPhase string
var ( NoPhase StatusPhase PhaseReconciling StatusPhase = "reconciling" PhaseFailing StatusPhase = "failing" PhaseInitialising StatusPhase = "initialising" )
var ( UserPhaseReconciled StatusPhase = "reconciled" UserPhaseFailing StatusPhase = "failing" )
type TokenResponse ¶
type TokenResponse struct {
// Token Response Access Token.
// +optional
AccessToken string `json:"access_token"`
// Token Response Expired In setting.
// +optional
ExpiresIn int `json:"expires_in"`
// Token Response Refresh Expires In setting.
// +optional
RefreshExpiresIn int `json:"refresh_expires_in"`
// Token Response Refresh Token.
// +optional
RefreshToken string `json:"refresh_token"`
// Token Response Token Type.
// +optional
TokenType string `json:"token_type"`
// Token Response Not Before Policy setting.
// +optional
NotBeforePolicy int `json:"not-before-policy"`
// Token Response Session State.
// +optional
SessionState string `json:"session_state"`
// Token Response Error.
// +optional
Error string `json:"error"`
// Token Response Error Description.
// +optional
ErrorDescription string `json:"error_description"`
}
func (*TokenResponse) DeepCopy ¶
func (in *TokenResponse) DeepCopy() *TokenResponse
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenResponse.
func (*TokenResponse) DeepCopyInto ¶
func (in *TokenResponse) DeepCopyInto(out *TokenResponse)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.