Documentation
¶
Overview ¶
Package actuation contains API Schema definitions for the cli-utils.kubernetes.io API group. +k8s:deepcopy-gen=package +groupName=cli-utils.kubernetes.io
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActuationStatus ¶
type ActuationStatus int
const ( ActuationPending ActuationStatus = iota // Pending ActuationSucceeded // Succeeded ActuationSkipped // Skipped ActuationFailed // Failed )
func (ActuationStatus) String ¶
func (i ActuationStatus) String() string
type ActuationStrategy ¶
type ActuationStrategy int
const ( ActuationStrategyApply ActuationStrategy = iota // Apply ActuationStrategyDelete // Delete )
func (ActuationStrategy) String ¶
func (i ActuationStrategy) String() string
type Inventory ¶
type Inventory struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec InventorySpec `json:"spec,omitempty"`
Status InventoryStatus `json:"status,omitempty"`
}
Inventory represents the inventory object in memory. Inventory is currently only used for in-memory storage and not serialized to disk or to the API server.
func (*Inventory) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Inventory.
func (*Inventory) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InventorySpec ¶
type InventorySpec struct {
Objects []ObjectReference `json:"objects,omitempty"`
}
InventorySpec is the specification of the desired/expected inventory state.
func (*InventorySpec) DeepCopy ¶
func (in *InventorySpec) DeepCopy() *InventorySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InventorySpec.
func (*InventorySpec) DeepCopyInto ¶
func (in *InventorySpec) DeepCopyInto(out *InventorySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InventoryStatus ¶
type InventoryStatus struct {
Objects []ObjectStatus `json:"objects,omitempty"`
}
InventoryStatus is the status of the current/last-known inventory state.
func (*InventoryStatus) DeepCopy ¶
func (in *InventoryStatus) DeepCopy() *InventoryStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InventoryStatus.
func (*InventoryStatus) DeepCopyInto ¶
func (in *InventoryStatus) DeepCopyInto(out *InventoryStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ObjectReference ¶
type ObjectReference struct {
// Kind identifies a REST resource within a Group.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Kind string `json:"kind,omitempty"`
// Group identifies an API namespace for REST resources.
// If group is omitted, it is treated as the "core" group.
// More info: https://kubernetes.io/docs/reference/using-api/#api-groups
// +optional
Group string `json:"group,omitempty"`
// Name identifies an object instance of a REST resource.
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name string `json:"name,omitempty"`
// Namespace identifies a group of objects across REST resources.
// If namespace is specified, the resource must be namespace-scoped.
// If namespace is omitted, the resource must be cluster-scoped.
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
// +optional
Namespace string `json:"namespace,omitempty"`
}
ObjectReference is a reference to a KRM resource by name and kind.
Kubernetes only stores one API Version for each Kind at any given time, so version is not used when referencing objects.
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.
type ObjectStatus ¶
type ObjectStatus struct {
ObjectReference `json:",inline"`
// Strategy indicates the method of actuation (apply or delete) used or planned to be used.
Strategy ActuationStrategy `json:"strategy,omitempty"`
// Actuation indicates whether actuation has been performed yet and how it went.
Actuation ActuationStatus `json:"actuation,omitempty"`
// Reconcile indicates whether reconciliation has been performed yet and how it went.
Reconcile ReconcileStatus `json:"reconcile,omitempty"`
// UID is the last known UID (after apply or before delete).
// This can help identify if the object has been replaced.
// +optional
UID types.UID `json:"uid,omitempty"`
// Generation is the last known Generation (after apply or before delete).
// This can help identify if the object has been modified.
// Generation is not available for deleted objects.
// +optional
Generation int64 `json:"generation,omitempty"`
}
ObjectStatus is a snapshot of the actuation and reconciliation status of a referenced object.
func (*ObjectStatus) DeepCopy ¶
func (in *ObjectStatus) DeepCopy() *ObjectStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectStatus.
func (*ObjectStatus) DeepCopyInto ¶
func (in *ObjectStatus) DeepCopyInto(out *ObjectStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReconcileStatus ¶
type ReconcileStatus int
const ( ReconcilePending ReconcileStatus = iota // Pending ReconcileSucceeded // Succeeded ReconcileSkipped // Skipped ReconcileFailed // Failed ReconcileTimeout // Timeout )
func (ReconcileStatus) String ¶
func (i ReconcileStatus) String() string
Source Files