ProductManifest [config.alauda.io/v1]

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

spec selects the product manifest source to resolve.

statusobject

status reports resolved artifacts for the requested manifest source.

.spec

Description
spec selects the product manifest source to resolve.
Type
object
PropertyTypeDescription
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

Description
status reports resolved artifacts for the requested manifest source.
Type
object
PropertyTypeDescription
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

Description
artifacts reports channel-level artifact metadata and availability.
Type
array

.status.artifacts[]

Description
Artifact describes one manifest component and its channels.
Type
object
Required
name
PropertyTypeDescription
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

Description
channels lists all channels reported by the manifest for this component.
Type
array

.status.artifacts[].channels[]

Description
ArtifactChannel describes one artifact channel from product.yaml.
Type
object
Required
channelrepositorytag
PropertyTypeDescription
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

Description
brief is the localized short channel summary.
Type
object
PropertyTypeDescription
enstring

en is the English variant.

zhstring

zh is the Simplified Chinese variant.

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

Description
categories is the category set of this channel.
Type
array

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

Type
string

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

Description
description is the localized channel description.
Type
object
PropertyTypeDescription
enstring

en is the English variant.

zhstring

zh is the Simplified Chinese variant.

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

Description
displayName is the localized channel display name.
Type
object
PropertyTypeDescription
enstring

en is the English variant.

zhstring

zh is the Simplified Chinese variant.

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

Description
provider is the localized provider name.
Type
object
PropertyTypeDescription
enstring

en is the English variant.

zhstring

zh is the Simplified Chinese variant.

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

Description
supportedArchitectures is the architecture set this channel supports.
Type
array

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

Type
string

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

Description
supportedPlatformVersions is the ACP platform version set this channel supports.
Type
array

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

Type
string

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

Description
supportedProtocolStacks is the protocol stack set this channel supports.
Type
array

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

Type
string

.status.conditions

Description
conditions reports reconciliation state for this ProductManifest.
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/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 method
DELETE
Description
delete collection of ProductManifest
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind ProductManifest
HTTP responses
HTTP codeResponse body
200 - OKProductManifestList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new ProductManifest
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
bodyProductManifest schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKProductManifest schema
201 - CreatedProductManifest schema
202 - AcceptedProductManifest schema
401 - UnauthorizedEmpty

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

HTTP method
DELETE
Description
delete the specified ProductManifest
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 ProductManifest
HTTP responses
HTTP codeResponse body
200 - OKProductManifest schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified ProductManifest
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 - OKProductManifest schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified ProductManifest
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
bodyProductManifest schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKProductManifest schema
201 - CreatedProductManifest schema
401 - UnauthorizedEmpty

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

HTTP method
GET
Description
read status of the specified ProductManifest
HTTP responses
HTTP codeResponse body
200 - OKProductManifest schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified ProductManifest
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 - OKProductManifest schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified ProductManifest
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
bodyProductManifest schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKProductManifest schema
201 - CreatedProductManifest schema
401 - UnauthorizedEmpty