Skip to main content
Version: latest

Returns the specified TKE cloud config

GET 

/v1/cloudconfigs/tke/:configUid

Returns the specified TKE cloud config

Request

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Responses

OK

Schema

    metadata

    object

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations

    object

    Annotations are system generated key value metadata for the resource. As an input certain annotations like description can be set.

    property name*string
    creationTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    deletionTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    labels

    object

    Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

    property name*string
    lastModifiedTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    namestring

    Name of the resource.

    uidstring

    UID is the unique identifier generated for the resource. This is not an input field for any request.

    spec

    object

    TencentCloudConfigSpec defines the cloud configuration input by user This will translate to clusterspec/machinespec for cluster-api

    cloudAccountRef

    object

    ObjectReference contains enough information to let you inspect or modify the referred object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

    namestring

    Name of the referent.

    uidstring

    UID of the referent.

    clusterConfig

    object

    Cluster level configuration for tencent cloud and applicable for all the machine pools

    endpointAccess

    object

    Endpoints specifies access to this cluster's control plane endpoints

    IsExtranetboolean

    IsExtranet Whether it is external network access (TRUE external network access FALSE internal network access, default value: FALSE)

    privateboolean

    Private points VPC-internal control plane access to the private endpoint

    privateCIDRstring

    Deprecated. PrivateCIDRs specifies which blocks can access the public endpoint

    publicboolean

    Public controls whether control plane endpoints are publicly accessible

    publicCIDRsstring[]

    Deprecated. PublicCIDRs specifies which blocks can access the public endpoint

    securityGroupstring

    Tencent security group

    subnetIdstring

    Tencent Subnet

    regionstringrequired
    sshKeyIDsstring[]
    vpcIDstring

    VPC Id to deploy cluster into should have one public and one private subnet for the the cluster creation, this field is optional, If VPC Id is not provided a fully managed VPC will be created

    machinePoolConfig

    object[]

  • Array [

  • additionalLabels

    object

    AdditionalLabels

    property name*string

    additionalTags

    object

    AdditionalTags is an optional set of tags to add to resources managed by the provider, in addition to the ones added by default. For eg., tags for EKS nodeGroup or EKS NodegroupIAMRole

    property name*string
    azsstring[]

    AZs is only used for dynamic placement

    instanceConfig

    categorystring
    cpuSetint64
    diskGiBint64
    memoryMiBint64

    MemoryMiB is the size of a virtual machine's memory, in MiB

    namestring
    numCPUsint32

    NumCPUs is the number of virtual processors in a virtual machine

    instanceTypestring

    instance type

    isControlPlaneboolean

    whether this pool is for control plane

    labelsstring[]

    labels for this pool, example: master/worker, gpu, windows

    machinePoolProperties

    object

    Machine pool specific properties

    archTypestring

    Possible values: [amd64, arm64]

    Default value: amd64

    Architecture type of the pool. Default value is 'amd64'

    maxSizeint32

    max size of the pool, for scaling

    minSizeint32

    min size of the pool, for scaling

    namestring
    nodeRepaveIntervalint32

    Minimum number of seconds a node should be Ready, before the next node is selected for repave. Applicable only for workerpools in infrastructure cluster

    rootDeviceSizeint64

    rootDeviceSize in GBs

    sizeint32

    size of the pool, number of machines

    subnetIds

    object

    AZ to subnet mapping filled by ally from hubble SubnetIDs ["ap-guangzhou-6"] = "subnet-079b6061" This field is optional If we don't provide a subnetId then by default the first subnet from the AZ will be picked up for deployment

    property name*string

    taints

    object[]

    master or worker taints

  • Array [

  • effectstring

    Possible values: [NoSchedule, PreferNoSchedule, NoExecute]

    keystring

    The taint key to be applied to a node

    timeAddeddate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    valuestring

    The taint value corresponding to the taint key.

  • ]

  • updateStrategy

    object

    rolling update strategy for this machinepool if not specified, will use ScaleOut

    typestring

    Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]

    update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut

    useControlPlaneAsWorkerboolean

    if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools

  • ]

Loading...