MachineOSBuild [machineconfiguration.openshift.io/v1]

Description

MachineOSBuild describes a build process managed and deployed by the MCO 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 describes the configuration of the machine os build. It is immutable once set.
status	object	status describes the last observed state of this machine os build.

.spec

Description

spec describes the configuration of the machine os build. It is immutable once set.

Type

`object`

Required

• machineConfig
• machineOSConfig
• renderedImagePushSpec

Property	Type	Description
machineConfig	object	machineConfig points to the rendered MachineConfig resource to be included in this image build.
machineOSConfig	object	machineOSConfig references the MachineOSConfig resource that this image build extends.
renderedImagePushSpec	string	renderedImagePushSpec is set by the Machine Config Operator from the MachineOSConfig object this build is attached to. This field describes the location of the final image, which will be pushed by the build once complete. The format of the image push spec is: host[:port][/namespace]/name: or svc_name.namespace.svc[:port]/repository/name:. The length of the push spec must be between 1 to 447 characters.

.spec.machineConfig

Description

machineConfig points to the rendered MachineConfig resource to be included in this image build.

Type

`object`

Required

• name

Property	Type	Description
name	string	name is the name of the rendered MachineConfig object. This value should be between 10 and 253 characters, and must contain only lowercase alphanumeric characters, hyphens and periods, and should start and end with an alphanumeric character.

.spec.machineOSConfig

Description

machineOSConfig references the MachineOSConfig resource that this image build extends.

Type

`object`

Required

• name

Property	Type	Description
name	string	name of the MachineOSConfig. The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.

.status

Description

status describes the last observed state of this machine os build.

Type

`object`

Property	Type	Description
buildEnd	string	buildEnd is the timestamp corresponding to completion of the builder backend. When omitted the build has either not been started, or is in progress. It will be populated once the build completes, fails or is interrupted.
buildStart	string	buildStart is the timestamp corresponding to the build controller initiating the build backend for this MachineOSBuild.
builder	object	builder describes the image builder backend used for this build.
conditions	array	conditions are state related conditions for the build. Valid types are: Prepared, Building, Failed, Interrupted, and Succeeded. Once a Build is marked as Failed, Interrupted or Succeeded, no future conditions can be set.
conditions[]	object	Condition contains details for one aspect of the current state of this API Resource.
digestedImagePushSpec	string	digestedImagePushSpec describes the fully qualified push spec produced by this build. The format of the push spec is: host[:port][/namespace]/name@sha256:, where the digest must be 64 characters long, and consist only of lowercase hexadecimal characters, a-f and 0-9. The length of the whole spec must be between 1 to 447 characters.
relatedObjects	array	relatedObjects is a list of references to ephemeral objects such as ConfigMaps or Secrets that are meant to be consumed while the build process runs. After a successful build or when this MachineOSBuild is deleted, these ephemeral objects will be removed. In the event of a failed build, the objects will remain until the build is removed to allow for inspection.
relatedObjects[]	object	ObjectReference contains enough information to let you inspect or modify the referred object.

.status.builder

Description

builder describes the image builder backend used for this build.

Type

`object`

Required

• imageBuilderType

Property	Type	Description
imageBuilderType	string	imageBuilderType describes the type of image builder used to build this image. Valid values are Job only. When set to Job, a pod based builder, using buildah, is launched to build the specified image.
job	object	job is a reference to the job object that is managing the image build. This is required if the imageBuilderType is Job, and forbidden otherwise.

.status.builder.job

Description

job is a reference to the job object that is managing the image build. This is required if the imageBuilderType is Job, and forbidden otherwise.

Type

`object`

Required

• group
• name
• resource

Property	Type	Description
group	string	group of the referent. The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character. Example: "", "apps", "build.openshift.io", etc.
name	string	name of the referent. The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
namespace	string	namespace of the referent. This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens, and should start and end with an alphanumeric character.
resource	string	resource of the referent. This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens, and should start with an alphabetic character and end with an alphanumeric character. Example: "deployments", "deploymentconfigs", "pods", etc.

.status.conditions

Description

conditions are state related conditions for the build. Valid types are: Prepared, Building, Failed, Interrupted, and Succeeded. Once a Build is marked as Failed, Interrupted or Succeeded, no future conditions can be set.

Type

`array`

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource.

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.

.status.relatedObjects

Description

relatedObjects is a list of references to ephemeral objects such as ConfigMaps or Secrets that are meant to be consumed while the build process runs. After a successful build or when this MachineOSBuild is deleted, these ephemeral objects will be removed. In the event of a failed build, the objects will remain until the build is removed to allow for inspection.

Type

`array`

.status.relatedObjects[]

Description

ObjectReference contains enough information to let you inspect or modify the referred object.

Type

`object`

Required

• group
• name
• resource

Property	Type	Description
group	string	group of the referent. The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character. Example: "", "apps", "build.openshift.io", etc.
name	string	name of the referent. The name must contain only lowercase alphanumeric characters, '-' or '.' and start/end with an alphanumeric character.
namespace	string	namespace of the referent. This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens, and should start and end with an alphanumeric character.
resource	string	resource of the referent. This value should consist of at most 63 characters, and of only lowercase alphanumeric characters and hyphens, and should start with an alphabetic character and end with an alphanumeric character. Example: "deployments", "deploymentconfigs", "pods", etc.

API endpoints

The following API endpoints are available:

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

/apis/machineconfiguration.openshift.io/v1/machineosbuilds

HTTP method

`DELETE`

Description

delete collection of MachineOSBuild

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

list objects of kind MachineOSBuild

HTTP responses

HTTP code	Reponse body
200 - OK	MachineOSBuildList schema
401 - Unauthorized	Empty

HTTP method

`POST`

Description

create a MachineOSBuild

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.

Body parameters

Parameter	Type	Description
body	MachineOSBuild schema

HTTP responses

HTTP code	Reponse body
200 - OK	MachineOSBuild schema
201 - Created	MachineOSBuild schema
202 - Accepted	MachineOSBuild schema
401 - Unauthorized	Empty

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

Global path parameters

Parameter	Type	Description
name	string	name of the MachineOSBuild

HTTP method

`DELETE`

Description

delete a MachineOSBuild

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

HTTP responses

HTTP code	Reponse body
200 - OK	Status schema
202 - Accepted	Status schema
401 - Unauthorized	Empty

HTTP method

`GET`

Description

read the specified MachineOSBuild

HTTP responses

HTTP code	Reponse body
200 - OK	MachineOSBuild schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update the specified MachineOSBuild

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.

HTTP responses

HTTP code	Reponse body
200 - OK	MachineOSBuild schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace the specified MachineOSBuild

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.

Body parameters

Parameter	Type	Description
body	MachineOSBuild schema

HTTP responses

HTTP code	Reponse body
200 - OK	MachineOSBuild schema
201 - Created	MachineOSBuild schema
401 - Unauthorized	Empty

/apis/machineconfiguration.openshift.io/v1/machineosbuilds/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the MachineOSBuild

HTTP method

`GET`

Description

read status of the specified MachineOSBuild

HTTP responses

HTTP code	Reponse body
200 - OK	MachineOSBuild schema
401 - Unauthorized	Empty

HTTP method

`PATCH`

Description

partially update status of the specified MachineOSBuild

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.

HTTP responses

HTTP code	Reponse body
200 - OK	MachineOSBuild schema
401 - Unauthorized	Empty

HTTP method

`PUT`

Description

replace status of the specified MachineOSBuild

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.

Body parameters

Parameter	Type	Description
body	MachineOSBuild schema

HTTP responses

HTTP code	Reponse body
200 - OK	MachineOSBuild schema
201 - Created	MachineOSBuild schema
401 - Unauthorized	Empty