ProductManifest [config.alauda.io/v1]

类型
object

规格

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

spec selects the product manifest source to resolve.

statusobject

status reports resolved artifacts for the requested manifest source.

.spec

描述
spec selects the product manifest source to resolve.
类型
object
属性类型描述
imagestring

image is a container image reference that contains the update payload.

versionstring

version is the container image tag that identifies the update payload.

.status

描述
status reports resolved artifacts for the requested manifest source.
类型
object
属性类型描述
artifactsarray

artifacts reports channel-level artifact metadata and availability.

conditionsarray

conditions reports reconciliation state for this ProductManifest.

observedGenerationinteger

observedGeneration of the object. When this matches the object's metadata.generation, it indicates the status is up-to-date.

resolvedImageDigeststring

resolvedImageDigest is the digest resolved from the desired release image.

.status.artifacts

描述
artifacts reports channel-level artifact metadata and availability.
类型
array

.status.artifacts[]

描述
Artifact describes one manifest component and its channels.
类型
object
必填
name
属性类型描述
channelsarray

channels lists all channels reported by the manifest for this component.

namestring

name is the manifest component name.

packageTypestring

packageType is the manifest package type.

.status.artifacts[].channels

描述
channels lists all channels reported by the manifest for this component.
类型
array

.status.artifacts[].channels[]

描述
ArtifactChannel describes one artifact channel from product.yaml.
类型
object
必填
channelrepositorytag
属性类型描述
artifactStatusstring

artifactStatus is the channel artifact probe result.

briefobject

brief is the localized short channel summary.

catalogSourcestring

catalogSource is the OLM catalog source name.

categoriesarray

categories is the category set of this channel.

channelstring

channel is the channel name in product.yaml.

defaultboolean

default indicates whether this channel is the default channel.

descriptionobject

description is the localized channel description.

digeststring

digest is the optional OCI digest of this channel package.

displayNameobject

displayName is the localized channel display name.

hiddenboolean

hidden indicates this channel should be hidden from normal display.

packIgnoreboolean

packIgnore controls whether this channel is excluded by packaging workflows.

providerobject

provider is the localized provider name.

providerTypestring

providerType is the provider classification.

repositorystring

repository is the OCI repository of this channel package.

supportedArchitecturesarray

supportedArchitectures is the architecture set this channel supports.

supportedPlatformVersionsarray

supportedPlatformVersions is the ACP platform version set this channel supports.

supportedProtocolStacksarray

supportedProtocolStacks is the protocol stack set this channel supports.

tagstring

tag is the OCI tag of this channel package.

.status.artifacts[].channels[].brief

描述
brief is the localized short channel summary.
类型
object
属性类型描述
enstring

en is the English variant.

zhstring

zh is the Simplified Chinese variant.

.status.artifacts[].channels[].categories

描述
categories is the category set of this channel.
类型
array

.status.artifacts[].channels[].categories[]

类型
string

.status.artifacts[].channels[].description

描述
description is the localized channel description.
类型
object
属性类型描述
enstring

en is the English variant.

zhstring

zh is the Simplified Chinese variant.

.status.artifacts[].channels[].displayName

描述
displayName is the localized channel display name.
类型
object
属性类型描述
enstring

en is the English variant.

zhstring

zh is the Simplified Chinese variant.

.status.artifacts[].channels[].provider

描述
provider is the localized provider name.
类型
object
属性类型描述
enstring

en is the English variant.

zhstring

zh is the Simplified Chinese variant.

.status.artifacts[].channels[].supportedArchitectures

描述
supportedArchitectures is the architecture set this channel supports.
类型
array

.status.artifacts[].channels[].supportedArchitectures[]

类型
string

.status.artifacts[].channels[].supportedPlatformVersions

描述
supportedPlatformVersions is the ACP platform version set this channel supports.
类型
array

.status.artifacts[].channels[].supportedPlatformVersions[]

类型
string

.status.artifacts[].channels[].supportedProtocolStacks

描述
supportedProtocolStacks is the protocol stack set this channel supports.
类型
array

.status.artifacts[].channels[].supportedProtocolStacks[]

类型
string

.status.conditions

描述
conditions reports reconciliation state for this ProductManifest.
类型
array

.status.conditions[]

描述
Condition contains details for one aspect of the current state of this API Resource.
类型
object
必填
lastTransitionTimemessagereasonstatustype
属性类型描述
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 端点

可用的 API 端点如下:

  • /apis/config.alauda.io/v1/productmanifests
    • DELETE: delete collection of ProductManifest
    • GET: list objects of kind ProductManifest
    • POST: create a new ProductManifest
  • /apis/config.alauda.io/v1/productmanifests/{name}
    • DELETE: delete the specified ProductManifest
    • GET: read the specified ProductManifest
    • PATCH: partially update the specified ProductManifest
    • PUT: replace the specified ProductManifest
  • /apis/config.alauda.io/v1/productmanifests/{name}/status
    • GET: read status of the specified ProductManifest
    • PATCH: partially update status of the specified ProductManifest
    • PUT: replace status of the specified ProductManifest

/apis/config.alauda.io/v1/productmanifests

HTTP 方法
DELETE
描述
delete collection of ProductManifest
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind ProductManifest
HTTP 响应
HTTP 状态码响应体
200 - OKProductManifestList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new ProductManifest
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyProductManifest schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKProductManifest schema
201 - CreatedProductManifest schema
202 - AcceptedProductManifest schema
401 - UnauthorizedEmpty

/apis/config.alauda.io/v1/productmanifests/{name}

HTTP 方法
DELETE
描述
delete the specified ProductManifest
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified ProductManifest
HTTP 响应
HTTP 状态码响应体
200 - OKProductManifest schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified ProductManifest
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKProductManifest schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified ProductManifest
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyProductManifest schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKProductManifest schema
201 - CreatedProductManifest schema
401 - UnauthorizedEmpty

/apis/config.alauda.io/v1/productmanifests/{name}/status

HTTP 方法
GET
描述
read status of the specified ProductManifest
HTTP 响应
HTTP 状态码响应体
200 - OKProductManifest schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified ProductManifest
查询参数
参数类型描述
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 响应
HTTP 状态码响应体
200 - OKProductManifest schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified ProductManifest
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyProductManifest schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKProductManifest schema
201 - CreatedProductManifest schema
401 - UnauthorizedEmpty