MachineConfig [machineconfiguration.openshift.io/v1] - Machine APIs | API reference

Specification
- .spec
API endpoints
- /apis/machineconfiguration.openshift.io/v1/machineconfigs
- /apis/machineconfiguration.openshift.io/v1/machineconfigs/{name}

Description: MachineConfig defines the configuration for a machine Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type: object

Specification

Property Type Description

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`	MachineConfigSpec is the spec for MachineConfig

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

MachineConfigSpec is the spec for MachineConfig

.spec

Description: MachineConfigSpec is the spec for MachineConfig
Type: object

Property Type Description

Property	Type	Description
`baseOSExtensionsContainerImage`	`string`	BaseOSExtensionsContainerImage specifies the remote location that will be used to fetch the extensions container matching a new-format OS image
`config`	``	Config is a Ignition Config object.
`extensions`	`array (string)`	extensions contains a list of additional features that can be enabled on host
`fips`	`boolean`	fips controls fips mode
`kernelArguments`	``	kernelArguments contains a list of kernel arguments to be added
`kernelType`	`string`	kernelType contains which kernel we want to be running like default (traditional), realtime, 64k-pages (aarch64 only).
`osImageURL`	`string`	OSImageURL specifies the remote location that will be used to fetch the OS.

baseOSExtensionsContainerImage

string

BaseOSExtensionsContainerImage specifies the remote location that will be used to fetch the extensions container matching a new-format OS image

config

Config is a Ignition Config object.

extensions

array (string)

extensions contains a list of additional features that can be enabled on host

fips

boolean

fips controls fips mode

kernelArguments

kernelArguments contains a list of kernel arguments to be added

kernelType

string

kernelType contains which kernel we want to be running like default (traditional), realtime, 64k-pages (aarch64 only).

osImageURL

string

OSImageURL specifies the remote location that will be used to fetch the OS.

API endpoints

The following API endpoints are available:

/apis/machineconfiguration.openshift.io/v1/machineconfigs
- DELETE: delete collection of MachineConfig
- GET: list objects of kind MachineConfig
- POST: create a MachineConfig
/apis/machineconfiguration.openshift.io/v1/machineconfigs/{name}
- DELETE: delete a MachineConfig
- GET: read the specified MachineConfig
- PATCH: partially update the specified MachineConfig
- PUT: replace the specified MachineConfig

/apis/machineconfiguration.openshift.io/v1/machineconfigs

HTTP method: DELETE
Description: delete collection of MachineConfig

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind MachineConfig

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`MachineConfigList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a MachineConfig

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`	`MachineConfig` schema

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`MachineConfig` schema
201 - Created	`MachineConfig` schema
202 - Accepted	`MachineConfig` schema
401 - Unauthorized	Empty

/apis/machineconfiguration.openshift.io/v1/machineconfigs/{name}

Table 6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the MachineConfig

HTTP method: DELETE
Description: delete a MachineConfig

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 MachineConfig

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`MachineConfig` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified MachineConfig

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	`MachineConfig` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified MachineConfig

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`	`MachineConfig` schema

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`MachineConfig` schema
201 - Created	`MachineConfig` schema
401 - Unauthorized	Empty