Returns the specified AKS cloud config
GET/v1/cloudconfigs/aks/:configUid
Returns the specified AKS cloud config
Request​
Path Parameters
Cluster's cloud config uid
Responses​
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
Array [
]
Array [
]
Array [
]
]
Array [
]
]
Array [
]
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
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
metadata
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
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.
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
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
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.
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
SelfLink is a URL representing this object. Populated by the system. Read-only.
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
spec
object
AwsCloudConfigSpec 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.
API version of the referent.
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
clusterConfig
object
Cluster level configuration for Azure cloud and applicable for all the machine pools
aadProfile
object
AadProfile is Azure Active Directory configuration to integrate with AKS for aad authentication.
AdminGroupObjectIDs - AAD group object IDs that will have admin role of the cluster.
Managed - Whether to enable managed AAD.
apiServerAccessProfile
object
APIServerAccessProfile is the access profile for AKS API server.
AuthorizedIPRanges - Authorized IP Ranges to kubernetes API server.
EnablePrivateCluster - Whether to create the cluster as a private cluster or not.
EnablePrivateClusterPublicFQDN - Whether to create additional public FQDN for private cluster or not.
PrivateDNSZone - Private dns zone mode for private cluster.
controlPlaneSubnet
object
Subnet for Kubernetes control-plane node
CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.
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
Deprecated. use apiServerAccessProfile.enablePrivateCluster
infraLBConfig
object
APIServerLB is the configuration for the control-plane load balancer.
apiServerLB
object
APIServerLB is the configuration for the control-plane load balancer.
Possible values: [Static, Dynamic]
Default value: Dynamic
Possible values: [Internal, Public]
Default value: Public
Load Balancer type
Location is the Azure datacenter location
Subscription ID is unique identifier for the subscription used to access Azure services
VNETName is the virtual network in which the cluster is to be provisioned.
workerSubnet
object
Subnet for Kubernetes worker node
CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.
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[]
additionalLabels
object
additionalLabels
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
infraProfileRef
object
ObjectReference contains enough information to let you inspect or modify the referred object.
API version of the referent.
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
infraProfileTemplate
object
InfraProfile contains OS/Kernel for this NodePool
Possible values: [all, aws, azure, gcp, vsphere, openstack, maas, nested, baremetal, eks, aks, edge, edge-native, libvirt, tencent, tke, coxedge, generic, gke]
Default value: all
packServerRefs
object[]
PackServerRefs is only used on Hubble side it is reference to pack registry servers which PackRef belongs to in hubble, pack server is a top level object, so use a reference to point to it packs within a clusterprofile can come from different pack servers, so this is an array
API version of the referent.
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
This secret is used only on Palette side use case is similar to k8s image pull secret this single secret internally should contains all the pack servers in PackServerRefs if empty, means no credential is needed to access the pack server For spectro saas, Ally will set this field before pass to palette
packs
object[]
Packs definitions here are final definitions. If ClonedFrom and ParamsOverwrite is present, then Packs are the final merge result of ClonedFrom and ParamsOverwrite So orchestration engine will just take the Packs and do the work, no need to worry about parameters merge
annotations
object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
pack is invalid when the associated tag is deleted from the registry
Possible values: [kernel, os, k8s, cni, csi, addon]
manifests
object[]
API version of the referent.
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
pack name
PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.
params
object
params passed as env variables to be consumed at installation time
presets
object[]
pack registry uid
schema
object[]
pack registry server or helm repo
pack tag
Possible values: [spectro, helm, manifest]
type of the pack
values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
pack version
version start from 1.0.0, matching the index of ClusterProfileSpec.Versions[] will be used by clusterSpec to identify which version is applied to the cluster
Deprecated. Use profileVersion
instanceConfig
MemoryMiB is the size of a virtual machine's memory, in MiB
NumCPUs is the number of virtual processors in a virtual machine
Instance type stands for VMSize in Azure
whether this pool is for control plane
whether this pool is for system node Pool
labels for this pool, example: master/worker, gpu, windows
max size of the pool, for scaling
min size of the pool, for scaling
osDisk
object
managedDisk
object
Possible values: [Linux, Windows]
Default value: Linux
Possible values: [Linux, Windows]
Default value: Linux
size of the pool, number of machines
spotVMOptions
object
SpotVMOptions allows the ability to specify the Machine should use a Spot VM
MaxPrice defines the maximum price the user is willing to pay for Spot VM instances
taints
object[]
master or worker taints
Possible values: [NoSchedule, PreferNoSchedule, NoExecute]
The taint key to be applied to a node
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.
The taint value corresponding to the taint key.
updateStrategy
object
rolling update strategy for this machinepool if not specified, will use ScaleOut
Possible values: [RollingUpdateScaleOut, RollingUpdateScaleIn]
update strategy, either ScaleOut or ScaleIn if empty, will default to RollingUpdateScaleOut
if IsControlPlane==true and 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
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"
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.
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.
Human-readable message indicating details about last transition.
Unique, one-word, CamelCase reason for the condition's last transition.
images
object
Images array items should be 1-to-1 mapping to Spec.MachinePoolConfig
addon layers present in spc
roleDigest
object
this map will be for ansible roles present in eack pack
sourceImageId, it can be from packref's annotations or from pack.json
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
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-01T22:51:15.104Z",
"deletionTimestamp": "2024-07-01T22:51:15.104Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-01T22:51:15.104Z",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cloudAccountRef": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"clusterConfig": {
"aadProfile": {
"adminGroupObjectIDs": [
"string"
],
"managed": true
},
"apiServerAccessProfile": {
"authorizedIPRanges": [
"string"
],
"enablePrivateCluster": true,
"enablePrivateClusterPublicFQDN": true,
"privateDNSZone": "string"
},
"containerName": "string",
"controlPlaneSubnet": {
"cidrBlock": "string",
"name": "string",
"securityGroupName": "string"
},
"enablePrivateCluster": true,
"infraLBConfig": {
"apiServerLB": {
"apiServerLBStaticIP": "string",
"ipAllocationMethod": "Dynamic",
"privateDNSName": "string",
"type": "Public"
}
},
"location": "string",
"resourceGroup": "string",
"sshKey": "string",
"storageAccountName": "string",
"subscriptionId": "string",
"vnetCidrBlock": "string",
"vnetName": "string",
"vnetResourceGroup": "string",
"workerSubnet": {
"cidrBlock": "string",
"name": "string",
"securityGroupName": "string"
}
},
"machinePoolConfig": [
{
"additionalLabels": {},
"additionalTags": {},
"azs": [
"string"
],
"infraProfileRef": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"infraProfileTemplate": {
"cloudType": "all",
"name": "string",
"packServerRefs": [
{
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
}
],
"packServerSecret": "string",
"packs": [
{
"annotations": {},
"digest": "string",
"inValidReason": "string",
"isInvalid": true,
"layer": "kernel",
"manifests": [
{
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
}
],
"name": "string",
"packUid": "string",
"params": {},
"presets": [
{
"add": "string",
"displayName": "string",
"group": "string",
"name": "string",
"remove": [
"string"
]
}
],
"registryUid": "string",
"schema": [
{
"format": "string",
"hints": [
"string"
],
"listOptions": [
"string"
],
"name": "string",
"readonly": true,
"regex": "string",
"required": true,
"type": "string"
}
],
"server": "string",
"tag": "string",
"type": "spectro",
"values": "string",
"version": "string"
}
],
"profileVersion": "string",
"type": "string",
"uid": "string",
"version": 0
},
"instanceConfig": {
"category": "string",
"cpuSet": 0,
"diskGiB": 0,
"memoryMiB": 0,
"name": "string",
"numCPUs": 0
},
"instanceType": "string",
"isControlPlane": true,
"isSystemNodePool": true,
"labels": [
"string"
],
"maxSize": 0,
"minSize": 0,
"name": "string",
"osDisk": {
"diskSizeGB": 0,
"managedDisk": {
"storageAccountType": "string"
},
"osType": "Linux"
},
"osType": "Linux",
"size": 0,
"spotVMOptions": {
"maxPrice": "string"
},
"taints": [
{
"effect": "NoSchedule",
"key": "string",
"timeAdded": "2024-07-01T22:51:15.105Z",
"value": "string"
}
],
"updateStrategy": {
"type": "RollingUpdateScaleOut"
},
"useControlPlaneAsWorker": true
}
]
},
"status": {
"ansibleRoleDigest": "string",
"conditions": [
{
"lastProbeTime": "2024-07-01T22:51:15.105Z",
"lastTransitionTime": "2024-07-01T22:51:15.105Z",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"images": {
"gallery": "string",
"name": "string",
"resourceGroup": "string",
"state": "string",
"subscriptionID": "string",
"version": "string"
},
"isAddonLayer": true,
"roleDigest": {},
"sourceImageId": "string",
"useCapiImage": true,
"vhdImage": {
"id": "string",
"name": "string",
"os": "string",
"region": "string",
"state": "string"
}
}
}