Documentation
¶
Overview ¶
Package machine is the internal version of the API. +groupName=machine.sapcloud.io
Package machine is the internal version of the API.
Package machine is the internal version of the API.
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type ClassSpec
- type ConditionStatus
- type CurrentStatus
- type InPlaceUpdateMachineDeployment
- type LastOperation
- type Machine
- type MachineClass
- type MachineClassList
- type MachineConfiguration
- type MachineDeployment
- type MachineDeploymentCondition
- type MachineDeploymentConditionType
- type MachineDeploymentList
- type MachineDeploymentRollback
- type MachineDeploymentSpec
- type MachineDeploymentStatus
- type MachineDeploymentStrategy
- type MachineDeploymentStrategyType
- type MachineList
- type MachineOperationType
- type MachinePhase
- type MachineSet
- type MachineSetCondition
- type MachineSetConditionType
- type MachineSetList
- type MachineSetSpec
- type MachineSetStatus
- type MachineSpec
- type MachineState
- type MachineStatus
- type MachineSummary
- type MachineTemplate
- type MachineTemplateList
- type MachineTemplateSpec
- type NodeTemplate
- type NodeTemplateSpec
- type OrchestrationType
- type RollbackConfig
- type RollingUpdateMachineDeployment
- type UpdateConfiguration
Constants ¶
const ( // NodeInPlaceUpdate is a node condition type for in-place update NodeInPlaceUpdate corev1.NodeConditionType = "InPlaceUpdate" // CandidateForUpdate is a constant for reason in condition that indicates node is candidate for update CandidateForUpdate string = "CandidateForUpdate" // SelectedForUpdate is a constant for reason in condition that indicates node is selected for update SelectedForUpdate string = "SelectedForUpdate" // DrainSuccessful is a constant for reason in condition that indicates node drain is successful DrainSuccessful string = "DrainSuccessful" // ReadyForUpdate is a constant for reason in condition that indicates node is ready for update ReadyForUpdate string = "ReadyForUpdate" // UpdateSuccessful is a constant for reason in condition that indicates update succeeded UpdateSuccessful string = "UpdateSuccessful" // UpdateFailed is a constant for reason in condition that indicates update failed UpdateFailed string = "UpdateFailed" )
const ( // DefaultMachineDeploymentUniqueLabelKey is the default key of the selector that is added // to existing MCs (and label key that is added to its machines) to prevent the existing MCs // to select new machines (and old machines being select by new MC). DefaultMachineDeploymentUniqueLabelKey string = "machine-template-hash" )
const GroupName = "machine.sapcloud.io"
GroupName of all machine-controller-manager objects
Variables ¶
var ( // SchemeBuilder needs to be exported as `SchemeBuilder` so // the code-generation can find it. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme is exposed for API installation AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}
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 ClassSpec ¶
type ClassSpec struct {
// API group to which it belongs
APIGroup string
// Kind for machine class
Kind string
// Name of machine class
Name string
}
ClassSpec is the class specification of machine
func (*ClassSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClassSpec.
func (*ClassSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConditionStatus ¶
type ConditionStatus string
ConditionStatus is a label for condition statuses
const ( ConditionTrue ConditionStatus = "True" ConditionFalse ConditionStatus = "False" ConditionUnknown ConditionStatus = "Unknown" )
These are valid condition statuses. "ConditionTrue" means a resource is in the condition; "ConditionFalse" means a resource is not in the condition; "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.
type CurrentStatus ¶
type CurrentStatus struct {
Phase MachinePhase
TimeoutActive bool
// Last update time of current status
LastUpdateTime metav1.Time
}
CurrentStatus contains information about the current status of Machine.
func (*CurrentStatus) DeepCopy ¶
func (in *CurrentStatus) DeepCopy() *CurrentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CurrentStatus.
func (*CurrentStatus) DeepCopyInto ¶
func (in *CurrentStatus) DeepCopyInto(out *CurrentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InPlaceUpdateMachineDeployment ¶ added in v0.57.0
type InPlaceUpdateMachineDeployment struct {
UpdateConfiguration
// OrchestrationType specifies the orchestration type for the inplace update.
OrchestrationType OrchestrationType
}
InPlaceUpdateMachineDeployment specifies the spec to control the desired behavior of inplace update.
func (*InPlaceUpdateMachineDeployment) DeepCopy ¶ added in v0.57.0
func (in *InPlaceUpdateMachineDeployment) DeepCopy() *InPlaceUpdateMachineDeployment
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InPlaceUpdateMachineDeployment.
func (*InPlaceUpdateMachineDeployment) DeepCopyInto ¶ added in v0.57.0
func (in *InPlaceUpdateMachineDeployment) DeepCopyInto(out *InPlaceUpdateMachineDeployment)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LastOperation ¶
type LastOperation struct {
// Description of the current operation
Description string
// ErrorCode of the current operation if any
// +optional
ErrorCode string
// Last update time of current operation
LastUpdateTime metav1.Time
// State of operation
State MachineState
// Type of operation
Type MachineOperationType
}
LastOperation suggests the last operation performed on the object
func (*LastOperation) DeepCopy ¶
func (in *LastOperation) DeepCopy() *LastOperation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LastOperation.
func (*LastOperation) DeepCopyInto ¶
func (in *LastOperation) DeepCopyInto(out *LastOperation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Machine ¶
type Machine struct {
// ObjectMeta for machine object
metav1.ObjectMeta
// TypeMeta for machine object
metav1.TypeMeta
// Spec contains the specification of the machine
Spec MachineSpec
// Status contains fields depicting the status
Status MachineStatus
}
Machine TODO
func (*Machine) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Machine.
func (*Machine) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Machine) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineClass ¶ added in v0.30.0
type MachineClass struct {
metav1.TypeMeta
// +optional
metav1.ObjectMeta
// +optional
// NodeTemplate contains subfields to track all node resources and other node info required to scale nodegroup from zero
NodeTemplate *NodeTemplate
// CredentialsSecretRef can optionally store the credentials (in this case the SecretRef does not need to store them).
// This might be useful if multiple machine classes with the same credentials but different user-datas are used.
CredentialsSecretRef *corev1.SecretReference
// Provider is the combination of name and location of cloud-specific drivers.
// eg. awsdriver//127.0.0.1:8080
Provider string
// Provider-specific configuration to use during node creation.
ProviderSpec runtime.RawExtension
// SecretRef stores the necessary secrets such as credentials or userdata.
SecretRef *corev1.SecretReference
}
MachineClass can be used to templatize and re-use provider configuration across multiple Machines / MachineSets / MachineDeployments. +k8s:openapi-gen=true +resource:path=machineclasses
func (*MachineClass) DeepCopy ¶ added in v0.30.0
func (in *MachineClass) DeepCopy() *MachineClass
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineClass.
func (*MachineClass) DeepCopyInto ¶ added in v0.30.0
func (in *MachineClass) DeepCopyInto(out *MachineClass)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineClass) DeepCopyObject ¶ added in v0.30.0
func (in *MachineClass) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineClassList ¶ added in v0.30.0
type MachineClassList struct {
metav1.TypeMeta
metav1.ListMeta
Items []MachineClass
}
MachineClassList contains a list of MachineClasses
func (*MachineClassList) DeepCopy ¶ added in v0.30.0
func (in *MachineClassList) DeepCopy() *MachineClassList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineClassList.
func (*MachineClassList) DeepCopyInto ¶ added in v0.30.0
func (in *MachineClassList) DeepCopyInto(out *MachineClassList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineClassList) DeepCopyObject ¶ added in v0.30.0
func (in *MachineClassList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineConfiguration ¶ added in v0.33.0
type MachineConfiguration struct {
// MachineDrainTimeout is the time out after which machine is deleted force-fully.
MachineDrainTimeout *metav1.Duration
// MachineHealthTimeout is the timeout after which machine is declared unhealthy/failed.
MachineHealthTimeout *metav1.Duration
// MachineCreationTimeout is the timeout after which machinie creation is declared failed.
MachineCreationTimeout *metav1.Duration
// MachineInPlaceUpdateTimeout is the timeout after which in-place update is declared failed.
MachineInPlaceUpdateTimeout *metav1.Duration
// DisableHealthTimeout if set to true, health timeout will be ignored. Leading to machine never being declared failed.
// This is intended to be used only for in-place updates.
DisableHealthTimeout *bool
// MaxEvictRetries is the number of retries that will be attempted while draining the node.
MaxEvictRetries *int32
// NodeConditions are the set of conditions if set to true for MachineHealthTimeOut, machine will be declared failed.
NodeConditions *string
}
MachineConfiguration describes the configurations useful for the machine-controller.
func (*MachineConfiguration) DeepCopy ¶ added in v0.33.0
func (in *MachineConfiguration) DeepCopy() *MachineConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineConfiguration.
func (*MachineConfiguration) DeepCopyInto ¶ added in v0.33.0
func (in *MachineConfiguration) DeepCopyInto(out *MachineConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineDeployment ¶
type MachineDeployment struct {
metav1.TypeMeta
// Standard object metadata.
metav1.ObjectMeta
// Specification of the desired behavior of the MachineDeployment.
Spec MachineDeploymentSpec
// Most recently observed status of the MachineDeployment.
Status MachineDeploymentStatus
}
MachineDeployment enables declarative updates for machines and MachineSets.
func (*MachineDeployment) DeepCopy ¶
func (in *MachineDeployment) DeepCopy() *MachineDeployment
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineDeployment.
func (*MachineDeployment) DeepCopyInto ¶
func (in *MachineDeployment) DeepCopyInto(out *MachineDeployment)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineDeployment) DeepCopyObject ¶
func (in *MachineDeployment) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineDeploymentCondition ¶
type MachineDeploymentCondition struct {
// Type of MachineDeployment condition.
Type MachineDeploymentConditionType
// Status of the condition, one of True, False, Unknown.
Status ConditionStatus
// The last time this condition was updated.
LastUpdateTime metav1.Time
// Last time the condition transitioned from one status to another.
LastTransitionTime metav1.Time
// The reason for the condition's last transition.
Reason string
// A human readable message indicating details about the transition.
Message string
}
MachineDeploymentCondition describes the state of a MachineDeployment at a certain point.
func (*MachineDeploymentCondition) DeepCopy ¶
func (in *MachineDeploymentCondition) DeepCopy() *MachineDeploymentCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineDeploymentCondition.
func (*MachineDeploymentCondition) DeepCopyInto ¶
func (in *MachineDeploymentCondition) DeepCopyInto(out *MachineDeploymentCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineDeploymentConditionType ¶
type MachineDeploymentConditionType string
MachineDeploymentConditionType are the valid conditions of a MachineDeployment.
const ( // Available means the MachineDeployment is available, ie. at least the minimum available // replicas required are up and running for at least minReadySeconds. MachineDeploymentAvailable MachineDeploymentConditionType = "Available" // Progressing means the MachineDeployment is progressing. Progress for a MachineDeployment is // considered when a new machine set is created or adopted, and when new machines scale // up or old machines scale down. Progress is not estimated for paused MachineDeployments or // when progressDeadlineSeconds is not specified. MachineDeploymentProgressing MachineDeploymentConditionType = "Progressing" // ReplicaFailure is added in a MachineDeployment when one of its machines fails to be created // or deleted. MachineDeploymentReplicaFailure MachineDeploymentConditionType = "ReplicaFailure" // MachineDeploymentFrozen is added in a MachineDeployment when one of its // machineSet has either the "freeze" label or the "Frozen" condition on it. MachineDeploymentFrozen MachineDeploymentConditionType = "Frozen" )
These are valid conditions of a MachineDeployment.
type MachineDeploymentList ¶
type MachineDeploymentList struct {
metav1.TypeMeta
// Standard list metadata.
metav1.ListMeta
// Items is the list of MachineDeployments.
Items []MachineDeployment
}
MachineDeploymentList is a list of MachineDeployments.
func (*MachineDeploymentList) DeepCopy ¶
func (in *MachineDeploymentList) DeepCopy() *MachineDeploymentList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineDeploymentList.
func (*MachineDeploymentList) DeepCopyInto ¶
func (in *MachineDeploymentList) DeepCopyInto(out *MachineDeploymentList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineDeploymentList) DeepCopyObject ¶
func (in *MachineDeploymentList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineDeploymentRollback ¶
type MachineDeploymentRollback struct {
metav1.TypeMeta
// Required: This must match the Name of a MachineDeployment.
Name string
// The annotations to be updated to a MachineDeployment
UpdatedAnnotations map[string]string
// The config of this MachineDeployment rollback.
RollbackTo RollbackConfig
}
MachineDeploymentRollback stores the information required to rollback a MachineDeployment. DEPRECATED.
func (*MachineDeploymentRollback) DeepCopy ¶
func (in *MachineDeploymentRollback) DeepCopy() *MachineDeploymentRollback
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineDeploymentRollback.
func (*MachineDeploymentRollback) DeepCopyInto ¶
func (in *MachineDeploymentRollback) DeepCopyInto(out *MachineDeploymentRollback)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineDeploymentRollback) DeepCopyObject ¶
func (in *MachineDeploymentRollback) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineDeploymentSpec ¶
type MachineDeploymentSpec struct {
// Number of desired machines. This is a pointer to distinguish between explicit
// zero and not specified. Defaults to 1.
Replicas int32
// Label selector for machines. Existing MachineSets whose machines are
// selected by this will be the ones affected by this MachineDeployment.
Selector *metav1.LabelSelector
// Template describes the machines that will be created.
Template MachineTemplateSpec
// The MachineDeployment strategy to use to replace existing machines with new ones.
// +patchStrategy=retainKeys
Strategy MachineDeploymentStrategy
// Minimum number of seconds for which a newly created machine should be ready
// without any of its container crashing, for it to be considered available.
// Defaults to 0 (machine will be considered available as soon as it is ready)
MinReadySeconds int32
// The number of old MachineSets to retain to allow rollback.
// This is a pointer to distinguish between explicit zero and not specified.
RevisionHistoryLimit *int32
// Indicates that the MachineDeployment is paused and will not be processed by the
// MachineDeployment controller.
Paused bool
// DEPRECATED.
// The config this MachineDeployment is rolling back to. Will be cleared after rollback is done.
RollbackTo *RollbackConfig
// The maximum time in seconds for a MachineDeployment to make progress before it
// is considered to be failed. The MachineDeployment controller will continue to
// process failed MachineDeployments and a condition with a ProgressDeadlineExceeded
// reason will be surfaced in the MachineDeployment status. Note that progress will
// not be estimated during the time a MachineDeployment is paused. This is not set
// by default.
ProgressDeadlineSeconds *int32
}
MachineDeploymentSpec is the specification of the desired behavior of the MachineDeployment.
func (*MachineDeploymentSpec) DeepCopy ¶
func (in *MachineDeploymentSpec) DeepCopy() *MachineDeploymentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineDeploymentSpec.
func (*MachineDeploymentSpec) DeepCopyInto ¶
func (in *MachineDeploymentSpec) DeepCopyInto(out *MachineDeploymentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineDeploymentStatus ¶
type MachineDeploymentStatus struct {
// The generation observed by the MachineDeployment controller.
ObservedGeneration int64
// Total number of non-terminated machines targeted by this MachineDeployment (their labels match the selector).
Replicas int32
// Total number of non-terminated machines targeted by this MachineDeployment that have the desired template spec.
UpdatedReplicas int32
// Total number of ready machines targeted by this MachineDeployment.
ReadyReplicas int32
// Total number of available machines (ready for at least minReadySeconds) targeted by this MachineDeployment.
AvailableReplicas int32
// machines that are still required for the MachineDeployment to have 100% available capacity. They may
// either be machines that are running but not yet available or machines that still have not been created.
UnavailableReplicas int32
// Represents the latest available observations of a MachineDeployment's current state.
// +patchMergeKey=type
// +patchStrategy=merge
Conditions []MachineDeploymentCondition
// Count of hash collisions for the MachineDeployment. The MachineDeployment controller uses this
// field as a collision avoidance mechanism when it needs to create the name for the
// newest MachineSet.
CollisionCount *int32
// FailedMachines has summary of machines on which lastOperation Failed
FailedMachines []*MachineSummary
}
MachineDeploymentStatus is the most recently observed status of the MachineDeployment.
func (*MachineDeploymentStatus) DeepCopy ¶
func (in *MachineDeploymentStatus) DeepCopy() *MachineDeploymentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineDeploymentStatus.
func (*MachineDeploymentStatus) DeepCopyInto ¶
func (in *MachineDeploymentStatus) DeepCopyInto(out *MachineDeploymentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineDeploymentStrategy ¶
type MachineDeploymentStrategy struct {
// Type of MachineDeployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
Type MachineDeploymentStrategyType
// Rolling update config params. Present only if MachineDeploymentStrategyType =
// RollingUpdate.
//---
// TODO: Update this to follow our convention for oneOf, whatever we decide it
// to be.
RollingUpdate *RollingUpdateMachineDeployment
// InPlaceUpdate update config params. Present only if MachineDeploymentStrategyType =
// InPlaceUpdate.
InPlaceUpdate *InPlaceUpdateMachineDeployment
}
MachineDeploymentStrategy describes how to replace existing machines with new ones.
func (*MachineDeploymentStrategy) DeepCopy ¶
func (in *MachineDeploymentStrategy) DeepCopy() *MachineDeploymentStrategy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineDeploymentStrategy.
func (*MachineDeploymentStrategy) DeepCopyInto ¶
func (in *MachineDeploymentStrategy) DeepCopyInto(out *MachineDeploymentStrategy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineDeploymentStrategyType ¶
type MachineDeploymentStrategyType string
MachineDeploymentStrategyType is the strategy to be used for rolling a MachineDeployment
const ( // RecreateMachineDeploymentStrategyType means that all existing machines will be killed before creating new ones. RecreateMachineDeploymentStrategyType MachineDeploymentStrategyType = "Recreate" // RollingUpdateMachineDeploymentStrategyType means that old MCs will be replaced by new one using rolling update i.e gradually scale down the old MCs and scale up the new one. RollingUpdateMachineDeploymentStrategyType MachineDeploymentStrategyType = "RollingUpdate" // InPlaceUpdateMachineDeploymentStrategyType signifies that VMs will be updated in place and // machine objects will gradually transition from the old MachineSet to the new MachineSet without requiring VM recreation. InPlaceUpdateMachineDeploymentStrategyType MachineDeploymentStrategyType = "InPlaceUpdate" )
type MachineList ¶
type MachineList struct {
// ObjectMeta for MachineList object
metav1.TypeMeta
// TypeMeta for MachineList object
metav1.ListMeta
// Items contains the list of machines
Items []Machine
}
MachineList is a collection of Machines.
func (*MachineList) DeepCopy ¶
func (in *MachineList) DeepCopy() *MachineList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineList.
func (*MachineList) DeepCopyInto ¶
func (in *MachineList) DeepCopyInto(out *MachineList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineList) DeepCopyObject ¶
func (in *MachineList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineOperationType ¶
type MachineOperationType string
MachineOperationType is a label for the operation performed on a machine object.
const ( // MachineOperationCreate indicates that the operation was a create MachineOperationCreate MachineOperationType = "Create" // MachineOperationUpdate indicates that the operation was an update MachineOperationUpdate MachineOperationType = "Update" // MachineOperationInPlaceUpdate indicates that the operation was an in-place update MachineOperationInPlaceUpdate MachineOperationType = "InPlaceUpdate" // MachineOperationDrainNode indicates that the operation was a drain node MachineOperationDrainNode MachineOperationType = "DrainNode" // MachineOperationHealthCheck indicates that the operation was a create MachineOperationHealthCheck MachineOperationType = "HealthCheck" // MachineOperationDelete indicates that the operation was a create MachineOperationDelete MachineOperationType = "Delete" )
These are the valid statuses of machines.
type MachinePhase ¶
type MachinePhase string
MachinePhase is a label for the condition of a machines at the current time.
const ( // MachinePending means that the machine is being created MachinePending MachinePhase = "Pending" // MachineAvailable means that machine is present on provider but hasn't joined cluster yet MachineAvailable MachinePhase = "Available" // MachineRunning means node is ready and running successfully MachineRunning MachinePhase = "Running" // MachineTerminating means node is terminating MachineTerminating MachinePhase = "Terminating" // MachineUnknown indicates that the node is not ready at the movement MachineUnknown MachinePhase = "Unknown" // MachineFailed means operation failed leading to machine status failure MachineFailed MachinePhase = "Failed" // MachineCrashLoopBackOff means creation or deletion of the machine is failing. It means that machine object is present but there is no corresponding VM. MachineCrashLoopBackOff MachinePhase = "CrashLoopBackOff" // MachineInPlaceUpdating means machine is being updated in-place MachineInPlaceUpdating MachinePhase = "InPlaceUpdating" // MachineInPlaceUpdateSuccessful means machine in-place update was successful MachineInPlaceUpdateSuccessful MachinePhase = "InPlaceUpdateSuccessful" // MachineInPlaceUpdateFailed means machine in-place update failed MachineInPlaceUpdateFailed MachinePhase = "InPlaceUpdateFailed" )
These are the valid statuses of machines.
type MachineSet ¶
type MachineSet struct {
metav1.ObjectMeta
metav1.TypeMeta
Spec MachineSetSpec
Status MachineSetStatus
}
MachineSet TODO
func (*MachineSet) DeepCopy ¶
func (in *MachineSet) DeepCopy() *MachineSet
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineSet.
func (*MachineSet) DeepCopyInto ¶
func (in *MachineSet) DeepCopyInto(out *MachineSet)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineSet) DeepCopyObject ¶
func (in *MachineSet) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineSetCondition ¶
type MachineSetCondition struct {
// Type of machine set condition.
Type MachineSetConditionType
// Status of the condition, one of True, False, Unknown.
Status ConditionStatus
// The last time the condition transitioned from one status to another.
LastTransitionTime metav1.Time
// The reason for the condition's last transition.
Reason string
// A human readable message indicating details about the transition.
Message string
}
MachineSetCondition describes the state of a machine set at a certain point.
func (*MachineSetCondition) DeepCopy ¶
func (in *MachineSetCondition) DeepCopy() *MachineSetCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineSetCondition.
func (*MachineSetCondition) DeepCopyInto ¶
func (in *MachineSetCondition) DeepCopyInto(out *MachineSetCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineSetConditionType ¶
type MachineSetConditionType string
MachineSetConditionType is the condition on machineset object
const ( // MachineSetReplicaFailure is added in a machine set when one of its machines fails to be created // due to insufficient quota, limit ranges, machine security policy, node selectors, etc. or deleted // due to kubelet being down or finalizers are failing. MachineSetReplicaFailure MachineSetConditionType = "ReplicaFailure" // MachineSetFrozen is set when the machineset has exceeded its replica threshold at the safety controller MachineSetFrozen MachineSetConditionType = "Frozen" )
These are valid conditions of a machine set.
type MachineSetList ¶
type MachineSetList struct {
metav1.TypeMeta
metav1.ListMeta
Items []MachineSet
}
MachineSetList is a collection of MachineSet.
func (*MachineSetList) DeepCopy ¶
func (in *MachineSetList) DeepCopy() *MachineSetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineSetList.
func (*MachineSetList) DeepCopyInto ¶
func (in *MachineSetList) DeepCopyInto(out *MachineSetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineSetList) DeepCopyObject ¶
func (in *MachineSetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineSetSpec ¶
type MachineSetSpec struct {
Replicas int32
Selector *metav1.LabelSelector
MachineClass ClassSpec
Template MachineTemplateSpec
MinReadySeconds int32
}
MachineSetSpec is the specification of a MachineSet.
func (*MachineSetSpec) DeepCopy ¶
func (in *MachineSetSpec) DeepCopy() *MachineSetSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineSetSpec.
func (*MachineSetSpec) DeepCopyInto ¶
func (in *MachineSetSpec) DeepCopyInto(out *MachineSetSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineSetStatus ¶
type MachineSetStatus struct {
// Replicas is the number of actual replicas.
Replicas int32
// The number of pods that have labels matching the labels of the pod template of the replicaset.
FullyLabeledReplicas int32
// The number of ready replicas for this replica set.
ReadyReplicas int32
// The number of available replicas (ready for at least minReadySeconds) for this replica set.
AvailableReplicas int32
// ObservedGeneration is the most recent generation observed by the controller.
ObservedGeneration int64
// Represents the latest available observations of a replica set's current state.
Conditions []MachineSetCondition
// LastOperation performed
LastOperation LastOperation
// FailedMachines has summary of machines on which lastOperation Failed
FailedMachines *[]MachineSummary
}
MachineSetStatus holds the most recently observed status of MachineSet.
func (*MachineSetStatus) DeepCopy ¶
func (in *MachineSetStatus) DeepCopy() *MachineSetStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineSetStatus.
func (*MachineSetStatus) DeepCopyInto ¶
func (in *MachineSetStatus) DeepCopyInto(out *MachineSetStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineSpec ¶
type MachineSpec struct {
// Class contains the machineclass attributes of a machine
Class ClassSpec
// ProviderID represents the provider's unique ID given to a machine
ProviderID string
NodeTemplateSpec NodeTemplateSpec
// Configuration for the machine-controller.
*MachineConfiguration
}
MachineSpec is the specification of a Machine.
func (*MachineSpec) DeepCopy ¶
func (in *MachineSpec) DeepCopy() *MachineSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineSpec.
func (*MachineSpec) DeepCopyInto ¶
func (in *MachineSpec) DeepCopyInto(out *MachineSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineState ¶
type MachineState string
MachineState is a label for the state of a machines at the current time.
const ( // MachineStatePending means there are operations pending on this machine state MachineStateProcessing MachineState = "Processing" // MachineStateFailed means operation failed leading to machine status failure MachineStateFailed MachineState = "Failed" // MachineStateSuccessful indicates that the node is not ready at the moment MachineStateSuccessful MachineState = "Successful" )
These are the valid statuses of machines.
type MachineStatus ¶
type MachineStatus struct {
// Addresses of this machines. This field is only present if the MCM provider runs without a target cluster and may
// be used by clients to determine how to connect to the machine, instead of the `Node.status.addresses` field.
Addresses []corev1.NodeAddress
// Conditions of this machine, same as node
Conditions []corev1.NodeCondition
// Last operation refers to the status of the last operation performed
LastOperation LastOperation
// Current status of the machine object
CurrentStatus CurrentStatus
// LastKnownState can store details of the last known state of the VM by the plugins.
// It can be used by future operation calls to determine current infrastucture state
// +optional
LastKnownState string
}
MachineStatus holds the most recently observed status of Machine.
func (*MachineStatus) DeepCopy ¶
func (in *MachineStatus) DeepCopy() *MachineStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineStatus.
func (*MachineStatus) DeepCopyInto ¶
func (in *MachineStatus) DeepCopyInto(out *MachineStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineSummary ¶
type MachineSummary struct {
// Name of the machine object
Name string
// ProviderID represents the provider's unique ID given to a machine
ProviderID string
// Last operation refers to the status of the last operation performed
LastOperation LastOperation
// OwnerRef
OwnerRef string
}
MachineSummary store the summary of machine.
func (*MachineSummary) DeepCopy ¶
func (in *MachineSummary) DeepCopy() *MachineSummary
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineSummary.
func (*MachineSummary) DeepCopyInto ¶
func (in *MachineSummary) DeepCopyInto(out *MachineSummary)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineTemplate ¶
type MachineTemplate struct {
metav1.TypeMeta
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta
// Template defines the machines that will be created from this machine template.
// https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Template MachineTemplateSpec
}
MachineTemplate describes a template for creating copies of a predefined machine.
func (*MachineTemplate) DeepCopy ¶
func (in *MachineTemplate) DeepCopy() *MachineTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineTemplate.
func (*MachineTemplate) DeepCopyInto ¶
func (in *MachineTemplate) DeepCopyInto(out *MachineTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineTemplate) DeepCopyObject ¶
func (in *MachineTemplate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineTemplateList ¶
type MachineTemplateList struct {
metav1.TypeMeta
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metav1.ListMeta
// List of machine templates
Items []MachineTemplate
}
MachineTemplateList is a list of MachineTemplates.
func (*MachineTemplateList) DeepCopy ¶
func (in *MachineTemplateList) DeepCopy() *MachineTemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineTemplateList.
func (*MachineTemplateList) DeepCopyInto ¶
func (in *MachineTemplateList) DeepCopyInto(out *MachineTemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachineTemplateList) DeepCopyObject ¶
func (in *MachineTemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachineTemplateSpec ¶
type MachineTemplateSpec struct {
// Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta
// Specification of the desired behavior of the machine.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Spec MachineSpec
}
MachineTemplateSpec describes the data a machine should have when created from a template
func (*MachineTemplateSpec) DeepCopy ¶
func (in *MachineTemplateSpec) DeepCopy() *MachineTemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineTemplateSpec.
func (*MachineTemplateSpec) DeepCopyInto ¶
func (in *MachineTemplateSpec) DeepCopyInto(out *MachineTemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NodeTemplate ¶ added in v0.42.0
type NodeTemplate struct {
// Capacity contains subfields to track all node resources required to scale nodegroup from zero
Capacity corev1.ResourceList
// VirtualCapacity represents the expected Node 'virtual' capacity ie comprising virtual extended resources.
// +optional
VirtualCapacity corev1.ResourceList
// Instance type of the node belonging to nodeGroup
InstanceType string
// Region of the node belonging to nodeGroup
Region string
// Zone of the node belonging to nodeGroup
Zone string
// +optional
// CPU Architecture of the node belonging to nodeGroup
Architecture *string
}
NodeTemplate contains subfields to track all node resources and other node info required to scale nodegroup from zero
func (*NodeTemplate) DeepCopy ¶ added in v0.42.0
func (in *NodeTemplate) DeepCopy() *NodeTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeTemplate.
func (*NodeTemplate) DeepCopyInto ¶ added in v0.42.0
func (in *NodeTemplate) DeepCopyInto(out *NodeTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NodeTemplateSpec ¶
type NodeTemplateSpec struct {
metav1.ObjectMeta
Spec corev1.NodeSpec
}
NodeTemplateSpec describes the data a node should have when created from a template
func (*NodeTemplateSpec) DeepCopy ¶
func (in *NodeTemplateSpec) DeepCopy() *NodeTemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NodeTemplateSpec.
func (*NodeTemplateSpec) DeepCopyInto ¶
func (in *NodeTemplateSpec) DeepCopyInto(out *NodeTemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OrchestrationType ¶ added in v0.57.0
type OrchestrationType string
OrchestrationType specifies the orchestration type for the inplace update.
const ( // OrchestrationTypeAuto signifies that the machines are automatically selected for update based on UpdateConfiguration. OrchestrationTypeAuto OrchestrationType = "Auto" // OrchestrationTypeManual signifies that the user has to select the machines to be updated manually. OrchestrationTypeManual OrchestrationType = "Manual" )
type RollbackConfig ¶
type RollbackConfig struct {
// The revision to rollback to. If set to 0, rollback to the last revision.
Revision int64
}
RollbackConfig is the config of a MachineDeployment rollback
func (*RollbackConfig) DeepCopy ¶
func (in *RollbackConfig) DeepCopy() *RollbackConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RollbackConfig.
func (*RollbackConfig) DeepCopyInto ¶
func (in *RollbackConfig) DeepCopyInto(out *RollbackConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RollingUpdateMachineDeployment ¶
type RollingUpdateMachineDeployment struct {
UpdateConfiguration
}
RollingUpdateMachineDeployment specifies the spec to control the desired behavior of rolling update.
func (*RollingUpdateMachineDeployment) DeepCopy ¶
func (in *RollingUpdateMachineDeployment) DeepCopy() *RollingUpdateMachineDeployment
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RollingUpdateMachineDeployment.
func (*RollingUpdateMachineDeployment) DeepCopyInto ¶
func (in *RollingUpdateMachineDeployment) DeepCopyInto(out *RollingUpdateMachineDeployment)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type UpdateConfiguration ¶ added in v0.57.0
type UpdateConfiguration struct {
// Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%).
// Absolute number is calculated from percentage by rounding down.
// This can not be 0 if MaxSurge is 0.
// By default, a fixed value of 1 is used.
// Example: when this is set to 30%, the old MC can be scaled down to 70% of desired machines
// immediately when the update starts. Once new machines are ready, old MC
// can be scaled down further, followed by scaling up the new MC, ensuring
// that the total number of machines available at all times during the update is at
// least 70% of desired machines.
MaxUnavailable *intstr.IntOrString
// The maximum number of machines that can be scheduled above the desired number of
// machines.
// Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%).
// This can not be 0 if MaxUnavailable is 0.
// Absolute number is calculated from percentage by rounding up.
// By default, a value of 1 is used.
// Example: when this is set to 30%, the new MC can be scaled up immediately when
// the update starts, such that the total number of old and new machines do not exceed
// 130% of desired machines. Once old machines have been killed,
// new MC can be scaled up further, ensuring that total number of machines running
// at any time during the update is atmost 130% of desired machines.
MaxSurge *intstr.IntOrString
}
UpdateConfiguration specifies the udpate configuration for the deployment strategy.
func (*UpdateConfiguration) DeepCopy ¶ added in v0.57.0
func (in *UpdateConfiguration) DeepCopy() *UpdateConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UpdateConfiguration.
func (*UpdateConfiguration) DeepCopyInto ¶ added in v0.57.0
func (in *UpdateConfiguration) DeepCopyInto(out *UpdateConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
|
Package validation is used to validate all the machine CRD objects
|
Package validation is used to validate all the machine CRD objects |