Documentation
¶
Overview ¶
Package v1alpha1 contains the configuration of the Gardener Resource Manager. +groupName=resources.gardener.cloud
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type ConditionStatus
- type ConditionType
- type ManagedResource
- type ManagedResourceCondition
- type ManagedResourceList
- type ManagedResourceSpec
- type ManagedResourceStatus
- type ObjectReference
Constants ¶
const ( // Ignore is an annotation that dictates whether a resources should be ignored during // reconciliation. Ignore = "resources.gardener.cloud/ignore" // DeleteOnInvalidUpdate is a constant for an annotation on a resource managed by a ManagedResource. If set to // true then the controller will delete the object in case it faces an "Invalid" response during an update operation. DeleteOnInvalidUpdate = "resources.gardener.cloud/delete-on-invalid-update" // KeepObject is a constant for an annotation on a resource managed by a ManagedResource. If set to // true then the controller will not delete the object in case it is removed from the ManagedResource or the // ManagedResource itself is deleted. KeepObject = "resources.gardener.cloud/keep-object" )
const ( // ConditionApplySucceeded indicates that the `ResourcesApplied` condition is `True`, // because all resources have been applied successfully. ConditionApplySucceeded = "ApplySucceeded" // ConditionApplyFailed indicates that the `ResourcesApplied` condition is `False`, // because applying the resources failed. ConditionApplyFailed = "ApplyFailed" // ConditionDecodingFailed indicates that the `ResourcesApplied` condition is `False`, // because decoding the resources of the ManagedResource failed. ConditionDecodingFailed = "DecodingFailed" // ConditionApplyProgressing indicates that the `ResourcesApplied` condition is `Progressing`, // because the resources are currently being reconciled. ConditionApplyProgressing = "ApplyProgressing" // ConditionDeletionFailed indicates that the `ResourcesApplied` condition is `False`, // because deleting the resources failed. ConditionDeletionFailed = "DeletionFailed" // ConditionDeletionPending indicates that the `ResourcesApplied` condition is `Progressing`, // because the deletion of some resources are still pending. ConditionDeletionPending = "DeletionPending" // ConditionHealthChecksPending indicates that the `ResourcesHealthy` condition is `Unknown`, // because the health checks have not been completely executed yet for the current set of resources. ConditionHealthChecksPending = "HealthChecksPending" )
These are well-known reasons for ManagedResourceConditions.
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: resources.GroupName, Version: "v1alpha1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type ConditionStatus ¶
type ConditionStatus string
ConditionStatus is the status of a condition.
const ( // ConditionTrue means a resource is in the condition. ConditionTrue ConditionStatus = "True" // ConditionFalse means a resource is not in the condition. ConditionFalse ConditionStatus = "False" // ConditionUnknown means that the controller can't decide if a resource is in the condition or not ConditionUnknown ConditionStatus = "Unknown" // ConditionProgressing means that the controller is currently acting on the resource and the condition is therefore progressing. ConditionProgressing ConditionStatus = "Progressing" )
These are valid condition statuses.
type ConditionType ¶
type ConditionType string
ConditionType is the type of a condition.
const ( // ResourcesApplied is a condition type that indicates whether all resources are applied to the target cluster. ResourcesApplied ConditionType = "ResourcesApplied" // ResourcesHealthy is a condition type that indicates whether all resources are present and healthy. ResourcesHealthy ConditionType = "ResourcesHealthy" )
type ManagedResource ¶
type ManagedResource struct { metav1.TypeMeta `json:",inline"` // Standard object metadata. metav1.ObjectMeta `json:"metadata,omitempty"` // Spec contains the specification of this managed resource. Spec ManagedResourceSpec `json:"spec,omitempty"` // Status contains the status of this managed resource. Status ManagedResourceStatus `json:"status,omitempty"` }
ManagedResource describes a list of managed resources.
func (*ManagedResource) DeepCopy ¶
func (in *ManagedResource) DeepCopy() *ManagedResource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedResource.
func (*ManagedResource) DeepCopyInto ¶
func (in *ManagedResource) DeepCopyInto(out *ManagedResource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ManagedResource) DeepCopyObject ¶
func (in *ManagedResource) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ManagedResourceCondition ¶
type ManagedResourceCondition struct { // Type of the ManagedResource condition. Type ConditionType `json:"type"` // Status of the ManagedResource condition. Status ConditionStatus `json:"status"` // Last time the condition was updated. LastUpdateTime metav1.Time `json:"lastUpdateTime"` // Last time the condition transitioned from one status to another. LastTransitionTime metav1.Time `json:"lastTransitionTime"` // The reason for the condition's last transition. Reason string `json:"reason"` // A human readable message indicating details about the transition. Message string `json:"message"` }
ManagedResourceCondition describes the state of a deployment at a certain period.
func (*ManagedResourceCondition) DeepCopy ¶
func (in *ManagedResourceCondition) DeepCopy() *ManagedResourceCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedResourceCondition.
func (*ManagedResourceCondition) DeepCopyInto ¶
func (in *ManagedResourceCondition) DeepCopyInto(out *ManagedResourceCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ManagedResourceList ¶
type ManagedResourceList struct { metav1.TypeMeta `json:",inline"` // +optional metav1.ListMeta `json:"metadata,omitempty"` // Items is the list of ManagedResource. Items []ManagedResource `json:"items"` }
ManagedResourceList is a list of ManagedResource resources.
func (*ManagedResourceList) DeepCopy ¶
func (in *ManagedResourceList) DeepCopy() *ManagedResourceList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedResourceList.
func (*ManagedResourceList) DeepCopyInto ¶
func (in *ManagedResourceList) DeepCopyInto(out *ManagedResourceList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ManagedResourceList) DeepCopyObject ¶
func (in *ManagedResourceList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ManagedResourceSpec ¶
type ManagedResourceSpec struct { // Class holds the resource class used to control the responsibility for multiple resource manager instances // +optional Class *string `json:"class,omitempty"` // SecretRefs is a list of secret references. SecretRefs []corev1.LocalObjectReference `json:"secretRefs"` // InjectLabels injects the provided labels into every resource that is part of the referenced secrets. // +optional InjectLabels map[string]string `json:"injectLabels,omitempty"` // ForceOverwriteLabels specifies that all existing labels should be overwritten. Defaults to false. // +optional ForceOverwriteLabels *bool `json:"forceOverwriteLabels,omitempty"` // ForceOverwriteAnnotations specifies that all existing annotations should be overwritten. Defaults to false. // +optional ForceOverwriteAnnotations *bool `json:"forceOverwriteAnnotations,omitempty"` // KeepObjects specifies whether the objects should be kept although the managed resource has already been deleted. // Defaults to false. // +optional KeepObjects *bool `json:"keepObjects,omitempty"` // Equivalences specifies possible group/kind equivalences for objects. // +optional Equivalences [][]metav1.GroupKind `json:"equivalences,omitempty"` // DeletePersistentVolumeClaims specifies if PersistentVolumeClaims created by StatefulSets, which are managed by this // resource, should also be deleted when the corresponding StatefulSet is deleted (defaults to false). // +optional DeletePersistentVolumeClaims *bool `json:"deletePersistentVolumeClaims,omitempty"` }
func (*ManagedResourceSpec) DeepCopy ¶
func (in *ManagedResourceSpec) DeepCopy() *ManagedResourceSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedResourceSpec.
func (*ManagedResourceSpec) DeepCopyInto ¶
func (in *ManagedResourceSpec) DeepCopyInto(out *ManagedResourceSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ManagedResourceStatus ¶
type ManagedResourceStatus struct { Conditions []ManagedResourceCondition `json:"conditions,omitempty"` // ObservedGeneration is the most recent generation observed for this resource. ObservedGeneration int64 `json:"observedGeneration,omitempty"` // Resources is a list of objects that have been created. // +optional Resources []ObjectReference `json:"resources,omitempty"` }
ManagedResourceStatus is the status of a managed resource.
func (*ManagedResourceStatus) DeepCopy ¶
func (in *ManagedResourceStatus) DeepCopy() *ManagedResourceStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedResourceStatus.
func (*ManagedResourceStatus) DeepCopyInto ¶
func (in *ManagedResourceStatus) DeepCopyInto(out *ManagedResourceStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ObjectReference ¶
type ObjectReference struct { corev1.ObjectReference `json:",inline"` // Labels is a map of labels that were used during last update of the resource. Labels map[string]string `json:"labels,omitempty"` // Annotations is a map of annotations that were used during last update of the resource. Annotations map[string]string `json:"annotations,omitempty"` }
func (*ObjectReference) DeepCopy ¶
func (in *ObjectReference) DeepCopy() *ObjectReference
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectReference.
func (*ObjectReference) DeepCopyInto ¶
func (in *ObjectReference) DeepCopyInto(out *ObjectReference)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.