Alauda Container Platform
  • 简体中文

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

    描述
    ModuleInfo is the Schema for the moduleinfos API
    类型
    object

    规格

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

    ModuleInfoSpec defines the spec of ModuleInfo

    statusobject

    ModuleInfoStatus defines the observed state of ModuleInfo

    .spec

    描述
    ModuleInfoSpec defines the spec of ModuleInfo
    类型
    object
    必填
    version
    属性类型描述
    configobject

    Config stands for the user configs of the module instance

    entrypointstring

    Entrypoint stands for the entrypoint on the web GUI for this module instance

    selectedClusterobject

    SelectedCluster stands for the selected cluster of the module instance

    valuesOverrideobject

    ValuesOverride stands for the overrides for charts

    versionstring

    Version stands for the target version of the module

    .spec.config

    描述
    Config stands for the user configs of the module instance
    类型
    object

    .spec.selectedCluster

    描述
    SelectedCluster stands for the selected cluster of the module instance
    类型
    object

    .spec.valuesOverride

    描述
    ValuesOverride stands for the overrides for charts
    类型
    object

    .status

    描述
    ModuleInfoStatus defines the observed state of ModuleInfo
    类型
    object
    必填
    phaseversion
    属性类型描述
    appReleasesarray

    AppReleases stands for the module's app releases

    availableVersionsarray

    AvailableVersions stands for the available versions of the module can upgrade to.

    blockReasonsarray

    BlockReasons stands for the reasons blocked upgrade

    conditionsarray

    Conditions stands for the moudle's conditions

    moduleconfigSpecHashstring

    Hash stands for the has of ModuleConfig Spec

    phasestring

    Phase stands for the module's status

    removeIsPreventedboolean

    RemoveIsPrevented stands for you can not remove this plugin right now for some reason.

    specHashstring

    Hash stands for the has of ModuleInfo Spec

    transitTimeoutinteger

    TransitTimeout is the timeout duration for upgrade.

    transitTimestampstring

    TransitTimestamp stands for the timestamp of the version changed

    transitVersionstring

    TransitVersion stands for the module's transit version used for upgrade

    versionstring

    Version stands for the module's current version

    .status.appReleases

    描述
    AppReleases stands for the module's app releases
    类型
    array

    .status.appReleases[]

    描述
    AppReleaseStatus defines the status of the app release
    类型
    object
    必填
    failednamereadysynced
    属性类型描述
    chartVersionsarray
    failedboolean
    lastProbeTimestring
    messagestring
    namestring
    namespacestring
    readyboolean
    reasonstring
    syncedboolean

    .status.appReleases[].chartVersions

    类型
    array

    .status.appReleases[].chartVersions[]

    描述
    ChartVersion stands for chart version
    类型
    object
    必填
    namereleaseNameversion
    属性类型描述
    namestring

    Name stands for the chart's name

    releaseNamestring

    ReleaseName stands for the release name

    versionstring

    Version stands for the chart's version

    .status.availableVersions

    描述
    AvailableVersions stands for the available versions of the module can upgrade to.
    类型
    array

    .status.availableVersions[]

    描述
    ModuleAvailableVersion defines module's available upgrade version
    类型
    object
    必填
    descriptionriskLevelversion
    属性类型描述
    dependenciesarray

    Dependencies stands for the dependent modules

    descriptionstring

    Description stands for the description of uprading to this version

    descriptionEnstring

    DescriptionEn stands for the description of uprading to this version in English

    optionsobject

    Options stands for the options of uprading to this version

    riskLevelstring

    RiskLevel stands for the risk level of uprading to this version

    upgradeBeforearray

    UpgradeBefore stands for need upgrade before these mouldes

    versionstring

    Version stands for the version of the module can upgrade to

    .status.availableVersions[].dependencies

    描述
    Dependencies stands for the dependent modules
    类型
    array

    .status.availableVersions[].dependencies[]

    描述
    ModuleDependency defines the module's dependency
    类型
    object
    必填
    moduleName
    属性类型描述
    instanceNamestring

    InstanceName stands for the dependent module's ModuleInfo CR's name

    moduleNamestring

    ModuleName stands for the dependent module's name

    versionsMatcharray

    VersionMatch stands for the version requirements for the dependent module, any match will be acceptable.

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

    描述
    VersionMatch stands for the version requirements for the dependent module, any match will be acceptable.
    类型
    array

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

    类型
    string

    .status.availableVersions[].options

    描述
    Options stands for the options of uprading to this version
    类型
    object

    .status.availableVersions[].upgradeBefore

    描述
    UpgradeBefore stands for need upgrade before these mouldes
    类型
    array

    .status.availableVersions[].upgradeBefore[]

    描述
    ModuleRef defines the reference for the module
    类型
    object
    必填
    moduleName
    属性类型描述
    moduleNamestring

    ModuleName stands for the dependent module's name

    .status.blockReasons

    描述
    BlockReasons stands for the reasons blocked upgrade
    类型
    array

    .status.blockReasons[]

    类型
    string

    .status.conditions

    描述
    Conditions stands for the moudle's conditions
    类型
    array

    .status.conditions[]

    描述
    ModuleCondition defines the module's conditions
    类型
    object
    必填
    messagereasonstatustype
    属性类型描述
    lastProbeTimestring

    LastProbeTime stands for the timestamp to probe status

    lastTransitionTimestring

    LastTransitionTime stands for the timestamp of the status changed

    messagestring

    Message contains the detail information why in the current status

    reasonstring

    Reason contains the reason why in the current status

    statusstring

    Status stands for condition's status

    typestring

    Type stands for condition's type

    API 端点

    可用的 API 端点如下：

    • /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 方法
    DELETE
    描述
    delete collection of ModuleInfo
    HTTP 响应
    HTTP 状态码响应体
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    list objects of kind ModuleInfo
    HTTP 响应
    HTTP 状态码响应体
    200 - OKModuleInfoList schema
    401 - UnauthorizedEmpty
    HTTP 方法
    POST
    描述
    create a new ModuleInfo
    查询参数
    参数类型描述
    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.
    请求体参数
    参数类型描述
    bodyModuleInfo schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKModuleInfo schema
    201 - CreatedModuleInfo schema
    202 - AcceptedModuleInfo schema
    401 - UnauthorizedEmpty

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

    HTTP 方法
    DELETE
    描述
    delete the specified ModuleInfo
    查询参数
    参数类型描述
    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 响应
    HTTP 状态码响应体
    200 - OKStatus schema
    202 - AcceptedStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    read the specified ModuleInfo
    HTTP 响应
    HTTP 状态码响应体
    200 - OKModuleInfo schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update the specified ModuleInfo
    查询参数
    参数类型描述
    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 响应
    HTTP 状态码响应体
    200 - OKModuleInfo schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace the specified ModuleInfo
    查询参数
    参数类型描述
    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.
    请求体参数
    参数类型描述
    bodyModuleInfo schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKModuleInfo schema
    201 - CreatedModuleInfo schema
    401 - UnauthorizedEmpty

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

    HTTP 方法
    GET
    描述
    read status of the specified ModuleInfo
    HTTP 响应
    HTTP 状态码响应体
    200 - OKModuleInfo schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update status of the specified ModuleInfo
    查询参数
    参数类型描述
    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 响应
    HTTP 状态码响应体
    200 - OKModuleInfo schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace status of the specified ModuleInfo
    查询参数
    参数类型描述
    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.
    请求体参数
    参数类型描述
    bodyModuleInfo schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKModuleInfo schema
    201 - CreatedModuleInfo schema
    401 - UnauthorizedEmpty