Skip to main content

Returns the specified GKE cloud config

GET 
/v1/cloudconfigs/gke/:configUid

Returns the specified GKE 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

    apiVersionstring

    Deprecated. Not used for the resource info. 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

    Cloud type of the cloud config

    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

    GcpCloudConfigSpec 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 gcp cloud and applicable for all the machine pools

    managedClusterConfig

    object

    GCP managed cluster config

    enableAutoPilotboolean

    EnableAutopilot indicates whether to enable autopilot for this GKE cluster

    locationstring

    Can be Region or Zone

    networkstring

    NetworkName if empty would create VPC Network in auto mode. If provided, custom VPC network will be used

    projectstringrequired

    Name of the project in which cluster is to be deployed

    regionstringrequired

    GCP region for the cluster

    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[]

    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

    instanceTypestringrequired
    isControlPlanebooleanrequired

    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

    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

    Size of root volume in GB. Default is 30GB

    sizeint32

    size of the pool, number of machines

    subnetstring

    Subnet specifies the subnetwork to use for given instance. If not specified, the first subnet from the cluster region and network is used

    subnetIds

    object

    AZ to subnet mapping filled by ally from hubble SubnetIDs ["us-west-2d"] = "subnet-079b6061" This field is optional If we don't provide a subnetId then by default the first private 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

    UpdatesStrategy will be used to translate to RollingUpdateStrategy of a MachineDeployment We'll start with default values for the translation, can expose more details later Following is details of parameters translated from the type ScaleOut => maxSurge=1, maxUnavailable=0 ScaleIn => maxSurge=0, maxUnavailable=1

    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

  • ]

    • status

    object

    GcpCloudConfigStatus defines the observed state of GcpCloudConfig The cloudimage info built by Mold is stored here image should be mapped to a specific machinepool

    ansibleRoleDigeststring

    For mold controller to identify if is there any changes in Pack

    conditions

    object[]

    spectroAnsibleProvisioner: should be added only once, subsequent recocile will use the same provisioner SpectroAnsiblePacker bool json:"spectroAnsiblePacker,omitempty"

  • Array [

    • lastProbeTimedate-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.

    lastTransitionTimedate-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.

    messagestring

    Human-readable message indicating details about last transition.

    reasonstring

    Unique, one-word, CamelCase reason for the condition's last transition.

    statusstringrequired
    typestringrequired

  • ]

    • images

    object

    Refers to GCP image

    namestring
    osstring
    regionstring
    statestring
    isAddonLayerboolean

    addon layers present in spc

    roleDigest

    object

    this map will be for ansible roles present in each pack

    property name*string
    sourceImageIdstring

    sourceImageId, it can be from packref's annotations or from pack.json

    useCapiImageboolean

    PackerVariableDigest string json:"packerDigest,omitempty" If no ansible roles found in Packs then Mold should tell Drive to use capi image and not create custom image, because there is nothing to add

Loading...