Skip to content

Latest commit

 

History

History
1231 lines (1231 loc) · 22.1 KB

api.md

File metadata and controls

1231 lines (1231 loc) · 22.1 KB
Raw

Packages:

azure.provider.extensions.gardener.cloud/v1alpha1

Package v1alpha1 contains the Azure provider API resources.

Resource Types:

CloudProfileConfig

CloudProfileConfig contains provider-specific configuration that is embedded into Gardener’s CloudProfile resource.

Field Description
apiVersion
string		 azure.provider.extensions.gardener.cloud/v1alpha1
kind
string 		CloudProfileConfig
countUpdateDomains
[]DomainCount

CountUpdateDomains is list of update domain counts for each region.
countFaultDomains
[]DomainCount

CountFaultDomains is list of fault domain counts for each region.
machineImages
[]MachineImages

MachineImages is the list of machine images that are understood by the controller. It maps logical names and versions to provider-specific identifiers.

ControlPlaneConfig

ControlPlaneConfig contains configuration settings for the control plane.

Field Description
apiVersion
string		 azure.provider.extensions.gardener.cloud/v1alpha1
kind
string 		ControlPlaneConfig
cloudControllerManager
CloudControllerManagerConfig 		(Optional)

CloudControllerManager contains configuration settings for the cloud-controller-manager.

InfrastructureConfig

InfrastructureConfig infrastructure configuration resource

Field Description
apiVersion
string		 azure.provider.extensions.gardener.cloud/v1alpha1
kind
string 		InfrastructureConfig
resourceGroup
ResourceGroup 		(Optional)

ResourceGroup is azure resource group.
networks
NetworkConfig

Networks is the network configuration (VNet, subnets, etc.).
identity
IdentityConfig 		(Optional)

Identity containts configuration for the assigned managed identity.
zoned
bool 		(Optional)

Zoned indicates whether the cluster uses availability zones.

WorkerStatus

WorkerStatus contains information about created worker resources.

Field Description
apiVersion
string		 azure.provider.extensions.gardener.cloud/v1alpha1
kind
string 		WorkerStatus
machineImages
[]MachineImage 		(Optional)

MachineImages is a list of machine images that have been used in this worker. Usually, the extension controller gets the mapping from name/version to the provider-specific machine image data in its componentconfig. However, if a version that is still in use gets removed from this componentconfig it cannot reconcile anymore existing Worker resources that are still using this version. Hence, it stores the used versions in the provider status to ensure reconciliation is possible.

AvailabilitySet

(Appears on: InfrastructureStatus)

AvailabilitySet contains information about the azure availability set

Field Description
purpose
Purpose

Purpose is the purpose of the availability set
id
string

ID is the id of the availability set
name
string

Name is the name of the availability set

AzureResourceReference

(Appears on: NatGatewayConfig)

AzureResourceReference contains information to identify a generic Azure resource.

Field Description
name
string

Name is the name of the referenced Azure resource.
resourceGroup
string

ResourceGroup is the resource group which contain the referenced Azure resource.

CloudControllerManagerConfig

(Appears on: ControlPlaneConfig)

CloudControllerManagerConfig contains configuration settings for the cloud-controller-manager.

Field Description
featureGates
map[string]bool 		(Optional)

FeatureGates contains information about enabled feature gates.

DomainCount

(Appears on: CloudProfileConfig)

DomainCount defines the region and the count for this domain count value.

Field Description
region
string

Region is a region.
count
int

Count is the count value for the respective domain count.

IdentityConfig

(Appears on: InfrastructureConfig)

IdentityConfig contains configuration for the managed identity.

Field Description
name
string

Name is the name of the identity.
resourceGroup
string

ResourceGroup is the resource group where the identity belongs to.
acrAccess
bool 		(Optional)

ACRAccess indicated if the identity should be used by the Shoot worker nodes to pull from an Azure Container Registry.

IdentityStatus

(Appears on: InfrastructureStatus)

IdentityStatus contains the status information of the created managed identity.

Field Description
id
string

ID is the Azure resource if of the identity.
clientID
string

ClientID is the client id of the identity.
acrAccess
bool

ACRAccess specifies if the identity should be used by the Shoot worker nodes to pull from an Azure Container Registry.

InfrastructureStatus

InfrastructureStatus contains information about created infrastructure resources.

Field Description
networks
NetworkStatus

Networks is the status of the networks of the infrastructure.
resourceGroup
ResourceGroup

ResourceGroup is azure resource group
availabilitySets
[]AvailabilitySet

AvailabilitySets is a list of created availability sets
routeTables
[]RouteTable

AvailabilitySets is a list of created route tables
securityGroups
[]SecurityGroup

SecurityGroups is a list of created security groups
identity
IdentityStatus 		(Optional)

Identity is the status of the managed identity.
zoned
bool 		(Optional)

Zoned indicates whether the cluster uses zones

MachineImage

(Appears on: WorkerStatus)

MachineImage is a mapping from logical names and versions to provider-specific machine image data.

Field Description
name
string

Name is the logical name of the machine image.
version
string

Version is the logical version of the machine image.
urn
string 		(Optional)

URN is the uniform resource name, it has the format ‘publisher:offer:sku:version’

MachineImageVersion

(Appears on: MachineImages)

MachineImageVersion contains a version and a provider-specific identifier.

Field Description
version
string

Version is the version of the image.
urn
string

URN is the identifier for the image.

MachineImages

(Appears on: CloudProfileConfig)

MachineImages is a mapping from logical names and versions to provider-specific identifiers.

Field Description
name
string

Name is the logical name of the machine image.
versions
[]MachineImageVersion

Versions contains versions and a provider-specific identifier.

NatGatewayConfig

(Appears on: NetworkConfig)

NatGatewayConfig contains configuration for the nat gateway and the attached resources.

Field Description
enabled
bool

Enabled is an indicator if NAT gateway should be deployed.
ipAddresses
[]AzureResourceReference 		(Optional)

IPAddresses is a list of ip addresses which should be assigned to the NAT gateway.
ipAddressRanges
[]AzureResourceReference 		(Optional)

IPAddressRanges is a list of ip address ranges/prefixes which should be assigned to the NAT gateway.

NetworkConfig

(Appears on: InfrastructureConfig)

NetworkConfig holds information about the Kubernetes and infrastructure networks.

Field Description
vnet
VNet

VNet indicates whether to use an existing VNet or create a new one.
workers
string

Workers is the worker subnet range to create (used for the VMs).
natGateway
NatGatewayConfig 		(Optional)

NatGateway contains the configuration for the NatGateway.
serviceEndpoints
[]string 		(Optional)

ServiceEndpoints is a list of Azure ServiceEndpoints which should be associated with the worker subnet.

NetworkStatus

(Appears on: InfrastructureStatus)

NetworkStatus is the current status of the infrastructure networks.

Field Description
vnet
VNetStatus

VNetStatus states the name of the infrastructure VNet.
subnets
[]Subnet

Subnets are the subnets that have been created.

Purpose (string alias)

(Appears on: AvailabilitySet, RouteTable, SecurityGroup, Subnet)

Purpose is a purpose of a subnet.

ResourceGroup

(Appears on: InfrastructureConfig, InfrastructureStatus)

ResourceGroup is azure resource group

Field Description
name
string

Name is the name of the resource group

RouteTable

(Appears on: InfrastructureStatus)

RouteTable is the azure route table

Field Description
purpose
Purpose

Purpose is the purpose of the route table
name
string

Name is the name of the route table

SecurityGroup

(Appears on: InfrastructureStatus)

SecurityGroup contains information about the security group

Field Description
purpose
Purpose

Purpose is the purpose of the security group
name
string

Name is the name of the security group

Subnet

(Appears on: NetworkStatus)

Subnet is a subnet that was created.

Field Description
name
string

Name is the name of the subnet.
purpose
Purpose

Purpose is the purpose for which the subnet was created.

VNet

(Appears on: NetworkConfig)

VNet contains information about the VNet and some related resources.

Field Description
name
string 		(Optional)

Name is the name of an existing vNet which should be used.
resourceGroup
string 		(Optional)

ResourceGroup is the resource group where the existing vNet blongs to.
cidr
string 		(Optional)

CIDR is the VNet CIDR

VNetStatus

(Appears on: NetworkStatus)

VNetStatus contains the VNet name.

Field Description
name
string

Name is the VNet name.
resourceGroup
string 		(Optional)

ResourceGroup is the resource group where the existing vNet belongs to.