v1

Documentation

Overview

Package v1 is the v1 version of the API.

Package v1 contains API Schema definitions for the disco v1 API group +kubebuilder:object:generate=true +groupName=disco.stable.sap.cc

Index

• Constants
• Variables
• type Record
  • func (in *Record) DeepCopy() *Record
  • func (in *Record) DeepCopyInto(out *Record)
  • func (in *Record) DeepCopyObject() runtime.Object
  • func (r *Record) Default()
  • func (r *Record) SetupWebhookWithManager(mgr ctrl.Manager) error
• type RecordCondition
  • func (in *RecordCondition) DeepCopy() *RecordCondition
  • func (in *RecordCondition) DeepCopyInto(out *RecordCondition)
• type RecordConditionType
• type RecordList
  • func (in *RecordList) DeepCopy() *RecordList
  • func (in *RecordList) DeepCopyInto(out *RecordList)
  • func (in *RecordList) DeepCopyObject() runtime.Object
• type RecordSpec
  • func (in *RecordSpec) DeepCopy() *RecordSpec
  • func (in *RecordSpec) DeepCopyInto(out *RecordSpec)
• type RecordStatus
  • func (in *RecordStatus) DeepCopy() *RecordStatus
  • func (in *RecordStatus) DeepCopyInto(out *RecordStatus)
• type RecordType

Constants

const (
	// RecordTypeA specifies an A record.
	RecordTypeA = "A"

	// RecordTypeCNAME specifies a CNAME record.
	RecordTypeCNAME = "CNAME"

	// RecordTypeSOA specifies a SOA record.
	RecordTypeSOA = "SOA"

	// RecordTypeNS specifies a SOA record.
	RecordTypeNS = "NS"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "disco.stable.sap.cc", 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 Record

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

	Spec   RecordSpec   `json:"spec,omitempty"`
	Status RecordStatus `json:"status,omitempty"`
}

Record is the Schema for the records API

func (*Record) DeepCopy

func (in *Record) DeepCopy() *Record

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

func (*Record) DeepCopyInto

func (in *Record) DeepCopyInto(out *Record)

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

func (*Record) DeepCopyObject

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

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

func (*Record) Default

func (r *Record) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*Record) SetupWebhookWithManager

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

type RecordCondition

type RecordCondition struct {
	// Type of the condition.
	Type RecordConditionType `json:"type"`

	// Status of the condition.
	Status metav1.ConditionStatus `json:"status"`

	// LastTransitionTime is the timestamp corresponding to the last status change of this condition.
	// +optional
	LastTransitionTime *metav1.Time `json:"lastTransitionTime,omitempty"`

	// Reason is a brief machine-readable explanation for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`

	// Message is a human-readable description of the details of the last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

func (*RecordCondition) DeepCopy

func (in *RecordCondition) DeepCopy() *RecordCondition

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

func (*RecordCondition) DeepCopyInto

func (in *RecordCondition) DeepCopyInto(out *RecordCondition)

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

type RecordConditionType

type RecordConditionType string

RecordConditionType represents a Record condition value.

const (
	// RecordConditionTypeReady indicates that a record is ready for use.
	RecordConditionTypeReady RecordConditionType = "Ready"
)

type RecordList

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

RecordList contains a list of Record

func (*RecordList) DeepCopy

func (in *RecordList) DeepCopy() *RecordList

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

func (*RecordList) DeepCopyInto

func (in *RecordList) DeepCopyInto(out *RecordList)

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

func (*RecordList) DeepCopyObject

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

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

type RecordSpec

type RecordSpec struct {
	// Type of the DNS record.
	Type RecordType `json:"type"`

	// List of hostnames.
	// +kubebuilder:validation:MinItems=1
	Hosts []string `json:"hosts"`

	// The record to use.
	// +kubebuilder:validation:MinLength=2
	Record string `json:"record"`

	// Optional DNS zone for the record.
	ZoneName string `json:"zoneName,omitempty"`

	// Optional description for the record.
	Description string `json:"description,omitempty"`
}

RecordSpec defines the desired state of Record

func (*RecordSpec) DeepCopy

func (in *RecordSpec) DeepCopy() *RecordSpec

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

func (*RecordSpec) DeepCopyInto

func (in *RecordSpec) DeepCopyInto(out *RecordSpec)

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

type RecordStatus

type RecordStatus struct {
	// List of status conditions to indicate the status of the record.
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []RecordCondition `json:"conditions,omitempty"`
}

RecordStatus defines the observed state of a Record.

func (*RecordStatus) DeepCopy

func (in *RecordStatus) DeepCopy() *RecordStatus

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

func (*RecordStatus) DeepCopyInto

func (in *RecordStatus) DeepCopyInto(out *RecordStatus)

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

type RecordType

type RecordType string

RecordType is the type of the DNS record. +kubebuilder:validation:Enum=A;CNAME;SOA;NS