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

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

spec is the specification of the desired behavior of the Machine Config Operator

statusobject

status is the most recently observed status of the Machine Config Operator

.spec

Description
spec is the specification of the desired behavior of the Machine Config Operator
Type
object
PropertyTypeDescription
defaultNodeDisruptionPolicySpecActionobject

DefaultNodeDisruptionPolicy is the default disruption policy for files/units/sshkeys

nodeDisruptionPolicyobject

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.

.spec.defaultNodeDisruptionPolicySpecAction

Description
DefaultNodeDisruptionPolicy is the default disruption policy for files/units/sshkeys
Type
object
Required
filesunits
PropertyTypeDescription
filesarray

files is the default node desruption policy for files This list supports a maximum of 10 entries.

unitsarray

units is the default node desruption policy for units This list supports a maximum of 10 entries.

.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
PropertyTypeDescription
reloadobject

reload specifies the service to reload, only valid if type is reload

restartobject

restart specifies the service to restart, only valid if type is restart

typestring

type represents the commands that will be carried out if this NodeDisruptionPolicySpecActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload and None. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration

.spec.defaultNodeDisruptionPolicySpecAction.files[].reload

Description
reload specifies the service to reload, only valid if type is reload
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.spec.defaultNodeDisruptionPolicySpecAction.files[].restart

Description
restart specifies the service to restart, only valid if type is restart
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.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
PropertyTypeDescription
reloadobject

reload specifies the service to reload, only valid if type is reload

restartobject

restart specifies the service to restart, only valid if type is restart

typestring

type represents the commands that will be carried out if this NodeDisruptionPolicySpecActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload and None. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration

.spec.defaultNodeDisruptionPolicySpecAction.units[].reload

Description
reload specifies the service to reload, only valid if type is reload
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.spec.defaultNodeDisruptionPolicySpecAction.units[].restart

Description
restart specifies the service to restart, only valid if type is restart
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.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
PropertyTypeDescription
filesarray

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.

sshkeyobject

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

unitsarray

units is a list MachineConfig unit definitions and actions to take on changes to those services This list supports a maximum of 50 entries.

.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
PropertyTypeDescription
actionsarray

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.

pathstring

path is the location of a file being managed through a MachineConfig. The Actions in the policy will apply to changes to the file at this path.

.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
PropertyTypeDescription
reloadobject

reload specifies the service to reload, only valid if type is reload

restartobject

restart specifies the service to restart, only valid if type is restart

typestring

type represents the commands that will be carried out if this NodeDisruptionPolicySpecActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload and None. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration

.spec.nodeDisruptionPolicy.files[].actions[].reload

Description
reload specifies the service to reload, only valid if type is reload
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.spec.nodeDisruptionPolicy.files[].actions[].restart

Description
restart specifies the service to restart, only valid if type is restart
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.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
PropertyTypeDescription
actionsarray

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.

.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
PropertyTypeDescription
reloadobject

reload specifies the service to reload, only valid if type is reload

restartobject

restart specifies the service to restart, only valid if type is restart

typestring

type represents the commands that will be carried out if this NodeDisruptionPolicySpecActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload and None. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration

.spec.nodeDisruptionPolicy.sshkey.actions[].reload

Description
reload specifies the service to reload, only valid if type is reload
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.spec.nodeDisruptionPolicy.sshkey.actions[].restart

Description
restart specifies the service to restart, only valid if type is restart
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.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
PropertyTypeDescription
actionsarray

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.

namestring

name represents the service name of a systemd service managed through a MachineConfig Actions specified will be applied for changes to the named service. Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.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
PropertyTypeDescription
reloadobject

reload specifies the service to reload, only valid if type is reload

restartobject

restart specifies the service to restart, only valid if type is restart

typestring

type represents the commands that will be carried out if this NodeDisruptionPolicySpecActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload and None. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration

.spec.nodeDisruptionPolicy.units[].actions[].reload

Description
reload specifies the service to reload, only valid if type is reload
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.spec.nodeDisruptionPolicy.units[].actions[].restart

Description
restart specifies the service to restart, only valid if type is restart
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.status

Description
status is the most recently observed status of the Machine Config Operator
Type
object
PropertyTypeDescription
conditionsarray

conditions is a list of conditions and their status

nodeDisruptionPolicyStatusobject

nodeDisruptionPolicyStatus status reflects what the latest cluster-validated policies are, and will be used by the Machine Config Daemon during future node updates.

observedGenerationinteger

observedGeneration is the last generation change you've dealt with

.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
PropertyTypeDescription
lastTransitionTimestring

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

messagestring

message is a human readable message indicating details about the transition. This may be an empty string.

observedGenerationinteger

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reasonstring

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

statusstring

status of the condition, one of True, False, Unknown.

typestring

type of condition in CamelCase or in foo.example.com/CamelCase.

Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.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
PropertyTypeDescription
clusterPoliciesobject

clusterPolicies is a merge of cluster default and user provided node disruption policies.

.status.nodeDisruptionPolicyStatus.clusterPolicies

Description
clusterPolicies is a merge of cluster default and user provided node disruption policies.
Type
object
PropertyTypeDescription
filesarray

files is a list of MachineConfig file definitions and actions to take to changes on those paths

sshkeyobject

sshkey is the overall sshkey MachineConfig definition

unitsarray

units is a list MachineConfig unit definitions and actions to take on changes to those services

.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
PropertyTypeDescription
actionsarray

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.

pathstring

path is the location of a file being managed through a MachineConfig. The Actions in the policy will apply to changes to the file at this path.

.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
PropertyTypeDescription
reloadobject

reload specifies the service to reload, only valid if type is reload

restartobject

restart specifies the service to restart, only valid if type is restart

typestring

type represents the commands that will be carried out if this NodeDisruptionPolicyStatusActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload, None and Special. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration

.status.nodeDisruptionPolicyStatus.clusterPolicies.files[].actions[].reload

Description
reload specifies the service to reload, only valid if type is reload
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.status.nodeDisruptionPolicyStatus.clusterPolicies.files[].actions[].restart

Description
restart specifies the service to restart, only valid if type is restart
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.status.nodeDisruptionPolicyStatus.clusterPolicies.sshkey

Description
sshkey is the overall sshkey MachineConfig definition
Type
object
Required
actions
PropertyTypeDescription
actionsarray

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.

.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
PropertyTypeDescription
reloadobject

reload specifies the service to reload, only valid if type is reload

restartobject

restart specifies the service to restart, only valid if type is restart

typestring

type represents the commands that will be carried out if this NodeDisruptionPolicyStatusActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload, None and Special. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration

.status.nodeDisruptionPolicyStatus.clusterPolicies.sshkey.actions[].reload

Description
reload specifies the service to reload, only valid if type is reload
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.status.nodeDisruptionPolicyStatus.clusterPolicies.sshkey.actions[].restart

Description
restart specifies the service to restart, only valid if type is restart
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.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
PropertyTypeDescription
actionsarray

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.

namestring

name represents the service name of a systemd service managed through a MachineConfig Actions specified will be applied for changes to the named service. Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.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
PropertyTypeDescription
reloadobject

reload specifies the service to reload, only valid if type is reload

restartobject

restart specifies the service to restart, only valid if type is restart

typestring

type represents the commands that will be carried out if this NodeDisruptionPolicyStatusActionType is executed Valid values are Reboot, Drain, Reload, Restart, DaemonReload, None and Special. reload/restart requires a corresponding service target specified in the reload/restart field. Other values require no further configuration

.status.nodeDisruptionPolicyStatus.clusterPolicies.units[].actions[].reload

Description
reload specifies the service to reload, only valid if type is reload
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be reloaded Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

.status.nodeDisruptionPolicyStatus.clusterPolicies.units[].actions[].restart

Description
restart specifies the service to restart, only valid if type is restart
Type
object
Required
serviceName
PropertyTypeDescription
serviceNamestring

serviceName is the full name (e.g. crio.service) of the service to be restarted Service names should be of the format ${NAME}${SERVICETYPE} and can up to 255 characters long. ${NAME} must be atleast 1 character long and can only consist of alphabets, digits, ":", "-", "_", ".", and "". ${SERVICETYPE} must be one of ".service", ".socket", ".device", ".mount", ".automount", ".swap", ".target", ".path", ".timer", ".snapshot", ".slice" or ".scope".

API Endpoints

The following API endpoints are available:

  • /kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations
    • DELETE: delete collection of MachineConfiguration
    • GET: list objects of kind MachineConfiguration
    • POST: create a new MachineConfiguration
  • /kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations/{name}
    • DELETE: delete the specified MachineConfiguration
    • GET: read the specified MachineConfiguration
    • PATCH: partially update the specified MachineConfiguration
    • PUT: replace the specified MachineConfiguration
  • /kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations/{name}/status
    • GET: read status of the specified MachineConfiguration
    • PATCH: partially update status of the specified MachineConfiguration
    • PUT: 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 codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind MachineConfiguration
HTTP responses
HTTP codeResponse body
200 - OKMachineConfigurationList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new MachineConfiguration
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyMachineConfiguration schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineConfiguration schema
201 - CreatedMachineConfiguration schema
202 - AcceptedMachineConfiguration schema
401 - UnauthorizedEmpty

/kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations/{name}

HTTP method
DELETE
Description
delete the specified MachineConfiguration
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified MachineConfiguration
HTTP responses
HTTP codeResponse body
200 - OKMachineConfiguration schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified MachineConfiguration
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKMachineConfiguration schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified MachineConfiguration
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyMachineConfiguration schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineConfiguration schema
201 - CreatedMachineConfiguration schema
401 - UnauthorizedEmpty

/kubernetes/{cluster}/apis/machineconfiguration.alauda.io/v1alpha1/machineconfigurations/{name}/status

HTTP method
GET
Description
read status of the specified MachineConfiguration
HTTP responses
HTTP codeResponse body
200 - OKMachineConfiguration schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified MachineConfiguration
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKMachineConfiguration schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified MachineConfiguration
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyMachineConfiguration schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKMachineConfiguration schema
201 - CreatedMachineConfiguration schema
401 - UnauthorizedEmpty