v1alpha1

package
v0.0.0-...-913fb0f Latest Latest
Warning

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

Go to latest
Published: Jun 1, 2022 License: GPL-3.0 Imports: 12 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the erinnerung v1alpha1 API group +kubebuilder:object:generate=true +groupName=erinnerung.thoth-station.ninja

Index

Constants

View Source
const (
	// CallbackPayloadSending means that the payload is in the process of being send.
	CallbackPayloadSending string = "Sending"
	// CallbackPayloadComplete means the payload has been successfully sent.
	CallbackPayloadComplete string = "Complete"
	// CallbackPayloadFailed means the payload has failed sending.
	CallbackPayloadFailed string = "Failed"
)

These are built-in conditions of a CallbackPayload.

View Source
const (
	PhaseFailed           string = "Failed"
	PhaseAwaitingPayloads string = "AwaitingPayloads"
	PhasePending          string = "Pending"
	PhaseOk               string = "Ready"
)
View Source
const (
	AssociatedPayloads   string = "AssociatedPayloads"
	NoAssociatedPayloads string = "NoAssociatedPayloads"
)

CallbackUrl Condition Types

View Source
const ErinnerungGroupName string = "erinnerung.thoth-station.ninja"

Variables

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

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

	Spec   CallbackPayloadSpec   `json:"spec,omitempty"`
	Status CallbackPayloadStatus `json:"status,omitempty"`
}

CallbackPayload is storing the actual Payload Data we want to send back to any Callback URL. The web services receiving the Payload are determined via metav1.LabelSelector `selector`.

func (*CallbackPayload) DeepCopy

func (in *CallbackPayload) DeepCopy() *CallbackPayload

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

func (*CallbackPayload) DeepCopyInto

func (in *CallbackPayload) DeepCopyInto(out *CallbackPayload)

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

func (*CallbackPayload) DeepCopyObject

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

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

func (*CallbackPayload) SetCondition

func (p *CallbackPayload) SetCondition(conditionType string, status metav1.ConditionStatus, reason, message string)

Set status condition helper

type CallbackPayloadCondition

type CallbackPayloadCondition struct {
	// Type of condition, Complete or Failed.
	Type string `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status corev1.ConditionStatus `json:"status"`
	// Last time the condition was checked.
	// +optional
	LastProbeTime metav1.Time `json:"lastProbeTime,omitempty"`
	// Last time the condition transit from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

CallbackPayloadCondition describes current state of a payload.

func (*CallbackPayloadCondition) DeepCopy

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

func (*CallbackPayloadCondition) DeepCopyInto

func (in *CallbackPayloadCondition) DeepCopyInto(out *CallbackPayloadCondition)

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

type CallbackPayloadList

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

CallbackPayloadList contains a list of CallbackPayload

func (*CallbackPayloadList) DeepCopy

func (in *CallbackPayloadList) DeepCopy() *CallbackPayloadList

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

func (*CallbackPayloadList) DeepCopyInto

func (in *CallbackPayloadList) DeepCopyInto(out *CallbackPayloadList)

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

func (*CallbackPayloadList) DeepCopyObject

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

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

type CallbackPayloadSpec

type CallbackPayloadSpec struct {
	Data     string               `json:"data"`
	Selector metav1.LabelSelector `json:"selector"`
}

CallbackPayloadSpec defines the desired state of CallbackPayload

func (*CallbackPayloadSpec) DeepCopy

func (in *CallbackPayloadSpec) DeepCopy() *CallbackPayloadSpec

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

func (*CallbackPayloadSpec) DeepCopyInto

func (in *CallbackPayloadSpec) DeepCopyInto(out *CallbackPayloadSpec)

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

type CallbackPayloadStatus

type CallbackPayloadStatus struct {
	// Conditions is the list of error conditions for this resource
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Conditions",xDescriptors={"urn:alm:descriptor:io.kubernetes.conditions"}
	//+optional
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

CallbackPayloadStatus defines the observed state of CallbackPayload

func (*CallbackPayloadStatus) DeepCopy

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

func (*CallbackPayloadStatus) DeepCopyInto

func (in *CallbackPayloadStatus) DeepCopyInto(out *CallbackPayloadStatus)

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

type CallbackUrl

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

	Spec   CallbackUrlSpec   `json:"spec,omitempty"`
	Status CallbackUrlStatus `json:"status,omitempty"`
}

CallbackUrl is a web service's URL to receive a Callback. The Callback Payload to be send to the web service is determined via the metav1.LabelSelector `selector`.

func (*CallbackUrl) AggregatePhase

func (u *CallbackUrl) AggregatePhase() string

Aggregate phase from conditions

func (*CallbackUrl) DeepCopy

func (in *CallbackUrl) DeepCopy() *CallbackUrl

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

func (*CallbackUrl) DeepCopyInto

func (in *CallbackUrl) DeepCopyInto(out *CallbackUrl)

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

func (*CallbackUrl) DeepCopyObject

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

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

func (*CallbackUrl) SetupWebhookWithManager

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

func (*CallbackUrl) ValidateCreate

func (r *CallbackUrl) ValidateCreate() error

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

func (*CallbackUrl) ValidateDelete

func (r *CallbackUrl) ValidateDelete() error

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

func (*CallbackUrl) ValidateUpdate

func (r *CallbackUrl) ValidateUpdate(old runtime.Object) error

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

type CallbackUrlList

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

CallbackUrlList contains a list of CallbackUrl

func (*CallbackUrlList) DeepCopy

func (in *CallbackUrlList) DeepCopy() *CallbackUrlList

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

func (*CallbackUrlList) DeepCopyInto

func (in *CallbackUrlList) DeepCopyInto(out *CallbackUrlList)

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

func (*CallbackUrlList) DeepCopyObject

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

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

type CallbackUrlSpec

type CallbackUrlSpec struct {
	// Url is the Url to call back.
	URL      string               `json:"url"`
	Selector metav1.LabelSelector `json:"selector"`
}

CallbackUrlSpec defines the desired state of CallbackUrl

func (*CallbackUrlSpec) DeepCopy

func (in *CallbackUrlSpec) DeepCopy() *CallbackUrlSpec

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

func (*CallbackUrlSpec) DeepCopyInto

func (in *CallbackUrlSpec) DeepCopyInto(out *CallbackUrlSpec)

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

type CallbackUrlStatus

type CallbackUrlStatus struct {
	// Status is and aggregated view of the Conditions
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Phase",xDescriptors={"urn:alm:descriptor:io.kubernetes.phase'"}
	//+optional
	Phase string `json:"phase,omitempty"`

	// Conditions is the list of error conditions for this resource
	//+operator-sdk:csv:customresourcedefinitions:type=status,displayName="Conditions",xDescriptors={"urn:alm:descriptor:io.kubernetes.conditions"}
	//+optional
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
}

CallbackUrlStatus defines the observed state of CallbackUrl

func (*CallbackUrlStatus) DeepCopy

func (in *CallbackUrlStatus) DeepCopy() *CallbackUrlStatus

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

func (*CallbackUrlStatus) DeepCopyInto

func (in *CallbackUrlStatus) DeepCopyInto(out *CallbackUrlStatus)

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

type ErinnerungConfig

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

	// ControllerManagerConfigurationSpec returns the contfigurations for controllers
	cfg.ControllerManagerConfigurationSpec `json:",inline"`

	// Namespaces is the list of Namespaces we want to operate in
	// TODO this might be an anti-pattern, if the operator is namespace-scoped, do we need to deploy it to each namespace we want to operate in?!
	Namespaces []string `json:"namespaces,omitempty"`
}

ErinnerungConfig is the Schema for the erinnerungenconfigs API

func (*ErinnerungConfig) DeepCopy

func (in *ErinnerungConfig) DeepCopy() *ErinnerungConfig

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

func (*ErinnerungConfig) DeepCopyInto

func (in *ErinnerungConfig) DeepCopyInto(out *ErinnerungConfig)

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

func (*ErinnerungConfig) DeepCopyObject

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

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

Jump to

Keyboard shortcuts

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