Last generated October 19, 2020

AzureCluster

AzureCluster is the Schema for the azureclusters API

Full name:
azureclusters.infrastructure.cluster.x-k8s.io
Group:
infrastructure.cluster.x-k8s.io
Singular name:
azurecluster
Plural name:
azureclusters
Scope:
Namespaced
Versions:
v1alpha3

Version v1alpha3

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object

AzureClusterSpec defines the desired state of AzureCluster

.spec.additionalTags

object

AdditionalTags is an optional set of tags to add to Azure resources managed by the Azure provider, in addition to the ones added by default.

.spec.controlPlaneEndpoint

object

ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

.spec.controlPlaneEndpoint.host

string Required

The hostname on which the API server is serving.

.spec.controlPlaneEndpoint.port

integer Required

The port on which the API server is serving.

.spec.location

string Required

.spec.networkSpec

object

NetworkSpec encapsulates all things related to Azure network.

.spec.networkSpec.subnets

array

Subnets is the configuration for the control-plane subnet and the node subnet.

.spec.networkSpec.subnets[*]

object

SubnetSpec configures an Azure subnet.

.spec.networkSpec.subnets[*].cidrBlock

string

CidrBlock is the CIDR block to be used when the provider creates a managed Vnet. DEPRECATED: Use CIDRBlocks instead

.spec.networkSpec.subnets[*].cidrBlocks

array

CIDRBlocks defines the subnet’s address space, specified as one or more address prefixes in CIDR notation.

.spec.networkSpec.subnets[*].cidrBlocks[*]

string

.spec.networkSpec.subnets[*].id

string

ID defines a unique identifier to reference this resource.

.spec.networkSpec.subnets[*].internalLBIPAddress

string

InternalLBIPAddress is the IP address that will be used as the internal LB private IP. For the control plane subnet only.

.spec.networkSpec.subnets[*].name

string Required

Name defines a name for the subnet resource.

.spec.networkSpec.subnets[*].role

string

Role defines the subnet role (eg. Node, ControlPlane)

.spec.networkSpec.subnets[*].routeTable

object

RouteTable defines the route table that should be attached to this subnet.

.spec.networkSpec.subnets[*].routeTable.id

string

.spec.networkSpec.subnets[*].routeTable.name

string

.spec.networkSpec.subnets[*].securityGroup

object

SecurityGroup defines the NSG (network security group) that should be attached to this subnet.

.spec.networkSpec.subnets[*].securityGroup.id

string

.spec.networkSpec.subnets[*].securityGroup.ingressRule

array

IngressRules is a slice of Azure ingress rules for security groups.

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*]

object

IngressRule defines an Azure ingress rule for security groups.

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*].description

string Required

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*].destination

string

Destination - The destination address prefix. CIDR or destination IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used.

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*].destinationPorts

string

DestinationPorts - The destination port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports.

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*].name

string Required

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*].priority

integer

Priority - A number between 100 and 4096. Each rule should have a unique value for priority. Rules are processed in priority order, with lower numbers processed before higher numbers. Once traffic matches a rule, processing stops.

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*].protocol

string Required

SecurityGroupProtocol defines the protocol type for a security group rule.

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*].source

string

Source - The CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from.

.spec.networkSpec.subnets[*].securityGroup.ingressRule[*].sourcePorts

string

SourcePorts - The source port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports.

.spec.networkSpec.subnets[*].securityGroup.name

string

.spec.networkSpec.subnets[*].securityGroup.tags

object

Tags defines a map of tags.

.spec.networkSpec.vnet

object

Vnet is the configuration for the Azure virtual network.

.spec.networkSpec.vnet.cidrBlock

string

CidrBlock is the CIDR block to be used when the provider creates a managed virtual network. DEPRECATED: Use CIDRBlocks instead

.spec.networkSpec.vnet.cidrBlocks

array

CIDRBlocks defines the virtual network’s address space, specified as one or more address prefixes in CIDR notation.

.spec.networkSpec.vnet.cidrBlocks[*]

string

.spec.networkSpec.vnet.id

string

ID is the identifier of the virtual network this provider should use to create resources.

.spec.networkSpec.vnet.name

string Required

Name defines a name for the virtual network resource.

.spec.networkSpec.vnet.resourceGroup

string

ResourceGroup is the name of the resource group of the existing virtual network or the resource group where a managed virtual network should be created.

.spec.networkSpec.vnet.tags

object

Tags is a collection of tags describing the resource.

.spec.resourceGroup

string

.spec.subscriptionID

string

.status

object

AzureClusterStatus defines the observed state of AzureCluster

.status.conditions

array

Conditions defines current service state of the AzureCluster.

.status.conditions[*]

object

Condition defines an observation of a Cluster API resource operational state.

.status.conditions[*].lastTransitionTime

string

Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

.status.conditions[*].message

string

A human readable message indicating details about the transition. This field may be empty.

.status.conditions[*].reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

.status.conditions[*].severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

.status.conditions[*].status

string Required

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

string Required

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.failureDomains

object

FailureDomains specifies the list of unique failure domains for the location/region of the cluster. A FailureDomain maps to Availability Zone with an Azure Region (if the region support them). An Availability Zone is a separate data center within a region and they can be used to ensure the cluster is more resilient to failure. See: https://docs.microsoft.com/en-us/azure/availability-zones/az-overview This list will be used by Cluster API to try and spread the machines across the failure domains.

.status.network

object

Network encapsulates the state of Azure networking resources.

.status.network.apiServerIp

object

APIServerIP is the Kubernetes API server public IP address.

.status.network.apiServerIp.dnsName

string

.status.network.apiServerIp.id

string

.status.network.apiServerIp.ipAddress

string

.status.network.apiServerIp.name

string

.status.network.apiServerLb

object

APIServerLB is the Kubernetes API server load balancer.

.status.network.apiServerLb.backendPool

object

BackendPool defines a load balancer backend pool

.status.network.apiServerLb.backendPool.id

string

.status.network.apiServerLb.backendPool.name

string

.status.network.apiServerLb.frontendIpConfig

object

FrontendIPConfig - DO NOT USE this empty struct is here to preserve backwards compatibility and should be removed in v1alpha4

.status.network.apiServerLb.id

string

.status.network.apiServerLb.name

string

.status.network.apiServerLb.sku

string

SKU defines an Azure load balancer SKU.

.status.network.apiServerLb.tags

object

Tags defines a map of tags.

.status.ready

boolean

Ready is true when the provider resource is ready.


This documentation page shows information based on apiextensions v3.2.0.