PreprovisioningImage [metal3.io/v1alpha1]

Description

PreprovisioningImage is the Schema for the preprovisioningimages API.

Type

`object`

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	PreprovisioningImageSpec defines the desired state of PreprovisioningImage.
status	object	PreprovisioningImageStatus defines the observed state of PreprovisioningImage.

.spec

Description

PreprovisioningImageSpec defines the desired state of PreprovisioningImage.

Type

`object`

Property	Type	Description
acceptFormats	array (string)	acceptFormats is a list of acceptable image formats.
architecture	string	architecture is the processor architecture for which to build the image.
networkDataName	string	networkDataName is the name of a Secret in the local namespace that contains network data to build in to the image.

.status

Description

PreprovisioningImageStatus defines the observed state of PreprovisioningImage.

Type

`object`

Property	Type	Description
architecture	string	architecture is the processor architecture for which the image is built
conditions	array	conditions describe the state of the built image
conditions[]	object	Condition contains details for one aspect of the current state of this API Resource.
extraKernelParams	string	extraKernelParams is a string with extra parameters to pass to the kernel when booting the image over network. Only makes sense for initrd images.
format	string	format is the type of image that is available at the download url: either iso or initrd.
imageUrl	string	imageUrl is the URL from which the built image can be downloaded.
kernelUrl	string	kernelUrl is the URL from which the kernel of the image can be downloaded. Only makes sense for initrd images.
networkData	object	networkData is a reference to the version of the Secret containing the network data used to build the image.

.status.conditions

Description

conditions describe the state of the built image

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

Description

networkData is a reference to the version of the Secret containing the network data used to build the image.

Type

`object`

Property	Type	Description
name	string
version	string

API endpoints

The following API endpoints are available:

• /apis/metal3.io/v1alpha1/preprovisioningimages
  • GET: list objects of kind PreprovisioningImage
• /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages
  • DELETE: delete collection of PreprovisioningImage
  • GET: list objects of kind PreprovisioningImage
  • POST: create a PreprovisioningImage
• /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}
  • DELETE: delete a PreprovisioningImage
  • GET: read the specified PreprovisioningImage
  • PATCH: partially update the specified PreprovisioningImage
  • PUT: replace the specified PreprovisioningImage
• /apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}/status
  • GET: read status of the specified PreprovisioningImage
  • PATCH: partially update status of the specified PreprovisioningImage
  • PUT: replace status of the specified PreprovisioningImage

/apis/metal3.io/v1alpha1/preprovisioningimages

HTTP method

`GET`

Description

list objects of kind PreprovisioningImage

HTTP responses

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

/apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages

HTTP method

`DELETE`

Description

delete collection of PreprovisioningImage

HTTP responses

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

HTTP method

`GET`

Description

list objects of kind PreprovisioningImage

HTTP responses

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

HTTP method

`POST`

Description

create a PreprovisioningImage

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	PreprovisioningImage schema

HTTP responses

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

/apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}

Global path parameters

Parameter	Type	Description
name	string	name of the PreprovisioningImage

HTTP method

`DELETE`

Description

delete a PreprovisioningImage

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 PreprovisioningImage

HTTP responses

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

HTTP method

`PATCH`

Description

partially update the specified PreprovisioningImage

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

HTTP method

`PUT`

Description

replace the specified PreprovisioningImage

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	PreprovisioningImage schema

HTTP responses

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

/apis/metal3.io/v1alpha1/namespaces/{namespace}/preprovisioningimages/{name}/status

Global path parameters

Parameter	Type	Description
name	string	name of the PreprovisioningImage

HTTP method

`GET`

Description

read status of the specified PreprovisioningImage

HTTP responses

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

HTTP method

`PATCH`

Description

partially update status of the specified PreprovisioningImage

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

HTTP method

`PUT`

Description

replace status of the specified PreprovisioningImage

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	PreprovisioningImage schema

HTTP responses

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