ProductConfig [alauda.io/v1alpha1]

Description: ProductConfig is the Schema for the productconfigs 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`	ProductConfigSpec defines the desired state of ProductConfig
`status`	`object`	ProductConfigStatus defines the observed state of ProductConfig

.spec

Description: ProductConfigSpec defines the desired state of ProductConfig
Type: object
Required: availableVersionbriefdescriptiondisplayNamedisplayUIConfiginstallUIConfiglogoplatformVersionMatchproductResourcetype

Property	Type	Description
`availableVersion`	`string`	AvailableVersion stands for the available version to deploy
`brief`	`object`	Brief stands for the product's brief
`chartVersions`	`array`	ChartVersions stands for the charts when deploying, they are optional and will be added to the Prouct CR
`commonConfigRef`	`array`	CommonConfigRef stands for the reference from CommonConfig to Product CR
`description`	`object`	Description stands for the product's description
`displayName`	`object`	DisplayName stands for the product's display name
`displayUIConfig`	`object`	DisplayUIConfig stands for the web UI type when showing product's detail information
`installUIConfig`	`object`	InstallUIConfig stands for the web UI config when deploying product
`isDisplay`	`boolean`	IsDisplay stands for if the product displaying on the products list
`logo`	`string`	Logo stands for the product logo with base64 encoded data uri
`platformVersionMatch`	`string`	PlatformVersionMatch stands for the product need match the platform version
`productResource`	`object`	ProductResource defines the target product CRD type
`singleApp`	`object`	SingleAppConfig stands for the config for SignleApp type
`subApp`	`object`	SubApp stands for the config for SubApp type
`type`	`string`	Type stands for the product's type
`upgradeUIConfig`	`array`	UpgradeUIConfig stands for the web UI config when upgrading product
`upgradeableVersions`	`array`	UpgradeableVersions stands for the versions can upgrade from

.spec.brief

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

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

.spec.chartVersions

Description: ChartVersions stands for the charts when deploying, they are optional and will be added to the Prouct CR
Type: array

.spec.chartVersions[]

Description: ChartVersion stands for chart version
Type: object
Required: nameversion

Property	Type	Description
`name`	`string`	Name stands for the chart's name
`version`	`string`	Version stands for the chart's version

.spec.commonConfigRef

Description: CommonConfigRef stands for the reference from CommonConfig to Product CR
Type: array

.spec.commonConfigRef[]

Description: KeysRef stands for key references with specified version
Type: object
Required: keysversionMatch

Property	Type	Description
`keys`	`array`	Keys stands for a set of keys
`versionMatch`	`string`	VersionMatch stands for the target version

.spec.commonConfigRef[].keys

Description: Keys stands for a set of keys
Type: array

.spec.commonConfigRef[].keys[]

Description: KeyRef stands for key reference
Type: object
Required: refKeytargetKey

Property	Type	Description
`refKey`	`string`	RefKey stands for source key
`targetKey`	`string`	TargetKey stands for target key

.spec.description

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

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

.spec.displayName

Description: DisplayName stands for the product'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

.spec.displayUIConfig

Description: DisplayUIConfig stands for the web UI type when showing product's detail information
Type: object
Required: type

Property	Type	Description
`scheme`	`object`	Scheme defines the dynamic form, used when Type is DynamicForm
`type`	`string`	Type defines the web UI type, [InUnderlord is DEPRECATED, use SubApp instead]

.spec.displayUIConfig.scheme

Description: Scheme defines the dynamic form, used when Type is DynamicForm
Type: object

.spec.installUIConfig

Description: InstallUIConfig stands for the web UI config when deploying product
Type: object
Required: type

Property	Type	Description
`scheme`	`object`	Scheme defines the dynamic form, used when Type is DynamicForm
`type`	`string`	Type defines the web UI type, [InUnderlord is DEPRECATED, use SubApp instead]

.spec.installUIConfig.scheme

Description: Scheme defines the dynamic form, used when Type is DynamicForm
Type: object

.spec.productResource

Description: ProductResource defines the target product CRD type
Type: object
Required: groupnamesversion

Property	Type	Description
`group`	`string`	Group stands for the target product's CRD Group
`names`	`object`	Names stands for the target product's CRD's kind name
`version`	`string`	Version stands for the target product's CRD version

.spec.productResource.names

Description: Names stands for the target product's CRD's kind name
Type: object
Required: kindplural

Property	Type	Description
`categories`	`array`	categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
`kind`	`string`	kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls.
`listKind`	`string`	listKind is the serialized kind of the list for this resource. Defaults to "`kind`List".
`plural`	`string`	plural is the plural name of the resource to serve. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase.
`shortNames`	`array`	shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.
`singular`	`string`	singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`.

.spec.productResource.names.categories

Description: categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`.
Type: array

.spec.productResource.names.categories[]

Type: string

.spec.productResource.names.shortNames

Description: shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase.
Type: array

.spec.productResource.names.shortNames[]

Type: string

.spec.singleApp

Description: SingleAppConfig stands for the config for SignleApp type
Type: object
Required: entrypoint

Property	Type	Description
`entrypoint`	`string`	Entrypoint stands for the entrypoint of standalone app

.spec.subApp

Description: SubApp stands for the config for SubApp type
Type: object
Required: entrypointname

Property	Type	Description
`entrypoint`	`string`	Entrypoint stands for the entrypoint of sub app
`name`	`string`	Name stands for the name of sub app

.spec.upgradeUIConfig

Description: UpgradeUIConfig stands for the web UI config when upgrading product
Type: array

.spec.upgradeUIConfig[]

Description: VersionedUIConfig stands for the web UI type with special version
Type: object
Required: typeversionMatch

Property	Type	Description
`scheme`	`object`	Scheme defines the dynamic form, used when Type is DynamicForm
`type`	`string`	Type defines the web UI type, [InUnderlord is DEPRECATED, use SubApp instead]
`versionMatch`	`string`	VersionMatch stands for the target version

.spec.upgradeUIConfig[].scheme

Description: Scheme defines the dynamic form, used when Type is DynamicForm
Type: object

.spec.upgradeableVersions

Description: UpgradeableVersions stands for the versions can upgrade from
Type: array

.spec.upgradeableVersions[]

Type: string

.status

Description: ProductConfigStatus defines the observed state of ProductConfig
Type: object
Required: messagephasereason

Property	Type	Description
`message`	`string`	Message contains the detail messages about the status
`phase`	`string`	Phase stands for the ProductConfig's status
`reason`	`string`	Reason explain why the ProductCongfig in this status

API Endpoints

The following API endpoints are available:

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

/apis/alauda.io/v1alpha1/productconfigs

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

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

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

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

HTTP method: POST
Description: create a new ProductConfig

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

HTTP responses

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

/apis/alauda.io/v1alpha1/productconfigs/{name}

HTTP method: DELETE
Description: delete the specified ProductConfig

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 ProductConfig
HTTP responses

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

HTTP method: PATCH
Description: partially update the specified ProductConfig

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	`ProductConfig` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified ProductConfig

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

HTTP responses

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

/apis/alauda.io/v1alpha1/productconfigs/{name}/status

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

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

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

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	`ProductConfig` schema
401 - Unauthorized	Empty

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

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

HTTP responses

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

#ProductConfig [alauda.io/v1alpha1]

Specification#

.spec#

.spec.brief#

.spec.chartVersions#

.spec.chartVersions[]#

.spec.commonConfigRef#

.spec.commonConfigRef[]#

.spec.commonConfigRef[].keys#

.spec.commonConfigRef[].keys[]#

.spec.description#

.spec.displayName#

.spec.displayUIConfig#

.spec.displayUIConfig.scheme#

.spec.installUIConfig#

.spec.installUIConfig.scheme#

.spec.productResource#

.spec.productResource.names#

.spec.productResource.names.categories#

.spec.productResource.names.categories[]#

.spec.productResource.names.shortNames#

.spec.productResource.names.shortNames[]#

.spec.singleApp#

.spec.subApp#

.spec.upgradeUIConfig#

.spec.upgradeUIConfig[]#

.spec.upgradeUIConfig[].scheme#

.spec.upgradeableVersions#

.spec.upgradeableVersions[]#

.status#

API Endpoints#

/apis/alauda.io/v1alpha1/productconfigs#

/apis/alauda.io/v1alpha1/productconfigs/{name}#

/apis/alauda.io/v1alpha1/productconfigs/{name}/status#

ProductConfig [alauda.io/v1alpha1]

Specification

.spec

.spec.brief

.spec.chartVersions

.spec.chartVersions[]

.spec.commonConfigRef

.spec.commonConfigRef[]

.spec.commonConfigRef[].keys

.spec.commonConfigRef[].keys[]

.spec.description

.spec.displayName

.spec.displayUIConfig

.spec.displayUIConfig.scheme

.spec.installUIConfig

.spec.installUIConfig.scheme

.spec.productResource

.spec.productResource.names

.spec.productResource.names.categories

.spec.productResource.names.categories[]

.spec.productResource.names.shortNames

.spec.productResource.names.shortNames[]

.spec.singleApp

.spec.subApp

.spec.upgradeUIConfig

.spec.upgradeUIConfig[]

.spec.upgradeUIConfig[].scheme

.spec.upgradeableVersions

.spec.upgradeableVersions[]

.status

API Endpoints

/apis/alauda.io/v1alpha1/productconfigs

/apis/alauda.io/v1alpha1/productconfigs/{name}

/apis/alauda.io/v1alpha1/productconfigs/{name}/status