ModuleInfo [moduleinfoes.cluster.alauda.io/v1alpha1]

Description: ModuleInfo is the Schema for the moduleinfos 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`	ModuleInfoSpec defines the spec of ModuleInfo
`status`	`object`	ModuleInfoStatus defines the observed state of ModuleInfo

.spec

Description: ModuleInfoSpec defines the spec of ModuleInfo
Type: object
Required: version

Property	Type	Description
`config`	`object`	Config stands for the user configs of the module instance
`entrypoint`	`string`	Entrypoint stands for the entrypoint on the web GUI for this module instance
`selectedCluster`	`object`	SelectedCluster stands for the selected cluster of the module instance
`valuesOverride`	`object`	ValuesOverride stands for the overrides for charts
`version`	`string`	Version stands for the target version of the module

.spec.config

Description: Config stands for the user configs of the module instance
Type: object

.spec.selectedCluster

Description: SelectedCluster stands for the selected cluster of the module instance
Type: object

.spec.valuesOverride

Description: ValuesOverride stands for the overrides for charts
Type: object

.status

Description: ModuleInfoStatus defines the observed state of ModuleInfo
Type: object
Required: phaseversion

Property	Type	Description
`appReleases`	`array`	AppReleases stands for the module's app releases
`availableVersions`	`array`	AvailableVersions stands for the available versions of the module can upgrade to.
`blockReasons`	`array`	BlockReasons stands for the reasons blocked upgrade
`conditions`	`array`	Conditions stands for the moudle's conditions
`moduleconfigSpecHash`	`string`	Hash stands for the has of ModuleConfig Spec
`phase`	`string`	Phase stands for the module's status
`removeIsPrevented`	`boolean`	RemoveIsPrevented stands for you can not remove this plugin right now for some reason.
`specHash`	`string`	Hash stands for the has of ModuleInfo Spec
`transitTimeout`	`integer`	TransitTimeout is the timeout duration for upgrade.
`transitTimestamp`	`string`	TransitTimestamp stands for the timestamp of the version changed
`transitVersion`	`string`	TransitVersion stands for the module's transit version used for upgrade
`version`	`string`	Version stands for the module's current version

.status.appReleases

Description: AppReleases stands for the module's app releases
Type: array

.status.appReleases[]

Description: AppReleaseStatus defines the status of the app release
Type: object
Required: failednamereadysynced

Property	Type	Description
`chartVersions`	`array`
`failed`	`boolean`
`lastProbeTime`	`string`
`message`	`string`
`name`	`string`
`namespace`	`string`
`ready`	`boolean`
`reason`	`string`
`synced`	`boolean`

.status.appReleases[].chartVersions

Type: array

.status.appReleases[].chartVersions[]

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

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

.status.availableVersions

Description: AvailableVersions stands for the available versions of the module can upgrade to.
Type: array

.status.availableVersions[]

Description: ModuleAvailableVersion defines module's available upgrade version
Type: object
Required: descriptionriskLevelversion

Property	Type	Description
`dependencies`	`array`	Dependencies stands for the dependent modules
`description`	`string`	Description stands for the description of uprading to this version
`descriptionEn`	`string`	DescriptionEn stands for the description of uprading to this version in English
`options`	`object`	Options stands for the options of uprading to this version
`riskLevel`	`string`	RiskLevel stands for the risk level of uprading to this version
`upgradeBefore`	`array`	UpgradeBefore stands for need upgrade before these mouldes
`version`	`string`	Version stands for the version of the module can upgrade to

.status.availableVersions[].dependencies

Description: Dependencies stands for the dependent modules
Type: array

.status.availableVersions[].dependencies[]

Description: ModuleDependency defines the module's dependency
Type: object
Required: moduleName

Property	Type	Description
`instanceName`	`string`	InstanceName stands for the dependent module's ModuleInfo CR's name
`moduleName`	`string`	ModuleName stands for the dependent module's name
`versionsMatch`	`array`	VersionMatch stands for the version requirements for the dependent module, any match will be acceptable.

.status.availableVersions[].dependencies[].versionsMatch

Description: VersionMatch stands for the version requirements for the dependent module, any match will be acceptable.
Type: array

.status.availableVersions[].dependencies[].versionsMatch[]

Type: string

.status.availableVersions[].options

Description: Options stands for the options of uprading to this version
Type: object

.status.availableVersions[].upgradeBefore

Description: UpgradeBefore stands for need upgrade before these mouldes
Type: array

.status.availableVersions[].upgradeBefore[]

Description: ModuleRef defines the reference for the module
Type: object
Required: moduleName

Property	Type	Description
`moduleName`	`string`	ModuleName stands for the dependent module's name

.status.blockReasons

Description: BlockReasons stands for the reasons blocked upgrade
Type: array

.status.blockReasons[]

Type: string

.status.conditions

Description: Conditions stands for the moudle's conditions
Type: array

.status.conditions[]

Description: ModuleCondition defines the module's conditions
Type: object
Required: messagereasonstatustype

Property	Type	Description
`lastProbeTime`	`string`	LastProbeTime stands for the timestamp to probe status
`lastTransitionTime`	`string`	LastTransitionTime stands for the timestamp of the status changed
`message`	`string`	Message contains the detail information why in the current status
`reason`	`string`	Reason contains the reason why in the current status
`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/cluster.alauda.io/v1alpha1/moduleinfos
- DELETE: delete collection of ModuleInfo
- GET: list objects of kind ModuleInfo
- POST: create a new ModuleInfo
/apis/cluster.alauda.io/v1alpha1/moduleinfos/{name}
- DELETE: delete the specified ModuleInfo
- GET: read the specified ModuleInfo
- PATCH: partially update the specified ModuleInfo
- PUT: replace the specified ModuleInfo
/apis/cluster.alauda.io/v1alpha1/moduleinfos/{name}/status
- GET: read status of the specified ModuleInfo
- PATCH: partially update status of the specified ModuleInfo
- PUT: replace status of the specified ModuleInfo

/apis/cluster.alauda.io/v1alpha1/moduleinfos

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

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

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

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

HTTP method: POST
Description: create a new ModuleInfo

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

HTTP responses

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

/apis/cluster.alauda.io/v1alpha1/moduleinfos/{name}

HTTP method: DELETE
Description: delete the specified ModuleInfo

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

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

HTTP method: PATCH
Description: partially update the specified ModuleInfo

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

HTTP method: PUT
Description: replace the specified ModuleInfo

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

HTTP responses

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

/apis/cluster.alauda.io/v1alpha1/moduleinfos/{name}/status

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

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

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

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

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

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

HTTP responses

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

#ModuleInfo [moduleinfoes.cluster.alauda.io/v1alpha1]

Specification#

.spec#

.spec.config#

.spec.selectedCluster#

.spec.valuesOverride#

.status#

.status.appReleases#

.status.appReleases[]#

.status.appReleases[].chartVersions#

.status.appReleases[].chartVersions[]#

.status.availableVersions#

.status.availableVersions[]#

.status.availableVersions[].dependencies#

.status.availableVersions[].dependencies[]#

.status.availableVersions[].dependencies[].versionsMatch#

.status.availableVersions[].dependencies[].versionsMatch[]#

.status.availableVersions[].options#

.status.availableVersions[].upgradeBefore#

.status.availableVersions[].upgradeBefore[]#

.status.blockReasons#

.status.blockReasons[]#

.status.conditions#

.status.conditions[]#

API Endpoints#

/apis/cluster.alauda.io/v1alpha1/moduleinfos#

/apis/cluster.alauda.io/v1alpha1/moduleinfos/{name}#

/apis/cluster.alauda.io/v1alpha1/moduleinfos/{name}/status#

ModuleInfo [moduleinfoes.cluster.alauda.io/v1alpha1]

Specification

.spec

.spec.config

.spec.selectedCluster

.spec.valuesOverride

.status

.status.appReleases

.status.appReleases[]

.status.appReleases[].chartVersions

.status.appReleases[].chartVersions[]

.status.availableVersions

.status.availableVersions[]

.status.availableVersions[].dependencies

.status.availableVersions[].dependencies[]

.status.availableVersions[].dependencies[].versionsMatch

.status.availableVersions[].dependencies[].versionsMatch[]

.status.availableVersions[].options

.status.availableVersions[].upgradeBefore

.status.availableVersions[].upgradeBefore[]

.status.blockReasons

.status.blockReasons[]

.status.conditions

.status.conditions[]

API Endpoints

/apis/cluster.alauda.io/v1alpha1/moduleinfos

/apis/cluster.alauda.io/v1alpha1/moduleinfos/{name}

/apis/cluster.alauda.io/v1alpha1/moduleinfos/{name}/status