v1alpha1

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 10, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the directory v1alpha1 API group +kubebuilder:object:generate=true +groupName=directory.forgerock.io

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "directory.forgerock.io", 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
)

Functions

This section is empty.

Types

type BackupStatus added in v0.1.0 

type BackupStatus struct {

	// StartTimestamp records the time a backup was started.
	// The server's time is used for StartTimestamps
	// +optional
	// +nullable
	StartTimestamp *metav1.Time `json:"startTimestamp,omitempty"`

	// CompletionTimestamp records the time a backup was completed.
	// Completion time is recorded even on failed backups.
	// Completion time is recorded before uploading the backup object.
	// The server's time is used for CompletionTimestamps
	// +optional
	// +nullable
	CompletionTimestamp *metav1.Time `json:"completionTimestamp,omitempty"`
}

BackupStatus captures the current status of a backup.

func (*BackupStatus) DeepCopy added in v0.1.0 

func (in *BackupStatus) DeepCopy() *BackupStatus

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

func (*BackupStatus) DeepCopyInto added in v0.1.0 

func (in *BackupStatus) DeepCopyInto(out *BackupStatus)

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

type DirectoryBackup 

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

	Spec   DirectoryBackupSpec `json:"spec,omitempty"`
	Status BackupStatus        `json:"status,omitempty"`
}

DirectoryBackup is the Schema for the directorybackups API

func (*DirectoryBackup) DeepCopy 

func (in *DirectoryBackup) DeepCopy() *DirectoryBackup

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

func (*DirectoryBackup) DeepCopyInto 

func (in *DirectoryBackup) DeepCopyInto(out *DirectoryBackup)

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

func (*DirectoryBackup) DeepCopyObject added in v0.1.0 

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

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

type DirectoryBackupList added in v0.1.0 

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

DirectoryBackupList contains a list of DirectoryBackup

func (*DirectoryBackupList) DeepCopy added in v0.1.0 

func (in *DirectoryBackupList) DeepCopy() *DirectoryBackupList

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

func (*DirectoryBackupList) DeepCopyInto added in v0.1.0 

func (in *DirectoryBackupList) DeepCopyInto(out *DirectoryBackupList)

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

func (*DirectoryBackupList) DeepCopyObject added in v0.1.0 

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

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

type DirectoryBackupSpec added in v0.1.0 

type DirectoryBackupSpec struct {
	// Common pod settings for the backup job
	PodTemplate DirectoryPodTemplate `json:"podTemplate"`

	// DirectoryPVCClaim is the PVC that contains the directory data.
	// +kubebuilder:validation:Required
	ClaimToBackup string `json:"claimToBackup"`
}

DirectoryBackupSpec defines the desired state of DirectoryBackup

func (*DirectoryBackupSpec) DeepCopy added in v0.1.0 

func (in *DirectoryBackupSpec) DeepCopy() *DirectoryBackupSpec

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

func (*DirectoryBackupSpec) DeepCopyInto added in v0.1.0 

func (in *DirectoryBackupSpec) DeepCopyInto(out *DirectoryBackupSpec)

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

type DirectoryKeystores 

type DirectoryKeystores struct {
	// The name of a secret containing the keystore
	// +kubebuilder:default:=ds
	SecretName string `json:"secretName,required"`
}

DirectoryKeystores provides a reference to the keystore secrets

func (*DirectoryKeystores) DeepCopy 

func (in *DirectoryKeystores) DeepCopy() *DirectoryKeystores

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

func (*DirectoryKeystores) DeepCopyInto 

func (in *DirectoryKeystores) DeepCopyInto(out *DirectoryKeystores)

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

type DirectoryPasswords 

type DirectoryPasswords struct {
	// The name of a secret
	SecretName string `json:"secretName"`
	// The key within the secret
	Key string `json:"key"`
	// Create a random secret if true. Otherwise assumes the secret already exists
	Create bool `json:"create,omitempty"`
}

DirectoryPasswords is a reference to account secrets that contain passwords for the directory. The operator can set the passwords for accounts such as the uid=admin, uid=monitor and service accounts such as uid=idm-admin,ou=admins

func (*DirectoryPasswords) DeepCopy 

func (in *DirectoryPasswords) DeepCopy() *DirectoryPasswords

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

func (*DirectoryPasswords) DeepCopyInto 

func (in *DirectoryPasswords) DeepCopyInto(out *DirectoryPasswords)

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

type DirectoryPodTemplate added in v0.2.0 

type DirectoryPodTemplate struct {
	// Docker Image for the directory server.
	Image string `json:"image,required"`

	// +kubebuilder:validation:Optional
	// +kubebuilder:validation:Enum=Never;IfNotPresent;Always
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`

	// +kubebuilder:validation:Optional
	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`

	// Kubernetes resources assigned to the pod
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
	// Certificates needed for directory operation.
	Certificates DirectorySecrets `json:"secrets"`
	// +kubebuilder:validation:Required
	VolumeClaimSpec corev1.PersistentVolumeClaimSpec `json:"volumeClaimSpec,required"`

	// +kubebuilder:validation:Optional
	// The name of a configmap to mount on /opt/opendj/scripts
	// Optional - if not provided no mount will be performed
	ScriptConfigMapName string `json:"scriptConfigMapName,omitempty"`

	InitEnvFrom []corev1.EnvFromSource `json:"initEnvFrom,omitempty"`
	Env         []corev1.EnvVar        `json:"env,omitempty"`
	EnvFrom     []corev1.EnvFromSource `json:"envFrom,omitempty"`

	// Name of the volumesnapshot class used in any snapshot operation
	// +kubebuilder:validation:Required
	VolumeSnapshotClassName string `json:"volumeSnapshotClassName,omitempty"`

	// The optional service account
	// +kubebuilder:default:=default
	ServiceAccountName string `json:"serviceAccountName,omitempty"`
}

DirectoryPodTemplate provides the common configuration for all three CRDs

func (*DirectoryPodTemplate) DeepCopy added in v0.2.0 

func (in *DirectoryPodTemplate) DeepCopy() *DirectoryPodTemplate

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

func (*DirectoryPodTemplate) DeepCopyInto added in v0.2.0 

func (in *DirectoryPodTemplate) DeepCopyInto(out *DirectoryPodTemplate)

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

type DirectoryProxy added in v0.0.6 

type DirectoryProxy struct {
	Enabled bool `json:"enabled,required"`
	// Docker Image for the directory server.
	Image string `json:"image,required"`
	// Replicas is the number of directory server proxy instances to create
	// +kubebuilder:validation:Maximum:=8
	// +kubebuilder:validation:Minimum:=0
	Replicas int32 `json:"replicas,required"`
	// PrimaryGroupID specifies the group of servers the ds proxy should recognize as primary
	// If no value is provided, all available directory servers will be considered to be primary
	PrimaryGroupID string                      `json:"primaryGroupId,omitempty"`
	Resources      corev1.ResourceRequirements `json:"resources,omitempty"`
}

DirectoryProxy defines the settings of the directory proxy

func (*DirectoryProxy) DeepCopy added in v0.0.6 

func (in *DirectoryProxy) DeepCopy() *DirectoryProxy

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

func (*DirectoryProxy) DeepCopyInto added in v0.0.6 

func (in *DirectoryProxy) DeepCopyInto(out *DirectoryProxy)

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

type DirectoryProxyStatus added in v0.0.6 

type DirectoryProxyStatus struct {
	Replicas      int32  `json:"replicas,omitempty"`
	ReadyReplicas int32  `json:"readyReplicas,omitempty"`
	ServerMessage string `json:"serverMessage,omitempty"`
}

DirectoryProxyStatus defines the observed state of DirectoryService Proxy

func (*DirectoryProxyStatus) DeepCopy added in v0.0.6 

func (in *DirectoryProxyStatus) DeepCopy() *DirectoryProxyStatus

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

func (*DirectoryProxyStatus) DeepCopyInto added in v0.0.6 

func (in *DirectoryProxyStatus) DeepCopyInto(out *DirectoryProxyStatus)

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

type DirectoryRestore 

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

	Spec   DirectoryRestoreSpec   `json:"spec,omitempty"`
	Status DirectoryRestoreStatus `json:"status,omitempty"`
}

DirectoryRestore is the Schema for the directoryrestores API

func (*DirectoryRestore) DeepCopy 

func (in *DirectoryRestore) DeepCopy() *DirectoryRestore

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

func (*DirectoryRestore) DeepCopyInto 

func (in *DirectoryRestore) DeepCopyInto(out *DirectoryRestore)

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

func (*DirectoryRestore) DeepCopyObject added in v0.1.0 

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

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

type DirectoryRestoreList added in v0.1.0 

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

DirectoryRestoreList contains a list of DirectoryRestore

func (*DirectoryRestoreList) DeepCopy added in v0.1.0 

func (in *DirectoryRestoreList) DeepCopy() *DirectoryRestoreList

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

func (*DirectoryRestoreList) DeepCopyInto added in v0.1.0 

func (in *DirectoryRestoreList) DeepCopyInto(out *DirectoryRestoreList)

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

func (*DirectoryRestoreList) DeepCopyObject added in v0.1.0 

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

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

type DirectoryRestoreSpec added in v0.1.0 

type DirectoryRestoreSpec struct {
	PodTemplate DirectoryPodTemplate `json:"podTemplate"`

	SourcePVCName string `json:"sourcePvcName,required"`
}

DirectoryRestoreSpec defines the desired state of DirectoryRestore

func (*DirectoryRestoreSpec) DeepCopy added in v0.1.0 

func (in *DirectoryRestoreSpec) DeepCopy() *DirectoryRestoreSpec

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

func (*DirectoryRestoreSpec) DeepCopyInto added in v0.1.0 

func (in *DirectoryRestoreSpec) DeepCopyInto(out *DirectoryRestoreSpec)

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

type DirectoryRestoreStatus added in v0.1.0 

type DirectoryRestoreStatus struct {

	// StartTimestamp records the time a restore job was started.
	// The server's time is used for StartTimestamps
	// +optional
	// +nullable
	StartTimestamp *metav1.Time `json:"startTimestamp,omitempty"`

	// CompletionTimestamp records the time a restore was completed.
	// Completion time is recorded even on failed backups.
	// Completion time is recorded before uploading the backup object.
	// The server's time is used for CompletionTimestamps
	// +optional
	// +nullable
	CompletionTimestamp *metav1.Time `json:"completionTimestamp,omitempty"`
}

DirectoryRestoreStatus defines the observed state of DirectoryRestore

func (*DirectoryRestoreStatus) DeepCopy added in v0.1.0 

func (in *DirectoryRestoreStatus) DeepCopy() *DirectoryRestoreStatus

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

func (*DirectoryRestoreStatus) DeepCopyInto added in v0.1.0 

func (in *DirectoryRestoreStatus) DeepCopyInto(out *DirectoryRestoreStatus)

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

type DirectorySecrets added in v0.2.2 

type DirectorySecrets struct {
	// +kubebuilder:default:=ds-master-keypair
	MasterSecretName string `json:"masterSecretName"`
	// +kubebuilder:default:=ds-ssl-keypair
	SSLSecretName string `json:"sslSecretName"`
	// +kubebuilder:default:="ds-ssl-keypair"
	TruststoreSecretName string `json:"truststoreSecretName"`
}

DirectorySecrets required for operation of the directory server

func (*DirectorySecrets) DeepCopy added in v0.2.2 

func (in *DirectorySecrets) DeepCopy() *DirectorySecrets

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

func (*DirectorySecrets) DeepCopyInto added in v0.2.2 

func (in *DirectorySecrets) DeepCopyInto(out *DirectorySecrets)

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

type DirectoryService 

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

	Spec   DirectoryServiceSpec   `json:"spec,omitempty"`
	Status DirectoryServiceStatus `json:"status,omitempty"`
}

DirectoryService is the Schema for the directoryservices API

func (*DirectoryService) DeepCopy 

func (in *DirectoryService) DeepCopy() *DirectoryService

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

func (*DirectoryService) DeepCopyInto 

func (in *DirectoryService) DeepCopyInto(out *DirectoryService)

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

func (*DirectoryService) DeepCopyObject 

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

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

func (*DirectoryService) Default 

func (r *DirectoryService) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*DirectoryService) SecretNameForDN 

func (ds *DirectoryService) SecretNameForDN(pathRef string) string

SecretNameForDN looks up the secret name for the given dn (example, uid=admin)

func (*DirectoryService) SetupWebhookWithManager 

func (r *DirectoryService) SetupWebhookWithManager(mgr ctrl.Manager) error

SetupWebhookWithManager registers the webhook with the manager

func (*DirectoryService) ValidateCreate 

func (r *DirectoryService) ValidateCreate() (admission.Warnings, error)

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*DirectoryService) ValidateDelete 

func (r *DirectoryService) ValidateDelete() (admission.Warnings, error)

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*DirectoryService) ValidateUpdate 

func (r *DirectoryService) ValidateUpdate(old runtime.Object) (admission.Warnings, error)

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type DirectoryServiceList 

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

DirectoryServiceList contains a list of DirectoryService

func (*DirectoryServiceList) DeepCopy 

func (in *DirectoryServiceList) DeepCopy() *DirectoryServiceList

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

func (*DirectoryServiceList) DeepCopyInto 

func (in *DirectoryServiceList) DeepCopyInto(out *DirectoryServiceList)

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

func (*DirectoryServiceList) DeepCopyObject 

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

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

type DirectoryServiceSpec 

type DirectoryServiceSpec struct {

	// +kubebuilder:validation:Optional
	Labels map[string]string `json:"labels,optional"`

	PodTemplate DirectoryPodTemplate `json:"podTemplate"`

	// Replicas is the number of directory server instances to create
	// +kubebuilder:validation:Maximum:=8
	// +kubebuilder:default:=1
	Replicas *int32 `json:"replicas,required"`

	// The account secrets. The key is the DN of the secret (example, uid=admin)
	Passwords map[string]DirectoryPasswords `json:"passwords"`

	// Snapshots
	Snapshots DirectorySnapshotSpec `json:"snapshots,omitempty"`
	// Proxy configurations
	Proxy DirectoryProxy `json:"proxy,omitempty"`
}

DirectoryServiceSpec defines the desired state of DirectoryService

func (*DirectoryServiceSpec) DeepCopy 

func (in *DirectoryServiceSpec) DeepCopy() *DirectoryServiceSpec

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

func (*DirectoryServiceSpec) DeepCopyInto 

func (in *DirectoryServiceSpec) DeepCopyInto(out *DirectoryServiceSpec)

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

type DirectoryServiceStatus 

type DirectoryServiceStatus struct {
	// +optional
	Active          []corev1.ObjectReference `json:"active,omitempty"`
	CurrentReplicas *int32                   `json:"currentReplicas,omitempty"`
	ServerMessage   string                   `json:"serverMessage,omitempty"`
	ProxyStatus     DirectoryProxyStatus     `json:"proxyStatus,omitempty"`
	SnapshotStatus  SnapshotStatus           `json:"snapshotStatus,omitempty"`
}

DirectoryServiceStatus defines the observed state of DirectoryService

func (*DirectoryServiceStatus) DeepCopy 

func (in *DirectoryServiceStatus) DeepCopy() *DirectoryServiceStatus

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

func (*DirectoryServiceStatus) DeepCopyInto 

func (in *DirectoryServiceStatus) DeepCopyInto(out *DirectoryServiceStatus)

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

type DirectorySnapshotSpec added in v0.0.7 

type DirectorySnapshotSpec struct {
	// +kubebuilder:default:=false
	Enabled bool `json:"enabled,required"`
	// +kubebuilder:default:=30
	PeriodMinutes int32 `json:"periodMinutes,required"`
	// +kubebuilder:default:=10
	SnapshotsRetained int32 `json:"snapshotsRetained,required"`
	// +kubebuilder:default:=0
	DirectoryInstance int32 `json:"directoryInstance,omitempty"`
}

func (*DirectorySnapshotSpec) DeepCopy added in v0.0.7 

func (in *DirectorySnapshotSpec) DeepCopy() *DirectorySnapshotSpec

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

func (*DirectorySnapshotSpec) DeepCopyInto added in v0.0.7 

func (in *DirectorySnapshotSpec) DeepCopyInto(out *DirectorySnapshotSpec)

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

type SnapshotStatus added in v0.0.7 

type SnapshotStatus struct {
	LastSnapshotTimeStamp int64 `json:"lastSnapshotTimeStamp"`
}

func (*SnapshotStatus) DeepCopy added in v0.0.7 

func (in *SnapshotStatus) DeepCopy() *SnapshotStatus

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

func (*SnapshotStatus) DeepCopyInto added in v0.0.7 

func (in *SnapshotStatus) DeepCopyInto(out *SnapshotStatus)

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

type TrustStore added in v0.0.10 

type TrustStore struct {
	// The name of a secret
	SecretName string `json:"secretName,required"`
	KeyName    string `json:"keyName,required"`
	// Create a random secret if true. Otherwise assumes the secret already exists
	// Not currently supported
	Create bool `json:"create,omitempty"`
}

TrustStore defines a CA key pair

func (*TrustStore) DeepCopy added in v0.0.10 

func (in *TrustStore) DeepCopy() *TrustStore

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

func (*TrustStore) DeepCopyInto added in v0.0.10 

func (in *TrustStore) DeepCopyInto(out *TrustStore)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.