You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
These example YAML file and snippets demonstrate the base structure for a control plane machine set custom resource (CR) and platform-specific samples for failure domain and provider specification configurations.
9
+
These example YAML file and snippets demonstrate the base structure for a control plane machine set custom resource (CR) and platform-specific samples for provider specification and failure domain configurations.
10
10
11
11
//Sample YAML for a control plane machine set custom resource
@@ -25,37 +25,54 @@ The `<platform_failure_domains>` and `<platform_provider_spec>` sections of the
25
25
26
26
* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-aws_cpmso-configuration[Sample YAML snippets for configuring Amazon Web Services clusters]
27
27
28
+
* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-gcp_cpmso-configuration[Sample YAML snippets for configuring Google Cloud Platform clusters]
29
+
28
30
* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-azure_cpmso-configuration[Sample YAML snippets for configuring Microsoft Azure clusters]
29
31
30
32
* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-vsphere_cpmso-configuration[Sample YAML snippets for configuring VMware vSphere clusters]
31
33
32
-
33
34
[id="cpmso-sample-yaml-aws_{context}"]
34
35
== Sample YAML for configuring Amazon Web Services clusters
35
36
36
-
Some sections of the control plane machine set CR are provider-specific. The example YAML in this section show failure domain and provider specification configurations for an Amazon Web Services (AWS) cluster.
Some sections of the control plane machine set CR are provider-specific. The example YAML in this section show provider specification and failure domain configurations for an Amazon Web Services (AWS) cluster.
* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-supported-features-aws_cpmso-using[Enabling Amazon Web Services features for control plane machines]
47
48
49
+
[id="cpmso-sample-yaml-gcp_{context}"]
50
+
== Sample YAML for configuring Google Cloud Platform clusters
51
+
52
+
Some sections of the control plane machine set CR are provider-specific. The example YAML in this section show provider specification and failure domain configurations for a Google Cloud Platform (GCP) cluster.
* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-supported-features-gcp_cpmso-using[Enabling Google Cloud Platform features for control plane machines]
64
+
////
48
65
[id="cpmso-sample-yaml-azure_{context}"]
49
66
== Sample YAML for configuring Microsoft Azure clusters
50
67
51
-
Some sections of the control plane machine set CR are provider-specific. The example YAML in this section show failure domain and provider specification configurations for an Azure cluster.
Some sections of the control plane machine set CR are provider-specific. The example YAML in this section show provider specification and failure domain configurations for an Azure cluster.
* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-supported-features-azure_cpmso-using[Enabling Microsoft Azure features for control plane machines]
The control plane machine set concept of a failure domain is analogous to the existing GCP concept of a link:https://cloud.google.com/compute/docs/regions-zones[_zone_]. The `ControlPlaneMachineSet` CR spreads control plane machines across multiple failure domains when possible.
10
+
11
+
When configuring GCP failure domains in the control plane machine set, you must specify the zone name to use.
12
+
13
+
.Sample GCP failure domain values
14
+
[source,yaml]
15
+
----
16
+
failureDomains:
17
+
gcp:
18
+
- zone: <gcp_zone_a> <1>
19
+
- zone: <gcp_zone_b> <2>
20
+
- zone: <gcp_zone_c>
21
+
- zone: <gcp_zone_d>
22
+
platform: GCP <3>
23
+
----
24
+
<1> Specifies a GCP zone for the first failure domain.
25
+
<2> Specifies an additional failure domain. Further failure domains are added the same way.
26
+
<3> Specifies the cloud provider platform name. Do not change this value.
When you create a control plane machine set for an existing cluster, the provider specification must match the `providerSpec` configuration in the control plane machine custom resource (CR) that is created by the installation program. You can omit any field that is set in the failure domain section of the CR.
10
+
11
+
[discrete]
12
+
[id="cpmso-yaml-provider-spec-gcp-oc_{context}"]
13
+
== Values obtained by using the OpenShift CLI
14
+
15
+
In the following example, you can obtain some of the values for your cluster by using the OpenShift CLI.
16
+
17
+
Infrastructure ID:: The `<cluster_id>` string is the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command:
18
+
+
19
+
[source,terminal]
20
+
----
21
+
$ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
22
+
----
23
+
24
+
Image path:: The `<path_to_image>` string is the path to the image that was used to create the disk. If you have the OpenShift CLI installed, you can obtain the path to the image by running the following command:
<3> Specifies the cloud provider platform type. Do not change this value.
84
+
<4> Specifies the name of the GCP project that you use for your cluster.
85
+
<5> Specifies the GCP region for the cluster.
86
+
<6> Specifies the control plane user data secret. Do not change this value.
87
+
<7> This parameter is configured in the failure domain, and is shown with an empty value here. If a value specified for this parameter differs from the value in the failure domain, the Operator overwrites it with the value in the failure domain.
In this sample, `<infrastructure_id>` is the infrastructure ID label that is based on the cluster ID that you set when you provisioned the cluster, and
In the following example, you can obtain some of the values for your cluster by using the OpenShift CLI.
27
+
28
+
Infrastructure ID:: The `<infrastructure_id>` string is the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command:
29
+
+
30
+
[source,terminal]
31
+
----
32
+
$ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
33
+
----
34
+
35
+
Image path:: The `<path_to_image>` string is the path to the image that was used to create the disk. If you have the OpenShift CLI installed, you can obtain the path to the image by running the following command:
<1> For `<infrastructure_id>`, specify the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command:
103
-
+
104
-
[source,terminal]
105
-
----
106
-
$ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
107
-
----
124
+
<1> For `<infrastructure_id>`, specify the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster.
108
125
ifndef::infra[]
109
126
<2> For `<node>`, specify the node label to add.
110
127
endif::infra[]
111
128
ifdef::infra[]
112
129
<2> For `<infra>`, specify the `<infra>` node label.
113
130
endif::infra[]
114
-
<3> Specify the path to the image that is used in current compute machine sets. If you have the OpenShift CLI installed, you can obtain the path to the image by running the following command:
0 commit comments