v1

Documentation

Overview

Package v1 contains API Schema definitions for the k8s v1 API group +kubebuilder:object:generate=true +groupName=k8s.cloudogu.com

Index

• Constants
• Variables
• type Dogu
  • func (in *Dogu) DeepCopy() *Dogu
  • func (in *Dogu) DeepCopyInto(out *Dogu)
  • func (in *Dogu) DeepCopyObject() runtime.Object
  • func (d Dogu) GetDataVolumeName() string
  • func (d Dogu) GetDescriptorObjectKey() client.ObjectKey
  • func (d Dogu) GetObjectKey() *client.ObjectKey
  • func (d Dogu) GetObjectMeta() *metav1.ObjectMeta
  • func (d Dogu) GetPrivateVolumeName() string
  • func (d Dogu) GetSecretObjectKey() client.ObjectKey
  • func (d *Dogu) Update(ctx context.Context, client client.Client) error
• type DoguList
  • func (in *DoguList) DeepCopy() *DoguList
  • func (in *DoguList) DeepCopyInto(out *DoguList)
  • func (in *DoguList) DeepCopyObject() runtime.Object
• type DoguSpec
  • func (in *DoguSpec) DeepCopy() *DoguSpec
  • func (in *DoguSpec) DeepCopyInto(out *DoguSpec)
• type DoguStatus
  • func (ds *DoguStatus) AddMessage(message string)
  • func (ds *DoguStatus) ClearMessages()
  • func (in *DoguStatus) DeepCopy() *DoguStatus
  • func (in *DoguStatus) DeepCopyInto(out *DoguStatus)
  • func (ds *DoguStatus) NextRequeue() time.Duration
  • func (ds *DoguStatus) ResetRequeueTime()

Constants

const (
	// RequeueTimeMultiplerForEachRequeue defines the factor to multiple the requeue time of a failed dogu crd operation
	RequeueTimeMultiplerForEachRequeue = 2
	// RequeueTimeInitialRequeueTime defines the initial value of the requeue time
	RequeueTimeInitialRequeueTime = time.Second * 5
	// RequeueTimeMaxRequeueTime defines the maximum amount of time to wait for a requeue of a dogu resource
	RequeueTimeMaxRequeueTime = time.Hour * 6
)

const (
	DoguStatusNotInstalled = ""
	DoguStatusInstalling   = "installing"
	DoguStatusDeleting     = "deleting"
	DoguStatusInstalled    = "installed"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "k8s.cloudogu.com", Version: "v1"}

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

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

	Spec   DoguSpec   `json:"spec,omitempty"`
	Status DoguStatus `json:"status,omitempty"`
}

Dogu is the Schema for the dogus API

func (*Dogu) DeepCopy

func (in *Dogu) DeepCopy() *Dogu

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

func (*Dogu) DeepCopyInto

func (in *Dogu) DeepCopyInto(out *Dogu)

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

func (*Dogu) DeepCopyObject

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

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

func (Dogu) GetDataVolumeName

func (d Dogu) GetDataVolumeName() string

GetDataVolumeName returns the data volume name for the dogu resource

func (Dogu) GetDescriptorObjectKey

func (d Dogu) GetDescriptorObjectKey() client.ObjectKey

GetDescriptorObjectKey returns the object key for the custom dogu descriptor with the actual name and namespace from the dogu resource

func (Dogu) GetObjectKey

func (d Dogu) GetObjectKey() *client.ObjectKey

GetObjectKey returns the object key with the actual name and namespace from the dogu resource

func (Dogu) GetObjectMeta

func (d Dogu) GetObjectMeta() *metav1.ObjectMeta

GetObjectMeta return the object meta with the actual name and namespace from the dogu resource

func (Dogu) GetPrivateVolumeName

func (d Dogu) GetPrivateVolumeName() string

GetPrivateVolumeName returns the private volume name for the dogu resource

func (Dogu) GetSecretObjectKey

func (d Dogu) GetSecretObjectKey() client.ObjectKey

GetSecretObjectKey returns the object key for the config map containing values that should be encrypted for the dogu

func (*Dogu) Update

func (d *Dogu) Update(ctx context.Context, client client.Client) error

Update removes all messages from the message log

type DoguList

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

DoguList contains a list of Dogu

func (*DoguList) DeepCopy

func (in *DoguList) DeepCopy() *DoguList

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

func (*DoguList) DeepCopyInto

func (in *DoguList) DeepCopyInto(out *DoguList)

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

func (*DoguList) DeepCopyObject

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

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

type DoguSpec

type DoguSpec struct {
	// Name of the dogu (e.g. official/ldap)
	Name string `json:"name,omitempty"`
	// Version of the dogu (e.g. 2.4.48-3)
	Version string `json:"version,omitempty"`
}

DoguSpec defines the desired state of a Dogu

func (*DoguSpec) DeepCopy

func (in *DoguSpec) DeepCopy() *DoguSpec

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

func (*DoguSpec) DeepCopyInto

func (in *DoguSpec) DeepCopyInto(out *DoguSpec)

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

type DoguStatus

type DoguStatus struct {
	// Status represents the state of the Dogu in the ecosystem
	Status string `json:"status"`
	// StatusMessages contains a list of status messages
	StatusMessages []string `json:"statusMessages"`
	// RequeueTime contains time necessary to perform the next requeue
	RequeueTime time.Duration `json:"requeueTime"`
}

DoguStatus defines the observed state of a Dogu

func (*DoguStatus) AddMessage

func (ds *DoguStatus) AddMessage(message string)

AddMessage adds a new entry to the message slice

func (*DoguStatus) ClearMessages

func (ds *DoguStatus) ClearMessages()

ClearMessages removes all messages from the message log

func (*DoguStatus) DeepCopy

func (in *DoguStatus) DeepCopy() *DoguStatus

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

func (*DoguStatus) DeepCopyInto

func (in *DoguStatus) DeepCopyInto(out *DoguStatus)

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

func (*DoguStatus) NextRequeue

func (ds *DoguStatus) NextRequeue() time.Duration

NextRequeue increases the requeue time of the dogu status and returns the new requeue time

func (*DoguStatus) ResetRequeueTime

func (ds *DoguStatus) ResetRequeueTime()

ResetRequeueTime resets the requeue timer to the initial value