Skip to content

Latest commit

 

History

History
88 lines (77 loc) · 5.89 KB

cloud-provider-config.md

File metadata and controls

88 lines (77 loc) · 5.89 KB

Cloud provider config

This doc describes cloud provider config file, which is to be used via --cloud-config flag of azure-cloud-controller-manager.

Here is a config file sample:

{
    "cloud":"AzurePublicCloud",
    "tenantId": "0000000-0000-0000-0000-000000000000",
    "aadClientId": "0000000-0000-0000-0000-000000000000",
    "aadClientSecret": "0000000-0000-0000-0000-000000000000",
    "subscriptionId": "0000000-0000-0000-0000-000000000000",
    "resourceGroup": "<name>",
    "location": "eastus",
    "subnetName": "<name>",
    "securityGroupName": "<name>",
    "vnetName": "<name>",
    "vnetResourceGroup": "",
    "routeTableName": "<name>",
    "primaryAvailabilitySetName": "<name>",
    "cloudProviderBackoff": false,
    "useManagedIdentityExtension": false,
    "useInstanceMetadata": true
}

Note: All values are of string type if not explicitly called out.

Auth config

Name Description Remark
cloud The cloud environment identifier Valid values
tenantID The AAD Tenant ID for the Subscription that the cluster is deployed in
aadClientID The ClientID for an AAD application with RBAC access to talk to Azure RM APIs
aadClientSecret The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs
aadClientCertPath The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs
aadClientCertPassword The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs
useManagedIdentityExtension Use managed service identity for the virtual machine to access Azure ARM APIs Boolean type, default to false
subscriptionId The ID of the Azure Subscription that the cluster is deployed in

Note: Cloud provider currently supports three authentication methods, you can choose one combination of them:

If more than one value is set, the order is Managed Identity > Service Principal > Client Certificate.

Cluster config

Name Description Remark
resourceGroup The name of the resource group that the cluster is deployed in
location The location of the resource group that the cluster is deployed in
vnetName The name of the VNet that the cluster is deployed in
vnetResourceGroup The name of the resource group that the Vnet is deployed in
subnetName The name of the subnet that the cluster is deployed in
securityGroupName The name of the security group attached to the cluster's subnet
routeTableName The name of the route table attached to the subnet that the cluster is deployed in Optional in 1.6
primaryAvailabilitySetName* The name of the availability set that should be used as the load balancer backend Optional
vmType The type of azure nodes. Candidate values are: vmss and standard Optional, default to standard
primaryScaleSetName* The name of the scale set that should be used as the load balancer backend Optional
cloudProviderBackoff Enable exponential backoff to manage resource request retries Boolean value, default to false
cloudProviderBackoffRetries Backoff retry limit Integer value, valid if cloudProviderBackoff is true
cloudProviderBackoffExponent Backoff exponent Float value, valid if cloudProviderBackoff is true
cloudProviderBackoffDuration Backoff duration Integer value, valid if cloudProviderBackoff is true
cloudProviderBackoffJitter Backoff jitter Float value, valid if cloudProviderBackoff is true
cloudProviderRateLimit Enable rate limiting Boolean value, default to false
cloudProviderRateLimitQPS Rate limit QPS (Read) Float value, valid if cloudProviderRateLimit is true
cloudProviderRateLimitBucket Rate limit Bucket Size Integar value, valid if cloudProviderRateLimit is true
cloudProviderRateLimitQPSWrite Rate limit QPS (Write) Float value, valid if cloudProviderRateLimit is true
cloudProviderRateLimitBucketWrite Rate limit Bucket Size Integer value, valid if cloudProviderRateLimit is true
useInstanceMetadata Use instance metadata service where possible Boolean value, default to false
loadBalancerSku Sku of Load Balancer and Public IP. Candidate values are: basic and standard. Default to basic.
excludeMasterFromStandardLB ExcludeMasterFromStandardLB excludes master nodes from standard load balancer. Boolean value, default to true.
maximumLoadBalancerRuleCount Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer Integer value, default to 148

primaryAvailabilitySetName

If this is set, the Azure cloudprovider will only add nodes from that availability set to the load balancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then the cloudprovider will try to add all nodes to a single backend pool which is forbidden. In other words, if you use multiple agent pools (availability sets), you MUST set this field.

primaryScaleSetName

If this is set, the Azure cloudprovider will only add nodes from that scale set to the load balancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then the cloudprovider will try to add all nodes to a single backend pool which is forbidden. In other words, if you use multiple agent pools (scale sets), you MUST set this field.