Chapter 7. MachineConfigNode [machineconfiguration.openshift.io/v1alpha1] Description MachineConfigNode describes the health of the Machines on the system Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. Type object Required spec 7.1. 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 describes the configuration of the machine config node. status object status describes the last observed state of this machine config node. 7.1.1. .spec Description spec describes the configuration of the machine config node. Type object Required configVersion node pool Property Type Description configVersion object configVersion holds the desired config version for the node targeted by this machine config node resource. The desired version represents the machine config the node will attempt to update to. This gets set before the machine config operator validates the new machine config against the current machine config. node object node contains a reference to the node for this machine config node. pool object pool contains a reference to the machine config pool that this machine config node's referenced node belongs to. 7.1.2. .spec.configVersion Description configVersion holds the desired config version for the node targeted by this machine config node resource. The desired version represents the machine config the node will attempt to update to. This gets set before the machine config operator validates the new machine config against the current machine config. Type object Required desired Property Type Description desired string desired is the name of the machine config that the the node should be upgraded to. This value is set when the machine config pool generates a new version of its rendered configuration. When this value is changed, the machine config daemon starts the node upgrade process. This value gets set in the machine config node spec once the machine config has been targeted for upgrade and before it is validated. Must be a lowercase RFC-1123 hostname ( https://tools.ietf.org/html/rfc1123 ) It may consist of only alphanumeric characters, hyphens (-) and periods (.) and must be at most 253 characters in length. 7.1.3. .spec.node Description node contains a reference to the node for this machine config node. Type object Required name Property Type Description name string name is the object name. Must be a lowercase RFC-1123 hostname ( https://tools.ietf.org/html/rfc1123 ) It may consist of only alphanumeric characters, hyphens (-) and periods (.) and must be at most 253 characters in length. 7.1.4. .spec.pool Description pool contains a reference to the machine config pool that this machine config node's referenced node belongs to. Type object Required name Property Type Description name string name is the object name. Must be a lowercase RFC-1123 hostname ( https://tools.ietf.org/html/rfc1123 ) It may consist of only alphanumeric characters, hyphens (-) and periods (.) and must be at most 253 characters in length. 7.1.5. .status Description status describes the last observed state of this machine config node. Type object Required configVersion Property Type Description conditions array conditions represent the observations of a machine config node's current state. 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 } configVersion object configVersion describes the current and desired machine config for this node. The current version represents the current machine config for the node and is updated after a successful update. The desired version represents the machine config the node will attempt to update to. This desired machine config has been compared to the current machine config and has been validated by the machine config operator as one that is valid and that exists. observedGeneration integer observedGeneration represents the generation observed by the controller. This field is updated when the controller observes a change to the desiredConfig in the configVersion of the machine config node spec. 7.1.6. .status.conditions Description conditions represent the observations of a machine config node's current state. Type array 7.1.7. .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) 7.1.8. .status.configVersion Description configVersion describes the current and desired machine config for this node. The current version represents the current machine config for the node and is updated after a successful update. The desired version represents the machine config the node will attempt to update to. This desired machine config has been compared to the current machine config and has been validated by the machine config operator as one that is valid and that exists. Type object Required desired Property Type Description current string current is the name of the machine config currently in use on the node. This value is updated once the machine config daemon has completed the update of the configuration for the node. This value should match the desired version unless an upgrade is in progress. Must be a lowercase RFC-1123 hostname ( https://tools.ietf.org/html/rfc1123 ) It may consist of only alphanumeric characters, hyphens (-) and periods (.) and must be at most 253 characters in length. desired string desired is the MachineConfig the node wants to upgrade to. This value gets set in the machine config node status once the machine config has been validated against the current machine config. Must be a lowercase RFC-1123 hostname ( https://tools.ietf.org/html/rfc1123 ) It may consist of only alphanumeric characters, hyphens (-) and periods (.) and must be at most 253 characters in length. 7.2. API endpoints The following API endpoints are available: /apis/machineconfiguration.openshift.io/v1alpha1/machineconfignodes DELETE : delete collection of MachineConfigNode GET : list objects of kind MachineConfigNode POST : create a MachineConfigNode /apis/machineconfiguration.openshift.io/v1alpha1/machineconfignodes/{name} DELETE : delete a MachineConfigNode GET : read the specified MachineConfigNode PATCH : partially update the specified MachineConfigNode PUT : replace the specified MachineConfigNode /apis/machineconfiguration.openshift.io/v1alpha1/machineconfignodes/{name}/status GET : read status of the specified MachineConfigNode PATCH : partially update status of the specified MachineConfigNode PUT : replace status of the specified MachineConfigNode 7.2.1. /apis/machineconfiguration.openshift.io/v1alpha1/machineconfignodes HTTP method DELETE Description delete collection of MachineConfigNode Table 7.1. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind MachineConfigNode Table 7.2. HTTP responses HTTP code Reponse body 200 - OK MachineConfigNodeList schema 401 - Unauthorized Empty HTTP method POST Description create a MachineConfigNode Table 7.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 7.4. Body parameters Parameter Type Description body MachineConfigNode schema Table 7.5. HTTP responses HTTP code Reponse body 200 - OK MachineConfigNode schema 201 - Created MachineConfigNode schema 202 - Accepted MachineConfigNode schema 401 - Unauthorized Empty 7.2.2. /apis/machineconfiguration.openshift.io/v1alpha1/machineconfignodes/{name} Table 7.6. Global path parameters Parameter Type Description name string name of the MachineConfigNode HTTP method DELETE Description delete a MachineConfigNode Table 7.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 7.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 MachineConfigNode Table 7.9. HTTP responses HTTP code Reponse body 200 - OK MachineConfigNode schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified MachineConfigNode Table 7.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 7.11. HTTP responses HTTP code Reponse body 200 - OK MachineConfigNode schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified MachineConfigNode Table 7.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 7.13. Body parameters Parameter Type Description body MachineConfigNode schema Table 7.14. HTTP responses HTTP code Reponse body 200 - OK MachineConfigNode schema 201 - Created MachineConfigNode schema 401 - Unauthorized Empty 7.2.3. /apis/machineconfiguration.openshift.io/v1alpha1/machineconfignodes/{name}/status Table 7.15. Global path parameters Parameter Type Description name string name of the MachineConfigNode HTTP method GET Description read status of the specified MachineConfigNode Table 7.16. HTTP responses HTTP code Reponse body 200 - OK MachineConfigNode schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified MachineConfigNode Table 7.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 7.18. HTTP responses HTTP code Reponse body 200 - OK MachineConfigNode schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified MachineConfigNode Table 7.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 7.20. Body parameters Parameter Type Description body MachineConfigNode schema Table 7.21. HTTP responses HTTP code Reponse body 200 - OK MachineConfigNode schema 201 - Created MachineConfigNode schema 401 - Unauthorized Empty

Commands: