v1beta1

package
v0.0.0-...-17071f4 Latest Latest
Warning

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

Go to latest
Published: Feb 23, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v1beta1 contains API Schema definitions for the couchbase v1beta1 API group +kubebuilder:object:generate=true +groupName=couchbase.btburnett.com

Index

Constants

This section is empty.

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "couchbase.btburnett.com", Version: "v1beta1"}

	// 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 CouchbaseCluster

type CouchbaseCluster struct {
	// Connect via a CouchbaseCluster resource in Kubernetes
	ClusterRef *CouchbaseClusterRef `json:"clusterRef,omitempty"`
	// Connect via manual connection information
	Manual *CouchbaseClusterManual `json:"manual,omitempty"`
}

+kubebuilder:validation:MinProperties:=1 +kubebuilder:validation:MaxProperties:=1 Defines how to connect to a Couchbase cluster

func (*CouchbaseCluster) DeepCopy

func (in *CouchbaseCluster) DeepCopy() *CouchbaseCluster

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

func (*CouchbaseCluster) DeepCopyInto

func (in *CouchbaseCluster) DeepCopyInto(out *CouchbaseCluster)

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

type CouchbaseClusterManual

type CouchbaseClusterManual struct {
	//+kubebuilder:validation:Pattern:="^couchbases?:\\/\\/(([\\w\\d\\-\\_]+\\.)*[\\w\\d\\-\\_]+,)*([\\w\\d\\-\\_]+\\.)*[\\w\\d\\-\\_]+(:\\d+)?\\/?$"
	// Couchbase connection string, in "couchbase://" format
	ConnectionString string `json:"connectionString"`
	// Name of a secret containing a username and password
	SecretName string `json:"secretName"`
}

func (*CouchbaseClusterManual) DeepCopy

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

func (*CouchbaseClusterManual) DeepCopyInto

func (in *CouchbaseClusterManual) DeepCopyInto(out *CouchbaseClusterManual)

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

type CouchbaseClusterRef

type CouchbaseClusterRef struct {
	// Name of the CouchbaseCluster resource in Kubernetes. This resource must be in the same namespace.
	Name string `json:"name"`
	// Optional name of a secret containing a username and password. If not present, uses the AdminSecretName found on the CouchbaseCluster resource.
	SecretName *string `json:"secretName,omitempty"`
}

func (*CouchbaseClusterRef) DeepCopy

func (in *CouchbaseClusterRef) DeepCopy() *CouchbaseClusterRef

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

func (*CouchbaseClusterRef) DeepCopyInto

func (in *CouchbaseClusterRef) DeepCopyInto(out *CouchbaseClusterRef)

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

type CouchbaseIndexSet

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

	Spec   CouchbaseIndexSetSpec   `json:"spec,omitempty"`
	Status CouchbaseIndexSetStatus `json:"status,omitempty"`
}

+kubebuilder:printcolumn:name="Bucket",type=string,JSONPath=`.spec.bucketName` +kubebuilder:printcolumn:name="Indices",type=integer,JSONPath=`.status.indexCount` +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.conditions[?(@.type=="Ready")].status` +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp` Defines a set of Couchbase indices

func (*CouchbaseIndexSet) DeepCopy

func (in *CouchbaseIndexSet) DeepCopy() *CouchbaseIndexSet

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

func (*CouchbaseIndexSet) DeepCopyInto

func (in *CouchbaseIndexSet) DeepCopyInto(out *CouchbaseIndexSet)

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

func (*CouchbaseIndexSet) DeepCopyObject

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

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

type CouchbaseIndexSetList

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

CouchbaseIndexSetList contains a list of CouchbaseIndexSet

func (*CouchbaseIndexSetList) DeepCopy

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

func (*CouchbaseIndexSetList) DeepCopyInto

func (in *CouchbaseIndexSetList) DeepCopyInto(out *CouchbaseIndexSetList)

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

func (*CouchbaseIndexSetList) DeepCopyObject

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

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

type CouchbaseIndexSetSpec

type CouchbaseIndexSetSpec struct {

	// Defines how to connect to a Couchbase cluster
	Cluster CouchbaseCluster `json:"cluster"`
	// Name of the bucket
	BucketName string `json:"bucketName"`
	//+listType:=map
	//+listMapKey:=name
	// List of global secondary indices
	Indices []GlobalSecondaryIndex `json:"indices,omitempty"`
	//+kubebuilder:default:=600
	//+kubebuilder:validation:Optional
	//+kubebuilder:validation:Minimum:=1
	// Specifies the duration in seconds relative to the startTime that a sync attempt may be active before the system tries to terminate it; value must be positive integer
	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty"`
	//+kubebuilder:default:=2
	//+kubebuilder:validation:Optional
	//+kubebuilder:validation:Minimum:=0
	// Specifies the number of retries before marking a sync attempt as failed.
	BackoffLimit *int32 `json:"backoffLimit,omitempty"`
	//+kubebuilder:default=false
	//+kubebuilder:validation:Optional
	// Pauses index synchronization for this index set. Deleting the index set will still perform cleanup.
	Paused *bool `json:"paused"`
}

Defines the desired state of a set of Couchbase indices

func (*CouchbaseIndexSetSpec) DeepCopy

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

func (*CouchbaseIndexSetSpec) DeepCopyInto

func (in *CouchbaseIndexSetSpec) DeepCopyInto(out *CouchbaseIndexSetSpec)

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

type CouchbaseIndexSetStatus

type CouchbaseIndexSetStatus struct {

	//+listType:=map
	//+listMapKey:=type
	// Conditions represent the latest available observations of an object's state
	Conditions []metav1.Condition `json:"conditions"`
	// Name of the generated config map
	ConfigMapName string `json:"configMapName,omitempty"`
	//+listType:=atomic
	// List of global secondary indices created and managed by this resource
	Indices []string `json:"indices,omitempty"`
	// Number of indices
	IndexCount *int32 `json:"indexCount"`
}

Defines the observed state of CouchbaseIndexSet

func (*CouchbaseIndexSetStatus) DeepCopy

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

func (*CouchbaseIndexSetStatus) DeepCopyInto

func (in *CouchbaseIndexSetStatus) DeepCopyInto(out *CouchbaseIndexSetStatus)

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

type GlobalSecondaryIndex

type GlobalSecondaryIndex struct {

	//+kubebuilder:validation:MinLength:=1
	//+kubebuilder:validation:Pattern:=^[A-Za-z][A-Za-z0-9#_\-]*$
	// Name of the index
	Name string `json:"name"`
	//+kubebuilder:validation:MinLength:=1
	//+kubebuilder:validation:Pattern:="^_default$|^[A-Za-z0-9\\-][A-Za-z0-9_\\-%]*$"
	// Name of the index's scope, assumes "_default" if not present
	ScopeName *string `json:"scopeName,omitempty"`
	//+kubebuilder:validation:MinLength:=1
	//+kubebuilder:validation:Pattern:="^_default$|^[A-Za-z0-9\\-][A-Za-z0-9_\\-%]*$"
	// Name of the index's collection, assumes "_default" if not present
	CollectionName *string `json:"collectionName,omitempty"`
	//+kubebuilder:validation:MinItems:=1
	// List of properties or deterministic functions which make up the index key
	IndexKey []string `json:"indexKey"`
	// Conditions to filter documents included on the index
	Condition *string `json:"condition,omitempty"`
	//+kubebuilder:validation:Minimum:=0
	// Number of replicas
	NumReplicas *int `json:"numReplicas,omitempty"`
	// Enable for Sync Gateway indices to preserve deleted XAttrs
	RetainDeletedXAttr *bool `json:"retainDeletedXAttr,omitempty"`
	// Defines partition information for a partitioned index
	Partition *GlobalSecondaryIndexPartition `json:"partition,omitempty"`
}

Defines the desired state of a Couchbase Global Secondary Index

func (*GlobalSecondaryIndex) DeepCopy

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

func (*GlobalSecondaryIndex) DeepCopyInto

func (in *GlobalSecondaryIndex) DeepCopyInto(out *GlobalSecondaryIndex)

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

type GlobalSecondaryIndexPartition

type GlobalSecondaryIndexPartition struct {
	//+kubebuilder:validation:MinItems:=1
	// Attributes to be used to partition documents across nodes
	Expressions []string `json:"expressions"`
	//+kubebuilder:default:=Hash
	//+kubebuilder:validation:Enum:=Hash
	// Partition strategy to use, defaults to Hash (which is currently the only option)
	Strategy *string `json:"strategy,omitempty"`
	//+kubebuilder:validation:Minimum:=2
	NumPartitions *int `json:"numPartitions,omitempty"`
}

Defines partition information for a partitioned index

func (*GlobalSecondaryIndexPartition) DeepCopy

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

func (*GlobalSecondaryIndexPartition) DeepCopyInto

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL