package
0.38.5
Repository: https://github.com/devigned/aks-engine.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package common stores helpers and utility functions.
Package v20160330 stores the API model for version "2016-03-30." Deprecated: Use the vlabs package instead.
Package v20160930 stores the API model for version "2016-09-30." Deprecated: Use the vlabs package instead.
Package v20170131 stores the API model for version "2017-01-31." Deprecated: Use the vlabs package instead.
Package v20170701 stores the API model for version "2017-07-01." Deprecated: Use the vlabs package instead.
Package v20170930 stores the API model for version "2017-09-30." Deprecated: Use the vlabs package instead.
Package vlabs stores an experimental API model.

# Functions

ConvertContainerServiceToV20160330 converts an unversioned ContainerService to a v20160330 ContainerService.
ConvertContainerServiceToV20160930 converts an unversioned ContainerService to a v20160930 ContainerService.
ConvertContainerServiceToV20170131 converts an unversioned ContainerService to a v20170131 ContainerService.
ConvertContainerServiceToV20170701 converts an unversioned ContainerService to a v20170701 ContainerService.
ConvertContainerServiceToV20170831AgentPoolOnly converts an unversioned ContainerService to a v20170831 ContainerService.
ConvertContainerServiceToV20180331AgentPoolOnly converts an unversioned ContainerService to a v20180331 ContainerService.
ConvertContainerServiceToVLabs converts an unversioned ContainerService to a vlabs ContainerService.
ConvertOrchestratorVersionProfileToV20170930 converts an unversioned OrchestratorVersionProfile to a v20170930 OrchestratorVersionProfile.
ConvertOrchestratorVersionProfileToVLabs converts an unversioned OrchestratorVersionProfile to a vlabs OrchestratorVersionProfile.
ConvertV20160330ContainerService converts a v20160330 ContainerService to an unversioned ContainerService.
ConvertV20160930ContainerService converts a v20160930 ContainerService to an unversioned ContainerService.
ConvertV20170131ContainerService converts a v20170131 ContainerService to an unversioned ContainerService.
ConvertV20170701ContainerService converts a v20170701 ContainerService to an unversioned ContainerService.
ConvertV20170831AgentPoolOnly converts an AgentPoolOnly object into an in-memory container service.
ConvertV20180331AgentPoolOnly converts an AgentPoolOnly object into an in-memory container service.
ConvertVLabsAgentPoolOnly converts a vlabs ContainerService to an unversioned ContainerService.
ConvertVLabsContainerService converts a vlabs ContainerService to an unversioned ContainerService.
CreateMockAgentPoolProfile creates a mock AgentPoolResource for testing.
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.
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.
GetOrchestratorVersionProfileListV20170930 returns v20170930 OrchestratorVersionProfileList object per (optionally) specified orchestrator and version.
GetOrchestratorVersionProfileListVLabs returns vlabs OrchestratorVersionProfileList object per (optionally) specified orchestrator and version.
LoadDefaultContainerServiceProperties loads the default API model.

# Constants

AADPodIdentityAddonName is the name of the aad-pod-identity addon deployment.
Distro string consts.
ACIConnectorAddonName is the name of the aci-connector addon deployment.
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.
AppGwIngressAddonName appgw addon.
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.
AzureChinaCloudDCOSBootstrapDownloadURL is the China specific DCOS package download url.
AzureCNINetworkMonitoringAddonName is the name of the Azure CNI networkmonitor addon.
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://acs-mirror.azureedge.net/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://acs-mirror.azureedge.net/cni.
AzureEdgeDCOSBootstrapDownloadURL is the azure edge CDN download url.
AzureGermanCloud is a const string reference identifier for german cloud.
AzureNetworkPolicyAddonName is the name of the Azure CNI networkmonitor addon.
AzurePublicCloud is a const string reference identifier for public cloud.
AzureStackCloud is a const string reference identifier for Azure Stack cloud.
AzureStackDependenciesLocationChina indicates to get dependencies from AzureChina cloud.
AzureStackDependenciesLocationGerman indicates to get dependencies from AzureGerman cloud.
AzureStackDependenciesLocationPublic indicates to get dependencies from in AzurePublic cloud.
AzureStackDependenciesLocationUSGovernment indicates to get dependencies from AzureUSGovernment cloud.
AzureUSGovernmentCloud is a const string reference identifier for us government cloud.
BlobfuseFlexVolumeAddonName is the name of the blobfuse flexvolume addon.
CalicoAddonName is the name of calico daemonset addon.
Supported container runtimes.
ClientCertificateAuthMethod indicates to use client certificate for authentication.
ClientSecretAuthMethod indicates to use client seret for authentication.
ClusterAutoscalerAddonName is the name of the cluster autoscaler addon deployment.
CNIPluginVer specifies the version of CNI implementation https://github.com/containernetworking/plugins.
Supported container runtimes.
ContainerMonitoringAddonName is the name of the kubernetes Container Monitoring addon deployment.
Distro string consts.
Creating means ContainerService resource is being created.
DashboardAddonName is the name of the kubernetes-dashboard addon deployment.
DCOS is the string constant for DCOS orchestrator type and defaults to DCOS188.
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.
DefaultACIConnectorAddonEnabled determines the aks-engine provided default for enabling aci connector addon.
DefaultAgentSubnetTemplate specifies a default agent subnet.
DefaultAppGwIngressAddonEnabled determines the aks-engine provided default for enabling appgw ingress addon.
DefaultAuditDEnabled determines the aks-engine provided default for enabling auditd.
DefaultAzureCNIMonitoringAddonEnabled determines the aks-engine provided default for enabling azurecni-network monitoring addon.
DefaultAzureStackAcceleratedNetworking set to false as Azure Stack today doesn't support accelerated networking.
DefaultAzureStackFaultDomainCount set to 3 as Azure Stack today has minimum 4 node deployment.
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.
DefaultDashboardAddonEnabled determines the aks-engine provided default for enabling kubernetes-dashboard addon.
DefaultDCOSBootstrapStaticIP specifies the static IP address on bootstrap for a DCOS cluster.
DefaultDCOSFirstConsecutiveStaticIP specifies the static IP address on master 0 for a DCOS cluster.
DefaultDCOSMasterSubnet specifies the default master subnet for a DCOS cluster.
DefaultDNSAutoscalerAddonEnabled determines the aks-engine provided default for dns-autoscaler addon.
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.
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.
DefaultEtcdVersion specifies the default etcd version to install.
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.
DefaultFirstConsecutiveStaticIP specifies the static IP address on master 0 for DCOS or Swarm.
DefaultHeapsterAddonEnabled determines the aks-engine provided default for enabling heapster addon.
DefaultHostedProfileMasterName specifies the 3 character orchestrator code of the clusters with hosted master profiles.
DefaultImageVersion sets the default ImageVersion value in WindowsProfile.
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.
DefaultKeyVaultFlexVolumeAddonEnabled determines the aks-engine provided default for enabling key vault flexvolume 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/.
DefaultKubeletPodMaxPIDs specifies the default max pid authorized by pods.
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/.
DefaultKubernetesCloudProviderBackoff is false to disable cloudprovider backoff implementation for API calls.
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.
DefaultKubernetesCloudProviderRateLimitQPS is 3, 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.
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.
DefaultKubernetesSubnet specifies the default subnet used for all masters, agents and pods when VNET integration is enabled.
DefaultLoadBalancerSku determines the aks-engine provided default for enabling Azure cloudprovider load balancer SKU.
DefaultMasterEtcdClientPort is the default etcd client port for Kubernetes master nodes.
DefaultMasterSubnet specifies the default master subnet for DCOS or Swarm.
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.
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.
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.
DefaultPreserveNodesProperties determines the aks-engine provided default for preserving nodes properties.
DefaultPrivateClusterEnabled determines the aks-engine provided default for enabling kubernetes Private Cluster.
DefaultRBACEnabled determines the aks-engine provided default for enabling kubernetes RBAC.
DefaultReschedulerAddonEnabled determines the aks-engine provided default for enabling kubernetes-rescheduler 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.
DefaultSwarmWindowsFirstConsecutiveStaticIP specifies the static IP address on master 0 for a Swarm WIndows cluster.
DefaultSwarmWindowsMasterSubnet specifies the default master subnet for a Swarm Windows cluster.
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.
DefaultWindowsOffer sets the default WindowsOffer value in WindowsProfile.
DefaultWindowsPublisher sets the default WindowsPublisher value in WindowsProfile.
DefaultWindowsSku sets the default WindowsSku value in WindowsProfile.
Deleting means resource is in the process of being deleted.
DNSAutoscalerAddonName is the name of the dns-autoscaler addon.
Supported container runtimes.
DockerCEDockerComposeVersion is the Docker Compose version.
DockerCEVersion is the DockerCE orchestrator version.
Failed means resource is in failed state.
HeapsterAddonName is the name of the heapster addon.
IPMASQAgentAddonName is the name of the ip masq agent addon.
Supported container runtimes.
KeyVaultFlexVolumeAddonName is the name of the key vault flexvolume addon deployment.
KubeProxyModeIPTables is used to set the kube-proxy to iptables mode.
KubeProxyModeIPVS is used to set the kube-proxy to ipvs mode.
Kubernetes is the string constant for the Kubernetes orchestrator type.
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 = size for Kubernetes master etcd disk volumes in GB if > 10 nodes as this is max what Azure Stack supports today.
MaxDisks specifies the maximum attached disks to add to the cluster.
MaxPort specifies the maximum tcp port to open.
Mesos is the string constant for MESOS orchestrator type.
MetricsServerAddonName is the name of the kubernetes metrics server addon deployment.
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.
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.
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".
NVIDIADevicePluginAddonName is the name of the NVIDIA device plugin addon deployment.
OIDC represent cluster setup in OIDC auth mode.
PodSecurityPolicyAddonName is the name of the PodSecurityPolicy addon.
ReschedulerAddonName is the name of the rescheduler addon deployment.
Distro string consts.
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.
Scaling means an existing ContainerService resource is being scaled only.
SMBFlexVolumeAddonName is the name of the smb flexvolume addon.
StandardLoadBalancerSku is the string const for Azure Standard Load Balancer.
StorageAccount means that the nodes use raw storage accounts for their os and attached volumes.
Succeeded means resource created succeeded during last create/update.
Swarm is the string constant for the Swarm orchestrator type.
SwarmDockerComposeVersion is the Docker Compose version.
SwarmMode is the string constant for the Swarm Mode orchestrator type.
SwarmVersion is the Swarm orchestrator version.
TillerAddonName is the name of the tiller addon deployment.
TLSStrongCipherSuitesAPIServer is a kube-bench-recommended allowed cipher suites for apiserver.
TLSStrongCipherSuitesKubelet is a kube-bench-recommended allowed cipher suites for kubelet.
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.
Webhook represent cluster setup in wehhook auth mode.
the OSTypes supported by vlabs.

# 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.
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.
CoreOSImageConfig is the CoreOS Linux distribution.
DefaultDCOSSpecConfig is the default DC/OS binary download URL.
DefaultDockerSpecConfig is the default Docker engine repo.
DefaultKubernetesSpecConfig is the default Docker image source of Kubernetes.
DistroValues is a list of currently supported distros.
K8sComponentsByVersionMap represents Docker images used for Kubernetes components based on Kubernetes versions (major.minor.patch).
RHELOSImageConfig is the RHEL Linux distribution.
Ubuntu1604OSImageConfig is the default Linux distribution.
Ubuntu1804OSImageConfig is the Ubunutu 18.04-LTS Linux distribution.

# Structs

AADProfile specifies attributes for AAD integration.
AddonProfile represents an addon for managed cluster.
AgentPoolProfile represents an agent pool definition.
AgentPoolResource complies with the ARM model of agentpool resource definition in a JSON template.
Apiloader represents the object that loads api model.
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.
BootstrapProfile represents the definition of the DCOS bootstrap node used to deploy the cluster.
CertificateProfile represents the definition of the master cluster.
CloudProviderConfig contains the KubernetesConfig properties specific to the Cloud Provider.
ClusterMetadata represents the metadata of the AKS cluster.
ContainerService complies with the ARM model of resource definition in a JSON template.
CustomCloudProfile represents the custom cloud profile.
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.
CustomProfile specifies custom properties that are used for cluster instantiation.
CustomSearchDomain represents the Search Domain when the custom vnet has a windows server DNS as a nameserver.
DcosConfig Configuration for DC/OS.
DCOSSpecConfig is the configurations of DCOS.
DiagnosticsProfile setting to enable/disable capturing diagnostics for VMs hosting container cluster.
DockerSpecConfig is the configurations of docker.
Extension represents an extension definition in the master or agentPoolProfile.
ExtensionProfile represents an extension definition.
FeatureFlags defines feature-flag restricted functionality.
HostedMasterProfile defines properties for a hosted master.
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.
KubernetesConfig contains the Kubernetes config structure, containing Kubernetes specific configuration.
KubernetesConfigDeprecated are properties that are no longer operable and will be ignored TODO use this when strict JSON checking accommodates struct embedding.
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.
PublicKey represents an SSH key for LinuxProfile.
ResourcePurchasePlan defines resource plan as required by ARM for billing purposes.
ServicePrincipalProfile contains the client and secret used by the cluster for Azure Resource CRUD.
TypeMeta describes an individual API model object.
V20160330ARMContainerService 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.
V20160930ARMContainerService 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.
V20170131ARMContainerService 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.
V20170701ARMContainerService 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.
V20170831ARMManagedContainerService 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.
V20180331ARMManagedContainerService 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.
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.
VMDiagnostics contains settings to on/off boot diagnostics collection in RD Host.
WindowsProfile represents the windows parameters passed to the cluster.

# Type aliases

AgentPoolProfileRole represents an agent role.
AuthenticatorType represents the authenticator type the cluster was set up with.
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.