Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the template v1alpha1 API group +kubebuilder:object:generate=true +groupName=template.onmetal.de
Index ¶
Constants ¶
const DefaultConfigMapTemplateKey = "template.yaml"
DefaultConfigMapTemplateKey is the default key of the template definition in a config map.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "template.onmetal.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 )
Functions ¶
This section is empty.
Types ¶
type ConfigMapKeySelector ¶
type ConfigMapKeySelector struct {
// The name of the ConfigMap resource being referred to.
corev1.LocalObjectReference `json:",inline"`
// The key of the entry in the ConfigMap resource's `data` field to be used.
// Some instances of this field may be defaulted, in others it may be
// required.
// +optional
Key string `json:"key,omitempty"`
}
ConfigMapKeySelector is a reference to a specific 'key' within a ConfigMap resource. In some instances, `key` is a required field.
func (*ConfigMapKeySelector) DeepCopy ¶
func (in *ConfigMapKeySelector) DeepCopy() *ConfigMapKeySelector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigMapKeySelector.
func (*ConfigMapKeySelector) DeepCopyInto ¶
func (in *ConfigMapKeySelector) DeepCopyInto(out *ConfigMapKeySelector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LocalObjectReference ¶
type LocalObjectReference struct {
// APIVersion is the api version of the target object to use.
APIVersion string `json:"apiVersion"`
// Kind is the kind of the target object.
Kind string `json:"kind"`
// Name is the name of the target object.
Name string `json:"name"`
}
LocalObjectReference references an object in a specific api version.
func (*LocalObjectReference) DeepCopy ¶
func (in *LocalObjectReference) DeepCopy() *LocalObjectReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalObjectReference.
func (*LocalObjectReference) DeepCopyInto ¶
func (in *LocalObjectReference) DeepCopyInto(out *LocalObjectReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Template ¶
type Template struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TemplateSpec `json:"spec,omitempty"`
Status TemplateStatus `json:"status,omitempty"`
}
Template is the Schema for the templates API
func (*Template) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Template.
func (*Template) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Template) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TemplateCondition ¶
type TemplateCondition struct {
// Type is the TemplateConditionType of this condition.
Type TemplateConditionType `json:"type"`
// Status reports the status of the condition.
Status corev1.ConditionStatus `json:"status"`
// Reason is a machine- and human-readable short explanation of the condition.
Reason string `json:"reason"`
// Message is a human-readable detailed explanation of the condition reason.
Message string `json:"message"`
// LastUpdateTime is the last time a condition has been updated.
LastUpdateTime metav1.Time `json:"lastUpdateTime"`
// LastTransitionTime is the last time a condition transitioned between two statuses.
LastTransitionTime metav1.Time `json:"lastTransitionTime"`
// ObservedGeneration is the observed generation for which a condition is reported.
ObservedGeneration int64 `json:"observedGeneration"`
}
TemplateCondition is a status information of an aspect of a Template.
func (*TemplateCondition) DeepCopy ¶
func (in *TemplateCondition) DeepCopy() *TemplateCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateCondition.
func (*TemplateCondition) DeepCopyInto ¶
func (in *TemplateCondition) DeepCopyInto(out *TemplateCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TemplateConditionType ¶
type TemplateConditionType string
TemplateConditionType is a type of a TemplateCondition.
const ( // TemplateApplied indicates whether a template could be successfully applied. TemplateApplied TemplateConditionType = "Applied" )
type TemplateData ¶
type TemplateData struct {
// Inline is an inline template definition.
Inline string `json:"inline,omitempty"`
// ConfigMapRef is the reference to a config map containing the template.
// If key is not specified, it defaults to DefaultConfigMapTemplateKey.
ConfigMapRef *ConfigMapKeySelector `json:"configMapRef,omitempty"`
}
TemplateData contains where the template definition should be drawn from.
func (*TemplateData) DeepCopy ¶
func (in *TemplateData) DeepCopy() *TemplateData
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateData.
func (*TemplateData) DeepCopyInto ¶
func (in *TemplateData) DeepCopyInto(out *TemplateData)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TemplateList ¶
type TemplateList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Template `json:"items"`
}
TemplateList contains a list of Template
func (*TemplateList) DeepCopy ¶
func (in *TemplateList) DeepCopy() *TemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateList.
func (*TemplateList) DeepCopyInto ¶
func (in *TemplateList) DeepCopyInto(out *TemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TemplateList) DeepCopyObject ¶
func (in *TemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TemplateSource ¶
type TemplateSource struct {
// Name is the name the source shall be registered with in the values.
Name string `json:"name"`
// ObjectReference is a reference to an object to serve as source.
Object *LocalObjectReference `json:"object,omitempty"`
// Value is a literal yaml value to use as source.
// +optional
Value *apiextensionsv1.JSON `json:"value,omitempty"`
}
TemplateSource is a source for the values of a template.
func (*TemplateSource) DeepCopy ¶
func (in *TemplateSource) DeepCopy() *TemplateSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateSource.
func (*TemplateSource) DeepCopyInto ¶
func (in *TemplateSource) DeepCopyInto(out *TemplateSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TemplateSpec ¶
type TemplateSpec struct {
// CommonLabels are common labels that should be applied for all resulting resources of this template.
CommonLabels map[string]string `json:"commonLabels,omitempty"`
// GroupKinds are metav1.GroupKinds that are produced by this template.
GroupKinds []metav1.GroupKind `json:"groupKinds,omitempty"`
// Selector is a metav1.LabelSelector to select resources produced by this template.
Selector *metav1.LabelSelector `json:"selector,omitempty"`
// Sources is a list of TemplateSource to draw template values from
Sources []TemplateSource `json:"sources,omitempty"`
// TemplateData holds the definition of the template.
Data TemplateData `json:"data"`
// Prune indicates whether to prune unused resources of a template.
Prune bool `json:"prune,omitempty"`
}
TemplateSpec defines the desired state of Template
func (*TemplateSpec) DeepCopy ¶
func (in *TemplateSpec) DeepCopy() *TemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateSpec.
func (*TemplateSpec) DeepCopyInto ¶
func (in *TemplateSpec) DeepCopyInto(out *TemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TemplateStatus ¶
type TemplateStatus struct {
// Conditions is a list of TemplateCondition referring to individual state
// information of a Template.
Conditions []TemplateCondition `json:"conditions,omitempty"`
// ManagedResources are resources that are managed by this template.
ManagedResources []LocalObjectReference `json:"managedResources,omitempty"`
}
TemplateStatus defines the observed state of Template
func (*TemplateStatus) DeepCopy ¶
func (in *TemplateStatus) DeepCopy() *TemplateStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateStatus.
func (*TemplateStatus) DeepCopyInto ¶
func (in *TemplateStatus) DeepCopyInto(out *TemplateStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.