ProductBase [product.alauda.io/v1alpha1]

Description: ProductBase is the Schema for the productbases 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`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	ProductBaseSpec defines the desired state of ProductBase
`status`	`object`	ProductBaseStatus defines the observed state of ProductBase

.spec

Description: ProductBaseSpec defines the desired state of ProductBase
Type: object
Required: defaultAdminhttpplatformURLregistryversion

Property	Type	Description
`alternativeURLs`	`array`	AlternativeURLs is the platform's alternative urls
`defaultAdmin`	`object`	DefaultAdmin stands for the admin's config
`defaultRedirectPath`	`string`	DefaultRedirectPath stands for the default redirect path
`globalConfig`	`object`	GlobalConfig stands for the global config
`http`	`object`	HTTP stands for the http config
`ingress`	`object`	Ingress stands for the ingress configs
`platformPublicURL`	`string`	PlatformPublicURL stands the platform's public url
`platformURL`	`string`	PlatformURL is the platform's access url
`productBrand`	`string`	ProductBrand values: TKE、ACP、Common
`registry`	`object`	Registry is Docker Registry's Config
`replicas`	`integer`	Replicas stands for the deploy replicas
`version`	`string`	Version stands for this product's version to deploy

.spec.alternativeURLs

Description: AlternativeURLs is the platform's alternative urls
Type: array

.spec.alternativeURLs[]

Type: string

.spec.defaultAdmin

Description: DefaultAdmin stands for the admin's config
Type: object
Required: accountemail

Property	Type	Description
`account`	`string`	Account stands for admin's account
`email`	`string`	Email stands for admin's email
`hash`	`string`	Hash stands for admin's password hash

.spec.globalConfig

Description: GlobalConfig stands for the global config
Type: object

Property	Type	Description
`labels`	`object`

.spec.globalConfig.labels

Type: object

.spec.http

Description: HTTP stands for the http config
Type: object
Required: forceRedirectHttps

Property	Type	Description
`forceRedirectHttps`	`boolean`	ForceRedirectHTTPS stands for if force redirect to https
`httpPort`	`integer`	HTTPPort is the port of http
`httpsPort`	`integer`	HTTPPort is the port of https
`tls`	`object`	TLS statnds for the server's TLS Certificate

.spec.http.tls

Description: TLS statnds for the server's TLS Certificate
Type: object

Property	Type	Description
`secretRef`	`object`	SecretRef is the reference for tls secret

.spec.http.tls.secretRef

Description: SecretRef is the reference for tls secret
Type: object
Required: name

Property	Type	Description
`name`	`string`	Name is the name of secret

.spec.ingress

Description: Ingress stands for the ingress configs
Type: object
Required: controllerhostingressClassName

Property	Type	Description
`annotations`	`object`
`controller`	`object`	Controller stands for the ingress controller configs
`host`	`string`	Host stands for the host config in ingress
`ingressClassName`	`string`	IngressClassName stands for the ingressClassName of the ingress

.spec.ingress.annotations

Type: object

.spec.ingress.controller

Description: Controller stands for the ingress controller configs
Type: object
Required: install

Property	Type	Description
`install`	`boolean`	Install stands for if install ingress controller
`nodes`	`array`	Nodes stands for the ingress controller's running node

.spec.ingress.controller.nodes

Description: Nodes stands for the ingress controller's running node
Type: array

.spec.ingress.controller.nodes[]

Type: string

.spec.registry

Description: Registry is Docker Registry's Config
Type: object
Required: addresspreferPlatformURL

Property	Type	Description
`address`	`string`	Address is Docker Registry's address
`external`	`boolean`	External stands for a external registry
`preferPlatformURL`	`boolean`	PreferPlatformURL stands for business cluster prefer platform URL as registry address
`secretRef`	`object`	SecretRef is the reference for pullImageSecret

.spec.registry.secretRef

Description: SecretRef is the reference for pullImageSecret
Type: object
Required: name

Property	Type	Description
`name`	`string`	Name is the name of secret

.status

Description: ProductBaseStatus defines the observed state of ProductBase
Type: object
Required: phaseversion

Property	Type	Description
`artifacts`	`array`	Artifacts stands for the product's artifacts
`conditions`	`array`	Conditions contains this product's conditions
`globalID`	`string`	GlobalID stands for the global Id
`phase`	`string`	Phase stands for this product's phase
`replicas`	`integer`	Replicas stands for the product workload replicas
`version`	`string`	Version statnds for this product's current version

.status.artifacts

Description: Artifacts stands for the product's artifacts
Type: array

.status.artifacts[]

Description: Artifact stands for the artifact's info
Type: object
Required: channelsnamepackageType

Property	Type	Description
`channels`	`array`	Channels stands for the artifact's channels
`name`	`string`	Name stands for the artifact's name
`packageType`	`string`	PackageType stands for the artifact's package type

.status.artifacts[].channels

Description: Channels stands for the artifact's channels
Type: array

.status.artifacts[].channels[]

Description: Channel stands for the artifact's channel
Type: object
Required: artifactStatuschanneldefaultdisplayNamerepositorytag

Property	Type	Description
`artifactStatus`	`string`	ArtifactStatus stands for the channel's artifact status
`brief`	`object`	Brief stands for the artifact's brief
`catalogSource`	`string`	CatalogSource stands for the catalog source to get the operator bundle
`categories`	`array`	Categories stands for the artifact's categories, such as: AI, Database, etc.
`channel`	`string`	Channel stands for the channel's name
`default`	`boolean`	Default stands for the artifact's default channel
`description`	`object`	Description stands for the channel's description
`digest`	`string`	Digest stands for the channel's digest
`displayName`	`object`	DisplayName stands for the artifact's display name
`hidden`	`boolean`	Hidden stands for the artifact is hidden on the Marketplace's page
`packIgnore`	`boolean`	PackIgnore indicates whether to skip packaging
`provider`	`object`	Provider stands for the artifact's provider
`providerType`	`string`	ProviderType stands for the artifact's provider type, such as: platform, certified, custom, community
`repository`	`string`	Repository stands for the channel's repository
`supportedArchitectures`	`array`	SupportedArchitectures stands for the supported architectures, such as: amd64, arm64, etc.
`supportedPlatformVersions`	`array`	SupportedPlatformVersions stands for the supported platform versions, such as: v4.0, v4.1, etc.
`supportedProtocolStacks`	`array`	SupportedProtocolStacks stands for the supported protocol stacks, such as: IPv4, IPv6, DualStack, etc.
`tag`	`string`	Tag stands for the channel's tag

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

Description: Brief stands for the artifact's brief
Type: object

Property	Type	Description
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

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

Description: Categories stands for the artifact's categories, such as: AI, Database, etc.
Type: array

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

Type: string

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

Description: Description stands for the channel's description
Type: object

Property	Type	Description
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

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

Description: DisplayName stands for the artifact's display name
Type: object

Property	Type	Description
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

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

Description: Provider stands for the artifact's provider
Type: object

Property	Type	Description
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

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

Description: SupportedArchitectures stands for the supported architectures, such as: amd64, arm64, etc.
Type: array

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

Type: string

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

Description: SupportedPlatformVersions stands for the supported platform versions, such as: v4.0, v4.1, etc.
Type: array

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

Type: string

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

Description: SupportedProtocolStacks stands for the supported protocol stacks, such as: IPv4, IPv6, DualStack, etc.
Type: array

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

Type: string

.status.conditions

Description: Conditions contains this product's conditions
Type: array

.status.conditions[]

Description: ProductBaseCondition ...
Type: object
Required: statustype

Property	Type	Description
`lastHeartbeatTime`	`string`	LastHeartbeatTime stands for the timestamp to check Condition
`lastTransitionTime`	`string`	LastTransitionTime stands for the timestamp of Condition's status changed
`message`	`string`	Message stands for Condition's message
`reason`	`string`	Reason stands for Condition's reason
`status`	`string`	Status stands for Condition's status
`type`	`string`	Type stands for Condition's type

API Endpoints

The following API endpoints are available:

/apis/product.alauda.io/v1alpha2/productbases
- DELETE: delete collection of ProductBase
- GET: list objects of kind ProductBase
- POST: create a new ProductBase
/apis/product.alauda.io/v1alpha2/productbases/{name}
- DELETE: delete the specified ProductBase
- GET: read the specified ProductBase
- PATCH: partially update the specified ProductBase
- PUT: replace the specified ProductBase
/apis/product.alauda.io/v1alpha2/productbases/{name}/status
- GET: read status of the specified ProductBase
- PATCH: partially update status of the specified ProductBase
- PUT: replace status of the specified ProductBase

/apis/product.alauda.io/v1alpha2/productbases

HTTP method: DELETE
Description: delete collection of ProductBase
HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind ProductBase
HTTP responses

HTTP code	Response body
200 - OK	`ProductBaseList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a new ProductBase

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`	`ProductBase` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`ProductBase` schema
201 - Created	`ProductBase` schema
202 - Accepted	`ProductBase` schema
401 - Unauthorized	Empty

/apis/product.alauda.io/v1alpha2/productbases/{name}

HTTP method: DELETE
Description: delete the specified ProductBase

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	Response body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified ProductBase
HTTP responses

HTTP code	Response body
200 - OK	`ProductBase` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified ProductBase

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	Response body
200 - OK	`ProductBase` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ProductBase

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`	`ProductBase` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`ProductBase` schema
201 - Created	`ProductBase` schema
401 - Unauthorized	Empty

/apis/product.alauda.io/v1alpha2/productbases/{name}/status

HTTP method: GET
Description: read status of the specified ProductBase
HTTP responses

HTTP code	Response body
200 - OK	`ProductBase` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified ProductBase

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	Response body
200 - OK	`ProductBase` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified ProductBase

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`	`ProductBase` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`ProductBase` schema
201 - Created	`ProductBase` schema
401 - Unauthorized	Empty

#ProductBase [product.alauda.io/v1alpha1]

Specification#

.spec#

.spec.alternativeURLs#

.spec.alternativeURLs[]#

.spec.defaultAdmin#

.spec.globalConfig#

.spec.globalConfig.labels#

.spec.http#

.spec.http.tls#

.spec.http.tls.secretRef#

.spec.ingress#

.spec.ingress.annotations#

.spec.ingress.controller#

.spec.ingress.controller.nodes#

.spec.ingress.controller.nodes[]#

.spec.registry#

.spec.registry.secretRef#

.status#

.status.artifacts#

.status.artifacts[]#

.status.artifacts[].channels#

.status.artifacts[].channels[]#

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

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

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

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

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

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

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

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

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

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

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

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

.status.conditions#

.status.conditions[]#

API Endpoints#

/apis/product.alauda.io/v1alpha2/productbases#

/apis/product.alauda.io/v1alpha2/productbases/{name}#

/apis/product.alauda.io/v1alpha2/productbases/{name}/status#

ProductBase [product.alauda.io/v1alpha1]

Specification

.spec

.spec.alternativeURLs

.spec.alternativeURLs[]

.spec.defaultAdmin

.spec.globalConfig

.spec.globalConfig.labels

.spec.http

.spec.http.tls

.spec.http.tls.secretRef

.spec.ingress

.spec.ingress.annotations

.spec.ingress.controller

.spec.ingress.controller.nodes

.spec.ingress.controller.nodes[]

.spec.registry

.spec.registry.secretRef

.status

.status.artifacts

.status.artifacts[]

.status.artifacts[].channels

.status.artifacts[].channels[]

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

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

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

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

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

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

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

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

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

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

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

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

.status.conditions

.status.conditions[]

API Endpoints

/apis/product.alauda.io/v1alpha2/productbases

/apis/product.alauda.io/v1alpha2/productbases/{name}

/apis/product.alauda.io/v1alpha2/productbases/{name}/status