Immutable Infrastructure

SeedImage [elemental.cattle.io/v1beta1]

SeedImage is owned by elemental-operator. Creating one references a MachineRegistration and triggers the operator to build an ISO with the registration URL embedded; operators download that ISO and boot bare-metal hosts from it. The resulting MachineInventory objects are what MachineInventoryPool allocates to BaremetalMachine.

Type
object

Specification

PropertyTypeDescription
apiVersionstring

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

kindstring

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

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject
statusobject

.spec

Type
object
Required
registrationReftype
PropertyTypeDescription
baseImagestring

BaseImg the base elemental image used to build the seed image.

buildContainerobject

BuildContainer settings for a custom container used to generate the downloadable image.

cleanupAfterMinutesinteger

LifetimeMinutes the time at which the built seed image will be cleaned up. If when the lifetime elapses the built image is being downloaded, the active download will be completed before removing the built image. Default is 60 minutes, set to 0 to disable.

cloud-config

CloudConfig contains cloud-config data to be put in the generated iso.

registrationRefobject

MachineRegistrationRef a reference to the related MachineRegistration.

retriggerBuildboolean

RetriggerBuild triggers to build again a cleaned up seed image.

size

Size specifies the size of the volume used to store the image. Defaults to 6Gi

targetPlatformstring

Platform specifies the target platform for the built image. Example: linux/amd64

typestring

Type specifies the type of seed image to built. Valid values are iso|raw Defaults to "iso"

.spec.buildContainer

Description
BuildContainer settings for a custom container used to generate the downloadable image.
Type
object
PropertyTypeDescription
argsarray

Args same as corev1.Container.Args

commandarray

Command same as corev1.Container.Command

imagestring

Image container image to run

imagePullPolicystring

Args same as corev1.Container.ImagePullPolicy

namestring

Name of the spawned container

.spec.buildContainer.args

Description
Args same as corev1.Container.Args
Type
array

.spec.buildContainer.args[]

Type
string

.spec.buildContainer.command

Description
Command same as corev1.Container.Command
Type
array

.spec.buildContainer.command[]

Type
string

.spec.registrationRef

Description
MachineRegistrationRef a reference to the related MachineRegistration.
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.status

Type
object
PropertyTypeDescription
checksumURLstring

ChecksumURL the URL from which the SeedImage checksum can be downloaded once the image is built.

conditionsarray

Conditions describe the state of the seedimage object.

downloadTokenstring

DownloadToken a token to identify the seed image to download.

downloadURLstring

DownloadURL the URL from which the SeedImage can be downloaded once built.

statestring

State reflect the state of the seed image build process.

.status.conditions

Description
Conditions describe the state of the seedimage object.
Type
array

.status.conditions[]

Description
Condition contains details for one aspect of the current state of this API Resource.
Type
object
Required
lastTransitionTimemessagereasonstatustype
PropertyTypeDescription
lastTransitionTimestring

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.

messagestring

message is a human readable message indicating details about the transition. This may be an empty string.

observedGenerationinteger

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.

reasonstring

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.

statusstring

status of the condition, one of True, False, Unknown.

typestring

type of condition in CamelCase or in foo.example.com/CamelCase.

API Endpoints

The following API endpoints are available:

  • /apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/seedimages
    • DELETE: delete collection of SeedImage
    • GET: list objects of kind SeedImage
    • POST: create a new SeedImage
  • /apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/seedimages/{name}
    • DELETE: delete the specified SeedImage
    • GET: read the specified SeedImage
    • PATCH: partially update the specified SeedImage
    • PUT: replace the specified SeedImage
  • /apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/seedimages/{name}/status
    • GET: read status of the specified SeedImage
    • PATCH: partially update status of the specified SeedImage
    • PUT: replace status of the specified SeedImage

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/seedimages

HTTP method
DELETE
Description
delete collection of SeedImage
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind SeedImage
HTTP responses
HTTP codeResponse body
200 - OKSeedImageList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new SeedImage
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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
ParameterTypeDescription
bodySeedImage schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKSeedImage schema
201 - CreatedSeedImage schema
202 - AcceptedSeedImage schema
401 - UnauthorizedEmpty

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/seedimages/{name}

HTTP method
DELETE
Description
delete the specified SeedImage
Query parameters
ParameterTypeDescription
dryRunstringWhen 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 codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified SeedImage
HTTP responses
HTTP codeResponse body
200 - OKSeedImage schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified SeedImage
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 codeResponse body
200 - OKSeedImage schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified SeedImage
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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
ParameterTypeDescription
bodySeedImage schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKSeedImage schema
201 - CreatedSeedImage schema
401 - UnauthorizedEmpty

/apis/elemental.cattle.io/v1beta1/namespaces/{namespace}/seedimages/{name}/status

HTTP method
GET
Description
read status of the specified SeedImage
HTTP responses
HTTP codeResponse body
200 - OKSeedImage schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified SeedImage
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 codeResponse body
200 - OKSeedImage schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified SeedImage
Query parameters
ParameterTypeDescription
dryRunstringWhen 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
fieldValidationstringfieldValidation 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
ParameterTypeDescription
bodySeedImage schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKSeedImage schema
201 - CreatedSeedImage schema
401 - UnauthorizedEmpty