SeedImage [elemental.cattle.io/v1beta1]

SeedImage 由 elemental-operator 拥有。创建 SeedImage 会引用一个 MachineRegistration，并触发 operator 构建一个嵌入注册 URL 的 ISO；operator 会下载该 ISO，并据此启动 bare-metal 主机。生成的 MachineInventory 对象将由 MachineInventoryPool 分配给 BaremetalMachine。

类型: object

规格

属性	类型	描述
`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`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`
`status`	`object`

.spec

类型: object
必填: registrationReftype

属性	类型	描述
`baseImage`	`string`	BaseImg the base elemental image used to build the seed image.
`buildContainer`	`object`	BuildContainer settings for a custom container used to generate the downloadable image.
`cleanupAfterMinutes`	`integer`	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.
`registrationRef`	`object`	MachineRegistrationRef a reference to the related MachineRegistration.
`retriggerBuild`	`boolean`	RetriggerBuild triggers to build again a cleaned up seed image.
`size`	`integer\|string`	Size specifies the size of the volume used to store the image. Defaults to 6Gi
`targetPlatform`	`string`	Platform specifies the target platform for the built image. Example: linux/amd64
`type`	`string`	Type specifies the type of seed image to built. Valid values are iso\|raw Defaults to "iso"

.spec.buildContainer

描述: BuildContainer settings for a custom container used to generate the downloadable image.
类型: object

属性	类型	描述
`args`	`array`	Args same as corev1.Container.Args
`command`	`array`	Command same as corev1.Container.Command
`image`	`string`	Image container image to run
`imagePullPolicy`	`string`	Args same as corev1.Container.ImagePullPolicy
`name`	`string`	Name of the spawned container

.spec.buildContainer.args

描述: Args same as corev1.Container.Args
类型: array

.spec.buildContainer.args[]

类型: string

.spec.buildContainer.command

描述: Command same as corev1.Container.Command
类型: array

.spec.buildContainer.command[]

类型: string

.spec.registrationRef

描述: MachineRegistrationRef a reference to the related MachineRegistration.
类型: object

属性	类型	描述
`apiVersion`	`string`	API version of the referent.
`fieldPath`	`string`	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.
`kind`	`string`	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`string`	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`string`	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
`uid`	`string`	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.status

类型: object

属性	类型	描述
`checksumURL`	`string`	ChecksumURL the URL from which the SeedImage checksum can be downloaded once the image is built.
`conditions`	`array`	Conditions describe the state of the seedimage object.
`downloadToken`	`string`	DownloadToken a token to identify the seed image to download.
`downloadURL`	`string`	DownloadURL the URL from which the SeedImage can be downloaded once built.
`state`	`string`	State reflect the state of the seed image build process.

.status.conditions

描述: Conditions describe the state of the seedimage object.
类型: array

.status.conditions[]

描述: Condition contains details for one aspect of the current state of this API Resource.
类型: object
必填: lastTransitionTimemessagereasonstatustype

属性	类型	描述
`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.

API 端点

可用的 API 端点如下：

/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 方法: DELETE
描述: delete collection of SeedImage
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind SeedImage
HTTP 响应

HTTP 状态码	响应体
200 - OK	`SeedImageList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new SeedImage

查询参数

参数	类型	描述
`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`	`SeedImage` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`SeedImage` schema
201 - Created	`SeedImage` schema
202 - Accepted	`SeedImage` schema
401 - Unauthorized	Empty

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

HTTP 方法: DELETE
描述: delete the specified SeedImage

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified SeedImage
HTTP 响应

HTTP 状态码	响应体
200 - OK	`SeedImage` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified SeedImage

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`SeedImage` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified SeedImage

查询参数

参数	类型	描述
`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`	`SeedImage` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`SeedImage` schema
201 - Created	`SeedImage` schema
401 - Unauthorized	Empty

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

HTTP 方法: GET
描述: read status of the specified SeedImage
HTTP 响应

HTTP 状态码	响应体
200 - OK	`SeedImage` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update status of the specified SeedImage

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`SeedImage` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace status of the specified SeedImage

查询参数

参数	类型	描述
`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`	`SeedImage` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`SeedImage` schema
201 - Created	`SeedImage` schema
401 - Unauthorized	Empty

#SeedImage [elemental.cattle.io/v1beta1]

#规格

#.spec

#.spec.buildContainer

#.spec.buildContainer.args

#.spec.buildContainer.args[]

#.spec.buildContainer.command

#.spec.buildContainer.command[]

#.spec.registrationRef

#.status

#.status.conditions

#.status.conditions[]

API 端点#

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

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

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