Skip to main content

Returns the specified Azure cloud config

GET 
/v1/cloudconfigs/azure/:configUid

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

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

    aadProfile

    object

    AADProfile - AAD integration is managed by AKS.

    adminGroupObjectIDsstring[]required

    AdminGroupObjectIDs - AAD group object IDs that will have admin role of the cluster.

    managedbooleanrequired

    Managed - Whether to enable managed AAD.

    apiServerAccessProfile

    object

    APIServerAccessProfile - access profile for AKS API server.

    authorizedIPRangesstring[]

    AuthorizedIPRanges - Authorized IP Ranges to kubernetes API server.

    enablePrivateClusterboolean

    EnablePrivateCluster - Whether to create the cluster as a private cluster or not.

    enablePrivateClusterPublicFQDNboolean

    EnablePrivateClusterPublicFQDN - Whether to create additional public FQDN for private cluster or not.

    privateDNSZonestring

    PrivateDNSZone - Private dns zone mode for private cluster.

    containerNamestring

    controlPlaneSubnet

    object

    cidrBlockstring

    CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.

    namestring
    securityGroupNamestring

    Network Security Group(NSG) to be attached to subnet. NSG for a control plane subnet, should allow inbound to port 6443, as port 6443 is used by kubeadm to bootstrap the control planes

    enablePrivateClusterboolean

    Deprecated. use apiServerAccessProfile.enablePrivateCluster

    infraLBConfig

    object

    apiServerLB

    object

    LoadBalancerSpec defines an Azure load balancer.

    apiServerLBStaticIPstring
    ipAllocationMethodstring

    Possible values: [Static, Dynamic]

    Default value: Dynamic

    privateDNSNamestring
    typestring

    Possible values: [Internal, Public]

    Default value: Public

    Load Balancer type

    locationstringrequired

    Location is the Azure datacenter location

    resourceGroupstring
    sshKeystringrequired
    storageAccountNamestring
    subscriptionIdstringrequired

    Subscription ID is unique identifier for the subscription used to access Azure services

    vnetCidrBlockstring
    vnetNamestring

    VNETName is the virtual network in which the cluster is to be provisioned.

    vnetResourceGroupstring

    workerSubnet

    object

    cidrBlockstring

    CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.

    namestring
    securityGroupNamestring

    Network Security Group(NSG) to be attached to subnet. NSG for a control plane subnet, should allow inbound to port 6443, as port 6443 is used by kubeadm to bootstrap the control planes

    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

    instanceTypestring

    Instance type stands for VMSize in Azure

    isControlPlanebooleanrequired

    whether this pool is for control plane

    isSystemNodePoolboolean

    whether this pool is for system node Pool

    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

    osDisk

    object

    diskSizeGBint32

    managedDisk

    object

    storageAccountTypestring
    osTypestring

    Possible values: [Linux, Windows]

    Default value: Linux

    osTypestring

    Possible values: [Linux, Windows]

    Default value: Linux

    sizeint32

    size of the pool, number of machines

    spotVMOptions

    object

    SpotVMOptions defines the options relevant to running the Machine on Spot VMs

    maxPricestring

    MaxPrice defines the maximum price the user is willing to pay for Spot VM instances

    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

    AzureCloudConfigStatus defines the observed state of AzureCloudConfig 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 Azure Shared Gallery image

    gallerystring
    namestring
    resourceGroupstring
    statestring
    subscriptionIDstring
    versionstring
    isAddonLayerboolean

    addon layers present in spc

    roleDigest

    object

    this map will be for ansible roles present in eack 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

    vhdImage

    object

    Mold always create VHD image for custom image, and this can be use as golden images

    idstring
    namestring
    osstring
    regionstring
    statestring
Loading...