github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-25 20:53:33 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #41992 from colemickens/cmpr-azure-config-doc

Browse Source 
Automatic merge from submit-queue (batch tested with PRs 35408, 41915, 41992, 41964, 41925)

azure: document config file (+ remove unused field)

**What this PR does / why we need it**:
* documents the config file used by the Azure cloudprovider
* removes an unused field that shouldn't have been added

```release-note
NONE
```
This commit is contained in:
Kubernetes Submit Queue 2017-02-26 18:07:57 -08:00 committed by GitHub
commit 7224805c55
1 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
pkg/cloudprovider/providers/azure/azure.go
View File

@ -34,21 +34,37 @@ import (
const CloudProviderName = "azure" const CloudProviderName = "azure"
// Config holds the configuration parsed from the --cloud-config flag // Config holds the configuration parsed from the --cloud-config flag
// All fields are required unless otherwise specified
type Config struct { type Config struct {
Cloud string `json:"cloud" yaml:"cloud"` // The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13
TenantID string `json:"tenantId" yaml:"tenantId"` Cloud string `json:"cloud" yaml:"cloud"`
SubscriptionID string `json:"subscriptionId" yaml:"subscriptionId"` // The AAD Tenant ID for the Subscription that the cluster is deployed in
ResourceGroup string `json:"resourceGroup" yaml:"resourceGroup"` TenantID string `json:"tenantId" yaml:"tenantId"`
Location string `json:"location" yaml:"location"` // The ID of the Azure Subscription that the cluster is deployed in
VnetName string `json:"vnetName" yaml:"vnetName"` SubscriptionID string `json:"subscriptionId" yaml:"subscriptionId"`
SubnetName string `json:"subnetName" yaml:"subnetName"` // The name of the resource group that the cluster is deployed in
SecurityGroupName string `json:"securityGroupName" yaml:"securityGroupName"` ResourceGroup string `json:"resourceGroup" yaml:"resourceGroup"`
RouteTableName string `json:"routeTableName" yaml:"routeTableName"` // The location of the resource group that the cluster is deployed in
Location string `json:"location" yaml:"location"`
// The name of the VNet that the cluster is deployed in
VnetName string `json:"vnetName" yaml:"vnetName"`
// The name of the subnet that the cluster is deployed in
SubnetName string `json:"subnetName" yaml:"subnetName"`
// The name of the security group attached to the cluster's subnet
SecurityGroupName string `json:"securityGroupName" yaml:"securityGroupName"`
// (Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in
RouteTableName string `json:"routeTableName" yaml:"routeTableName"`
// (Optional) The name of the availability set that should be used as the load balancer backend
// 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.
PrimaryAvailabilitySetName string `json:"primaryAvailabilitySetName" yaml:"primaryAvailabilitySetName"` PrimaryAvailabilitySetName string `json:"primaryAvailabilitySetName" yaml:"primaryAvailabilitySetName"`
AADClientID string `json:"aadClientId" yaml:"aadClientId"` // The ClientID for an AAD application with RBAC access to talk to Azure RM APIs
AADClientID string `json:"aadClientId" yaml:"aadClientId"`
// The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs
AADClientSecret string `json:"aadClientSecret" yaml:"aadClientSecret"` AADClientSecret string `json:"aadClientSecret" yaml:"aadClientSecret"`
AADTenantID string `json:"aadTenantId" yaml:"aadTenantId"`
} }
// Cloud holds the config and clients // Cloud holds the config and clients