Alauda Container Platform
  • 简体中文

    • ProductBase [product.alauda.io/v1alpha1]

    描述
    ProductBase is the Schema for the productbases 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

    ProductBaseSpec defines the desired state of ProductBase

    statusobject

    ProductBaseStatus defines the observed state of ProductBase

    .spec

    描述
    ProductBaseSpec defines the desired state of ProductBase
    类型
    object
    必填
    defaultAdminhttpplatformURLregistryversion
    属性类型描述
    alternativeURLsarray

    AlternativeURLs is the platform's alternative urls

    defaultAdminobject

    DefaultAdmin stands for the admin's config

    defaultRedirectPathstring

    DefaultRedirectPath stands for the default redirect path

    globalConfigobject

    GlobalConfig stands for the global config

    httpobject

    HTTP stands for the http config

    ingressobject

    Ingress stands for the ingress configs

    platformPublicURLstring

    PlatformPublicURL stands the platform's public url

    platformURLstring

    PlatformURL is the platform's access url

    productBrandstring

    ProductBrand values: TKE、ACP、Common

    registryobject

    Registry is Docker Registry's Config

    replicasinteger

    Replicas stands for the deploy replicas

    versionstring

    Version stands for this product's version to deploy

    .spec.alternativeURLs

    描述
    AlternativeURLs is the platform's alternative urls
    类型
    array

    .spec.alternativeURLs[]

    类型
    string

    .spec.defaultAdmin

    描述
    DefaultAdmin stands for the admin's config
    类型
    object
    必填
    accountemail
    属性类型描述
    accountstring

    Account stands for admin's account

    emailstring

    Email stands for admin's email

    hashstring

    Hash stands for admin's password hash

    .spec.globalConfig

    描述
    GlobalConfig stands for the global config
    类型
    object
    属性类型描述
    labelsobject

    .spec.globalConfig.labels

    类型
    object

    .spec.http

    描述
    HTTP stands for the http config
    类型
    object
    必填
    forceRedirectHttps
    属性类型描述
    forceRedirectHttpsboolean

    ForceRedirectHTTPS stands for if force redirect to https

    httpPortinteger

    HTTPPort is the port of http

    httpsPortinteger

    HTTPPort is the port of https

    tlsobject

    TLS statnds for the server's TLS Certificate

    .spec.http.tls

    描述
    TLS statnds for the server's TLS Certificate
    类型
    object
    属性类型描述
    secretRefobject

    SecretRef is the reference for tls secret

    .spec.http.tls.secretRef

    描述
    SecretRef is the reference for tls secret
    类型
    object
    必填
    name
    属性类型描述
    namestring

    Name is the name of secret

    .spec.ingress

    描述
    Ingress stands for the ingress configs
    类型
    object
    必填
    controllerhostingressClassName
    属性类型描述
    annotationsobject
    controllerobject

    Controller stands for the ingress controller configs

    hoststring

    Host stands for the host config in ingress

    ingressClassNamestring

    IngressClassName stands for the ingressClassName of the ingress

    .spec.ingress.annotations

    类型
    object

    .spec.ingress.controller

    描述
    Controller stands for the ingress controller configs
    类型
    object
    必填
    install
    属性类型描述
    installboolean

    Install stands for if install ingress controller

    nodesarray

    Nodes stands for the ingress controller's running node

    .spec.ingress.controller.nodes

    描述
    Nodes stands for the ingress controller's running node
    类型
    array

    .spec.ingress.controller.nodes[]

    类型
    string

    .spec.registry

    描述
    Registry is Docker Registry's Config
    类型
    object
    必填
    addresspreferPlatformURL
    属性类型描述
    addressstring

    Address is Docker Registry's address

    externalboolean

    External stands for a external registry

    preferPlatformURLboolean

    PreferPlatformURL stands for business cluster prefer platform URL as registry address

    secretRefobject

    SecretRef is the reference for pullImageSecret

    .spec.registry.secretRef

    描述
    SecretRef is the reference for pullImageSecret
    类型
    object
    必填
    name
    属性类型描述
    namestring

    Name is the name of secret

    .status

    描述
    ProductBaseStatus defines the observed state of ProductBase
    类型
    object
    必填
    phaseversion
    属性类型描述
    artifactsarray

    Artifacts stands for the product's artifacts

    conditionsarray

    Conditions contains this product's conditions

    globalIDstring

    GlobalID stands for the global Id

    phasestring

    Phase stands for this product's phase

    replicasinteger

    Replicas stands for the product workload replicas

    versionstring

    Version statnds for this product's current version

    .status.artifacts

    描述
    Artifacts stands for the product's artifacts
    类型
    array

    .status.artifacts[]

    描述
    Artifact stands for the artifact's info
    类型
    object
    必填
    channelsnamepackageType
    属性类型描述
    channelsarray

    Channels stands for the artifact's channels

    namestring

    Name stands for the artifact's name

    packageTypestring

    PackageType stands for the artifact's package type

    .status.artifacts[].channels

    描述
    Channels stands for the artifact's channels
    类型
    array

    .status.artifacts[].channels[]

    描述
    Channel stands for the artifact's channel
    类型
    object
    必填
    artifactStatuschanneldefaultdisplayNamerepositorytag
    属性类型描述
    artifactStatusstring

    ArtifactStatus stands for the channel's artifact status

    briefobject

    Brief stands for the artifact's brief

    catalogSourcestring

    CatalogSource stands for the catalog source to get the operator bundle

    categoriesarray

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

    channelstring

    Channel stands for the channel's name

    defaultboolean

    Default stands for the artifact's default channel

    descriptionobject

    Description stands for the channel's description

    digeststring

    Digest stands for the channel's digest

    displayNameobject

    DisplayName stands for the artifact's display name

    hiddenboolean

    Hidden stands for the artifact is hidden on the Marketplace's page

    packIgnoreboolean

    PackIgnore indicates whether to skip packaging

    providerobject

    Provider stands for the artifact's provider

    providerTypestring

    ProviderType stands for the artifact's provider type, such as: platform, certified, custom, community

    repositorystring

    Repository stands for the channel's repository

    supportedArchitecturesarray

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

    supportedPlatformVersionsarray

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

    supportedProtocolStacksarray

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

    tagstring

    Tag stands for the channel's tag

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

    描述
    Brief stands for the artifact's brief
    类型
    object
    属性类型描述
    enstring

    EN stands for text with English

    zhstring

    ZH stands for text with Simple Chinese

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

    描述
    Categories stands for the artifact's categories, such as: AI, Database, etc.
    类型
    array

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

    类型
    string

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

    描述
    Description stands for the channel's description
    类型
    object
    属性类型描述
    enstring

    EN stands for text with English

    zhstring

    ZH stands for text with Simple Chinese

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

    描述
    DisplayName stands for the artifact's display name
    类型
    object
    属性类型描述
    enstring

    EN stands for text with English

    zhstring

    ZH stands for text with Simple Chinese

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

    描述
    Provider stands for the artifact's provider
    类型
    object
    属性类型描述
    enstring

    EN stands for text with English

    zhstring

    ZH stands for text with Simple Chinese

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

    描述
    SupportedArchitectures stands for the supported architectures, such as: amd64, arm64, etc.
    类型
    array

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

    类型
    string

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

    描述
    SupportedPlatformVersions stands for the supported platform versions, such as: v4.0, v4.1, etc.
    类型
    array

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

    类型
    string

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

    描述
    SupportedProtocolStacks stands for the supported protocol stacks, such as: IPv4, IPv6, DualStack, etc.
    类型
    array

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

    类型
    string

    .status.conditions

    描述
    Conditions contains this product's conditions
    类型
    array

    .status.conditions[]

    描述
    ProductBaseCondition ...
    类型
    object
    必填
    statustype
    属性类型描述
    lastHeartbeatTimestring

    LastHeartbeatTime stands for the timestamp to check Condition

    lastTransitionTimestring

    LastTransitionTime stands for the timestamp of Condition's status changed

    messagestring

    Message stands for Condition's message

    reasonstring

    Reason stands for Condition's reason

    statusstring

    Status stands for Condition's status

    typestring

    Type stands for Condition's type

    API 端点

    可用的 API 端点如下：

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

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

    HTTP 方法
    DELETE
    描述
    delete the specified ProductBase
    查询参数
    参数类型描述
    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 ProductBase
    HTTP 响应
    HTTP 状态码响应体
    200 - OKProductBase schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update the specified ProductBase
    查询参数
    参数类型描述
    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 - OKProductBase schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace the specified ProductBase
    查询参数
    参数类型描述
    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.
    请求体参数
    参数类型描述
    bodyProductBase schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKProductBase schema
    201 - CreatedProductBase schema
    401 - UnauthorizedEmpty

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

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