This is a cache of https://docs.okd.io/latest/rest_api/operator_apis/machineconfiguration-operator-openshift-io-v1.html. It is a snapshot of the page at 2024-09-21T22:30:39.247+0000.
Machin<strong>e</strong>Configuration [op<strong>e</strong>rator.op<strong>e</strong>nshift.io/v1] - Op<strong>e</strong>rator APIs | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | OKD 4
&times;
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

Property Type Description

apiVersion

string

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

kind

string

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

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

status

object

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

Property Type Description

failedRevisionLimit

integer

failedRevisionLimit is the number of failed static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)

forceRedeploymentReason

string

forceRedeploymentReason can be used to force the redeployment of the operand by providing a unique string. This provides a mechanism to kick a previously failed deployment and provide a reason why you think it will work this time instead of failing again on the same config.

logLevel

string

logLevel is an intent based logging for an overall component. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for their operands. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

managedBootImages

object

managedBootImages allows configuration for the management of boot images for machine resources within the cluster. This configuration allows users to select resources that should be updated to the latest boot images during cluster upgrades, ensuring that new machines always boot with the current cluster version’s boot image. When omitted, no boot images will be updated.

managementState

string

managementState indicates whether and how the operator should manage the component

nodeDisruptionPolicy

object

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.

observedConfig

``

observedConfig holds a sparse config that controller has observed from the cluster state. It exists in spec because it is an input to the level for the operator

operatorLogLevel

string

operatorLogLevel is an intent based logging for the operator itself. It does not give fine grained control, but it is a simple way to manage coarse grained logging choices that operators have to interpret for themselves. Valid values are: "Normal", "Debug", "Trace", "TraceAll". Defaults to "Normal".

succeededRevisionLimit

integer

succeededRevisionLimit is the number of successful static pod installer revisions to keep on disk and in the api -1 = unlimited, 0 or unset = 5 (default)

unsupportedConfigOverrides

``

unsupportedConfigOverrides overrides the final configuration that was computed by the operator. Red Hat does not support the use of this field. Misuse of this field could lead to unexpected behavior or conflict with other configuration options. Seek guidance from the Red Hat support before using this field. Use of this property blocks cluster upgrades, it must be removed before upgrading your cluster.

.spec.managedBootImages

Description

managedBootImages allows configuration for the management of boot images for machine resources within the cluster. This configuration allows users to select resources that should be updated to the latest boot images during cluster upgrades, ensuring that new machines always boot with the current cluster version’s boot image. When omitted, no boot images will be updated.

Type

object

Property Type Description

machineManagers

array

machineManagers can be used to register machine management resources for boot image updates. The Machine Config Operator will watch for changes to this list. Only one entry is permitted per type of machine management resource.

machineManagers[]

object

MachineManager describes a target machine resource that is registered for boot image updates. It stores identifying information such as the resource type and the API Group of the resource. It also provides granular control via the selection field.

.spec.managedBootImages.machineManagers

Description

machineManagers can be used to register machine management resources for boot image updates. The Machine Config Operator will watch for changes to this list. Only one entry is permitted per type of machine management resource.

Type

array

.spec.managedBootImages.machineManagers[]

Description

MachineManager describes a target machine resource that is registered for boot image updates. It stores identifying information such as the resource type and the API Group of the resource. It also provides granular control via the selection field.

Type

object

Required
  • apiGroup

  • resource

  • selection

Property Type Description

apiGroup

string

apiGroup is name of the APIGroup that the machine management resource belongs to. The only current valid value is machine.openshift.io. machine.openshift.io means that the machine manager will only register resources that belong to OpenShift machine API group.

resource

string

resource is the machine management resource’s type. The only current valid value is machinesets. machinesets means that the machine manager will only register resources of the kind MachineSet.

selection

object

selection allows granular control of the machine management resources that will be registered for boot image updates.

.spec.managedBootImages.machineManagers[].selection

Description

selection allows granular control of the machine management resources that will be registered for boot image updates.

Type

object

Required
  • mode

Property Type Description

mode

string

mode determines how machine managers will be selected for updates. Valid values are All and Partial. All means that every resource matched by the machine manager will be updated. Partial requires specified selector(s) and allows customisation of which resources matched by the machine manager will be updated.

partial

object

partial provides label selector(s) that can be used to match machine management resources. Only permitted when mode is set to "Partial".

.spec.managedBootImages.machineManagers[].selection.partial

Description

partial provides label selector(s) that can be used to match machine management resources. Only permitted when mode is set to "Partial".

Type

object

Required
  • machineResourceSelector

Property Type Description

machineResourceSelector

object

machineResourceSelector is a label selector that can be used to select machine resources like MachineSets.

.spec.managedBootImages.machineManagers[].selection.partial.machineResourceSelector

Description

machineResourceSelector is a label selector that can be used to select machine resources like MachineSets.

Type

object

Property Type Description

matchexpressions

array

matchexpressions is a list of label selector requirements. The requirements are ANDed.

matchexpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchexpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.managedBootImages.machineManagers[].selection.partial.machineResourceSelector.matchexpressions

Description

matchexpressions is a list of label selector requirements. The requirements are ANDed.

Type

array

.spec.managedBootImages.machineManagers[].selection.partial.machineResourceSelector.matchexpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required
  • key

  • operator

Property Type Description

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, exists and DoesNotexist.

values

array (string)

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is exists or DoesNotexist, the values array must be empty. This array is replaced during a strategic merge patch.

.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

Property Type Description

files

array

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.

files[]

object

NodeDisruptionPolicySpecFile is a file entry and corresponding actions to take and is used in the NodeDisruptionPolicyConfig object

sshkey

object

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

units

array

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

units[]

object

NodeDisruptionPolicySpecUnit is a systemd unit name and corresponding actions to take and is used in the NodeDisruptionPolicyConfig 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
  • actions

  • path

Property Type Description

actions

array

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.

actions[]

object

path

string

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[]

Description
Type

object

Required
  • type

Property Type Description

reload

object

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

restart

object

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

type

string

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

Property Type Description

serviceName

string

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

Property Type Description

serviceName

string

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

Property Type Description

actions

array

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.

actions[]

object

.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[]

Description
Type

object

Required
  • type

Property Type Description

reload

object

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

restart

object

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

type

string

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

Property Type Description

serviceName

string

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

Property Type Description

serviceName

string

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
  • actions

  • name

Property Type Description

actions

array

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.

actions[]

object

name

string

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[]

Description
Type

object

Required
  • type

Property Type Description

reload

object

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

restart

object

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

type

string

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

Property Type Description

serviceName

string

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

Property Type Description

serviceName

string

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

Property Type Description

conditions

array

conditions is a list of conditions and their status

conditions[]

object

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 }

nodeDisruptionPolicyStatus

object

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

observedGeneration

integer

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
  • lastTransitionTime

  • message

  • reason

  • status

  • type

Property Type Description

lastTransitionTime

string

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.

message

string

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

observedGeneration

integer

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.

reason

string

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.

status

string

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

type

string

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

Property Type Description

clusterPolicies

object

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

Property Type Description

files

array

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

files[]

object

NodeDisruptionPolicyStatusFile is a file entry and corresponding actions to take and is used in the NodeDisruptionPolicyClusterStatus object

sshkey

object

sshkey is the overall sshkey MachineConfig definition

units

array

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

units[]

object

NodeDisruptionPolicyStatusUnit is a systemd unit name and corresponding actions to take and is used in the NodeDisruptionPolicyClusterStatus 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
  • actions

  • path

Property Type Description

actions

array

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.

actions[]

object

path

string

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[]

Description
Type

object

Required
  • type

Property Type Description

reload

object

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

restart

object

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

type

string

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

Property Type Description

serviceName

string

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

Property Type Description

serviceName

string

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

Property Type Description

actions

array

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.

actions[]

object

.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[]

Description
Type

object

Required
  • type

Property Type Description

reload

object

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

restart

object

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

type

string

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

Property Type Description

serviceName

string

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

Property Type Description

serviceName

string

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
  • actions

  • name

Property Type Description

actions

array

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.

actions[]

object

name

string

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[]

Description
Type

object

Required
  • type

Property Type Description

reload

object

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

restart

object

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

type

string

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

Property Type Description

serviceName

string

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

Property Type Description

serviceName

string

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:

  • /apis/operator.openshift.io/v1/machineconfigurations

    • DeLeTe: delete collection of MachineConfiguration

    • GeT: list objects of kind MachineConfiguration

    • POST: create a MachineConfiguration

  • /apis/operator.openshift.io/v1/machineconfigurations/{name}

    • DeLeTe: delete a MachineConfiguration

    • GeT: read the specified MachineConfiguration

    • PATCH: partially update the specified MachineConfiguration

    • PUT: replace the specified MachineConfiguration

  • /apis/operator.openshift.io/v1/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

/apis/operator.openshift.io/v1/machineconfigurations

HTTP method

DeLeTe

Description

delete collection of MachineConfiguration

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

empty

HTTP method

GeT

Description

list objects of kind MachineConfiguration

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

MachineConfigurationList schema

401 - Unauthorized

empty

HTTP method

POST

Description

create a MachineConfiguration

Table 3. Query parameters
Parameter Type Description

dryRun

string

When 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

fieldValidation

string

fieldValidation 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.

Table 4. Body parameters
Parameter Type Description

body

MachineConfiguration schema

Table 5. HTTP responses
HTTP code Reponse body

200 - OK

MachineConfiguration schema

201 - Created

MachineConfiguration schema

202 - Accepted

MachineConfiguration schema

401 - Unauthorized

empty

/apis/operator.openshift.io/v1/machineconfigurations/{name}

Table 6. Global path parameters
Parameter Type Description

name

string

name of the MachineConfiguration

HTTP method

DeLeTe

Description

delete a MachineConfiguration

Table 7. Query parameters
Parameter Type Description

dryRun

string

When 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

Table 8. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

empty

HTTP method

GeT

Description

read the specified MachineConfiguration

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

MachineConfiguration schema

401 - Unauthorized

empty

HTTP method

PATCH

Description

partially update the specified MachineConfiguration

Table 10. Query parameters
Parameter Type Description

dryRun

string

When 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

fieldValidation

string

fieldValidation 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.

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

MachineConfiguration schema

401 - Unauthorized

empty

HTTP method

PUT

Description

replace the specified MachineConfiguration

Table 12. Query parameters
Parameter Type Description

dryRun

string

When 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

fieldValidation

string

fieldValidation 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.

Table 13. Body parameters
Parameter Type Description

body

MachineConfiguration schema

Table 14. HTTP responses
HTTP code Reponse body

200 - OK

MachineConfiguration schema

201 - Created

MachineConfiguration schema

401 - Unauthorized

empty

/apis/operator.openshift.io/v1/machineconfigurations/{name}/status

Table 15. Global path parameters
Parameter Type Description

name

string

name of the MachineConfiguration

HTTP method

GeT

Description

read status of the specified MachineConfiguration

Table 16. HTTP responses
HTTP code Reponse body

200 - OK

MachineConfiguration schema

401 - Unauthorized

empty

HTTP method

PATCH

Description

partially update status of the specified MachineConfiguration

Table 17. Query parameters
Parameter Type Description

dryRun

string

When 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

fieldValidation

string

fieldValidation 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.

Table 18. HTTP responses
HTTP code Reponse body

200 - OK

MachineConfiguration schema

401 - Unauthorized

empty

HTTP method

PUT

Description

replace status of the specified MachineConfiguration

Table 19. Query parameters
Parameter Type Description

dryRun

string

When 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

fieldValidation

string

fieldValidation 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.

Table 20. Body parameters
Parameter Type Description

body

MachineConfiguration schema

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

MachineConfiguration schema

201 - Created

MachineConfiguration schema

401 - Unauthorized

empty