v1alpha2

package
v0.0.0-...-c3d1141 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package v1alpha2 is the v1alpha2 version of the API. +groupName=aerospike.travelaudience.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: aerospike.GroupName, Version: "v1alpha2"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type AerospikeCluster 

type AerospikeCluster struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object metadata.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// The specification of the Aerospike cluster.
	Spec AerospikeClusterSpec `json:"spec"`
	// The status of the Aerospike cluster.
	Status AerospikeClusterStatus `json:"status"`
}

AerospikeCluster represents an Aerospike cluster.

type AerospikeClusterBackupSpec 

type AerospikeClusterBackupSpec struct {
	// The retention period (days) during which to keep backup data in cloud storage, suffixed with d.
	// Defaults to 0d, meaning the backup data will be kept forever.
	// +optional
	TTL *string `json:"ttl,omitempty"`
	// Specifies how the backup should be stored.
	Storage BackupStorageSpec `json:"storage"`
}

AerospikeClusterBackupSpec specifies how Aerospike namespace backups made by aerospike-operator before a version upgrade should be stored.

type AerospikeClusterList 

type AerospikeClusterList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	metav1.ListMeta `json:"metadata"`

	// The list of AerospikeCluster resources.
	Items []AerospikeCluster `json:"items"`
}

AerospikeClusterList represents a list of Aerospike clusters.

type AerospikeClusterSpec 

type AerospikeClusterSpec struct {
	// The number of nodes in the Aerospike cluster.
	NodeCount int32 `json:"nodeCount"`
	// The version of Aerospike to be deployed.
	Version string `json:"version"`
	// The specification of the Aerospike namespaces in the cluster.
	// Must have exactly one element.
	Namespaces []AerospikeNamespaceSpec `json:"namespaces"`
	// The specification of how Aerospike namespace backups made by aerospike-operator should be performed and stored.
	// It is only required to be present if one wants to perform version upgrades on the Aerospike cluster.
	// +optional
	BackupSpec *AerospikeClusterBackupSpec `json:"backupSpec,omitempty"`
	// Define resources requests and limits for Aerospike Server Container.
	Resources *corev1.ResourceRequirements `json:"resources,omitempty"`
	// Define which Nodes the Pods are scheduled on.
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
	// If specified, the pod's tolerations.
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
}

AerospikeClusterSpec specifies the desired state of an Aerospike cluster.

type AerospikeClusterStatus 

type AerospikeClusterStatus struct {
	// The desired state of the Aerospike cluster.
	AerospikeClusterSpec
	// Details about the current condition of the AerospikeCluster resource.
	// +k8s:openapi-gen=false
	Conditions []apiextensions.CustomResourceDefinitionCondition `json:"conditions"`
}

AerospikeClusterStatus represents the current state of an Aerospike cluster.

type AerospikeNamespaceBackup 

type AerospikeNamespaceBackup struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object metadata.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// The specification of the backup operation.
	Spec AerospikeNamespaceBackupSpec `json:"spec"`
	// The status of the backup operation.
	Status AerospikeNamespaceBackupStatus `json:"status"`
}

AerospikeNamespaceBackup represents a single backup operation targeting a single Aerospike namespace.

func (*AerospikeNamespaceBackup) GetConditions 

func (b *AerospikeNamespaceBackup) GetConditions() []apiextensions.CustomResourceDefinitionCondition

func (*AerospikeNamespaceBackup) GetFailedConditionType 

func (b *AerospikeNamespaceBackup) GetFailedConditionType() apiextensions.CustomResourceDefinitionConditionType

func (*AerospikeNamespaceBackup) GetFinishedConditionType 

func (b *AerospikeNamespaceBackup) GetFinishedConditionType() apiextensions.CustomResourceDefinitionConditionType

func (*AerospikeNamespaceBackup) GetKind 

func (b *AerospikeNamespaceBackup) GetKind() string

func (*AerospikeNamespaceBackup) GetName 

func (b *AerospikeNamespaceBackup) GetName() string

func (*AerospikeNamespaceBackup) GetNamespace 

func (b *AerospikeNamespaceBackup) GetNamespace() string

func (*AerospikeNamespaceBackup) GetObjectMeta 

func (b *AerospikeNamespaceBackup) GetObjectMeta() *metav1.ObjectMeta

func (*AerospikeNamespaceBackup) GetOperationType 

func (b *AerospikeNamespaceBackup) GetOperationType() common.OperationType

func (*AerospikeNamespaceBackup) GetStartedConditionType 

func (b *AerospikeNamespaceBackup) GetStartedConditionType() apiextensions.CustomResourceDefinitionConditionType

func (*AerospikeNamespaceBackup) GetStorage 

func (b *AerospikeNamespaceBackup) GetStorage() *BackupStorageSpec

func (*AerospikeNamespaceBackup) GetTarget 

func (b *AerospikeNamespaceBackup) GetTarget() *TargetNamespace

func (*AerospikeNamespaceBackup) SetConditions 

func (b *AerospikeNamespaceBackup) SetConditions(newConditions []apiextensions.CustomResourceDefinitionCondition)

func (*AerospikeNamespaceBackup) SetStorage 

func (b *AerospikeNamespaceBackup) SetStorage(storage *BackupStorageSpec)

func (*AerospikeNamespaceBackup) SyncStatusWithSpec 

func (b *AerospikeNamespaceBackup) SyncStatusWithSpec() bool

type AerospikeNamespaceBackupList 

type AerospikeNamespaceBackupList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	metav1.ListMeta `json:"metadata"`

	// The list of AerospikeNamespaceBackup resources.
	Items []AerospikeNamespaceBackup `json:"items"`
}

AerospikeNamespaceBackupList represents a list of AerospikeNamespaceBackup resources.

type AerospikeNamespaceBackupSpec 

type AerospikeNamespaceBackupSpec struct {
	// The specification of the Aerospike cluster and Aerospike namespace to backup.
	Target TargetNamespace `json:"target"`
	// The specification of how the backup will be stored.
	// +optional
	Storage *BackupStorageSpec `json:"storage,omitempty"`
	// The retention period (days) during which to keep backup data in cloud storage, suffixed with d.
	// Defaults to 0d, meaning the backup data will be kept forever.
	// +optional
	TTL *string `json:"ttl,omitempty"`
}

AerospikeNamespaceBackupSpec specifies the configuration for a backup operation.

type AerospikeNamespaceBackupStatus 

type AerospikeNamespaceBackupStatus struct {
	// The configuration for the backup operation.
	AerospikeNamespaceBackupSpec
	// Details about the current condition of the AerospikeNamespaceBackup resource.
	// +k8s:openapi-gen=false
	Conditions []apiextensions.CustomResourceDefinitionCondition `json="conditions"`
}

AerospikeNamespaceBackupStatus is the status for an AerospikeNamespaceBackup resource.

type AerospikeNamespaceRestore 

type AerospikeNamespaceRestore struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object metadata.
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// The specification of the restore operation.
	Spec AerospikeNamespaceRestoreSpec `json:"spec"`
	// The status of the restore operation.
	Status AerospikeNamespaceRestoreStatus `json:"status"`
}

AerospikeNamespaceRestore represents a single restore operation targeting a single Aerospike namespace.

func (*AerospikeNamespaceRestore) GetConditions 

func (r *AerospikeNamespaceRestore) GetConditions() []apiextensions.CustomResourceDefinitionCondition

func (*AerospikeNamespaceRestore) GetFailedConditionType 

func (b *AerospikeNamespaceRestore) GetFailedConditionType() apiextensions.CustomResourceDefinitionConditionType

func (*AerospikeNamespaceRestore) GetFinishedConditionType 

func (b *AerospikeNamespaceRestore) GetFinishedConditionType() apiextensions.CustomResourceDefinitionConditionType

func (*AerospikeNamespaceRestore) GetKind 

func (r *AerospikeNamespaceRestore) GetKind() string

func (*AerospikeNamespaceRestore) GetName 

func (r *AerospikeNamespaceRestore) GetName() string

func (*AerospikeNamespaceRestore) GetNamespace 

func (r *AerospikeNamespaceRestore) GetNamespace() string

func (*AerospikeNamespaceRestore) GetObjectMeta 

func (r *AerospikeNamespaceRestore) GetObjectMeta() *metav1.ObjectMeta

func (*AerospikeNamespaceRestore) GetOperationType 

func (r *AerospikeNamespaceRestore) GetOperationType() common.OperationType

func (*AerospikeNamespaceRestore) GetStartedConditionType 

func (b *AerospikeNamespaceRestore) GetStartedConditionType() apiextensions.CustomResourceDefinitionConditionType

func (*AerospikeNamespaceRestore) GetStorage 

func (r *AerospikeNamespaceRestore) GetStorage() *BackupStorageSpec

func (*AerospikeNamespaceRestore) GetTarget 

func (r *AerospikeNamespaceRestore) GetTarget() *TargetNamespace

func (*AerospikeNamespaceRestore) SetConditions 

func (r *AerospikeNamespaceRestore) SetConditions(newConditions []apiextensions.CustomResourceDefinitionCondition)

func (*AerospikeNamespaceRestore) SetStorage 

func (r *AerospikeNamespaceRestore) SetStorage(storage *BackupStorageSpec)

func (*AerospikeNamespaceRestore) SyncStatusWithSpec 

func (b *AerospikeNamespaceRestore) SyncStatusWithSpec() bool

type AerospikeNamespaceRestoreList 

type AerospikeNamespaceRestoreList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadaata.
	metav1.ListMeta `json:"metadata"`

	// The list of AerospikeNamespaceRestore resources.
	Items []AerospikeNamespaceRestore `json:"items"`
}

AerospikeNamespaceRestoreList is a list of AerospikeNamespaceRestore resources

type AerospikeNamespaceRestoreSpec 

type AerospikeNamespaceRestoreSpec struct {
	// The specification of the Aerospike cluster and namespace the backup will be restored to.
	Target TargetNamespace `json:"target"`
	// The specification of how the backup should be retrieved.
	// +optional
	Storage *BackupStorageSpec `json:"storage,omitempty"`
}

AerospikeNamespaceRestoreSpec specifies the configuration for a restore operation.

type AerospikeNamespaceRestoreStatus 

type AerospikeNamespaceRestoreStatus struct {
	// The configuration for the restore operation.
	AerospikeNamespaceRestoreSpec
	// Details about the current condition of the AerospikeNamespaceRestore resource.
	// +k8s:openapi-gen=false
	Conditions []apiextensions.CustomResourceDefinitionCondition `json="conditions"`
}

AerospikeNamespaceRestoreStatus is the status for an AerospikeNamespaceRestore resource

type AerospikeNamespaceSpec 

type AerospikeNamespaceSpec struct {
	// The name of the Aerospike namespace.
	Name string `json:"name"`
	// The number of replicas (including the master copy) for this Aerospike namespace.
	// If absent, the default value provided by Aerospike will be used.
	// +optional
	ReplicationFactor *int32 `json:"replicationFactor,omitempty"`
	// The amount of memory (gibibytes) to be used for index and data, suffixed with G.
	// If absent, the default value provided by Aerospike will be used.
	// +optional
	MemorySize *string `json:"memorySize,omitempty"`
	// Default record time-to-live (seconds) since it is created or last updated, suffixed with s.
	// When TTL is reached, the record is deleted automatically.
	// A TTL of 0s means the record never expires.
	// If absent, the default value provided by Aerospike will be used.
	// +optional
	DefaultTTL *string `json:"defaultTTL,omitempty"`
	// Specifies how data for the Aerospike namespace will be stored.
	Storage StorageSpec `json:"storage"`
}

AerospikeNamespaceSpec specifies the configuration for an Aerospike namespace.

type BackupRestoreObject 

type BackupRestoreObject interface {
	GetOperationType() common.OperationType
	GetKind() string
	GetName() string
	GetNamespace() string
	GetObjectMeta() *v1.ObjectMeta
	GetStorage() *BackupStorageSpec
	SetStorage(*BackupStorageSpec)
	GetTarget() *TargetNamespace
	GetConditions() []apiextensions.CustomResourceDefinitionCondition
	SetConditions([]apiextensions.CustomResourceDefinitionCondition)
	GetFailedConditionType() apiextensions.CustomResourceDefinitionConditionType
	GetFinishedConditionType() apiextensions.CustomResourceDefinitionConditionType
	GetStartedConditionType() apiextensions.CustomResourceDefinitionConditionType
	SyncStatusWithSpec() bool
}

type BackupStorageSpec 

type BackupStorageSpec struct {
	// The type of cloud storage to use for the backup (e.g., gcs).
	Type string `json:"type"`
	// The name of the bucket where the backup is stored.
	Bucket string `json:"bucket"`
	// The name of the secret containing credentials to access the bucket.
	Secret string `json:"secret"`
	// The namespace to which the secret containing the credentials belongs to.
	// +optional
	SecretNamespace *string `json:"secretNamespace,omitempty"`
	// The name of the file in which the credentials are stored.
	// +optional
	SecretKey *string `json:"secretKey,omitempty"`
}

BackupStorageSpec specifies the configuration for the storage of a backup.

func (*BackupStorageSpec) GetSecret 

func (b *BackupStorageSpec) GetSecret() string

func (*BackupStorageSpec) GetSecretKey 

func (b *BackupStorageSpec) GetSecretKey() string

func (*BackupStorageSpec) GetSecretNamespace 

func (b *BackupStorageSpec) GetSecretNamespace(fallbackNamespace string) string

type StorageSpec 

type StorageSpec struct {
	// The storage engine to be used for the namespace (file or device).
	Type string `json:"type"`
	// The size (gibibytes) of the persistent volume to use for storing data in this namespace, suffixed with G.
	Size string `json:"size"`
	// The name of the storage class to use to create persistent volumes.
	// +optional
	StorageClassName *string `json:"storageClassName,omitempty"`
	// The retention period (days) during which to keep PVCs for being
	// re-used after unmounted. Defaults to 0d, meaning the PVCs will be
	// kept forever.
	// +optional
	PersistentVolumeClaimTTL *string `json:"persistentVolumeClaimTTL,omitempty"`
	// Whether to always keep an in-memory copy of all data in this Aerospike
	// namespace.
	// +optional
	DataInMemory *bool `json:"dataInMemory,omitempty"`
}

StorageSpec specifies how data in a given Aerospike namespace will be stored.

type TargetNamespace 

type TargetNamespace struct {
	// The name of the Aerospike cluster against which the backup/restore operation will be performed.
	Cluster string `json:"cluster"`
	// The name of the Aerospike namespace to backup/restore.
	Namespace string `json:"namespace"`
}

TargetNamespace specifies the Aerospike cluster and namespace a single backup or restore operation will target.

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.