# Packages
No description provided by the author
No description provided by the author
No description provided by the author
Package v20160330 stores the api model for version "2016-03-30".
Package v20160930 stores api model for version "2016-09-30".
Package v20170131 stores api model for version "2017-01-31".
Package v20170701 stores api model for version "2017-07-01".
No description provided by the author
Package vlabs stores an experimental api model for acs.
# 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.
ConvertContainerServiceToVLabsOpenShiftCluster converts from a ContainerService to a vlabs.OpenShiftCluster.
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.
ConvertVLabsOpenShiftClusterToContainerService converts from a vlabs.OpenShiftCluster to a ContainerService.
GetOrchestratorVersionProfile returns orchestrator info for upgradable container service.
GetOrchestratorVersionProfileListV20170930 returns v20170930 OrchestratorVersionProfileList object per (optionally) specified orchestrator and version.
GetOrchestratorVersionProfileListVLabs returns vlabs OrchestratorVersionProfileList object per (optionally) specified orchestrator and version.
IsNSeriesSKU returns whether or not the agent pool has Standard_N SKU VMs.
LoadDefaultContainerServiceProperties loads the default API model.
# Constants
AgentPoolProfileRoleCompute is the compute role.
AgentPoolProfileRoleEmpty is the empty role.
AgentPoolProfileRoleInfra is the infra role.
AgentPoolProfileRoleMaster is the master role.
the LinuxDistros supported by vlabs.
AvailabilitySet means that the vms are in an availability set.
ContainerMonitoringAddonName is the name of the kubernetes Container Monitoring addon deployment.
the LinuxDistros supported by vlabs.
Creating means ContainerService resource is being created.
DCOS is the string constant for DCOS orchestrator type and defaults to DCOS188.
DefaultAADPodIdentityAddonEnabled determines the acs-engine provided default for enabling aad-pod-identity addon.
DefaultAADPodIdentityAddonName is the name of the aad-pod-identity addon deployment.
DefaultACIConnectorAddonEnabled determines the acs-engine provided default for enabling aci connector addon.
DefaultACIConnectorAddonName is the name of the aci-connector addon deployment.
DefaultAzureCNINetworkMonitoringAddonEnabled Azure CNI networkmonitor addon default.
DefaultBlobfuseFlexVolumeAddonEnabled determines the acs-engine provided default for enabling blobfuse flexvolume addon.
DefaultBlobfuseFlexVolumeAddonName is the name of the blobfuse flexvolume addon.
DefaultClusterAutoscalerAddonEnabled determines the acs-engine provided default for enabling cluster autoscaler addon.
DefaultClusterAutoscalerAddonName is the name of the cluster autoscaler addon deployment.
DefaultContainerMonitoringAddonEnabled determines the acs-engine provided default for enabling kubernetes container monitoring addon.
DefaultDashboardAddonEnabled determines the acs-engine provided default for enabling kubernetes-dashboard addon.
DefaultDashboardAddonName is the name of the kubernetes-dashboard addon deployment.
DefaultDockerBridgeSubnet specifies the default subnet for the docker bridge network for masters and agents.
DefaultExcludeMasterFromStandardLB determines the acs-engine provided default for excluding master nodes from standard load balancer.
DefaultKeyVaultFlexVolumeAddonEnabled determines the acs-engine provided default for enabling key vault flexvolume addon.
DefaultKeyVaultFlexVolumeAddonName is the name of the key vault flexvolume addon deployment.
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.
DefaultKubernetesCloudProviderRateLimitBucket is 10, takes effect if DefaultKubernetesCloudProviderRateLimit is true.
DefaultKubernetesCloudProviderRateLimitQPS is 3, takes effect if DefaultKubernetesCloudProviderRateLimit is true.
DefaultKubernetesClusterSubnet specifies the default subnet for pods.
DefaultKubernetesDNSServiceIP specifies the IP address that kube-dns listens on by default.
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.
DefaultKubernetesServiceCIDR specifies the IP subnet that kubernetes will create Service IPs within.
DefaultLoadBalancerSku determines the acs-engine provided default for enabling Azure cloudprovider load balancer SKU.
DefaultMetricsServerAddonEnabled determines the acs-engine provided default for enabling kubernetes metrics-server addon.
DefaultMetricsServerAddonName is the name of the kubernetes metrics server addon deployment.
DefaultNVIDIADevicePluginAddonEnabled determines the acs-engine provided default for enabling NVIDIA Device Plugin.
DefaultPrivateClusterEnabled determines the acs-engine provided default for enabling kubernetes Private Cluster.
DefaultRBACEnabled determines the acs-engine provided default for enabling kubernetes RBAC.
DefaultReschedulerAddonEnabled determines the acs-engine provided default for enabling kubernetes-rescheduler addon.
DefaultReschedulerAddonName is the name of the rescheduler addon deployment.
DefaultSecureKubeletEnabled determines the acs-engine provided default for securing kubelet communications.
DefaultSinglePlacementGroup determines the acs-engine provided default for supporting large VMSS (true = single placement group 0-100 VMs, false = multiple placement group 0-1000 VMs).
DefaultSMBFlexVolumeAddonEnabled determines the acs-engine provided default for enabling smb flexvolume addon.
DefaultSMBFlexVolumeAddonName is the name of the smb flexvolume addon.
DefaultTillerAddonEnabled determines the acs-engine provided default for enabling tiller addon.
DefaultTillerAddonName is the name of the tiller addon deployment.
DefaultUseInstanceMetadata determines the acs-engine provided default for enabling Azure cloudprovider instance metadata service.
Deleting means resource is in the process of being deleted.
DockerCEDockerComposeVersion is the Docker Compose version.
DockerCEVersion is the DockerCE orchestrator version.
Failed means resource is in failed state.
Kubernetes is the string constant for the Kubernetes orchestrator type.
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.
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.
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 thee string expression for Azure CNI plugin.
NetworkPluginKubenet is the string expression for the kubenet NetworkPlugin config.
NetworkPolicyAzure is the string expression for Azure CNI network policy manager.
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.
OpenShift is the string constant for the OpenShift orchestrator type.
Supported distros by OpenShift.
the LinuxDistros supported by vlabs.
the LinuxDistros supported by vlabs.
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.
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.
the LinuxDistros supported by vlabs.
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.
# Structs
AADProfile specifies attributes for AAD integration.
AddonProfile represents an addon for managed cluster.
AgentPoolProfile represents an agent pool definition.
Apiloader represents the object that loads api model.
AzProfile holds the azure context for where the cluster resides.
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.
ContainerService complies with the ARM model of resource definition in a JSON template.
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.
DiagnosticsProfile setting to enable/disable capturing diagnostics for VMs hosting container cluster.
Extension represents an extension definition in the master or agentPoolProfile.
ExtensionProfile represents an extension definition.
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 ACS 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.
LinuxProfile represents the linux parameters passed to the cluster.
MasterProfile represents the definition of the master cluster.
OpenShiftConfig holds configuration for OpenShift.
OpenShiftRouterProfile represents an OpenShift router.
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 ACS 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 acs-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 acs-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 acs-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 acs-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 acs-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 acs-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 acs-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.
Distro represents Linux distro to use for Linux VMs.
OSType represents OS types of agents.
ProvisioningState represents the current state of container service resource.