×
Description

MachineOSBuild describes a build process managed and deployed by the MCO 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

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

status

object

status describes the lst observed state of this machine os build

.spec

Description

spec describes the configuration of the machine os build

Type

object

Required
  • configGeneration

  • desiredConfig

  • machineOSConfig

  • renderedImagePushspec

  • version

Property Type Description

configGeneration

integer

configGeneration tracks which version of MachineOSConfig this build is based off of

desiredConfig

object

desiredConfig is the desired config we want to build an image for.

machineOSConfig

object

machineOSConfig is the config object which the build is based off of

renderedImagePushspec

string

renderedImagePushspec is set from the MachineOSConfig The format of the image pullspec is: host[:port][/namespace]/name:<tag> or svc_name.namespace.svc[:port]/repository/name:<tag>

version

integer

version tracks the newest MachineOSBuild for each MachineOSConfig

.spec.desiredConfig

Description

desiredConfig is the desired config we want to build an image for.

Type

object

Required
  • name

Property Type Description

name

string

name is the name of the rendered MachineConfig object.

.spec.machineOSConfig

Description

machineOSConfig is the config object which the build is based off of

Type

object

Required
  • name

Property Type Description

name

string

name of the MachineOSConfig

.status

Description

status describes the lst observed state of this machine os build

Type

object

Required
  • buildStart

Property Type Description

buildEnd

string

buildEnd describes when the build ended.

buildStart

string

buildStart describes when the build started.

builderReference

object

ImageBuilderType describes the image builder set in the MachineOSConfig

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, no future conditions can be set. This is enforced by the MCO.

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 }

finalImagePullspec

string

finalImagePushSpec describes the fully qualified pushspec produced by this build that the final image can be. Must be in sha format.

relatedObjects

array

relatedObjects is a list of objects that are related to the build process.

relatedObjects[]

object

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

.status.builderReference

Description

ImageBuilderType describes the image builder set in the MachineOSConfig

Type

object

Required
  • imageBuilderType

Property Type Description

buildPod

object

relatedObjects is a list of objects that are related to the build process.

imageBuilderType

string

ImageBuilderType describes the image builder set in the MachineOSConfig

.status.builderReference.buildPod

Description

relatedObjects is a list of objects that are related to the build process.

Type

object

Required
  • group

  • name

  • resource

Property Type Description

group

string

group of the referent.

name

string

name of the referent.

namespace

string

namespace of the referent.

resource

string

resource of the referent.

.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, no future conditions can be set. This is enforced by the MCO.

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

Description

relatedObjects is a list of objects that are related to the build process.

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.

name

string

name of the referent.

namespace

string

namespace of the referent.

resource

string

resource of the referent.

API endpoints

The following API endpoints are available:

  • /apis/machineconfiguration.openshift.io/v1alpha1/machineosbuilds

    • DELETE: delete collection of MachineOSBuild

    • GET: list objects of kind MachineOSBuild

    • POST: create a MachineOSBuild

  • /apis/machineconfiguration.openshift.io/v1alpha1/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/v1alpha1/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/v1alpha1/machineosbuilds

HTTP method

DELETE

Description

delete collection of MachineOSBuild

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind MachineOSBuild

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

MachineOSBuildList schema

401 - Unauthorized

Empty

HTTP method

POST

Description

create a MachineOSBuild

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

MachineOSBuild schema

Table 5. 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/v1alpha1/machineosbuilds/{name}

Table 6. Global path parameters
Parameter Type Description

name

string

name of the MachineOSBuild

HTTP method

DELETE

Description

delete a MachineOSBuild

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 MachineOSBuild

Table 9. HTTP responses
HTTP code Reponse body

200 - OK

MachineOSBuild schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified MachineOSBuild

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

MachineOSBuild schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified MachineOSBuild

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

MachineOSBuild schema

Table 14. HTTP responses
HTTP code Reponse body

200 - OK

MachineOSBuild schema

201 - Created

MachineOSBuild schema

401 - Unauthorized

Empty

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

Table 15. Global path parameters
Parameter Type Description

name

string

name of the MachineOSBuild

HTTP method

GET

Description

read status of the specified MachineOSBuild

Table 16. HTTP responses
HTTP code Reponse body

200 - OK

MachineOSBuild schema

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update status of the specified MachineOSBuild

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

MachineOSBuild schema

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace status of the specified MachineOSBuild

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

MachineOSBuild schema

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

MachineOSBuild schema

201 - Created

MachineOSBuild schema

401 - Unauthorized

Empty