v1alpha3

package
v0.4.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 16, 2020 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Overview

Package v1alpha3 contains API Schema definitions for the infrastructure v1alpha3 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io

Index

Constants

View Source 
const (
	// DefaultVnetCIDR is the default Vnet CIDR
	DefaultVnetCIDR = "10.0.0.0/8"
	// DefaultControlPlaneSubnetCIDR is the default Control Plane Subnet CIDR
	DefaultControlPlaneSubnetCIDR = "10.0.0.0/16"
	// DefaultNodeSubnetCIDR is the default Node Subnet CIDR
	DefaultNodeSubnetCIDR = "10.1.0.0/16"
)
View Source 
const (
	// ResourceLifecycleOwned is the value we use when tagging resources to indicate
	// that the resource is considered owned and managed by the cluster,
	// and in particular that the lifecycle is tied to the lifecycle of the cluster.
	ResourceLifecycleOwned = ResourceLifecycle("owned")

	// ResourceLifecycleShared is the value we use when tagging resources to indicate
	// that the resource is shared between multiple clusters, and should not be destroyed
	// if the cluster is destroyed.
	ResourceLifecycleShared = ResourceLifecycle("shared")

	// NameKubernetesAzureCloudProviderPrefix is the tag name used by the cloud provider to logically
	// separate independent cluster resources. We use it to identify which resources we expect
	// to be permissive about state changes.
	// logically independent clusters running in the same AZ.
	// The tag key = NameKubernetesAzureCloudProviderPrefix + clusterID
	// The tag value is an ownership value
	NameKubernetesAzureCloudProviderPrefix = "kubernetes.io_cluster_"

	// NameAzureProviderPrefix is the tag prefix we use to differentiate
	// cluster-api-provider-azure owned components from other tooling that
	// uses NameKubernetesClusterPrefix
	NameAzureProviderPrefix = "sigs.k8s.io_cluster-api-provider-azure_"

	// NameAzureProviderOwned is the tag name we use to differentiate
	// cluster-api-provider-azure owned components from other tooling that
	// uses NameKubernetesClusterPrefix
	NameAzureProviderOwned = NameAzureProviderPrefix + "cluster_"

	// NameAzureClusterAPIRole is the tag name we use to mark roles for resources
	// dedicated to this cluster api provider implementation.
	NameAzureClusterAPIRole = NameAzureProviderPrefix + "role"

	// APIServerRole describes the value for the apiserver role
	APIServerRole = "apiserver"

	// NodeOutboundRole describes the value for the node outbound LB role
	NodeOutboundRole = "nodeOutbound"

	// BastionRole describes the value for the bastion role
	BastionRole = "bastion"

	// CommonRole describes the value for the common role
	CommonRole = "common"

	// PublicRole describes the value for the public role
	PublicRole = "public"

	// PrivateRole describes the value for the private role
	PrivateRole = "private"
)
View Source 
const (
	// ControlPlane machine label
	ControlPlane string = "control-plane"
	// Node machine label
	Node string = "node"
)
View Source 
const (
	// SecurityGroupNode defines a Kubernetes workload node role
	SecurityGroupNode = SecurityGroupRole(Node)

	// SecurityGroupControlPlane defines a Kubernetes control plane node role
	SecurityGroupControlPlane = SecurityGroupRole(ControlPlane)
)
View Source 
const (
	// SecurityGroupProtocolAll is a wildcard for all IP protocols
	SecurityGroupProtocolAll = SecurityGroupProtocol("*")

	// SecurityGroupProtocolTCP represents the TCP protocol in ingress rules
	SecurityGroupProtocolTCP = SecurityGroupProtocol("Tcp")

	// SecurityGroupProtocolUDP represents the UDP protocol in ingress rules
	SecurityGroupProtocolUDP = SecurityGroupProtocol("Udp")
)
View Source 
const (
	// SKUBasic is the value for the Azure load balancer Basic SKU
	SKUBasic = SKU("Basic")
	// SKUStandard is the value for the Azure load balancer Standard SKU
	SKUStandard = SKU("Standard")
)
View Source 
const (
	// SubnetNode defines a Kubernetes workload node role
	SubnetNode = SubnetRole(Node)

	// SubnetControlPlane defines a Kubernetes control plane node role
	SubnetControlPlane = SubnetRole(ControlPlane)
)
View Source 
const (
	// ClusterFinalizer allows ReconcileAzureCluster to clean up Azure resources associated with AzureCluster before
	// removing it from the apiserver.
	ClusterFinalizer = "azurecluster.infrastructure.cluster.x-k8s.io"
)
View Source 
const (
	// MachineFinalizer allows ReconcileAzureMachine to clean up Azure resources associated with AzureMachine before
	// removing it from the apiserver.
	MachineFinalizer = "azuremachine.infrastructure.cluster.x-k8s.io"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "infrastructure.cluster.x-k8s.io", Version: "v1alpha3"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func ClusterAzureCloudProviderTagKey 

func ClusterAzureCloudProviderTagKey(name string) string

ClusterAzureCloudProviderTagKey generates the key for resources associated a cluster's Azure cloud provider.

func ClusterTagKey 

func ClusterTagKey(name string) string

ClusterTagKey generates the key for resources associated with a cluster.

func ValidateImage 

func ValidateImage(image *Image, fldPath *field.Path) field.ErrorList

ValidateImage validates an image

func ValidateOSDisk added in v0.4.5 

func ValidateOSDisk(osDisk OSDisk, fieldPath *field.Path) field.ErrorList

ValidateOSDisk validates the OSDisk spec

func ValidateSSHKey added in v0.4.3 

func ValidateSSHKey(sshKey string, fldPath *field.Path) field.ErrorList

ValidateSSHKey validates an SSHKey

func ValidateUserAssignedIdentity added in v0.4.5 

func ValidateUserAssignedIdentity(identityType VMIdentity, userAssignedIdenteties []UserAssignedIdentity, fldPath *field.Path) field.ErrorList

ValidateUserAssignedIdentity validates the user-assigned identities list

Types

type AvailabilityZone deprecated 

type AvailabilityZone struct {
	ID      *string `json:"id,omitempty"`
	Enabled *bool   `json:"enabled,omitempty"`
}

AvailabilityZone specifies an Azure Availability Zone

Deprecated: Use FailureDomain instead

func (*AvailabilityZone) DeepCopy 

func (in *AvailabilityZone) DeepCopy() *AvailabilityZone

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AvailabilityZone.

func (*AvailabilityZone) DeepCopyInto 

func (in *AvailabilityZone) DeepCopyInto(out *AvailabilityZone)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureCluster 

type AzureCluster struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AzureClusterSpec   `json:"spec,omitempty"`
	Status AzureClusterStatus `json:"status,omitempty"`
}

AzureCluster is the Schema for the azureclusters API

func (*AzureCluster) DeepCopy 

func (in *AzureCluster) DeepCopy() *AzureCluster

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureCluster.

func (*AzureCluster) DeepCopyInto 

func (in *AzureCluster) DeepCopyInto(out *AzureCluster)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AzureCluster) DeepCopyObject 

func (in *AzureCluster) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AzureCluster) Default added in v0.4.5 

func (c *AzureCluster) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type

func (*AzureCluster) Hub 

func (*AzureCluster) Hub()

Hub marks AzureCluster as a conversion hub.

func (*AzureCluster) SetupWebhookWithManager 

func (c *AzureCluster) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*AzureCluster) ValidateCreate added in v0.4.3 

func (c *AzureCluster) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*AzureCluster) ValidateDelete added in v0.4.3 

func (c *AzureCluster) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*AzureCluster) ValidateUpdate added in v0.4.3 

func (c *AzureCluster) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type AzureClusterList 

type AzureClusterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AzureCluster `json:"items"`
}

AzureClusterList contains a list of AzureCluster

func (*AzureClusterList) DeepCopy 

func (in *AzureClusterList) DeepCopy() *AzureClusterList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureClusterList.

func (*AzureClusterList) DeepCopyInto 

func (in *AzureClusterList) DeepCopyInto(out *AzureClusterList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AzureClusterList) DeepCopyObject 

func (in *AzureClusterList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AzureClusterList) Hub 

func (*AzureClusterList) Hub()

Hub marks AzureClusterList as a conversion hub.

type AzureClusterSpec 

type AzureClusterSpec struct {
	// NetworkSpec encapsulates all things related to Azure network.
	NetworkSpec NetworkSpec `json:"networkSpec,omitempty"`

	ResourceGroup string `json:"resourceGroup"`

	SubscriptionID string `json:"subscriptionID,omitempty"`

	Location string `json:"location"`

	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
	// +optional
	ControlPlaneEndpoint clusterv1.APIEndpoint `json:"controlPlaneEndpoint"`

	// 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.
	// +optional
	AdditionalTags Tags `json:"additionalTags,omitempty"`
}

AzureClusterSpec defines the desired state of AzureCluster

func (*AzureClusterSpec) DeepCopy 

func (in *AzureClusterSpec) DeepCopy() *AzureClusterSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureClusterSpec.

func (*AzureClusterSpec) DeepCopyInto 

func (in *AzureClusterSpec) DeepCopyInto(out *AzureClusterSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureClusterStatus 

type AzureClusterStatus struct {
	Network Network `json:"network,omitempty"`

	// 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.
	FailureDomains clusterv1.FailureDomains `json:"failureDomains,omitempty"`

	Bastion VM `json:"bastion,omitempty"`

	// Ready is true when the provider resource is ready.
	// +optional
	Ready bool `json:"ready"`
}

AzureClusterStatus defines the observed state of AzureCluster

func (*AzureClusterStatus) DeepCopy 

func (in *AzureClusterStatus) DeepCopy() *AzureClusterStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureClusterStatus.

func (*AzureClusterStatus) DeepCopyInto 

func (in *AzureClusterStatus) DeepCopyInto(out *AzureClusterStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureMachine 

type AzureMachine struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AzureMachineSpec   `json:"spec,omitempty"`
	Status AzureMachineStatus `json:"status,omitempty"`
}

AzureMachine is the Schema for the azuremachines API

func (*AzureMachine) DeepCopy 

func (in *AzureMachine) DeepCopy() *AzureMachine

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMachine.

func (*AzureMachine) DeepCopyInto 

func (in *AzureMachine) DeepCopyInto(out *AzureMachine)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AzureMachine) DeepCopyObject 

func (in *AzureMachine) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AzureMachine) Default added in v0.4.3 

func (m *AzureMachine) Default()

Default implements webhookutil.defaulter so a webhook will be registered for the type

func (*AzureMachine) Hub 

func (*AzureMachine) Hub()

Hub marks AzureMachine as a conversion hub.

func (*AzureMachine) SetDefaultSSHPublicKey added in v0.4.3 

func (m *AzureMachine) SetDefaultSSHPublicKey() error

SetDefaultSSHPublicKey sets the default SSHPublicKey for an AzureMachine

func (*AzureMachine) SetupWebhookWithManager 

func (m *AzureMachine) SetupWebhookWithManager(mgr ctrl.Manager) error

SetupWebhookWithManager will setup and register the webhook with the controller mnager

func (*AzureMachine) ValidateCreate 

func (m *AzureMachine) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*AzureMachine) ValidateDelete 

func (m *AzureMachine) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*AzureMachine) ValidateUpdate 

func (m *AzureMachine) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type AzureMachineList 

type AzureMachineList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AzureMachine `json:"items"`
}

AzureMachineList contains a list of AzureMachine

func (*AzureMachineList) DeepCopy 

func (in *AzureMachineList) DeepCopy() *AzureMachineList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMachineList.

func (*AzureMachineList) DeepCopyInto 

func (in *AzureMachineList) DeepCopyInto(out *AzureMachineList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AzureMachineList) DeepCopyObject 

func (in *AzureMachineList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AzureMachineList) Hub 

func (*AzureMachineList) Hub()

Hub marks AzureMachineList as a conversion hub.

type AzureMachineSpec 

type AzureMachineSpec struct {
	// ProviderID is the unique identifier as specified by the cloud provider.
	// +optional
	ProviderID *string `json:"providerID,omitempty"`

	VMSize string `json:"vmSize"`

	// FailureDomain is the failure domain unique identifier this Machine should be attached to,
	// as defined in Cluster API. This relates to an Azure Availability Zone
	FailureDomain *string `json:"failureDomain,omitempty"`

	// DEPRECATED: use FailureDomain instead
	AvailabilityZone AvailabilityZone `json:"availabilityZone,omitempty"`

	// Image is used to provide details of an image to use during VM creation.
	// If image details are omitted the image will default the Azure Marketplace "capi" offer,
	// which is based on Ubuntu.
	// +kubebuilder:validation:nullable
	// +optional
	Image *Image `json:"image,omitempty"`

	// Identity is the type of identity used for the virtual machine.
	// The type 'SystemAssigned' is an implicitly created identity.
	// The generated identity will be assigned a Subscription contributor role.
	// The type 'UserAssigned' is a standalone Azure resource provided by the user
	// and assigned to the VM
	// +kubebuilder:default=None
	// +optional
	Identity VMIdentity `json:"identity,omitempty"`

	// UserAssignedIdentities is a list of standalone Azure identities provided by the user
	// The lifecycle of a user-assigned identity is managed separately from the lifecycle of
	// the AzureMachine.
	// +optional
	UserAssignedIdentities []UserAssignedIdentity `json:"userAssignedIdentities,omitempty"`

	OSDisk OSDisk `json:"osDisk"`

	Location string `json:"location"`

	SSHPublicKey string `json:"sshPublicKey"`

	// AdditionalTags is an optional set of tags to add to an instance, in addition to the ones added by default by the
	// Azure provider. If both the AzureCluster and the AzureMachine specify the same tag name with different values, the
	// AzureMachine's value takes precedence.
	// +optional
	AdditionalTags Tags `json:"additionalTags,omitempty"`

	// AllocatePublicIP allows the ability to create dynamic public ips for machines where this value is true.
	// +optional
	AllocatePublicIP bool `json:"allocatePublicIP,omitempty"`

	// AcceleratedNetworking enables or disables Azure accelerated networking. If omitted, it will be set based on
	// whether the requested VMSize supports accelerated networking.
	// If AcceleratedNetworking is set to true with a VMSize that does not support it, Azure will return an error.
	// +kubebuilder:validation:nullable
	// +optional
	AcceleratedNetworking *bool `json:"acceleratedNetworking,omitempty"`
}

AzureMachineSpec defines the desired state of AzureMachine

func (*AzureMachineSpec) DeepCopy 

func (in *AzureMachineSpec) DeepCopy() *AzureMachineSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMachineSpec.

func (*AzureMachineSpec) DeepCopyInto 

func (in *AzureMachineSpec) DeepCopyInto(out *AzureMachineSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureMachineStatus 

type AzureMachineStatus struct {
	// Ready is true when the provider resource is ready.
	// +optional
	Ready bool `json:"ready"`

	// Addresses contains the Azure instance associated addresses.
	Addresses []v1.NodeAddress `json:"addresses,omitempty"`

	// VMState is the provisioning state of the Azure virtual machine.
	// +optional
	VMState *VMState `json:"vmState,omitempty"`

	// ErrorReason will be set in the event that there is a terminal problem
	// reconciling the Machine and will contain a succinct value suitable
	// for machine interpretation.
	//
	// This field should not be set for transitive errors that a controller
	// faces that are expected to be fixed automatically over
	// time (like service outages), but instead indicate that something is
	// fundamentally wrong with the Machine's spec or the configuration of
	// the controller, and that manual intervention is required. Examples
	// of terminal errors would be invalid combinations of settings in the
	// spec, values that are unsupported by the controller, or the
	// responsible controller itself being critically misconfigured.
	//
	// Any transient errors that occur during the reconciliation of Machines
	// can be added as events to the Machine object and/or logged in the
	// controller's output.
	// +optional
	FailureReason *errors.MachineStatusError `json:"failureReason,omitempty"`

	// ErrorMessage will be set in the event that there is a terminal problem
	// reconciling the Machine and will contain a more verbose string suitable
	// for logging and human consumption.
	//
	// This field should not be set for transitive errors that a controller
	// faces that are expected to be fixed automatically over
	// time (like service outages), but instead indicate that something is
	// fundamentally wrong with the Machine's spec or the configuration of
	// the controller, and that manual intervention is required. Examples
	// of terminal errors would be invalid combinations of settings in the
	// spec, values that are unsupported by the controller, or the
	// responsible controller itself being critically misconfigured.
	//
	// Any transient errors that occur during the reconciliation of Machines
	// can be added as events to the Machine object and/or logged in the
	// controller's output.
	// +optional
	FailureMessage *string `json:"failureMessage,omitempty"`
}

AzureMachineStatus defines the observed state of AzureMachine

func (*AzureMachineStatus) DeepCopy 

func (in *AzureMachineStatus) DeepCopy() *AzureMachineStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMachineStatus.

func (*AzureMachineStatus) DeepCopyInto 

func (in *AzureMachineStatus) DeepCopyInto(out *AzureMachineStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureMachineTemplate 

type AzureMachineTemplate struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec AzureMachineTemplateSpec `json:"spec,omitempty"`
}

AzureMachineTemplate is the Schema for the azuremachinetemplates API

func (*AzureMachineTemplate) DeepCopy 

func (in *AzureMachineTemplate) DeepCopy() *AzureMachineTemplate

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMachineTemplate.

func (*AzureMachineTemplate) DeepCopyInto 

func (in *AzureMachineTemplate) DeepCopyInto(out *AzureMachineTemplate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AzureMachineTemplate) DeepCopyObject 

func (in *AzureMachineTemplate) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AzureMachineTemplate) Hub 

func (*AzureMachineTemplate) Hub()

Hub marks AzureMachineTemplate as a conversion hub.

func (*AzureMachineTemplate) SetupWebhookWithManager 

func (r *AzureMachineTemplate) SetupWebhookWithManager(mgr ctrl.Manager) error

type AzureMachineTemplateList 

type AzureMachineTemplateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AzureMachineTemplate `json:"items"`
}

AzureMachineTemplateList contains a list of AzureMachineTemplate

func (*AzureMachineTemplateList) DeepCopy 

func (in *AzureMachineTemplateList) DeepCopy() *AzureMachineTemplateList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMachineTemplateList.

func (*AzureMachineTemplateList) DeepCopyInto 

func (in *AzureMachineTemplateList) DeepCopyInto(out *AzureMachineTemplateList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AzureMachineTemplateList) DeepCopyObject 

func (in *AzureMachineTemplateList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AzureMachineTemplateList) Hub 

func (*AzureMachineTemplateList) Hub()

Hub marks AzureMachineTemplateList as a conversion hub.

type AzureMachineTemplateResource 

type AzureMachineTemplateResource struct {
	// Spec is the specification of the desired behavior of the machine.
	Spec AzureMachineSpec `json:"spec"`
}

AzureMachineTemplateResource describes the data needed to create an AzureMachine from a template

func (*AzureMachineTemplateResource) DeepCopy 

func (in *AzureMachineTemplateResource) DeepCopy() *AzureMachineTemplateResource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMachineTemplateResource.

func (*AzureMachineTemplateResource) DeepCopyInto 

func (in *AzureMachineTemplateResource) DeepCopyInto(out *AzureMachineTemplateResource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureMachineTemplateSpec 

type AzureMachineTemplateSpec struct {
	Template AzureMachineTemplateResource `json:"template"`
}

AzureMachineTemplateSpec defines the desired state of AzureMachineTemplate

func (*AzureMachineTemplateSpec) DeepCopy 

func (in *AzureMachineTemplateSpec) DeepCopy() *AzureMachineTemplateSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMachineTemplateSpec.

func (*AzureMachineTemplateSpec) DeepCopyInto 

func (in *AzureMachineTemplateSpec) DeepCopyInto(out *AzureMachineTemplateSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureMarketplaceImage 

type AzureMarketplaceImage struct {
	// Publisher is the name of the organization that created the image
	// +kubebuilder:validation:MinLength=1
	Publisher string `json:"publisher"`
	// Offer specifies the name of a group of related images created by the publisher.
	// For example, UbuntuServer, WindowsServer
	// +kubebuilder:validation:MinLength=1
	Offer string `json:"offer"`
	// SKU specifies an instance of an offer, such as a major release of a distribution.
	// For example, 18.04-LTS, 2019-Datacenter
	// +kubebuilder:validation:MinLength=1
	SKU string `json:"sku"`
	// Version specifies the version of an image sku. The allowed formats
	// are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers.
	// Specify 'latest' to use the latest version of an image available at deploy time.
	// Even if you use 'latest', the VM image will not automatically update after deploy
	// time even if a new version becomes available.
	// +kubebuilder:validation:MinLength=1
	Version string `json:"version"`
}

AzureMarketplaceImage defines an image in the Azure Marketplace to use for VM creation

func (*AzureMarketplaceImage) DeepCopy 

func (in *AzureMarketplaceImage) DeepCopy() *AzureMarketplaceImage

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureMarketplaceImage.

func (*AzureMarketplaceImage) DeepCopyInto 

func (in *AzureMarketplaceImage) DeepCopyInto(out *AzureMarketplaceImage)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureSharedGalleryImage 

type AzureSharedGalleryImage struct {
	// SubscriptionID is the identifier of the subscription that contains the shared image gallery
	// +kubebuilder:validation:MinLength=1
	SubscriptionID string `json:"subscriptionID"`
	// ResourceGroup specifies the resource group containing the shared image gallery
	// +kubebuilder:validation:MinLength=1
	ResourceGroup string `json:"resourceGroup"`
	// Gallery specifies the name of the shared image gallery that contains the image
	// +kubebuilder:validation:MinLength=1
	Gallery string `json:"gallery"`
	// Name is the name of the image
	// +kubebuilder:validation:MinLength=1
	Name string `json:"name"`
	// Version specifies the version of the marketplace image. The allowed formats
	// are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers.
	// Specify 'latest' to use the latest version of an image available at deploy time.
	// Even if you use 'latest', the VM image will not automatically update after deploy
	// time even if a new version becomes available.
	// +kubebuilder:validation:MinLength=1
	Version string `json:"version"`
}

AzureSharedGalleryImage defines an image in a Shared Image Gallery to use for VM creation

func (*AzureSharedGalleryImage) DeepCopy 

func (in *AzureSharedGalleryImage) DeepCopy() *AzureSharedGalleryImage

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureSharedGalleryImage.

func (*AzureSharedGalleryImage) DeepCopyInto 

func (in *AzureSharedGalleryImage) DeepCopyInto(out *AzureSharedGalleryImage)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BackendPool 

type BackendPool struct {
	Name string `json:"name,omitempty"`
	ID   string `json:"id,omitempty"`
}

BackendPool defines a load balancer backend pool

func (*BackendPool) DeepCopy 

func (in *BackendPool) DeepCopy() *BackendPool

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendPool.

func (*BackendPool) DeepCopyInto 

func (in *BackendPool) DeepCopyInto(out *BackendPool)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BuildParams 

type BuildParams struct {
	// Lifecycle determines the resource lifecycle.
	Lifecycle ResourceLifecycle

	// ClusterName is the cluster associated with the resource.
	ClusterName string

	// ResourceID is the unique identifier of the resource to be tagged.
	ResourceID string

	// Name is the name of the resource, it's applied as the tag "Name" on Azure.
	// +optional
	Name *string

	// Role is the role associated to the resource.
	// +optional
	Role *string

	// Any additional tags to be added to the resource.
	// +optional
	Additional Tags
}

BuildParams is used to build tags around an azure resource.

func (*BuildParams) DeepCopy 

func (in *BuildParams) DeepCopy() *BuildParams

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildParams.

func (*BuildParams) DeepCopyInto 

func (in *BuildParams) DeepCopyInto(out *BuildParams)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FrontendIPConfig 

type FrontendIPConfig struct{}

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

func (*FrontendIPConfig) DeepCopy 

func (in *FrontendIPConfig) DeepCopy() *FrontendIPConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FrontendIPConfig.

func (*FrontendIPConfig) DeepCopyInto 

func (in *FrontendIPConfig) DeepCopyInto(out *FrontendIPConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Image 

type Image struct {
	// ID specifies an image to use by ID
	// +optional
	ID *string `json:"id,omitempty"`

	// SharedGallery specifies an image to use from an Azure Shared Image Gallery
	// +optional
	SharedGallery *AzureSharedGalleryImage `json:"sharedGallery,omitempty"`

	// Marketplace specifies an image to use from the Azure Marketplace
	// +optional
	Marketplace *AzureMarketplaceImage `json:"marketplace,omitempty"`
}

Image defines information about the image to use for VM creation. There are three ways to specify an image: by ID, Marketplace Image or SharedImageGallery One of ID, SharedImage or Marketplace should be set.

func (*Image) DeepCopy 

func (in *Image) DeepCopy() *Image

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Image.

func (*Image) DeepCopyInto 

func (in *Image) DeepCopyInto(out *Image)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressRule 

type IngressRule struct {
	Description string                `json:"description"`
	Protocol    SecurityGroupProtocol `json:"protocol"`

	// SourcePorts - The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.
	SourcePorts *string `json:"sourcePorts,omitempty"`

	// DestinationPorts - The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports.
	DestinationPorts *string `json:"destinationPorts,omitempty"`

	// 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.
	Source *string `json:"source,omitempty"`

	// 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.
	Destination *string `json:"destination,omitempty"`
}

IngressRule defines an Azure ingress rule for security groups.

func (*IngressRule) DeepCopy 

func (in *IngressRule) DeepCopy() *IngressRule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRule.

func (*IngressRule) DeepCopyInto 

func (in *IngressRule) DeepCopyInto(out *IngressRule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressRules 

type IngressRules []*IngressRule

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

func (IngressRules) DeepCopy 

func (in IngressRules) DeepCopy() IngressRules

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressRules.

func (IngressRules) DeepCopyInto 

func (in IngressRules) DeepCopyInto(out *IngressRules)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LoadBalancer 

type LoadBalancer struct {
	ID               string           `json:"id,omitempty"`
	Name             string           `json:"name,omitempty"`
	SKU              SKU              `json:"sku,omitempty"`
	FrontendIPConfig FrontendIPConfig `json:"frontendIpConfig,omitempty"`
	BackendPool      BackendPool      `json:"backendPool,omitempty"`
	Tags             Tags             `json:"tags,omitempty"`
}

LoadBalancer defines an Azure load balancer.

func (*LoadBalancer) DeepCopy 

func (in *LoadBalancer) DeepCopy() *LoadBalancer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LoadBalancer.

func (*LoadBalancer) DeepCopyInto 

func (in *LoadBalancer) DeepCopyInto(out *LoadBalancer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ManagedDisk 

type ManagedDisk struct {
	StorageAccountType string `json:"storageAccountType"`
}

ManagedDisk defines the managed disk options for a VM.

func (*ManagedDisk) DeepCopy 

func (in *ManagedDisk) DeepCopy() *ManagedDisk

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedDisk.

func (*ManagedDisk) DeepCopyInto 

func (in *ManagedDisk) DeepCopyInto(out *ManagedDisk)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Network 

type Network struct {
	// SecurityGroups is a map from the role/kind of the security group to its unique name, if any.
	SecurityGroups map[SecurityGroupRole]SecurityGroup `json:"securityGroups,omitempty"`

	// APIServerLB is the Kubernetes API server load balancer.
	APIServerLB LoadBalancer `json:"apiServerLb,omitempty"`

	// APIServerIP is the Kubernetes API server public IP address.
	APIServerIP PublicIP `json:"apiServerIp,omitempty"`
}

Network encapsulates the state of Azure networking resources.

func (*Network) DeepCopy 

func (in *Network) DeepCopy() *Network

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Network.

func (*Network) DeepCopyInto 

func (in *Network) DeepCopyInto(out *Network)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type NetworkSpec 

type NetworkSpec struct {
	// Vnet is the configuration for the Azure virtual network.
	// +optional
	Vnet VnetSpec `json:"vnet,omitempty"`

	// Subnets is the configuration for the control-plane subnet and the node subnet.
	// +optional
	Subnets Subnets `json:"subnets,omitempty"`
}

NetworkSpec specifies what the Azure networking resources should look like.

func (*NetworkSpec) DeepCopy 

func (in *NetworkSpec) DeepCopy() *NetworkSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkSpec.

func (*NetworkSpec) DeepCopyInto 

func (in *NetworkSpec) DeepCopyInto(out *NetworkSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NetworkSpec) GetControlPlaneSubnet added in v0.4.5 

func (n *NetworkSpec) GetControlPlaneSubnet() *SubnetSpec

GetControlPlaneSubnet returns the cluster control plane subnet.

func (*NetworkSpec) GetNodeSubnet added in v0.4.5 

func (n *NetworkSpec) GetNodeSubnet() *SubnetSpec

GetNodeSubnet returns the cluster node subnet.

type OSDisk 

type OSDisk struct {
	OSType      string      `json:"osType"`
	DiskSizeGB  int32       `json:"diskSizeGB"`
	ManagedDisk ManagedDisk `json:"managedDisk"`
}

OSDisk defines the operating system disk for a VM.

func (*OSDisk) DeepCopy 

func (in *OSDisk) DeepCopy() *OSDisk

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OSDisk.

func (*OSDisk) DeepCopyInto 

func (in *OSDisk) DeepCopyInto(out *OSDisk)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PublicIP 

type PublicIP struct {
	ID        string `json:"id,omitempty"`
	Name      string `json:"name,omitempty"`
	IPAddress string `json:"ipAddress,omitempty"`
	DNSName   string `json:"dnsName,omitempty"`
}

PublicIP defines an Azure public IP address.

func (*PublicIP) DeepCopy 

func (in *PublicIP) DeepCopy() *PublicIP

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PublicIP.

func (*PublicIP) DeepCopyInto 

func (in *PublicIP) DeepCopyInto(out *PublicIP)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceLifecycle 

type ResourceLifecycle string

ResourceLifecycle configures the lifecycle of a resource

type RouteTable added in v0.4.5 

type RouteTable struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

RouteTable defines an Azure route table.

func (*RouteTable) DeepCopy added in v0.4.5 

func (in *RouteTable) DeepCopy() *RouteTable

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RouteTable.

func (*RouteTable) DeepCopyInto added in v0.4.5 

func (in *RouteTable) DeepCopyInto(out *RouteTable)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SKU 

type SKU string

SKU defines an Azure load balancer SKU.

type SecurityGroup 

type SecurityGroup struct {
	ID           string       `json:"id,omitempty"`
	Name         string       `json:"name,omitempty"`
	IngressRules IngressRules `json:"ingressRule,omitempty"`
	Tags         Tags         `json:"tags,omitempty"`
}

SecurityGroup defines an Azure security group.

func (*SecurityGroup) DeepCopy 

func (in *SecurityGroup) DeepCopy() *SecurityGroup

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecurityGroup.

func (*SecurityGroup) DeepCopyInto 

func (in *SecurityGroup) DeepCopyInto(out *SecurityGroup)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SecurityGroupProtocol 

type SecurityGroupProtocol string

SecurityGroupProtocol defines the protocol type for a security group rule.

type SecurityGroupRole 

type SecurityGroupRole string

SecurityGroupRole defines the unique role of a security group.

type SubnetRole 

type SubnetRole string

SubnetRole defines the unique role of a subnet.

type SubnetSpec 

type SubnetSpec struct {
	// Role defines the subnet role (eg. Node, ControlPlane)
	Role SubnetRole `json:"role,omitempty"`

	// ID defines a unique identifier to reference this resource.
	// +optional
	ID string `json:"id,omitempty"`

	// Name defines a name for the subnet resource.
	Name string `json:"name"`

	// CidrBlock is the CIDR block to be used when the provider creates a managed Vnet.
	// +optional
	CidrBlock string `json:"cidrBlock,omitempty"`

	// InternalLBIPAddress is the IP address that will be used as the internal LB private IP.
	// For the control plane subnet only.
	// +optional
	InternalLBIPAddress string `json:"internalLBIPAddress,omitempty"`

	// SecurityGroup defines the NSG (network security group) that should be attached to this subnet.
	// +optional
	SecurityGroup SecurityGroup `json:"securityGroup,omitempty"`

	// RouteTable defines the route table that should be attached to this subnet.
	// +optional
	RouteTable RouteTable `json:"routeTable,omitempty"`
}

SubnetSpec configures an Azure subnet.

func (*SubnetSpec) DeepCopy 

func (in *SubnetSpec) DeepCopy() *SubnetSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubnetSpec.

func (*SubnetSpec) DeepCopyInto 

func (in *SubnetSpec) DeepCopyInto(out *SubnetSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Subnets 

type Subnets []*SubnetSpec

Subnets is a slice of Subnet.

func (Subnets) DeepCopy 

func (in Subnets) DeepCopy() Subnets

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Subnets.

func (Subnets) DeepCopyInto 

func (in Subnets) DeepCopyInto(out *Subnets)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Tags 

type Tags map[string]string

Tags defines a map of tags.

func Build 

func Build(params BuildParams) Tags

Build builds tags including the cluster tag and returns them in map form.

func (Tags) DeepCopy 

func (in Tags) DeepCopy() Tags

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tags.

func (Tags) DeepCopyInto 

func (in Tags) DeepCopyInto(out *Tags)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Tags) Difference 

func (t Tags) Difference(other Tags) Tags

Difference returns the difference between this map of tags and the other map of tags. Items are considered equals if key and value are equals.

func (Tags) Equals 

func (t Tags) Equals(other Tags) bool

Equals returns true if the tags are equal.

func (Tags) GetRole 

func (t Tags) GetRole() string

GetRole returns the Cluster API role for the tagged resource

func (Tags) HasAzureCloudProviderOwned 

func (t Tags) HasAzureCloudProviderOwned(cluster string) bool

HasAzureCloudProviderOwned returns true if the tags contains a tag that marks the resource as owned by the cluster from the perspective of the in-tree cloud provider.

func (Tags) HasOwned 

func (t Tags) HasOwned(cluster string) bool

HasOwned returns true if the tags contains a tag that marks the resource as owned by the cluster from the perspective of this management tooling.

func (Tags) Merge 

func (t Tags) Merge(other Tags)

Merge merges in tags from other. If a tag already exists, it is replaced by the tag in other.

type UserAssignedIdentity added in v0.4.5 

type UserAssignedIdentity struct {
	// ProviderID is the identification ID of the user-assigned Identity, the format of an identity is:
	// 'azure:///subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'
	ProviderID string `json:"providerID"`
}

UserAssignedIdentity defines the user-assigned identities provided by the user to be assigned to Azure resources.

func (*UserAssignedIdentity) DeepCopy added in v0.4.5 

func (in *UserAssignedIdentity) DeepCopy() *UserAssignedIdentity

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserAssignedIdentity.

func (*UserAssignedIdentity) DeepCopyInto added in v0.4.5 

func (in *UserAssignedIdentity) DeepCopyInto(out *UserAssignedIdentity)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VM 

type VM struct {
	ID               string `json:"id,omitempty"`
	Name             string `json:"name,omitempty"`
	AvailabilityZone string `json:"availabilityZone,omitempty"`
	// Hardware profile
	VMSize string `json:"vmSize,omitempty"`
	// Storage profile
	Image         Image  `json:"image,omitempty"`
	OSDisk        OSDisk `json:"osDisk,omitempty"`
	StartupScript string `json:"startupScript,omitempty"`
	// State - The provisioning state, which only appears in the response.
	State    VMState    `json:"vmState,omitempty"`
	Identity VMIdentity `json:"identity,omitempty"`
	Tags     Tags       `json:"tags,omitempty"`

	// Addresses contains the addresses associated with the Azure VM.
	Addresses []corev1.NodeAddress `json:"addresses,omitempty"`
}

VM describes an Azure virtual machine.

func (*VM) DeepCopy 

func (in *VM) DeepCopy() *VM

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VM.

func (*VM) DeepCopyInto 

func (in *VM) DeepCopyInto(out *VM)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VMIdentity 

type VMIdentity string

VMIdentity defines the identity of the virtual machine, if configured. +kubebuilder:validation:Enum=None;SystemAssigned;UserAssigned 

const (
	// VMIdentityNone ...
	VMIdentityNone VMIdentity = "None"
	// VMIdentitySystemAssigned ...
	VMIdentitySystemAssigned VMIdentity = "SystemAssigned"
	// VMIdentityUserAssigned ...
	VMIdentityUserAssigned VMIdentity = "UserAssigned"
)

type VMState 

type VMState string

VMState describes the state of an Azure virtual machine. 

const (
	// VMStateCreating ...
	VMStateCreating VMState = "Creating"
	// VMStateDeleting ...
	VMStateDeleting VMState = "Deleting"
	// VMStateFailed ...
	VMStateFailed VMState = "Failed"
	// VMStateMigrating ...
	VMStateMigrating VMState = "Migrating"
	// VMStateSucceeded ...
	VMStateSucceeded VMState = "Succeeded"
	// VMStateUpdating ...
	VMStateUpdating VMState = "Updating"
)

type VnetSpec 

type VnetSpec struct {
	// 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.
	ResourceGroup string `json:"resourceGroup,omitempty"`

	// ID is the identifier of the virtual network this provider should use to create resources.
	ID string `json:"id,omitempty"`

	// Name defines a name for the virtual network resource.
	Name string `json:"name"`

	// CidrBlock is the CIDR block to be used when the provider creates a managed virtual network.
	CidrBlock string `json:"cidrBlock,omitempty"`

	// Tags is a collection of tags describing the resource.
	Tags Tags `json:"tags,omitempty"`
}

VnetSpec configures an Azure virtual network.

func (*VnetSpec) DeepCopy 

func (in *VnetSpec) DeepCopy() *VnetSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VnetSpec.

func (*VnetSpec) DeepCopyInto 

func (in *VnetSpec) DeepCopyInto(out *VnetSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VnetSpec) IsManaged 

func (v *VnetSpec) IsManaged(clusterName string) bool

IsManaged returns true if the vnet is managed.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.