v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the keycloak v1alpha1 API group +kubebuilder:object:generate=true +groupName=keycloak.appuio.ch

Index

• Variables
• type AttributeSync
  • func (in *AttributeSync) DeepCopy() *AttributeSync
  • func (in *AttributeSync) DeepCopyInto(out *AttributeSync)
  • func (in *AttributeSync) DeepCopyObject() runtime.Object
  • func (a *AttributeSync) GetConditions() []metav1.Condition
  • func (a *AttributeSync) GetLoginRealm() string
  • func (a *AttributeSync) SetConditions(conditions []metav1.Condition)
• type AttributeSyncList
  • func (in *AttributeSyncList) DeepCopy() *AttributeSyncList
  • func (in *AttributeSyncList) DeepCopyInto(out *AttributeSyncList)
  • func (in *AttributeSyncList) DeepCopyObject() runtime.Object
• type AttributeSyncSpec
  • func (in *AttributeSyncSpec) DeepCopy() *AttributeSyncSpec
  • func (in *AttributeSyncSpec) DeepCopyInto(out *AttributeSyncSpec)
• type AttributeSyncStatus
  • func (in *AttributeSyncStatus) DeepCopy() *AttributeSyncStatus
  • func (in *AttributeSyncStatus) DeepCopyInto(out *AttributeSyncStatus)
• type SecretRef
  • func (in *SecretRef) DeepCopy() *SecretRef
  • func (in *SecretRef) DeepCopyInto(out *SecretRef)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "keycloak.appuio.ch", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type AttributeSync

type AttributeSync struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AttributeSyncSpec   `json:"spec,omitempty"`
	Status AttributeSyncStatus `json:"status,omitempty"`
}

AttributeSync is the Schema for the attributesyncs API

func (*AttributeSync) DeepCopy

func (in *AttributeSync) DeepCopy() *AttributeSync

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttributeSync.

func (*AttributeSync) DeepCopyInto

func (in *AttributeSync) DeepCopyInto(out *AttributeSync)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AttributeSync) DeepCopyObject

func (in *AttributeSync) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AttributeSync) GetConditions

func (a *AttributeSync) GetConditions() []metav1.Condition

func (*AttributeSync) GetLoginRealm

func (a *AttributeSync) GetLoginRealm() string

func (*AttributeSync) SetConditions

func (a *AttributeSync) SetConditions(conditions []metav1.Condition)

type AttributeSyncList

type AttributeSyncList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AttributeSync `json:"items"`
}

AttributeSyncList contains a list of AttributeSync

func (*AttributeSyncList) DeepCopy

func (in *AttributeSyncList) DeepCopy() *AttributeSyncList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttributeSyncList.

func (*AttributeSyncList) DeepCopyInto

func (in *AttributeSyncList) DeepCopyInto(out *AttributeSyncList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AttributeSyncList) DeepCopyObject

func (in *AttributeSyncList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AttributeSyncSpec

type AttributeSyncSpec struct {
	// CaSecret is a reference to a secret containing a CA certificate to communicate to the Keycloak server
	// +kubebuilder:validation:Optional
	CaSecret *SecretRef `json:"caSecret,omitempty"`

	// CredentialsSecret is a reference to a secret containing authentication details for the Keycloak server
	// +kubebuilder:validation:Required
	CredentialsSecret *SecretRef `json:"credentialsSecret"`

	// Insecure specifies whether to allow for unverified certificates to be used when communicating to Keycloak
	// +kubebuilder:validation:Optional
	Insecure bool `json:"insecure,omitempty"`

	// LoginRealm is the Keycloak realm to authenticate against
	// +kubebuilder:validation:Optional
	LoginRealm string `json:"loginRealm,omitempty"`

	// Realm is the realm containing the groups to synchronize against
	// +kubebuilder:validation:Required
	Realm string `json:"realm"`

	// URL is the location of the Keycloak server
	// +kubebuilder:validation:Required
	URL string `json:"url"`

	// Attribute specifies the attribute to sync
	// +kubebuilder:validation:Required
	Attribute string `json:"attribute"`

	// TargetLabel specifies the label to sync the attribute to
	// +kubebuilder:validation:Optional
	TargetLabel string `json:"targetLabel,omitempty"`

	// TargetAnnotation specifies the label to sync the attribute to
	// +kubebuilder:validation:Optional
	TargetAnnotation string `json:"targetAnnotation,omitempty"`

	// Schedule represents a cron based configuration for synchronization
	// +kubebuilder:validation:Optional
	Schedule string `json:"schedule,omitempty"`
}

AttributeSyncSpec defines the desired state of AttributeSync

func (*AttributeSyncSpec) DeepCopy

func (in *AttributeSyncSpec) DeepCopy() *AttributeSyncSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttributeSyncSpec.

func (*AttributeSyncSpec) DeepCopyInto

func (in *AttributeSyncSpec) DeepCopyInto(out *AttributeSyncSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AttributeSyncStatus

type AttributeSyncStatus struct {
	// +kubebuilder:validation:Optional
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`

	// LastSyncSuccessTime represents the time last synchronization completed successfully
	// +kubebuilder:validation:Optional
	LastSyncSuccessTime *metav1.Time `json:"lastSyncSuccessTime,omitempty"`
}

AttributeSyncStatus defines the observed state of AttributeSync

func (*AttributeSyncStatus) DeepCopy

func (in *AttributeSyncStatus) DeepCopy() *AttributeSyncStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AttributeSyncStatus.

func (*AttributeSyncStatus) DeepCopyInto

func (in *AttributeSyncStatus) DeepCopyInto(out *AttributeSyncStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecretRef

type SecretRef struct {
	// Name represents the name of the secret
	// +kubebuilder:validation:Required
	Name string `json:"name"`

	// Namespace represents the namespace containing the secret
	// +kubebuilder:validation:Required
	Namespace string `json:"namespace"`

	// Key represents the specific key to reference from the secret
	// +kubebuilder:validation:Optional
	Key string `json:"key,omitempty"`
}

SecretRef represents a reference to an item within a Secret +k8s:openapi-gen=true

func (*SecretRef) DeepCopy

func (in *SecretRef) DeepCopy() *SecretRef

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretRef.

func (*SecretRef) DeepCopyInto

func (in *SecretRef) DeepCopyInto(out *SecretRef)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.