Merge pull request #87372 from jeana-redhat/OSDOCS-5774-TP-CAPI-Azure-supported

OSDOCS-5774: Azure CAPI TP

Author: jeana-redhat

_topic_maps/_topic_map.yml

@@ -2467,6 +2467,8 @@ Topics:
       File: cluster-api-config-options-aws
     - Name: Cluster API configuration options for Google Cloud Platform
       File: cluster-api-config-options-gcp
+    - Name: Cluster API configuration options for Microsoft Azure
+      File: cluster-api-config-options-azure
     - Name: Cluster API configuration options for VMware vSphere
       File: cluster-api-config-options-vsphere
 #  - Name: Cluster API resiliency and recovery

modules/capi-creating-infrastructure-resource.adoc renamed to _unused_topics/capi-creating-infrastructure-resource.adoc

@@ -46,6 +46,7 @@ This value must match the value for your platform.
 The following values are valid:
 * `AWSCluster`: The cluster is running on {aws-short}.
 * `GCPCluster`: The cluster is running on {gcp-short}.
+* `AzureCluster`: The cluster is running on {azure-first}.
 * `VSphereCluster`: The cluster is running on {vmw-short}.
 <3> Specify the name of the cluster.
 <4> Specify the details for your environment.

_unused_topics/capi-yaml-infrastructure-aws.adoc

@@ -0,0 +1,33 @@
+// Module included in the following assemblies:
+//
+// * machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="capi-yaml-infrastructure-aws_{context}"]
+= Sample YAML for a Cluster API infrastructure cluster resource on {aws-full}
+
+The infrastructure cluster resource is provider-specific and defines properties that all the compute machine sets in the cluster share, such as the region and subnets.
+The compute machine set references this resource when creating machines.
+
+In {product-title} {product-version}, the {cluster-capi-operator} generates this resource.
+The following sample YAML file is for informational purposes.
+User modification of this generated resource is not recommended.
+
+[source,yaml]
+----
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta2
+kind: AWSCluster # <1>
+metadata:
+  name: <cluster_name> # <2>
+  namespace: openshift-cluster-api
+spec:
+  controlPlaneEndpoint: # <3>
+    host: <control_plane_endpoint_address>
+    port: 6443
+  region: <region> # <4>
+----
+<1> Specifies the infrastructure kind for the cluster.
+This value matches the value for your platform.
+<2> Specifies the cluster ID as the name of the cluster.
+<3> Specifies the address of the control plane endpoint and the port to use to access it.
+<4> Specifies the {aws-short} region.

_unused_topics/capi-yaml-infrastructure-azure.adoc

@@ -0,0 +1,51 @@
+// Module included in the following assemblies:
+//
+// * machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="capi-yaml-infrastructure-azure_{context}"]
+= Sample YAML for a Cluster API infrastructure cluster resource on {azure-full}
+
+The infrastructure cluster resource is provider-specific and defines properties that all the compute machine sets in the cluster share, such as the region and subnets.
+The compute machine set references this resource when creating machines.
+
+In {product-title} {product-version}, the {cluster-capi-operator} generates this resource.
+The following sample YAML file is for informational purposes.
+User modification of this generated resource is not recommended.
+
+[source,yaml]
+----
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
+kind: AzureCluster # <1>
+metadata:
+  name: <cluster_name> # <2>
+  namespace: openshift-cluster-api
+spec:
+  azureEnvironment: AzurePublicCloud
+  bastionSpec: {}
+  controlPlaneEndpoint: # <3>
+    host: <control_plane_endpoint_address>
+    port: 6443
+  identityRef: # <4>
+    kind: AzureClusterIdentity
+    name: <cluster_name>
+    namespace: openshift-cluster-api
+  location: westus # <5>
+  networkSpec:
+    apiServerLB:
+      backendPool: {}
+    nodeOutboundLB:
+      backendPool:
+        name: <cluster_name>
+      name: <cluster_name>
+    vnet:
+      name: <cluster_name>-vnet
+      resourceGroup: <cluster_name>-rg
+  resourceGroup: <cluster_name>-rg
+----
+<1> Specifies the infrastructure kind for the cluster.
+This value matches the value for your platform.
+<2> Specifies the cluster ID as the name of the cluster.
+<3> Specifies the address of the control plane endpoint and the port to use to access it.
+<4> The cluster identity that the {cluster-capi-operator} creates.
+<5> Specifies the {azure-short} region.

_unused_topics/capi-yaml-infrastructure-gcp.adoc

@@ -0,0 +1,36 @@
+// Module included in the following assemblies:
+//
+// * machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="capi-yaml-infrastructure-gcp_{context}"]
+= Sample YAML for a Cluster API infrastructure cluster resource on {gcp-full}
+
+The infrastructure cluster resource is provider-specific and defines properties that all the compute machine sets in the cluster share, such as the region and subnets.
+The compute machine set references this resource when creating machines.
+
+In {product-title} {product-version}, the {cluster-capi-operator} generates this resource.
+The following sample YAML file is for informational purposes.
+User modification of this generated resource is not recommended.
+
+[source,yaml]
+----
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
+kind: GCPCluster # <1>
+metadata:
+  name: <cluster_name> # <2>
+spec:
+  controlPlaneEndpoint: # <3>
+    host: <control_plane_endpoint_address>
+    port: 6443
+  network:
+    name: <cluster_name>-network
+  project: <project> # <4>
+  region: <region> # <5>
+----
+<1> Specifies the infrastructure kind for the cluster.
+This value matches the value for your platform.
+<2> Specifies the cluster ID as the name of the cluster.
+<3> Specifies the IP address of the control plane endpoint and the port used to access it.
+<4> Specifies the {gcp-short} project name.
+<5> Specifies the {gcp-short} region.

modules/capi-yaml-infrastructure-vsphere.adoc renamed to _unused_topics/capi-yaml-infrastructure-vsphere.adoc

@@ -4,11 +4,15 @@
 
 :_mod-docs-content-type: REFERENCE
 [id="capi-yaml-infrastructure-vsphere_{context}"]
-= Sample YAML for a Cluster API infrastructure resource on {vmw-full}
+= Sample YAML for a Cluster API infrastructure cluster resource on {vmw-full}
 
-The infrastructure resource is provider-specific and defines properties that are shared by all the compute machine sets in the cluster, such as the region and subnets.
+The infrastructure cluster resource is provider-specific and defines properties that all the compute machine sets in the cluster share, such as the region and subnets.
 The compute machine set references this resource when creating machines.
 
+In {product-title} {product-version}, the {cluster-capi-operator} generates this resource.
+The following sample YAML file is for informational purposes.
+User modification of this generated resource is not recommended.
+
 [source,yaml]
 ----
 apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
@@ -24,11 +28,11 @@ spec:
     name: <cluster_name>
   server: <vsphere_server> # <4>
 ----
-<1> Specify the infrastructure kind for the cluster.
-This value must match the value for your platform.
-<2> Specify the cluster ID as the name of the cluster.
-<3> Specify the IP address of the control plane endpoint and the port used to access it.
-<4> Specify the {vmw-short} server for the cluster.
+<1> Specifies the infrastructure kind for the cluster.
+This value matches the value for your platform.
+<2> Specifies the cluster ID as the name of the cluster.
+<3> Specifies the IP address of the control plane endpoint and the port used to access it.
+<4> Specifies the {vmw-short} server for the cluster.
 You can find this value on an existing {vmw-short} cluster by running the following command:
 +
 [source,terminal]

machine_management/cluster_api_machine_management/cluster-api-about.adoc

@@ -9,7 +9,7 @@ toc::[]
 :FeatureName: Managing machines with the Cluster API
 include::snippets/technology-preview.adoc[]
 
-The link:https://cluster-api.sigs.k8s.io/[Cluster API] is an upstream project that is integrated into {product-title} as a Technology Preview for {aws-first}, {gcp-first}, and {vmw-first}.
+The link:https://cluster-api.sigs.k8s.io/[Cluster API] is an upstream project that is integrated into {product-title} as a Technology Preview for {aws-first}, {gcp-first}, {azure-first} and {vmw-first}.
 
 //Cluster API overview
 include::modules/capi-overview.adoc[leveloffset=+1]

machine_management/cluster_api_machine_management/cluster-api-configuration.adoc

@@ -24,4 +24,6 @@ For provider-specific configuration options for your cluster, see the following
 
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#cluster-api-config-options-gcp[Cluster API configuration options for {gcp-full}]
 
+* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#cluster-api-config-options-azure[Cluster API configuration options for {azure-full}]
+
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#cluster-api-config-options-vsphere[Cluster API configuration options for {vmw-full}]

machine_management/cluster_api_machine_management/cluster-api-getting-started.adoc

@@ -9,7 +9,7 @@ toc::[]
 :FeatureName: Managing machines with the Cluster API
 include::snippets/technology-preview.adoc[]
 
-For the Cluster API Technology Preview, you must create the primary resources that the Cluster API requires manually.
+For the Cluster API Technology Preview, you must manually create some of the primary resources that the Cluster API requires.
 
 [id="creating-primary-resources_{context}"]
 == Creating the Cluster API primary resources
@@ -27,20 +27,13 @@ include::modules/capi-creating-cluster-resource.adoc[leveloffset=+2]
 .Additional resources
 * xref:../../machine_management/cluster_api_machine_management/cluster-api-configuration.adoc#cluster-api-configuration[Cluster API configuration]
 
-//Creating a Cluster API infrastructure resource
-include::modules/capi-creating-infrastructure-resource.adoc[leveloffset=+2]
-[role="_additional-resources"]
-.Additional resources
-* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-infrastructure-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API infrastructure resource on {aws-full}]
-* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-infrastructure-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API infrastructure resource on {gcp-full}]
-* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-infrastructure-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API infrastructure resource on {vmw-full}]
-
 //Creating a Cluster API machine template
 include::modules/capi-creating-machine-template.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-template-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API machine template resource on {aws-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-template-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API machine template resource on {gcp-full}]
+* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-template-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API machine template resource on {azure-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-template-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API machine template resource on {vmw-full}]
 
 //Creating a Cluster API compute machine set
@@ -49,4 +42,5 @@ include::modules/capi-creating-machine-set.adoc[leveloffset=+2]
 .Additional resources
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-set-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API compute machine set resource on {aws-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-set-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API compute machine set resource on {gcp-full}]
+* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-set-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API compute machine set resource on {azure-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-set-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API compute machine set resource on {vmw-full}]

machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc

@@ -15,6 +15,7 @@ include::modules/capi-modifying-machine-template.adoc[leveloffset=+1]
 .Additional resources
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-template-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API machine template resource on {aws-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-template-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API machine template resource on {gcp-full}]
+* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-template-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API machine template resource on {azure-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-template-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API machine template resource on {vmw-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc#machineset-modifying_cluster-api-managing-machines[Modifying a compute machine set by using the CLI]
 
@@ -25,4 +26,5 @@ include::modules/machineset-modifying.adoc[leveloffset=+1,tag=!MAPI]
 .Additional resources
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-set-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API compute machine set resource on {aws-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-gcp.adoc#capi-yaml-machine-set-gcp_cluster-api-config-options-gcp[Sample YAML for a Cluster API compute machine set resource on {gcp-full}]
+* xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-azure.adoc#capi-yaml-machine-set-azure_cluster-api-config-options-azure[Sample YAML for a Cluster API compute machine set resource on {azure-full}]
 * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc#capi-yaml-machine-set-vsphere_cluster-api-config-options-vsphere[Sample YAML for a Cluster API compute machine set resource on {vmw-full}]