Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[release-1.9] Update Azure documentation links #3715

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The Azure provider is able to install and manage the [versions of Kubernetes sup

#### Managed Clusters (AKS)

Managed Clusters (AKS) follow their own [Kubernetes version support policy](https://docs.microsoft.com/en-us/azure/aks/supported-kubernetes-versions?tabs=azure-cli#kubernetes-version-support-policy). Please use the Azure portal or CLI to [find the versions supported in your cluster's location](https://docs.microsoft.com/en-us/azure/aks/supported-kubernetes-versions?tabs=azure-cli#azure-portal-and-cli-versions).
Managed Clusters (AKS) follow their own [Kubernetes version support policy](https://learn.microsoft.com/azure/aks/supported-kubernetes-versions?tabs=azure-cli#kubernetes-version-support-policy). Please use the Azure portal or CLI to [find the versions supported in your cluster's location](https://learn.microsoft.com/azure/aks/supported-kubernetes-versions?tabs=azure-cli#azure-portal-and-cli-versions).

For more information on Kubernetes version support, see the [Cluster API book](https://cluster-api.sigs.k8s.io/reference/versions.html).

Expand Down
10 changes: 5 additions & 5 deletions api/v1beta1/azurecluster_validation.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ const (
// not using . in the name to avoid issues when the name is part of DNS name.
clusterNameRegex = `^[a-z0-9][a-z0-9-]{0,42}[a-z0-9]$`
// max length of 44 to allow for cluster name to be used as a prefix for VMs and other resources that
// have limitations as outlined here https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules.
// have limitations as outlined here https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules.
clusterNameMaxLength = 44
// obtained from https://docs.microsoft.com/en-us/rest/api/resources/resourcegroups/createorupdate#uri-parameters.
// obtained from https://learn.microsoft.com/rest/api/resources/resourcegroups/createorupdate#uri-parameters.
resourceGroupRegex = `^[-\w\._\(\)]+$`
// described in https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules.
// described in https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules.
subnetRegex = `^[-\w\._]+$`
loadBalancerRegex = `^[-\w\._]+$`
// MaxLoadBalancerOutboundIPs is the maximum number of outbound IPs in a Standard LoadBalancer frontend configuration.
Expand All @@ -49,14 +49,14 @@ const (
// MaxLBIdleTimeoutInMinutes is the maximum number of minutes for the LB idle timeout.
MaxLBIdleTimeoutInMinutes = 30
// Network security rules should be a number between 100 and 4096.
// https://docs.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview#security-rules
// https://learn.microsoft.com/azure/virtual-network/network-security-groups-overview#security-rules
minRulePriority = 100
maxRulePriority = 4096
// Must start with 'Microsoft.', then an alpha character, then can include alnum.
serviceEndpointServiceRegexPattern = `^Microsoft\.[a-zA-Z]{1,42}[a-zA-Z0-9]{0,42}$`
// Must start with an alpha character and then can include alnum OR be only *.
serviceEndpointLocationRegexPattern = `^([a-z]{1,42}\d{0,5}|[*])$`
// described in https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules.
// described in https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules.
privateEndpointRegex = `^[-\w\._]+$`
// resource ID Pattern.
resourceIDPattern = `(?i)subscriptions/(.+)/resourceGroups/(.+)/providers/(.+?)/(.+?)/(.+)`
Expand Down
2 changes: 1 addition & 1 deletion api/v1beta1/azuremachine_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ type AzureMachineSpec struct {
// 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.
// See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli
// See https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli
// +optional
UserAssignedIdentities []UserAssignedIdentity `json:"userAssignedIdentities,omitempty"`

Expand Down
4 changes: 2 additions & 2 deletions api/v1beta1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ const (
// Canceled represents an action which was initiated but terminated by the user before completion.
Canceled ProvisioningState = "Canceled"
// Deleted represents a deleted VM
// NOTE: This state is specific to capz, and does not have corresponding mapping in Azure API (https://docs.microsoft.com/en-us/azure/virtual-machines/states-billing#provisioning-states)
// NOTE: This state is specific to capz, and does not have corresponding mapping in Azure API (https://learn.microsoft.com/azure/virtual-machines/states-billing#provisioning-states)
Deleted ProvisioningState = "Deleted"
)

Expand Down Expand Up @@ -628,7 +628,7 @@ type DiskEncryptionSetParameters struct {
// DiffDiskSettings describe ephemeral disk settings for the os disk.
type DiffDiskSettings struct {
// Option enables ephemeral OS when set to "Local"
// See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks for full details
// See https://learn.microsoft.com/azure/virtual-machines/ephemeral-os-disks for full details
// +kubebuilder:validation:Enum=Local
Option string `json:"option"`
}
Expand Down
2 changes: 1 addition & 1 deletion azure/defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ func ManagedClusterID(subscriptionID, resourceGroup, managedClusterName string)

// GetBootstrappingVMExtension returns the CAPZ Bootstrapping VM extension.
// The CAPZ Bootstrapping extension is a simple clone of https://github.com/Azure/custom-script-extension-linux for Linux or
// https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/custom-script-windows for Windows.
// https://learn.microsoft.com/azure/virtual-machines/extensions/custom-script-windows for Windows.
// This extension allows running arbitrary scripts on the VM.
// Its role is to detect and report Kubernetes bootstrap failure or success.
func GetBootstrappingVMExtension(osType string, cloud string, vmName string) *ExtensionSpec {
Expand Down
2 changes: 1 addition & 1 deletion azure/services/loadbalancers/spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ func getOutboundRules(lbSpec LBSpec, frontendIDs []network.SubResource) []networ
func getLoadBalancingRules(lbSpec LBSpec, frontendIDs []network.SubResource) []network.LoadBalancingRule {
if lbSpec.Role == infrav1.APIServerRole {
// We disable outbound SNAT explicitly in the HTTPS LB rule and enable TCP and UDP outbound NAT with an outbound rule.
// For more information on Standard LB outbound connections see https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-outbound-connections.
// For more information on Standard LB outbound connections see https://learn.microsoft.com/azure/load-balancer/load-balancer-outbound-connections.
var frontendIPConfig network.SubResource
if len(frontendIDs) != 0 {
frontendIPConfig = frontendIDs[0]
Expand Down
2 changes: 1 addition & 1 deletion azure/services/managedclusters/spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ type LoadBalancerProfile struct {
// Load balancer profile must specify at most one of ManagedOutboundIPs, OutboundIPPrefixes and OutboundIPs.
// By default the AKS cluster automatically creates a public IP in the AKS-managed infrastructure resource group and assigns it to the load balancer outbound pool.
// Alternatively, you can assign your own custom public IP or public IP prefix at cluster creation time.
// See https://docs.microsoft.com/en-us/azure/aks/load-balancer-standard#provide-your-own-outbound-public-ips-or-prefixes
// See https://learn.microsoft.com/azure/aks/load-balancer-standard#provide-your-own-outbound-public-ips-or-prefixes

// ManagedOutboundIPs are the desired managed outbound IPs for the cluster load balancer.
ManagedOutboundIPs *int32
Expand Down
2 changes: 1 addition & 1 deletion azure/services/virtualmachineimages/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
ctx, _, done := tele.StartSpanWithLogger(ctx, "virtualmachineimages.AzureClient.List")
defer done()

// See https://docs.microsoft.com/en-us/odata/concepts/queryoptions-overview for how to use these query options.
// See https://learn.microsoft.com/odata/concepts/queryoptions-overview for how to use these query options.

Check warning on line 59 in azure/services/virtualmachineimages/client.go

View check run for this annotation

Codecov / codecov/patch

azure/services/virtualmachineimages/client.go#L59

Added line #L59 was not covered by tests
expand, orderby := "", ""
var top *int32
return ac.images.List(ctx, location, publisher, offer, sku, expand, top, orderby)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ spec:
properties:
option:
description: Option enables ephemeral OS when set to "Local"
See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks
See https://learn.microsoft.com/azure/virtual-machines/ephemeral-os-disks
for full details
enum:
- Local
Expand Down Expand Up @@ -665,7 +665,7 @@ spec:
type: array
vmSize:
description: VMSize is the size of the Virtual Machine to build.
See https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/createorupdate#virtualmachinesizetypes
See https://learn.microsoft.com/rest/api/compute/virtualmachines/createorupdate#virtualmachinesizetypes
type: string
required:
- osDisk
Expand All @@ -675,7 +675,7 @@ spec:
description: 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 AzureMachinePool.
See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli
See https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli
items:
description: UserAssignedIdentity defines the user-assigned identities
provided by the user to be assigned to Azure resources.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ spec:
properties:
option:
description: Option enables ephemeral OS when set to "Local"
See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks
See https://learn.microsoft.com/azure/virtual-machines/ephemeral-os-disks
for full details
enum:
- Local
Expand Down Expand Up @@ -553,7 +553,7 @@ spec:
description: 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.
See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli
See https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli
items:
description: UserAssignedIdentity defines the user-assigned identities
provided by the user to be assigned to Azure resources.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ spec:
properties:
option:
description: Option enables ephemeral OS when set
to "Local" See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks
to "Local" See https://learn.microsoft.com/azure/virtual-machines/ephemeral-os-disks
for full details
enum:
- Local
Expand Down Expand Up @@ -588,7 +588,7 @@ spec:
description: 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. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli
of the AzureMachine. See https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli
items:
description: UserAssignedIdentity defines the user-assigned
identities provided by the user to be assigned to Azure
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/developers/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ You can also customize the configuration of the CAPZ cluster (assuming that `SKI
[gettextwindows]: https://mlocati.github.io/articles/gettext-iconv-windows.html
[go.mod]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/blob/main/go.mod
[kind]: https://sigs.k8s.io/kind
[azure_cli]: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest
[azure_cli]: https://learn.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest
[manifests]: /docs/manifests.md
[kustomize]: https://github.com/kubernetes-sigs/kustomize
[kustomizelinux]: https://kubectl.docs.kubernetes.io/installation/kustomize/
Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/topics/api-server-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CAPZ supports two load balancer types, `Public` and `Internal`.

For a more complete "private cluster" template example, you may refer to [this reference template](https://raw.githubusercontent.com/kubernetes-sigs/cluster-api-provider-azure/main/templates/cluster-template-private.yaml) that the capz project maintains.

For more information on Azure load balancing, see [Load Balancer documentation](https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-overview).
For more information on Azure load balancing, see [Load Balancer documentation](https://learn.microsoft.com/azure/load-balancer/load-balancer-overview).

<aside class="note warning">

Expand Down Expand Up @@ -103,4 +103,4 @@ When you BYO api server IP, CAPZ does not manage its lifecycle, ie. the IP will

### Load Balancer SKU

At this time, CAPZ only supports Azure Standard Load Balancers. See [SKU comparison](https://docs.microsoft.com/en-us/azure/load-balancer/skus#skus) for more information on Azure Load Balancers SKUs.
At this time, CAPZ only supports Azure Standard Load Balancers. See [SKU comparison](https://learn.microsoft.com/azure/load-balancer/skus#skus) for more information on Azure Load Balancers SKUs.
14 changes: 7 additions & 7 deletions docs/book/src/topics/custom-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Managed images support only 20 simultaneous deployments, so for most use cases A

### Using Azure Marketplace

To use an image from [Azure Marketplace][azure-marketplace], populate the `publisher`, `offer`, `sku`, and `version` fields and, if this image is published by a third party publisher, set the `thirdPartyImage` flag to `true` so an image Plan can be generated for it. In the case of a third party image, you must accept the license terms with the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/vm/image/terms?view=azure-cli-latest) before consuming it.
To use an image from [Azure Marketplace][azure-marketplace], populate the `publisher`, `offer`, `sku`, and `version` fields and, if this image is published by a third party publisher, set the `thirdPartyImage` flag to `true` so an image Plan can be generated for it. In the case of a third party image, you must accept the license terms with the [Azure CLI](https://learn.microsoft.com/cli/azure/vm/image/terms?view=azure-cli-latest) before consuming it.

```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
Expand Down Expand Up @@ -217,18 +217,18 @@ This will make API calls to create Virtual Machines or Virtual Machine Scale Set

In the case of a third party image, you must accept the license terms with the [Azure CLI][azure-cli] before consuming it.

[azure-cli]: https://docs.microsoft.com/en-us/cli/azure/vm/image/terms?view=azure-cli-latest
[azure-community-gallery]: https://docs.microsoft.com/en-us/azure/virtual-machines/azure-compute-gallery#community
[azure-marketplace]: https://docs.microsoft.com/azure/marketplace/marketplace-publishers-guide
[azure-cli]: https://learn.microsoft.com/cli/azure/vm/image/terms?view=azure-cli-latest
[azure-community-gallery]: https://learn.microsoft.com/azure/virtual-machines/azure-compute-gallery#community
[azure-marketplace]: https://learn.microsoft.com/azure/marketplace/marketplace-publishers-guide
[azure-capi-images]: https://image-builder.sigs.k8s.io/capi/providers/azure.html
[azure-compute-gallery]: https://docs.microsoft.com/azure/virtual-machines/linux/shared-image-galleries
[azure-compute-gallery]: https://learn.microsoft.com/azure/virtual-machines/linux/shared-image-galleries
[capi-images]: https://image-builder.sigs.k8s.io/capi/capi.html
[creating-managed-image]: https://docs.microsoft.com/azure/virtual-machines/linux/capture-image
[creating-managed-image]: https://learn.microsoft.com/azure/virtual-machines/linux/capture-image
[creating-vm-offer]: https://docs.azure.cn/en-us/articles/azure-marketplace/imagepublishguide#5-azure-
[image-builder]: https://github.com/kubernetes-sigs/image-builder
[image-builder-azure]: https://github.com/kubernetes-sigs/image-builder/tree/master/images/capi/packer/azure
[kubeadm-preflight-checks]: https://github.com/kubernetes/kubeadm/blob/master/docs/design/design_v1.10.md#preflight-checks
[replication-recommendations]: https://docs.microsoft.com/azure/virtual-machines/linux/shared-image-galleries#scaling
[replication-recommendations]: https://learn.microsoft.com/azure/virtual-machines/linux/shared-image-galleries#scaling
[supported-capi]: https://cluster-api.sigs.k8s.io/reference/versions.html#supported-kubernetes-versions
[supported-k8s]: https://kubernetes.io/releases/version-skew-policy/#supported-versions
[upgrading-clusters]: https://cluster-api.sigs.k8s.io/tasks/upgrading-clusters.html
2 changes: 1 addition & 1 deletion docs/book/src/topics/custom-vnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ spec:

### Virtual Network service endpoints

Sometimes it's desirable to use [Virtual Network service endpoints](https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-service-endpoints-overview) to establish secure and direct connectivity to Azure services from your subnet(s). Service Endpoints are configured on a per-subnet basis. Vnets managed by either `AzureCluster` or `AzureManagedControlPlane` can have `serviceEndpoints` optionally set on each subnet.
Sometimes it's desirable to use [Virtual Network service endpoints](https://learn.microsoft.com/azure/virtual-network/virtual-network-service-endpoints-overview) to establish secure and direct connectivity to Azure services from your subnet(s). Service Endpoints are configured on a per-subnet basis. Vnets managed by either `AzureCluster` or `AzureManagedControlPlane` can have `serviceEndpoints` optionally set on each subnet.

```yaml
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
Expand Down
Loading