package
0.80.2
Repository: https://github.com/azure/aks-engine-azurestack.git
Documentation: pkg.go.dev

# Packages

Package common stores helpers and utility functions.
Package vlabs stores an experimental API model.

# Functions

ConvertContainerServiceToVLabs converts an unversioned ContainerService to a vlabs ContainerService.
ConvertOrchestratorVersionProfileToVLabs converts an unversioned OrchestratorVersionProfile to a vlabs OrchestratorVersionProfile.
ConvertVLabsContainerService converts a vlabs ContainerService to an unversioned ContainerService.
CreateMockContainerService returns a mock container service for testing purposes.
FormatAzureProdFQDNByLocation constructs an Azure prod fqdn.
FormatProdFQDNByLocation constructs an Azure prod fqdn with custom cloud profile CustomCloudName is name of environment if customCloudProfile is provided, it will be empty string if customCloudProfile is empty.
GetClusterAutoscalerNodesConfig returns the cluster-autoscaler runtime configuration flag for a nodepool.
No description provided by the author
No description provided by the author
GetK8sDefaultProperties returns a struct of type api.Properties for testing purposes.
GetMockPropertiesWithCustomCloudProfile returns a Properties object w/ mock CustomCloudProfile data.
GetOrchestratorVersionProfile returns orchestrator info for upgradable container service.
GetOrchestratorVersionProfileList returns a list of unversioned OrchestratorVersionProfile objects per (optionally) specified orchestrator and version.
GetOrchestratorVersionProfileListVLabs returns vlabs OrchestratorVersionProfileList object per (optionally) specified orchestrator and version.
ImagePublisherAndOfferMatch returns true if image publisher and offer match for specified WindowsProfile and AzureOSImageConfig objects.
LoadDefaultContainerServiceProperties loads the default API model.

# Constants

Distro string consts.
AddonModeEnsureExists.
AddonModeReconcile.
ADFSIdentitySystem is a const string reference identifier for ADFS identity System.
AgentPoolProfileRoleCompute is the compute role.
AgentPoolProfileRoleEmpty is the empty role.
AgentPoolProfileRoleInfra is the infra role.
AgentPoolProfileRoleMaster is the master role.
deprecated AKS 16.04 distro.
deprecated AKS 18.04 distro.
deprecated docker-engine distro.
Distro string consts.
Distro string consts.
Distro string consts.
Azure API Versions.
Azure API Versions.
Azure API Versions.
Azure API Versions.
Azure API Versions.
Azure API Versions.
Azure API Versions.
Azure API Versions.
ARMNetworkNamespace is the ARM-specific namespace for ARM's network providers.
ARMVirtualNetworksResourceType is the ARM resource type for virtual network resources of ARM.
AvailabilitySet means that the vms are in an availability set.
AzureADIdentitySystem is a const string reference identifier for Azure AD identity System.
AzureChinaCloud is a const string reference identifier for china cloud.
AzureCniPluginVerLinux specifies version of Azure CNI plugin, which has been mirrored from https://github.com/Azure/azure-container-networking/releases/download/${AZURE_PLUGIN_VER}/azure-vnet-cni-linux-amd64-${AZURE_PLUGIN_VER}.tgz to https://kubernetesartifacts.azureedge.net/azure-cni.
AzureCniPluginVerWindows specifies version of Azure CNI plugin, which has been mirrored from https://github.com/Azure/azure-container-networking/releases/download/${AZURE_PLUGIN_VER}/azure-vnet-cni-windows-amd64-${AZURE_PLUGIN_VER}.zip to https://kubernetesartifacts.azureedge.net/azure-cni.
AzureCustomCloudDependenciesLocationChina indicates to get dependencies from AzureChina cloud.
AzureCustomCloudDependenciesLocationGerman indicates to get dependencies from AzureGerman cloud.
AzureCustomCloudDependenciesLocationPublic indicates to get dependencies from in AzurePublic cloud.
AzureCustomCloudDependenciesLocationUSGovernment indicates to get dependencies from AzureUSGovernment cloud.
AzureGermanCloud is a const string reference identifier for german cloud.
AzurePublicCloud is a const string reference identifier for public cloud.
AzureStackCloud is a const string reference identifier for Azure Stack cloud.
AzureStackSuffix is appended to kubernetes version on Azure Stack instances.
AzureUSGovernmentCloud is a const string reference identifier for us government cloud.
BasicLoadBalancerSku is the string const for Azure Basic Load Balancer.
ClientCertificateAuthMethod indicates to use client certificate for authentication.
ClientSecretAuthMethod indicates to use client seret for authentication.
No description provided by the author
CNIPluginVer specifies the version of CNI implementation https://github.com/containernetworking/plugins.
Supported container runtimes.
Creating means ContainerService resource is being created.
DefaultAADPodIdentityAddonEnabled determines the aks-engine provided default for enabling aad-pod-identity addon.
DefaultAcceleratedNetworking determines the aks-engine provided default for enabling accelerated networking on Linux nodes.
DefaultAcceleratedNetworkingWindowsEnabled determines the aks-engine provided default for enabling accelerated networking on Windows nodes.
Deprecated.
DefaultAgentSubnetTemplate specifies a default agent subnet.
DefaultAlwaysPullWindowsPauseImage is the default windowsProfile.AlwaysPullWindowsPauseImage value.
DefaultAppGwIngressAddonEnabled determines the aks-engine provided default for enabling appgw ingress addon.
DefaultAuditDEnabled determines the aks-engine provided default for enabling auditd.
DefaultArcAddonEnabled determines the aks-engine provided default for enabling arc addon.
DefaultAzureCNIMonitoringAddonEnabled determines the aks-engine provided default for enabling azurecni-network monitoring addon.
DefaultAzureDiskCSIDriverAddonEnabled determines the aks-engine provided default for enabling Azure Disk CSI Driver.
DefaultAzureFileCSIDriverAddonEnabled determines the aks-engine provided default for enabling Azure File CSI Driver.
DefaultAzurePolicyAddonEnabled determines the aks-engine provided default for enabling azure policy addon.
DefaultAzureStackAcceleratedNetworking set to false as Azure Stack today doesn't support accelerated networking.
DefaultAzureStackAvailabilityProfile set to AvailabilitySet as VMSS clusters are not suppored on Azure Stack.
DefaultAzureStackDeployTelemetryPID tracking ID for Deployment.
DefaultAzureStackFaultDomainCount set to 3 as Azure Stack today has minimum 4 node deployment.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
Azure Stack configures all clusters as if they were large clusters.
DefaultAzureStackLoadBalancerSku determines the aks-engine provided default for enabling Azure cloudprovider load balancer SKU on Azure Stack.
DefaultAzureStackScaleTelemetryPID tracking ID for Scale.
DefaultAzureStackUpgradeTelemetryPID tracking ID for Upgrade.
DefaultUseInstanceMetadata set to false as Azure Stack today doesn't support instance metadata service.
DefaultBlobfuseFlexVolumeAddonEnabled determines the aks-engine provided default for enabling blobfuse flexvolume addon.
DefaultClusterAutoscalerAddonEnabled determines the aks-engine provided default for enabling cluster autoscaler addon.
DefaultCNICIDR specifies the default value for.
DefaultContainerdVersion specifies the default containerd version to install.
DefaultContainerMonitoringAddonEnabled determines the aks-engine provided default for enabling kubernetes container monitoring addon.
DefaultContainerRuntime is docker.
DefaultCoreDNSAddonEnabled determines the aks-engine provided default for enabling coredns addon.
Deprecated.
DefaultDockerBridgeSubnet specifies the default subnet for the docker bridge network for masters and agents.
DefaultEnableAutomaticUpdates determines the aks-engine provided default for enabling automatic updates.
DefaultEnableUnattendedUpgrades sets the default configuration for running unattended-upgrade on a regular schedule in the background.
DefaultEnableUnattendedUpgradesAzureStack sets the default configuration for running unattended-upgrade on a regular schedule in the background for Azure Stack Hub.
DefaultEnableVMSSNodePublicIP determines the aks-engine provided default for enable VMSS node public IP.
DefaultEtcdDiskSize specifies the default size for Kubernetes master etcd disk volumes in GB.
DefaultEtcdDiskSizeGT10Nodes = size for Kubernetes master etcd disk volumes in GB if > 10 nodes.
DefaultEtcdDiskSizeGT20Nodes = size for Kubernetes master etcd disk volumes in GB if > 20 nodes.
DefaultEtcdDiskSizeGT3Nodes = size for Kubernetes master etcd disk volumes in GB if > 3 nodes.
DefaultEtcdStorageLimitGB specifies the default size for etcd data storage limit.
DefaultEtcdVersion specifies the default etcd version to install.
DefaultEth0MTU is the default MTU configuration for eth0 Linux interfaces.
DefaultExcludeMasterFromStandardLB determines the aks-engine provided default for excluding master nodes from standard load balancer.
DefaultExtensionsRootURL Root URL for extensions.
DefaultFirstConsecutiveKubernetesStaticIP specifies the static IP address on Kubernetes master 0.
DefaultFirstConsecutiveKubernetesStaticIPVMSS specifies the static IP address on Kubernetes master 0 of VMSS.
DefaultInternalLbStaticIPOffset specifies the offset of the internal LoadBalancer's IP address relative to the first consecutive Kubernetes static IP.
DefaultIPMasqAgentAddonEnabled enables the ip-masq-agent addon.
DefaultJumpboxDiskSize specifies the default size for private cluster jumpbox OS disk in GB.
DefaultJumpboxUsername specifies the default admin username for the private cluster jumpbox.
DefaultKubeDNSAddonEnabled determines the aks-engine provided default for enabling coredns addon.
DefaultKubeletCadvisorPort is 0, see --cadvisor-port at https://kubernetes.io/docs/reference/generated/kubelet/.
DefaultKubeletEventQPS is 0, see --event-qps at https://kubernetes.io/docs/reference/generated/kubelet/.
DefaultKubeletHealthzPort is the default /healthz port for the kubelet runtime.
DefaultKubeletPodMaxPIDs specifies the default max pid authorized by pods.
DefaultKubeProxyAddonEnabled determines the aks-engine provided default for enabling kube-proxy addon.
DefaultKubeProxyMode is the default KubeProxyMode value.
DefaultKubernetesAgentSubnetVMSS specifies the default subnet for agents when master is VMSS.
DefaultKubernetesAPIServerEnableProfiling is the config that enables profiling via web interface host:port/debug/pprof/.
DefaultKubernetesAPIServerVerbosity is the default verbosity setting for the apiserver.
DefaultKubernetesCloudProviderBackoffDuration is 5, takes effect if DefaultKubernetesCloudProviderBackoff is true.
DefaultKubernetesCloudProviderBackoffExponent is 1.5, takes effect if DefaultKubernetesCloudProviderBackoff is true.
DefaultKubernetesCloudProviderBackoffJitter is 1, takes effect if DefaultKubernetesCloudProviderBackoff is true.
DefaultKubernetesCloudProviderBackoffRetries is 6, takes effect if DefaultKubernetesCloudProviderBackoff is true.
DefaultKubernetesCloudProviderRateLimit is false to disable cloudprovider rate limiting implementation for API calls.
DefaultKubernetesCloudProviderRateLimitBucket is 10, takes effect if DefaultKubernetesCloudProviderRateLimit is true.
DefaultKubernetesCloudProviderRateLimitBucketWrite is 10, takes effect if DefaultKubernetesCloudProviderRateLimit is true.
DefaultKubernetesCloudProviderRateLimitQPS is 3, takes effect if DefaultKubernetesCloudProviderRateLimit is true.
DefaultKubernetesCloudProviderRateLimitQPSWrite is 1, takes effect if DefaultKubernetesCloudProviderRateLimit is true.
DefaultKubernetesClusterDomain is the dns suffix used in the cluster (used as a SAN in the PKI generation).
DefaultKubernetesClusterSubnet specifies the default subnet for pods.
DefaultKubernetesClusterSubnetIPv6 specifies the IPv6 default subnet for pods.
DefaultKubernetesCtrlMgrNodeMonitorGracePeriod is 40s, see --node-monitor-grace-period at https://kubernetes.io/docs/admin/kube-controller-manager/.
DefaultKubernetesCtrlMgrPodEvictionTimeout is 5m0s, see --pod-eviction-timeout at https://kubernetes.io/docs/admin/kube-controller-manager/.
DefaultKubernetesCtrlMgrRouteReconciliationPeriod is 10s, see --route-reconciliation-period at https://kubernetes.io/docs/admin/kube-controller-manager/.
DefaultKubernetesCtrlMgrTerminatedPodGcThreshold is set to 5000, see --terminated-pod-gc-threshold at https://kubernetes.io/docs/admin/kube-controller-manager/ and https://github.com/kubernetes/kubernetes/issues/22680.
DefaultKubernetesCtrlMgrUseSvcAccountCreds is "true", see --use-service-account-credentials at https://kubernetes.io/docs/admin/kube-controller-manager/.
DefaultKubernetesCtrMgrEnableProfiling is the config that enables profiling via web interface host:port/debug/pprof/.
DefaultKubernetesDNSServiceIP specifies the IP address that kube-dns listens on by default.
DefaultKubernetesDNSServiceIPv6 specifies the IPv6 address that kube-dns listens on by default.
DefaultKubernetesFirstConsecutiveStaticIPOffset specifies the IP address offset of master 0 when VNET integration is enabled.
DefaultKubernetesFirstConsecutiveStaticIPOffsetVMSS specifies the IP address offset of master 0 in VMSS when VNET integration is enabled.
DefaultKubernetesGCHighThreshold specifies the value for for the image-gc-high-threshold kubelet flag.
DefaultKubernetesGCLowThreshold specifies the value for the image-gc-low-threshold kubelet flag.
DefaultKubernetesHardEvictionThreshold is memory.available<100Mi,nodefs.available<10%,nodefs.inodesFree<5%, see --eviction-hard at https://kubernetes.io/docs/admin/kubelet/.
DefaultKubernetesMasterSubnet specifies the default subnet for masters and agents.
DefaultKubernetesMasterSubnetIPv6 specifies the default IPv6 subnet for masters and agents.
DefaultKubernetesMaxPods is the maximum number of pods to run on a node.
DefaultKubernetesMaxPodsAzureCNI is the maximum number of pods to run on a node for Azure CNI.
DefaultKubernetesMaxPodsKubenet is the maximum number of pods to run on a node for Kubenet.
DefaultKubernetesMaxPodsVNETIntegrated is the maximum number of pods to run on a node when VNET integration is enabled.
DefaultKubernetesNodeStatusUpdateFrequency is 10s, see --node-status-update-frequency at https://kubernetes.io/docs/admin/kubelet/.
DefaultKubernetesSchedulerEnableProfiling is the config that enables profiling via web interface host:port/debug/pprof/.
DefaultKubernetesServiceCIDR specifies the IP subnet that kubernetes will create Service IPs within.
DefaultKubernetesServiceCIDRIPv6 specifies the IPv6 subnet that kubernetes will create Service IPs within.
DefaultKubernetesSubnet specifies the default subnet used for all masters, agents and pods when VNET integration is enabled.
DefaultMasterEtcdClientPort is the default etcd client port for Kubernetes master nodes.
DefaultMaximumLoadBalancerRuleCount determines the default value of maximum allowed loadBalancer rule count according to https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits#load-balancer.
DefaultMetricsServerAddonEnabled determines the aks-engine provided default for enabling kubernetes metrics-server addon.
No description provided by the author
DefaultMobyVersion specifies the default Azure build version of Moby to install.
DefaultNetworkPlugin defines the network plugin to use by default.
DefaultNetworkPluginWindows defines the network plugin implementation to use by default for clusters with Windows agent pools.
DefaultNetworkPolicy defines the network policy implementation to use by default.
DefaultNetworkPolicyWindows defines the network policy implementation to use by default for clusters with Windows agent pools.
DefaultNodeProblemDetectorAddonEnabled determines the aks-engine provided default for enabling the node problem detector addon.
DefaultNonMasqueradeCIDR is the default --non-masquerade-cidr value for kubelet.
DefaultNVIDIADevicePluginAddonEnabled determines the aks-engine provided default for enabling NVIDIA Device Plugin.
DefaultOrchestratorName specifies the 3 character orchestrator code of the cluster template and affects resource naming.
DefaultOutboundRuleIdleTimeoutInMinutes determines the aks-engine provided default for IdleTimeoutInMinutes of the OutboundRule of the agent loadbalancer This value is set greater than the default Linux idle timeout (15.4 min): https://pracucci.com/linux-tcp-rto-min-max-and-tcp-retries2.html.
DefaultPreserveNodesProperties determines the aks-engine provided default for preserving nodes properties.
DefaultPrivateClusterEnabled determines the aks-engine provided default for enabling kubernetes Private Cluster.
DefaultPrivateClusterHostsConfigAgentEnabled enables the hosts config agent for private cluster.
DefaultRBACEnabled determines the aks-engine provided default for enabling kubernetes RBAC.
Deprecated.
DefaultRunUnattendedUpgradesOnBootstrap sets the default configuration for running a blocking unattended-upgrade on Linux VMs as part of CSE.
DefaultRunUnattendedUpgradesOnBootstrapAzureStack sets the default configuration for running a blocking unattended-upgrade on Linux VMs as part of CSE for Azure Stack Hub.
DefaultSecretStoreCSIDriverAddonEnabled determines the aks-engine provided default for enabling secrets-store-csi-driver addon.
DefaultSecureKubeletEnabled determines the aks-engine provided default for securing kubelet communications.
DefaultSinglePlacementGroup determines the aks-engine provided default for supporting large VMSS (true = single placement group 0-100 VMs, false = multiple placement group 0-1000 VMs).
DefaultSMBFlexVolumeAddonEnabled determines the aks-engine provided default for enabling smb flexvolume addon.
DefaultSubnetNameResourceSegmentIndex specifies the default subnet name resource segment index.
DefaultTillerAddonEnabled determines the aks-engine provided default for enabling tiller addon.
DefaultTillerMaxHistory limits the maximum number of revisions saved per release.
DefaultUseCosmos determines if the cluster will use cosmos as etcd storage.
DefaultUseInstanceMetadata determines the aks-engine provided default for enabling Azure cloudprovider instance metadata service.
DefaultVMSSOverProvisioningEnabled determines the aks-engine provided default for enabling VMSS Overprovisioning.
DefaultVNETCIDR is the default CIDR block for the VNET.
DefaultVNETCIDRIPv6 is the default IPv6 CIDR block for the VNET.
DefaultVnetNameResourceSegmentIndex specifies the default virtual network name segment index.
DefaultVnetResourceGroupSegmentIndex specifies the default virtual network resource segment index.
DefaultWindowsContainerdURL is the URL for the default containerd package on Windows.
WindowsProfile defaults TODO: Move other values defined in WindowsProfiles (like DefaultWindowsSSHEnabled) here.
WindowsProfile defaults TODO: Move other values defined in WindowsProfiles (like DefaultWindowsSSHEnabled) here.
DefaultWindowsSSHEnabled is the default windowsProfile.sshEnabled value.
Deleting means resource is in the process of being deleted.
Supported container runtimes.
Ephemeral means that the node's os disk is ephemeral.
Failed means resource is in failed state.
Distro string consts.
Deprecated.
KubeProxyModeIPTables is used to set the kube-proxy to iptables mode.
KubeProxyModeIPVS is used to set the kube-proxy to ipvs mode.
No description provided by the author
Kubernetes is the string constant for the Kubernetes orchestrator type.
KubernetesDefaultWindowsRuntimeHandler is the default containerd handler for windows pods.
KubernetesDefaultWindowsSku is the default SKU for Windows VMs in kubernetes.
KubernetesWindowsDockerVersion is the default version for docker on Windows nodes in kubernetes.
the OSTypes supported by vlabs.
ManagedDisks means that the nodes use managed disks for their os and attached volumes.
MaxAgentCount are the maximum number of agents per agent pool.
MaxAzureStackManagedDiskSize is the size in GB of the etcd disk volumes when total nodes count is greater than 10.
MaxDisks specifies the maximum attached disks to add to the cluster.
MaxPort specifies the maximum tcp port to open.
Migrating means resource is being migrated from one subscription or resource group to another.
MinAgentCount are the minimum number of agents per agent pool.
MinPort specifies the minimum tcp port to open.
NetworkModeTransparent is the string expression for transparent network mode config option.
NetworkPluginAntrea is the string expression for antrea network plugin config option.
NetworkPluginAzure is the string expression for Azure CNI plugin.
NetworkPluginCilium is the string expression for cilium network plugin config option.
NetworkPluginFlannel is the string expression for flannel network policy config option.
NetworkPluginKubenet is the string expression for the kubenet NetworkPlugin config.
NetworkPolicyAntrea is the string expression for antrea network policy config option.
NetworkPolicyAzure is the string expression for Azure CNI network policy manager.
NetworkPolicyCalico is the string expression for calico network policy config option.
NetworkPolicyCilium is the string expression for cilium network policy config option.
NetworkPolicyNone is the string expression for the deprecated NetworkPolicy usage pattern "none".
OIDC represent cluster setup in OIDC auth mode.
ScaleSetEvictionPolicyDeallocate means a Low-priority VM ScaleSet will deallocate, rather than delete, VMs.
ScaleSetEvictionPolicyDelete is the default Eviction Policy for Low-priority VM ScaleSets.
ScaleSetPriorityLow means the ScaleSet will use Low-priority VMs.
ScaleSetPriorityRegular is the default ScaleSet Priority.
ScaleSetPrioritySpot means the ScaleSet will use Spot VMs.
Scaling means an existing ContainerService resource is being scaled only.
No description provided by the author
StandardLoadBalancerSku is the string const for Azure Standard Load Balancer.
StandardVMType is the string const for the standard VM Type.
StorageAccount means that the nodes use raw storage accounts for their os and attached volumes.
Succeeded means resource created succeeded during last create/update.
TLSStrongCipherSuitesAPIServer is a kube-bench-recommended allowed cipher suites for apiserver STIG Rule ID: SV-242418r879636_rule.
TLSStrongCipherSuitesKubelet is a kube-bench-recommended allowed cipher suites for kubelet.
Ubuntu 16.04-LTS is at EOL, TODO deprecate this distro.
Distro string consts.
Distro string consts.
Distro string consts.
Updating means an existing ContainerService resource is being updated.
Upgrading means an existing ContainerService resource is being upgraded.
VHDDiskSizeAKS maps to the OSDiskSizeGB for AKS VHD image.
VirtualMachineScaleSets means that the vms are in a virtual machine scaleset.
VMSSVMType is the string const for the vmss VM Type.
Webhook represent cluster setup in wehhook auth mode.
the OSTypes supported by vlabs.
WindowsLicenseTypeNone specifies that the image or disk that is being used was not licensed on-premises.
WindowsLicenseTypeServer specifies that the image or disk that is being used was licensed server on-premises.
WindowsPauseImageVersion specifies version of Windows pause image.

# Variables

ACC1604OSImageConfig is the ACC image based on Ubuntu 16.04.
AKSUbuntu1604OSImageConfig is the AKS image based on Ubuntu 16.04-LTS.
AKSUbuntu1804OSImageConfig is the AKS image based on Ubuntu 18.04-LTS.
AKSUbuntu2004OSImageConfig is the AKS Engine image based on Ubuntu 20.04-LTS.
AKSWindowsServer2019ContainerDOSImageConfig is the aks-engine image based on Windows Server 2019 configured with containerd.
AKSWindowsServer2019OSImageConfig is the aks-engine image based on Windows Server 2019.
AzureChinaCloudSpec is the configurations for Azure China (Mooncake).
AzureCloudSpec is the default configurations for global azure.
AzureCloudSpecEnvMap is the environment configuration map for all the Azure cloud environments.
AzureGermanCloudSpec is the German cloud config.
AzureUSGovernmentCloudSpec is the US government config.
DefaultKubernetesSpecConfig is the default Docker image source of Kubernetes.
DistroValues is a list of currently supported distros.
FlatcarImageConfig is the Flatcar Linux distribution.
Ubuntu1604OSImageConfig is the default Linux distribution.
Ubuntu1804Gen2OSImageConfig is Gen2 flavor the Ubunutu 18.04-LTS Linux distribution.
Ubuntu1804OSImageConfig is the Ubunutu 18.04-LTS Linux distribution.
Ubuntu2004OSImageConfig is the Ubunutu 20.04-LTS Linux distribution.
WindowsServer2019OSImageConfig is the 'vanilla' Windows Server 2019 image.

# Structs

AADProfile specifies attributes for AAD integration.
AddonNodePoolsConfig defines configuration for pool-specific cluster-autoscaler configuration.
AgentPoolProfile represents an agent pool definition.
Apiloader represents the object that loads api model.
AzureCustomCloudSpecParams is the parameters when we set the custom cloud spec defaults for ContainerService.
AzureEndpointConfig describes an Azure endpoint.
AzureEnvironmentSpecConfig is the overall configuration differences in different cloud environments.
AzureOSImageConfig describes an Azure OS image.
AzureStackMetadataAuthentication is the type for Azure Stack metadata authentication endpoints.
AzureStackMetadataEndpoints is the type for Azure Stack metadata endpoints.
CertificateProfile represents the definition of the master cluster.
CloudProviderConfig contains the KubernetesConfig properties specific to the Cloud Provider.
ContainerService complies with the ARM model of resource definition in a JSON template.
CustomCloudProfile represents the custom cloud profile.
CustomCloudProfileDefaultsParams is the parameters when we set the cloud profile defaults for ContainerService.
CustomFile has source as the full absolute source path to a file and dest is the full absolute desired destination path to put the file on a master node.
CustomNodesDNS represents the Search Domain when the custom vnet for a custom DNS as a nameserver.
CustomSearchDomain represents the Search Domain when the custom vnet has a windows server DNS as a nameserver.
DefaultCertParams is the params when we set the default certs.
Extension represents an extension definition in the master or agentPoolProfile.
ExtensionProfile represents an extension definition.
FeatureFlags defines feature-flag restricted functionality.
ImageReference represents a reference to an Image resource in Azure.
JumpboxProfile describes properties of the jumpbox setup in the AKS container cluster.
KeyVaultCertificate specifies a certificate to install On Linux, the certificate file is placed under the /var/lib/waagent directory with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for the private key.
KeyVaultID specifies a key vault.
KeyvaultSecretRef specifies path to the Azure keyvault along with secret name and (optionaly) version for Service Principal's secret.
KeyVaultSecrets specifies certificates to install on the pool of machines from a given key vault the key vault specified must have been granted read permissions to CRP.
KubernetesAddon defines a list of addons w/ configuration to include with the cluster deployment.
KubernetesComponent defines a component w/ configuration to include with the cluster deployment.
KubernetesConfig contains the Kubernetes config structure, containing Kubernetes specific configuration.
KubernetesContainerSpec defines configuration for a container spec.
KubernetesSpecConfig is the kubernetes container images used.
LinuxProfile represents the linux parameters passed to the cluster.
MasterProfile represents the definition of the master cluster.
OrchestratorProfile contains Orchestrator properties.
OrchestratorVersionProfile contains information of a supported orchestrator version:.
PrivateCluster defines the configuration for a private cluster.
PrivateJumpboxProfile represents a jumpbox definition.
Properties represents the AKS cluster definition.
PropertiesDefaultsParams is the parameters when we set the properties defaults for ContainerService.
ProvisionScriptParametersInput is the struct used to pass in Azure environment variables and secrets as either values or ARM template variables when generating provision script parameters.
PublicKey represents an SSH key for LinuxProfile.
ResourcePurchasePlan defines resource plan as required by ARM for billing purposes.
RuntimeHandlers configures the runtime settings in containerd.
ServicePrincipalProfile contains the client and secret used by the cluster for Azure Resource CRUD.
TelemetryProfile contains settings for collecting telemtry.
TypeMeta describes an individual API model object.
VlabsARMContainerService is the type we read and write from file needed because the json that is sent to ARM and aks-engine is different from the json that the ACS RP Api gets from ARM.
WindowsProfile represents the windows parameters passed to the cluster.
WindowsRuntimes configures containerd runtimes that are available on the windows nodes.

# Type aliases

AgentPoolProfileRole represents an agent role.
AuthenticatorType represents the authenticator type the cluster was set up with.
AzureTelemetryPID represents the current telemetry ID See more information here https://docs.microsoft.com/en-us/azure/marketplace/azure-partner-customer-usage-attribution PID is maintained to keep consistent with Azure Stack Telemetry Terminologies.
DependenciesLocation represents location to retrieve the dependencies.
Distro represents Linux distro to use for Linux VMs.
KubeProxyMode is for iptables and ipvs (and future others).
OSType represents OS types of agents.
ProvisioningState represents the current state of container service resource.