mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-5774: Azure CAPI TP
This commit is contained in:
Jeana Routh
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
10d51ac079
commit
88f1738d6c
@@ -2466,6 +2466,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
|
||||
|
||||
@@ -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.
|
||||
33
_unused_topics/capi-yaml-infrastructure-aws.adoc
Normal file
33
_unused_topics/capi-yaml-infrastructure-aws.adoc
Normal file
@@ -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.
|
||||
51
_unused_topics/capi-yaml-infrastructure-azure.adoc
Normal file
51
_unused_topics/capi-yaml-infrastructure-azure.adoc
Normal file
@@ -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.
|
||||
36
_unused_topics/capi-yaml-infrastructure-gcp.adoc
Normal file
36
_unused_topics/capi-yaml-infrastructure-gcp.adoc
Normal file
@@ -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.
|
||||
@@ -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]
|
||||
@@ -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]
|
||||
|
||||
@@ -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}]
|
||||
@@ -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}]
|
||||
@@ -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}]
|
||||
@@ -16,9 +16,6 @@ You can change the configuration of your {aws-first} Cluster API machines by upd
|
||||
|
||||
The following example YAML files show configurations for an {aws-full} cluster.
|
||||
|
||||
//Sample YAML for a CAPI AWS infrastructure resource
|
||||
include::modules/capi-yaml-infrastructure-aws.adoc[leveloffset=+2]
|
||||
|
||||
//Sample YAML for CAPI AWS machine template resource
|
||||
include::modules/capi-yaml-machine-template-aws.adoc[leveloffset=+2]
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="cluster-api-config-options-azure"]
|
||||
= Cluster API configuration options for {azure-full}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: cluster-api-config-options-azure
|
||||
|
||||
toc::[]
|
||||
|
||||
:FeatureName: Managing machines with the Cluster API
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
You can change the configuration of your {azure-first} Cluster API machines by updating values in the Cluster API custom resource manifests.
|
||||
|
||||
[id="cluster-api-sample-yaml-azure_{context}"]
|
||||
== Sample YAML for configuring {azure-full} clusters
|
||||
|
||||
The following example YAML files show configurations for an {azure-short} cluster.
|
||||
|
||||
//Sample YAML for CAPI Azure machine template resource
|
||||
include::modules/capi-yaml-machine-template-azure.adoc[leveloffset=+2]
|
||||
|
||||
//Sample YAML for a CAPI Azure compute machine set resource
|
||||
include::modules/capi-yaml-machine-set-azure.adoc[leveloffset=+2]
|
||||
|
||||
// [id="cluster-api-supported-features-azure_{context}"]
|
||||
// == Enabling {azure-full} features with the Cluster API
|
||||
|
||||
// You can enable the following features by updating values in the Cluster API custom resource manifests.
|
||||
|
||||
//Not sure what, if anything, we can add here at this time.
|
||||
@@ -16,9 +16,6 @@ You can change the configuration of your {gcp-first} Cluster API machines by upd
|
||||
|
||||
The following example YAML files show configurations for a {gcp-full} cluster.
|
||||
|
||||
//Sample YAML for a CAPI GCP infrastructure resource
|
||||
include::modules/capi-yaml-infrastructure-gcp.adoc[leveloffset=+2]
|
||||
|
||||
//Sample YAML for CAPI GCP machine template resource
|
||||
include::modules/capi-yaml-machine-template-gcp.adoc[leveloffset=+2]
|
||||
|
||||
|
||||
@@ -16,9 +16,6 @@ You can change the configuration of your {vmw-first} Cluster API machines by upd
|
||||
|
||||
The following example YAML files show configurations for a {vmw-full} cluster.
|
||||
|
||||
//Sample YAML for a CAPI vSphere infrastructure resource
|
||||
include::modules/capi-yaml-infrastructure-vsphere.adoc[leveloffset=+2]
|
||||
|
||||
//Sample YAML for CAPI vSphere machine template resource
|
||||
include::modules/capi-yaml-machine-template-vsphere.adoc[leveloffset=+2]
|
||||
|
||||
|
||||
@@ -6,11 +6,11 @@
|
||||
[id="capi-arch-resources_{context}"]
|
||||
= Cluster API primary resources
|
||||
|
||||
The Cluster API consists of the following primary resources. For the Technology Preview of this feature, you must create these resources manually in the `openshift-cluster-api` namespace.
|
||||
The Cluster API consists of the following primary resources. For the Technology Preview of this feature, you must create some of these resources manually in the `openshift-cluster-api` namespace.
|
||||
|
||||
Cluster:: A fundamental unit that represents a cluster that is managed by the Cluster API.
|
||||
|
||||
Infrastructure:: A provider-specific resource that defines properties that are shared by all the compute machine sets in the cluster, such as the region and subnets.
|
||||
Infrastructure cluster:: A provider-specific resource that defines properties that all of the compute machine sets in the cluster share, such as the region and subnets.
|
||||
|
||||
Machine template:: A provider-specific template that defines the properties of the machines that a compute machine set creates.
|
||||
|
||||
|
||||
@@ -45,6 +45,7 @@ The following values are valid:
|
||||
+
|
||||
* `AWSCluster`: The cluster is running on {aws-first}.
|
||||
* `GCPCluster`: The cluster is running on {gcp-first}.
|
||||
* `AzureCluster`: The cluster is running on {azure-first}.
|
||||
* `VSphereCluster`: The cluster is running on {vmw-first}.
|
||||
--
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ You can create compute machine sets that use the Cluster API to dynamically mana
|
||||
|
||||
* You have installed the {oc-first}.
|
||||
|
||||
* You have created the cluster, infrastructure, and machine template resources.
|
||||
* You have created the cluster and machine template resources.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -46,6 +46,7 @@ spec:
|
||||
# ...
|
||||
----
|
||||
<1> Specify a name for the compute machine set.
|
||||
The cluster ID, machine role, and region form a typical pattern for this value in the following format: `<cluster_name>-<role>-<region>`.
|
||||
<2> Specify the name of the cluster.
|
||||
<3> Specify the details for your environment. These parameters are provider specific. For more information, see the sample Cluster API compute machine set YAML for your provider.
|
||||
--
|
||||
|
||||
@@ -18,7 +18,7 @@ You can create a provider-specific machine template resource by creating a YAML
|
||||
|
||||
* You have installed the {oc-first}.
|
||||
|
||||
* You have created and applied the cluster and infrastructure resources.
|
||||
* You have created and applied the cluster resource.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -39,6 +39,7 @@ spec:
|
||||
<1> Specify the machine template kind. This value must match the value for your platform. The following values are valid:
|
||||
* `AWSMachineTemplate`: The cluster is running on {aws-first}.
|
||||
* `GCPMachineTemplate`: The cluster is running on {gcp-first}.
|
||||
* `AzureMachineTemplate`: The cluster is running on {azure-first}.
|
||||
* `VSphereMachineTemplate`: The cluster is running on {vmw-first}.
|
||||
<2> Specify a name for the machine template.
|
||||
<3> Specify the details for your environment. These parameters are provider specific. For more information, see the sample Cluster API machine template YAML for your provider.
|
||||
|
||||
@@ -15,9 +15,9 @@ Using the Cluster API to manage machines is a Technology Preview feature and has
|
||||
Enabling this feature set cannot be undone and prevents minor version updates.
|
||||
====
|
||||
|
||||
* Only {aws-first}, {gcp-first}, and {vmw-first} clusters can use the Cluster API.
|
||||
* Only {aws-first}, {gcp-first}, {azure-first}, and {vmw-first} clusters can use the Cluster API.
|
||||
|
||||
* You must manually create the primary resources that the Cluster API requires.
|
||||
* You must manually create some of the primary resources that the Cluster API requires.
|
||||
For more information, see "Getting started with the Cluster API".
|
||||
|
||||
* You cannot use the Cluster API to manage control plane machines.
|
||||
|
||||
@@ -28,6 +28,7 @@ $ oc get <machine_template_kind> <1>
|
||||
<1> Specify the value that corresponds to your platform. The following values are valid:
|
||||
* `AWSMachineTemplate`: The cluster is running on {aws-first}.
|
||||
* `GCPMachineTemplate`: The cluster is running on {gcp-first}.
|
||||
* `AzureMachineTemplate`: The cluster is running on {azure-first}.
|
||||
* `VSphereMachineTemplate`: The cluster is running on {vmw-first}.
|
||||
--
|
||||
+
|
||||
|
||||
@@ -34,5 +34,6 @@ Valid values are:
|
||||
--
|
||||
* `AWSCluster`: The cluster is running on {aws-full}.
|
||||
* `GCPCluster`: The cluster is running on {gcp-full}.
|
||||
* `AzureCluster`: The cluster is running on {azure-full}.
|
||||
* `VSphereCluster`: The cluster is running on {vmw-full}.
|
||||
--
|
||||
@@ -1,29 +0,0 @@
|
||||
// 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 resource on {aws-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 compute machine set references this resource when creating machines.
|
||||
|
||||
[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> 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 address of the control plane endpoint and the port to use to access it.
|
||||
<4> Specify the {aws-short} region.
|
||||
@@ -1,32 +0,0 @@
|
||||
// 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 resource on {gcp-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 compute machine set references this resource when creating machines.
|
||||
|
||||
[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> 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 {gcp-short} project name.
|
||||
<5> Specify the {gcp-short} region.
|
||||
@@ -7,7 +7,7 @@
|
||||
= Sample YAML for a Cluster API compute machine set resource on {aws-full}
|
||||
|
||||
The compute machine set resource defines additional properties of the machines that it creates.
|
||||
The compute machine set also references the infrastructure resource and machine template when creating machines.
|
||||
The compute machine set also references the cluster resource and machine template when creating machines.
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
@@ -16,28 +16,35 @@ kind: MachineSet
|
||||
metadata:
|
||||
name: <machine_set_name> # <1>
|
||||
namespace: openshift-cluster-api
|
||||
labels:
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name> # <2>
|
||||
spec:
|
||||
clusterName: <cluster_name> # <2>
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
test: example
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name>
|
||||
cluster.x-k8s.io/set-name: <machine_set_name>
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
test: example
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name>
|
||||
cluster.x-k8s.io/set-name: <machine_set_name>
|
||||
node-role.kubernetes.io/<role>: ""
|
||||
spec:
|
||||
bootstrap:
|
||||
dataSecretName: worker-user-data # <3>
|
||||
dataSecretName: worker-user-data
|
||||
clusterName: <cluster_name>
|
||||
infrastructureRef:
|
||||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
|
||||
kind: AWSMachineTemplate # <4>
|
||||
name: <template_name> # <5>
|
||||
kind: AWSMachineTemplate # <3>
|
||||
name: <template_name> # <4>
|
||||
----
|
||||
<1> Specify a name for the compute machine set.
|
||||
The cluster ID, machine role, and region form a typical pattern for this value in the following format: `<cluster_name>-<role>-<region>`.
|
||||
<2> Specify the cluster ID as the name of the cluster.
|
||||
<3> For the Cluster API Technology Preview, the Operator can use the worker user data secret from the `openshift-machine-api` namespace.
|
||||
<4> Specify the machine template kind.
|
||||
<3> Specify the machine template kind.
|
||||
This value must match the value for your platform.
|
||||
<5> Specify the machine template name.
|
||||
<4> Specify the machine template name.
|
||||
|
||||
50
modules/capi-yaml-machine-set-azure.adoc
Normal file
50
modules/capi-yaml-machine-set-azure.adoc
Normal file
@@ -0,0 +1,50 @@
|
||||
// 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-machine-set-azure_{context}"]
|
||||
= Sample YAML for a Cluster API compute machine set resource on {azure-full}
|
||||
|
||||
The compute machine set resource defines additional properties of the machines that it creates.
|
||||
The compute machine set also references the cluster resource and machine template when creating machines.
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: cluster.x-k8s.io/v1beta1
|
||||
kind: MachineSet
|
||||
metadata:
|
||||
name: <machine_set_name> # <1>
|
||||
namespace: openshift-cluster-api
|
||||
labels:
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name> # <2>
|
||||
spec:
|
||||
clusterName: <cluster_name>
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
test: example
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name>
|
||||
cluster.x-k8s.io/set-name: <machine_set_name>
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
test: example
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name>
|
||||
cluster.x-k8s.io/set-name: <machine_set_name>
|
||||
node-role.kubernetes.io/<role>: ""
|
||||
spec:
|
||||
bootstrap:
|
||||
dataSecretName: worker-user-data
|
||||
clusterName: <cluster_name>
|
||||
infrastructureRef:
|
||||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
|
||||
kind: AzureMachineTemplate # <3>
|
||||
name: <template_name> # <4>
|
||||
----
|
||||
<1> Specify a name for the compute machine set.
|
||||
The cluster ID, machine role, and region form a typical pattern for this value in the following format: `<cluster_name>-<role>-<region>`.
|
||||
<2> Specify the cluster ID as the name of the cluster.
|
||||
<3> Specify the machine template kind.
|
||||
This value must match the value for your platform.
|
||||
<4> Specify the machine template name.
|
||||
@@ -7,7 +7,7 @@
|
||||
= Sample YAML for a Cluster API compute machine set resource on {gcp-full}
|
||||
|
||||
The compute machine set resource defines additional properties of the machines that it creates.
|
||||
The compute machine set also references the infrastructure resource and machine template when creating machines.
|
||||
The compute machine set also references the cluster resource and machine template when creating machines.
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
@@ -16,30 +16,37 @@ kind: MachineSet
|
||||
metadata:
|
||||
name: <machine_set_name> # <1>
|
||||
namespace: openshift-cluster-api
|
||||
labels:
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name> # <2>
|
||||
spec:
|
||||
clusterName: <cluster_name> # <2>
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
test: example
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name>
|
||||
cluster.x-k8s.io/set-name: <machine_set_name>
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
test: example
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name>
|
||||
cluster.x-k8s.io/set-name: <machine_set_name>
|
||||
node-role.kubernetes.io/<role>: ""
|
||||
spec:
|
||||
bootstrap:
|
||||
dataSecretName: worker-user-data # <3>
|
||||
dataSecretName: worker-user-data
|
||||
clusterName: <cluster_name>
|
||||
infrastructureRef:
|
||||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
|
||||
kind: GCPMachineTemplate # <4>
|
||||
name: <template_name> # <5>
|
||||
failureDomain: <failure_domain> # <6>
|
||||
kind: GCPMachineTemplate # <3>
|
||||
name: <template_name> # <4>
|
||||
failureDomain: <failure_domain> # <5>
|
||||
----
|
||||
<1> Specify a name for the compute machine set.
|
||||
The cluster ID, machine role, and region form a typical pattern for this value in the following format: `<cluster_name>-<role>-<region>`.
|
||||
<2> Specify the cluster ID as the name of the cluster.
|
||||
<3> For the Cluster API Technology Preview, the Operator can use the worker user data secret from the `openshift-machine-api` namespace.
|
||||
<4> Specify the machine template kind.
|
||||
<3> Specify the machine template kind.
|
||||
This value must match the value for your platform.
|
||||
<5> Specify the machine template name.
|
||||
<6> Specify the failure domain within the {gcp-short} region.
|
||||
<4> Specify the machine template name.
|
||||
<5> Specify the failure domain within the {gcp-short} region.
|
||||
@@ -7,7 +7,7 @@
|
||||
= Sample YAML for a Cluster API compute machine set resource on {vmw-full}
|
||||
|
||||
The compute machine set resource defines additional properties of the machines that it creates.
|
||||
The compute machine set also references the infrastructure resource and machine template when creating machines.
|
||||
The compute machine set also references the cluster resource and machine template when creating machines.
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
@@ -16,25 +16,32 @@ kind: MachineSet
|
||||
metadata:
|
||||
name: <machine_set_name> # <1>
|
||||
namespace: openshift-cluster-api
|
||||
labels:
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name> # <2>
|
||||
spec:
|
||||
clusterName: <cluster_name> # <2>
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
test: example
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name>
|
||||
cluster.x-k8s.io/set-name: <machine_set_name>
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
test: example
|
||||
cluster.x-k8s.io/cluster-name: <cluster_name>
|
||||
cluster.x-k8s.io/set-name: <machine_set_name>
|
||||
node-role.kubernetes.io/<role>: ""
|
||||
spec:
|
||||
bootstrap:
|
||||
dataSecretName: worker-user-data # <3>
|
||||
dataSecretName: worker-user-data
|
||||
clusterName: <cluster_name>
|
||||
infrastructureRef:
|
||||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
|
||||
kind: VSphereMachineTemplate # <4>
|
||||
name: <template_name> # <5>
|
||||
failureDomain: # <6>
|
||||
kind: VSphereMachineTemplate # <3>
|
||||
name: <template_name> # <4>
|
||||
failureDomain: # <5>
|
||||
- name: <failure_domain_name>
|
||||
region: <region_a>
|
||||
zone: <zone_a>
|
||||
@@ -48,17 +55,17 @@ spec:
|
||||
- port-group
|
||||
----
|
||||
<1> Specify a name for the compute machine set.
|
||||
The cluster ID, machine role, and region form a typical pattern for this value in the following format: `<cluster_name>-<role>-<region>`.
|
||||
<2> Specify the cluster ID as the name of the cluster.
|
||||
<3> For the Cluster API Technology Preview, the Operator can use the worker user data secret from the `openshift-machine-api` namespace.
|
||||
<4> Specify the machine template kind.
|
||||
<3> Specify the machine template kind.
|
||||
This value must match the value for your platform.
|
||||
<5> Specify the machine template name.
|
||||
<6> Specify the failure domain configuration details.
|
||||
<4> Specify the machine template name.
|
||||
<5> Specify the failure domain configuration details.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
Using multiple regions and zones on a {vmw-short} cluster that uses the Cluster API is not a validated configuration.
|
||||
====
|
||||
// This callout section can be updated if this configuration is validated. (see also: additional resources in cluster-api-config-options-vsphere.adoc)
|
||||
// <6> Specify one or more failure domains.
|
||||
// <5> Specify one or more failure domains.
|
||||
// For more information about specifying multiple regions and zones on a {vmw-short} cluster, see "Multiple regions and zones configuration for a cluster on {vmw-full}."
|
||||
57
modules/capi-yaml-machine-template-azure.adoc
Normal file
57
modules/capi-yaml-machine-template-azure.adoc
Normal file
@@ -0,0 +1,57 @@
|
||||
// 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-machine-template-azure_{context}"]
|
||||
= Sample YAML for a Cluster API machine template resource on {azure-full}
|
||||
|
||||
The machine template resource is provider-specific and defines the basic properties of the machines that a compute machine set creates.
|
||||
The compute machine set references this template when creating machines.
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
|
||||
kind: AzureMachineTemplate # <1>
|
||||
metadata:
|
||||
name: <template_name> # <2>
|
||||
namespace: openshift-cluster-api
|
||||
spec:
|
||||
template:
|
||||
spec: # <3>
|
||||
disableExtensionOperations: true
|
||||
identity: UserAssigned
|
||||
image:
|
||||
id: /subscriptions/<subscription_id>/resourceGroups/<cluster_name>-rg/providers/Microsoft.Compute/galleries/gallery_<compliant_cluster_name>/images/<cluster_name>-gen2/versions/latest # <4>
|
||||
networkInterfaces:
|
||||
- acceleratedNetworking: true
|
||||
privateIPConfigs: 1
|
||||
subnetName: <cluster_name>-worker-subnet
|
||||
osDisk:
|
||||
diskSizeGB: 128
|
||||
managedDisk:
|
||||
storageAccountType: Premium_LRS
|
||||
osType: Linux
|
||||
sshPublicKey: <ssh_key_value>
|
||||
userAssignedIdentities:
|
||||
- providerID: 'azure:///subscriptions/<subscription_id>/resourcegroups/<cluster_name>-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<cluster_name>-identity'
|
||||
vmSize: Standard_D4s_v3
|
||||
----
|
||||
<1> Specify the machine template kind.
|
||||
This value must match the value for your platform.
|
||||
<2> Specify a name for the machine template.
|
||||
<3> Specify the details for your environment.
|
||||
The values here are examples.
|
||||
<4> Specify an image that is compatible with your instance type.
|
||||
The Hyper-V generation V2 images created by the installation program have a `-gen2` suffix, while V1 images have the same name without the suffix.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
Default {product-title} cluster names contain hyphens (`-`), which are not compatible with {azure-short} gallery name requirements.
|
||||
The value of `<compliant_cluster_name>` in this configuration must use underscores (`_`) instead of hyphens to comply with these requirements.
|
||||
Other instances of `<cluster_name>` do not change.
|
||||
|
||||
For example, a cluster name of `jdoe-test-2m2np` transforms to `jdoe_test_2m2np`.
|
||||
The full string for `gallery_<compliant_cluster_name>` in this example is `gallery_jdoe_test_2m2np`, not `gallery_jdoe-test-2m2np`.
|
||||
The complete value of `spec.template.spec.image.id` for this example value is `/subscriptions/<subscription_id>/resourceGroups/jdoe-test-2m2np-rg/providers/Microsoft.Compute/galleries/gallery_jdoe_test_2m2np/images/jdoe-test-2m2np-gen2/versions/latest`.
|
||||
====
|
||||
@@ -7,7 +7,7 @@
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
This Operator is available as a link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] for {aws-first}, {gcp-first}, and {vmw-first} clusters.
|
||||
This Operator is available as a link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] for {aws-first}, {gcp-first}, {azure-first}, and {vmw-first} clusters.
|
||||
====
|
||||
|
||||
[discrete]
|
||||
|
||||
Reference in New Issue
Block a user