ProductConfig [alauda.io/v1alpha1]

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

.spec

描述: ProductConfigSpec defines the desired state of ProductConfig
类型: object
必填: availableVersionbriefdescriptiondisplayNamedisplayUIConfiginstallUIConfiglogoplatformVersionMatchproductResourcetype

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

描述: Brief stands for the product's brief
类型: object

属性	类型	描述
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

.spec.chartVersions

描述: ChartVersions stands for the charts when deploying, they are optional and will be added to the Prouct CR
类型: array

.spec.chartVersions[]

描述: ChartVersion stands for chart version
类型: object
必填: nameversion

属性	类型	描述
`name`	`string`	Name stands for the chart's name
`version`	`string`	Version stands for the chart's version

.spec.commonConfigRef

描述: CommonConfigRef stands for the reference from CommonConfig to Product CR
类型: array

.spec.commonConfigRef[]

描述: KeysRef stands for key references with specified version
类型: object
必填: keysversionMatch

属性	类型	描述
`keys`	`array`	Keys stands for a set of keys
`versionMatch`	`string`	VersionMatch stands for the target version

.spec.commonConfigRef[].keys

描述: Keys stands for a set of keys
类型: array

.spec.commonConfigRef[].keys[]

描述: KeyRef stands for key reference
类型: object
必填: refKeytargetKey

属性	类型	描述
`refKey`	`string`	RefKey stands for source key
`targetKey`	`string`	TargetKey stands for target key

.spec.description

描述: Description stands for the product's description
类型: object

属性	类型	描述
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

.spec.displayName

描述: DisplayName stands for the product's display name
类型: object

属性	类型	描述
`en`	`string`	EN stands for text with English
`zh`	`string`	ZH stands for text with Simple Chinese

.spec.displayUIConfig

描述: DisplayUIConfig stands for the web UI type when showing product's detail information
类型: object
必填: type

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

描述: Scheme defines the dynamic form, used when Type is DynamicForm
类型: object

.spec.installUIConfig

描述: InstallUIConfig stands for the web UI config when deploying product
类型: object
必填: type

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

描述: Scheme defines the dynamic form, used when Type is DynamicForm
类型: object

.spec.productResource

描述: ProductResource defines the target product CRD type
类型: object
必填: groupnamesversion

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

描述: Names stands for the target product's CRD's kind name
类型: object
必填: kindplural

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

描述: 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`.
类型: array

.spec.productResource.names.categories[]

类型: string

.spec.productResource.names.shortNames

描述: 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.
类型: array

.spec.productResource.names.shortNames[]

类型: string

.spec.singleApp

描述: SingleAppConfig stands for the config for SignleApp type
类型: object
必填: entrypoint

属性	类型	描述
`entrypoint`	`string`	Entrypoint stands for the entrypoint of standalone app

.spec.subApp

描述: SubApp stands for the config for SubApp type
类型: object
必填: entrypointname

属性	类型	描述
`entrypoint`	`string`	Entrypoint stands for the entrypoint of sub app
`name`	`string`	Name stands for the name of sub app

.spec.upgradeUIConfig

描述: UpgradeUIConfig stands for the web UI config when upgrading product
类型: array

.spec.upgradeUIConfig[]

描述: VersionedUIConfig stands for the web UI type with special version
类型: object
必填: typeversionMatch

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

描述: Scheme defines the dynamic form, used when Type is DynamicForm
类型: object

.spec.upgradeableVersions

描述: UpgradeableVersions stands for the versions can upgrade from
类型: array

.spec.upgradeableVersions[]

类型: string

.status

描述: ProductConfigStatus defines the observed state of ProductConfig
类型: object
必填: messagephasereason

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

可用的 API 端点如下：

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

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

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

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

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

查询参数

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

HTTP 响应

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

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

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

查询参数

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

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

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

查询参数

参数	类型	描述
`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	`ProductConfig` schema
401 - Unauthorized	Empty

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

查询参数

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

HTTP 响应

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

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

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

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

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

查询参数

参数	类型	描述
`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	`ProductConfig` schema
401 - Unauthorized	Empty

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

查询参数

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

HTTP 响应

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

#ProductConfig [alauda.io/v1alpha1]

#规格

#.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 端点#

/apis/alauda.io/v1alpha1/productconfigs#

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

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

ProductConfig [alauda.io/v1alpha1]

规格

.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 端点

/apis/alauda.io/v1alpha1/productconfigs

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

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