v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the CockroachDB v1alpha1 API group +kubebuilder:object:generate=true +groupName=metalmatze.de

Index

• Variables
• type CockroachDB
  • func (in *CockroachDB) DeepCopy() *CockroachDB
  • func (in *CockroachDB) DeepCopyInto(out *CockroachDB)
  • func (in *CockroachDB) DeepCopyObject() runtime.Object
• type CockroachDBList
  • func (in *CockroachDBList) DeepCopy() *CockroachDBList
  • func (in *CockroachDBList) DeepCopyInto(out *CockroachDBList)
  • func (in *CockroachDBList) DeepCopyObject() runtime.Object
• type CockroachDBSpec
  • func (in *CockroachDBSpec) DeepCopy() *CockroachDBSpec
  • func (in *CockroachDBSpec) DeepCopyInto(out *CockroachDBSpec)
• type CockroachDBStatus
  • func (in *CockroachDBStatus) DeepCopy() *CockroachDBStatus
  • func (in *CockroachDBStatus) DeepCopyInto(out *CockroachDBStatus)
• type EmbeddedObjectMetadata
  • func (in *EmbeddedObjectMetadata) DeepCopy() *EmbeddedObjectMetadata
  • func (in *EmbeddedObjectMetadata) DeepCopyInto(out *EmbeddedObjectMetadata)
• type EmbeddedPersistentVolumeClaim
  • func (in *EmbeddedPersistentVolumeClaim) DeepCopy() *EmbeddedPersistentVolumeClaim
  • func (in *EmbeddedPersistentVolumeClaim) DeepCopyInto(out *EmbeddedPersistentVolumeClaim)
• type StorageSpec
  • func (in *StorageSpec) DeepCopy() *StorageSpec
  • func (in *StorageSpec) DeepCopyInto(out *StorageSpec)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "metalmatze.de", 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 CockroachDB

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

	Spec   CockroachDBSpec    `json:"spec,omitempty"`
	Status *CockroachDBStatus `json:"status,omitempty"`
}

CockroachDB is the Schema for the a CockroachDB instance managed by the Operator. +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas,selectorpath=.status.selector +kubebuilder:printcolumn:name="Replicas",type="integer",JSONPath=".spec.replicas" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"

func (*CockroachDB) DeepCopy

func (in *CockroachDB) DeepCopy() *CockroachDB

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

func (*CockroachDB) DeepCopyInto

func (in *CockroachDB) DeepCopyInto(out *CockroachDB)

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

func (*CockroachDB) DeepCopyObject

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

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

type CockroachDBList

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

CockroachDBList contains a list of CockroachDB +kubebuilder:object:root=true

func (*CockroachDBList) DeepCopy

func (in *CockroachDBList) DeepCopy() *CockroachDBList

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

func (*CockroachDBList) DeepCopyInto

func (in *CockroachDBList) DeepCopyInto(out *CockroachDBList)

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

func (*CockroachDBList) DeepCopyObject

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

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

type CockroachDBSpec

type CockroachDBSpec struct {
	Image *string `json:"image"`

	// Define the number of replicas to run for the CockroachDB cluster.
	Replicas *uint32 `json:"replicas,omitempty"`

	// Define resources requests and limits for single Pods.
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`

	// Storage spec to specify how storage shall be used.
	Storage *StorageSpec `json:"storage,omitempty"`
}

CockroachDBSpec defines the desired state of a CockroachDB instance.

func (*CockroachDBSpec) DeepCopy

func (in *CockroachDBSpec) DeepCopy() *CockroachDBSpec

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

func (*CockroachDBSpec) DeepCopyInto

func (in *CockroachDBSpec) DeepCopyInto(out *CockroachDBSpec)

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

type CockroachDBStatus

type CockroachDBStatus struct{}

func (*CockroachDBStatus) DeepCopy

func (in *CockroachDBStatus) DeepCopy() *CockroachDBStatus

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

func (*CockroachDBStatus) DeepCopyInto

func (in *CockroachDBStatus) DeepCopyInto(out *CockroachDBStatus)

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

type EmbeddedObjectMetadata

type EmbeddedObjectMetadata struct {
	// Name must be unique within a namespace. Is required when creating resources, although
	// some resources may allow a client to request the generation of an appropriate name
	// automatically. Name is primarily intended for creation idempotence and configuration
	// definition.
	// Cannot be updated.
	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
	// +optional
	Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`

	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects. May match selectors of replication controllers
	// and services.
	// More info: http://kubernetes.io/docs/user-guide/labels
	// +optional
	Labels map[string]string `json:"labels,omitempty" protobuf:"bytes,11,rep,name=labels"`

	// Annotations is an unstructured key value map stored with a resource that may be
	// set by external tools to store and retrieve arbitrary metadata. They are not
	// queryable and should be preserved when modifying objects.
	// More info: http://kubernetes.io/docs/user-guide/annotations
	// +optional
	Annotations map[string]string `json:"annotations,omitempty" protobuf:"bytes,12,rep,name=annotations"`
}

EmbeddedObjectMetadata contains a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta Only fields which are relevant to embedded resources are included.

func (*EmbeddedObjectMetadata) DeepCopy

func (in *EmbeddedObjectMetadata) DeepCopy() *EmbeddedObjectMetadata

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

func (*EmbeddedObjectMetadata) DeepCopyInto

func (in *EmbeddedObjectMetadata) DeepCopyInto(out *EmbeddedObjectMetadata)

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

type EmbeddedPersistentVolumeClaim

type EmbeddedPersistentVolumeClaim struct {
	metav1.TypeMeta `json:",inline"`

	// EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
	EmbeddedObjectMetadata `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Spec defines the desired characteristics of a volume requested by a pod author.
	// More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
	// +optional
	Spec corev1.PersistentVolumeClaimSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`

	// Status represents the current information/status of a persistent volume claim.
	// Read-only.
	// More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
	// +optional
	Status corev1.PersistentVolumeClaimStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

EmbeddedPersistentVolumeClaim is an embedded version of k8s.io/api/core/v1.PersistentVolumeClaim. It contains TypeMeta and a reduced ObjectMeta.

func (*EmbeddedPersistentVolumeClaim) DeepCopy

func (in *EmbeddedPersistentVolumeClaim) DeepCopy() *EmbeddedPersistentVolumeClaim

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

func (*EmbeddedPersistentVolumeClaim) DeepCopyInto

func (in *EmbeddedPersistentVolumeClaim) DeepCopyInto(out *EmbeddedPersistentVolumeClaim)

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

type StorageSpec

type StorageSpec struct {
	// EmptyDirVolumeSource to be used by the CockroachDB StatefulSets. If specified, used in place of any volumeClaimTemplate. More
	// info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
	EmptyDir *corev1.EmptyDirVolumeSource `json:"emptyDir,omitempty"`
	// A PVC spec to be used by the CockroachDB StatefulSets.
	VolumeClaimTemplate EmbeddedPersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
}

StorageSpec defines the configured storage for a group CockroachDB clusters. If neither `emptyDir` nor `volumeClaimTemplate` is specified, then by default an [EmptyDir](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) will be used. +k8s:openapi-gen=true

func (*StorageSpec) DeepCopy

func (in *StorageSpec) DeepCopy() *StorageSpec

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

func (*StorageSpec) DeepCopyInto

func (in *StorageSpec) DeepCopyInto(out *StorageSpec)

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