MachineConfiguration [machineconfiguration.alauda.io/v1alpha1]
- Description
- MachineConfiguration provides information to configure an operator to manage Machine Configuration. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
- Type
object- Required
spec
Specification
.spec
- Description
- spec is the specification of the desired behavior of the Machine Config Operator
- Type
object
.spec.defaultNodeDisruptionPolicySpecAction
- Description
- DefaultNodeDisruptionPolicy is the default disruption policy for files/units/sshkeys
- Type
object- Required
filesunits
.spec.defaultNodeDisruptionPolicySpecAction.files
- Description
- files is the default node desruption policy for files This list supports a maximum of 10 entries.
- Type
array
.spec.defaultNodeDisruptionPolicySpecAction.files[]
- Type
object- Required
type
.spec.defaultNodeDisruptionPolicySpecAction.files[].reload
- Description
- reload specifies the service to reload, only valid if type is reload
- Type
object- Required
serviceName
.spec.defaultNodeDisruptionPolicySpecAction.files[].restart
- Description
- restart specifies the service to restart, only valid if type is restart
- Type
object- Required
serviceName
.spec.defaultNodeDisruptionPolicySpecAction.units
- Description
- units is the default node desruption policy for units This list supports a maximum of 10 entries.
- Type
array
.spec.defaultNodeDisruptionPolicySpecAction.units[]
- Type
object- Required
type
.spec.defaultNodeDisruptionPolicySpecAction.units[].reload
- Description
- reload specifies the service to reload, only valid if type is reload
- Type
object- Required
serviceName
.spec.defaultNodeDisruptionPolicySpecAction.units[].restart
- Description
- restart specifies the service to restart, only valid if type is restart
- Type
object- Required
serviceName
.spec.nodeDisruptionPolicy
- Description
- nodeDisruptionPolicy allows an admin to set granular node disruption actions for MachineConfig-based updates, such as drains, service reloads, etc. Specifying this will allow for less downtime when doing small configuration updates to the cluster. This configuration has no effect on cluster upgrades which will still incur node disruption where required.
- Type
object
.spec.nodeDisruptionPolicy.files
- Description
- files is a list of MachineConfig file definitions and actions to take to changes on those paths This list supports a maximum of 50 entries.
- Type
array
.spec.nodeDisruptionPolicy.files[]
- Description
- NodeDisruptionPolicySpecFile is a file entry and corresponding actions to take and is used in the NodeDisruptionPolicyConfig object
- Type
object- Required
actionspath
.spec.nodeDisruptionPolicy.files[].actions
- Description
- actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.
- Type
array
.spec.nodeDisruptionPolicy.files[].actions[]
- Type
object- Required
type
.spec.nodeDisruptionPolicy.files[].actions[].reload
- Description
- reload specifies the service to reload, only valid if type is reload
- Type
object- Required
serviceName
.spec.nodeDisruptionPolicy.files[].actions[].restart
- Description
- restart specifies the service to restart, only valid if type is restart
- Type
object- Required
serviceName
.spec.nodeDisruptionPolicy.sshkey
- Description
- sshkey maps to the ignition.sshkeys field in the MachineConfig object, definition an action for this will apply to all sshkey changes in the cluster
- Type
object- Required
actions
.spec.nodeDisruptionPolicy.sshkey.actions
- Description
- actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.
- Type
array
.spec.nodeDisruptionPolicy.sshkey.actions[]
- Type
object- Required
type
.spec.nodeDisruptionPolicy.sshkey.actions[].reload
- Description
- reload specifies the service to reload, only valid if type is reload
- Type
object- Required
serviceName
.spec.nodeDisruptionPolicy.sshkey.actions[].restart
- Description
- restart specifies the service to restart, only valid if type is restart
- Type
object- Required
serviceName
.spec.nodeDisruptionPolicy.units
- Description
- units is a list MachineConfig unit definitions and actions to take on changes to those services This list supports a maximum of 50 entries.
- Type
array
.spec.nodeDisruptionPolicy.units[]
- Description
- NodeDisruptionPolicySpecUnit is a systemd unit name and corresponding actions to take and is used in the NodeDisruptionPolicyConfig object
- Type
object- Required
actionsname
.spec.nodeDisruptionPolicy.units[].actions
- Description
- actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.
- Type
array
.spec.nodeDisruptionPolicy.units[].actions[]
- Type
object- Required
type
.spec.nodeDisruptionPolicy.units[].actions[].reload
- Description
- reload specifies the service to reload, only valid if type is reload
- Type
object- Required
serviceName
.spec.nodeDisruptionPolicy.units[].actions[].restart
- Description
- restart specifies the service to restart, only valid if type is restart
- Type
object- Required
serviceName
.status
- Description
- status is the most recently observed status of the Machine Config Operator
- Type
object
.status.conditions
- Description
- conditions is a list of conditions and their status
- Type
array
.status.conditions[]
- Description
- Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // other fields }
- Type
object- Required
lastTransitionTimemessagereasonstatustype
.status.nodeDisruptionPolicyStatus
- Description
- nodeDisruptionPolicyStatus status reflects what the latest cluster-validated policies are, and will be used by the Machine Config Daemon during future node updates.
- Type
object
.status.nodeDisruptionPolicyStatus.clusterPolicies
- Description
- clusterPolicies is a merge of cluster default and user provided node disruption policies.
- Type
object
.status.nodeDisruptionPolicyStatus.clusterPolicies.files
- Description
- files is a list of MachineConfig file definitions and actions to take to changes on those paths
- Type
array
.status.nodeDisruptionPolicyStatus.clusterPolicies.files[]
- Description
- NodeDisruptionPolicyStatusFile is a file entry and corresponding actions to take and is used in the NodeDisruptionPolicyClusterStatus object
- Type
object- Required
actionspath
.status.nodeDisruptionPolicyStatus.clusterPolicies.files[].actions
- Description
- actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.
- Type
array
.status.nodeDisruptionPolicyStatus.clusterPolicies.files[].actions[]
- Type
object- Required
type
.status.nodeDisruptionPolicyStatus.clusterPolicies.files[].actions[].reload
- Description
- reload specifies the service to reload, only valid if type is reload
- Type
object- Required
serviceName
.status.nodeDisruptionPolicyStatus.clusterPolicies.files[].actions[].restart
- Description
- restart specifies the service to restart, only valid if type is restart
- Type
object- Required
serviceName
.status.nodeDisruptionPolicyStatus.clusterPolicies.sshkey
- Description
- sshkey is the overall sshkey MachineConfig definition
- Type
object- Required
actions
.status.nodeDisruptionPolicyStatus.clusterPolicies.sshkey.actions
- Description
- actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.
- Type
array
.status.nodeDisruptionPolicyStatus.clusterPolicies.sshkey.actions[]
- Type
object- Required
type
.status.nodeDisruptionPolicyStatus.clusterPolicies.sshkey.actions[].reload
- Description
- reload specifies the service to reload, only valid if type is reload
- Type
object- Required
serviceName
.status.nodeDisruptionPolicyStatus.clusterPolicies.sshkey.actions[].restart
- Description
- restart specifies the service to restart, only valid if type is restart
- Type
object- Required
serviceName
.status.nodeDisruptionPolicyStatus.clusterPolicies.units
- Description
- units is a list MachineConfig unit definitions and actions to take on changes to those services
- Type
array
.status.nodeDisruptionPolicyStatus.clusterPolicies.units[]
- Description
- NodeDisruptionPolicyStatusUnit is a systemd unit name and corresponding actions to take and is used in the NodeDisruptionPolicyClusterStatus object
- Type
object- Required
actionsname
.status.nodeDisruptionPolicyStatus.clusterPolicies.units[].actions
- Description
- actions represents the series of commands to be executed on changes to the file at the corresponding file path. Actions will be applied in the order that they are set in this list. If there are other incoming changes to other MachineConfig entries in the same update that require a reboot, the reboot will supercede these actions. Valid actions are Reboot, Drain, Reload, DaemonReload and None. The Reboot action and the None action cannot be used in conjunction with any of the other actions. This list supports a maximum of 10 entries.
- Type
array
.status.nodeDisruptionPolicyStatus.clusterPolicies.units[].actions[]
- Type
object- Required
type
.status.nodeDisruptionPolicyStatus.clusterPolicies.units[].actions[].reload
- Description
- reload specifies the service to reload, only valid if type is reload
- Type
object- Required
serviceName
.status.nodeDisruptionPolicyStatus.clusterPolicies.units[].actions[].restart
- Description
- restart specifies the service to restart, only valid if type is restart
- Type
object- Required
serviceName
API Endpoints
The following API endpoints are available:
/kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurationsDELETE: delete collection of MachineConfigurationGET: list objects of kind MachineConfigurationPOST: create a new MachineConfiguration
/kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations/{name}DELETE: delete the specified MachineConfigurationGET: read the specified MachineConfigurationPATCH: partially update the specified MachineConfigurationPUT: replace the specified MachineConfiguration
/kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations/{name}/statusGET: read status of the specified MachineConfigurationPATCH: partially update status of the specified MachineConfigurationPUT: replace status of the specified MachineConfiguration
/kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations
- HTTP method
DELETE- Description
- delete collection of MachineConfiguration
- HTTP responses
- HTTP method
GET- Description
- list objects of kind MachineConfiguration
- HTTP responses
- HTTP method
POST- Description
- create a new MachineConfiguration
- Query parameters
- Body parameters
- HTTP responses
/kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations/{name}
- HTTP method
DELETE- Description
- delete the specified MachineConfiguration
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified MachineConfiguration
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified MachineConfiguration
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified MachineConfiguration
- Query parameters
- Body parameters
- HTTP responses
/kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations/{name}/status
- HTTP method
GET- Description
- read status of the specified MachineConfiguration
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified MachineConfiguration
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified MachineConfiguration
- Query parameters
- Body parameters
- HTTP responses