Skip to content

Commit 6e357df

Browse files
authored
Merge pull request #64049 from mjpytlak/osdocs-6505
OSDOCS#6505: Alibaba - move install config parameters out of assemblies
2 parents 6916c79 + 01f7566 commit 6e357df

6 files changed

+47
-38
lines changed

_topic_maps/_topic_map.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,8 @@ Topics:
144144
File: installing-alibaba-network-customizations
145145
- Name: Installing a cluster on Alibaba Cloud into an existing VPC
146146
File: installing-alibaba-vpc
147+
- Name: Installation configuration parameters for Alibaba Cloud
148+
File: installation-config-parameters-alibaba
147149
- Name: Uninstalling a cluster on Alibaba Cloud
148150
File: uninstall-cluster-alibaba
149151
- Name: Installing on AWS
@@ -1948,7 +1950,7 @@ Topics:
19481950
- Name: Setting up a new Argo CD instance
19491951
File: setting-up-argocd-instance
19501952
- Name: Monitoring Argo CD instances
1951-
File: monitoring-argo-cd-instances
1953+
File: monitoring-argo-cd-instances
19521954
- Name: Using Argo Rollouts for progressive deployment delivery
19531955
File: using-argo-rollouts-for-progressive-deployment-delivery
19541956
- Name: Configuring an OpenShift cluster by deploying an application with cluster configurations
@@ -3907,4 +3909,3 @@ Topics:
39073909
# - Name: Collecting OKD Virtualization data for community report
39083910
# File: virt-collecting-virt-data
39093911
# Distros: openshift-origin
3910-
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:_content-type: ASSEMBLY
2+
[id="installation-config-parameters-alibaba"]
3+
= Installation configuration parameters for Alibaba Cloud
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installation-config-parameters-alibaba
6+
:platform: Alibaba Cloud
7+
8+
toc::[]
9+
10+
Before you deploy an {product-title} cluster on Alibaba Cloud, you provide parameters to customize your cluster and the platform that hosts it. When you create the `install-config.yaml` file, you provide values for the required parameters through the command line. You can then modify the `install-config.yaml` file to customize your cluster further.
11+
12+
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]

installing/installing_alibaba/installing-alibaba-customizations.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,14 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
3333

3434
include::modules/installation-initializing.adoc[leveloffset=+2]
3535

36+
[role="_additional-resources"]
37+
.Additional resources
38+
* xref:../../installing/installing_alibaba/installation-config-parameters-alibaba.adoc#installation-config-parameters-alibaba[Installation configuration parameters for Alibaba Cloud]
39+
3640
include::modules/manually-creating-alibaba-manifests.adoc[leveloffset=+2]
3741

3842
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+2]
3943

40-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
41-
4244
include::modules/installation-alibaba-config-yaml.adoc[leveloffset=+2]
4345

4446
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

installing/installing_alibaba/installing-alibaba-network-customizations.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,14 @@ include::modules/nw-network-config.adoc[leveloffset=+1]
3434

3535
include::modules/installation-initializing.adoc[leveloffset=+2]
3636

37+
[role="_additional-resources"]
38+
.Additional resources
39+
* xref:../../installing/installing_alibaba/installation-config-parameters-alibaba.adoc#installation-config-parameters-alibaba[Installation configuration parameters for Alibaba Cloud]
40+
3741
include::modules/manually-creating-alibaba-manifests.adoc[leveloffset=+2]
3842

3943
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+2]
4044

41-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
42-
4345
include::modules/installation-alibaba-config-yaml.adoc[leveloffset=+2]
4446

4547
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
@@ -77,4 +79,4 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1]
7779
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
7880
* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
7981
//Given that manual mode is required to install on Alibaba Cloud, I do not believe this xref is necessary.
80-
//* If necessary, you can xref:../../authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc#manually-removing-cloud-creds_cco-mode-mint[remove cloud provider credentials].
82+
//* If necessary, you can xref:../../authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc#manually-removing-cloud-creds_cco-mode-mint[remove cloud provider credentials].

installing/installing_alibaba/installing-alibaba-vpc.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
3535

3636
include::modules/installation-initializing.adoc[leveloffset=+2]
3737

38-
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
38+
[role="_additional-resources"]
39+
.Additional resources
40+
* xref:../../installing/installing_alibaba/installation-config-parameters-alibaba.adoc#installation-config-parameters-alibaba[Installation configuration parameters for Alibaba Cloud]
3941

4042
include::modules/installation-alibaba-config-yaml.adoc[leveloffset=+2]
4143

@@ -69,4 +71,3 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1]
6971
* If necessary, you can xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
7072
//Given that manual mode is required to install on Alibaba Cloud, I do not believe this xref is necessary.
7173
//* If necessary, you can xref:../../authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc#manually-removing-cloud-creds_cco-mode-mint[remove cloud provider credentials].
72-

modules/installation-configuration-parameters.adoc

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
// Module included in the following assemblies:
22
//
3-
// * installing/installing_alibaba/installing-alibaba-default.adoc
4-
// * installing/installing_aws/installing-alibaba-customizations.adoc
5-
// * installing/installing_alibaba/installing-alibaba-network-customizations.adoc
6-
// * installing/installing_alibaba_installing-alibaba-vpc.adoc
73
// * installing/installing_aws/installing-aws-china.adoc
84
// * installing/installing_aws/installing-aws-customizations.adoc
95
// * installing/installing_aws/installing-aws-government-region.adoc
@@ -49,13 +45,8 @@
4945
// * installing/installing_azure_stack_hub/installation-config-parameters-ash.adoc
5046
// * installing/installing_bare_metal/installation-config-parameters-bare-metal.adoc
5147
// * installing/installing_ibm_cloud_public/installation-config-parameters-ibm-cloud-vps.adoc
48+
// * installing/installing_alibaba/installation-config-parameters-alibaba.adoc
5249

53-
ifeval::["{context}" == "installing-alibaba-customizations"]
54-
:alibabacloud:
55-
endif::[]
56-
ifeval::["{context}" == "installing-alibaba-vpc"]
57-
:alibabacloud:
58-
endif::[]
5950
ifeval::["{context}" == "installing-aws-customizations"]
6051
:aws:
6152
endif::[]
@@ -194,28 +185,31 @@ endif::[]
194185
ifeval::["{context}" == "installation-config-parameters-ibm-cloud-vpc"]
195186
:ibm-cloud:
196187
endif::[]
188+
ifeval::["{context}" == "installation-config-parameters-alibaba"]
189+
:alibaba-cloud:
190+
endif::[]
197191

198192

199193
:_content-type: CONCEPT
200194
[id="installation-configuration-parameters_{context}"]
201-
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
195+
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud[]
202196
= Installation configuration parameters
203-
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
197+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud[]
204198

205199
// Managing headings is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493.
206200
// This accommodates the existing IA of the installation assemblies, while the improvement is implemented.
207201
// As part of the updates for the last provider, the conditions can be removed and the following heading can be used.
208-
ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
202+
ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud[]
209203
= Available installation configuration parameters for {platform}
210-
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
204+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud[]
211205

212206
// If install-config.yaml is generated by openshift-install
213207
// The addition of providers beyond bare,ibm-power,ibm-z,ash is necessary as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493
214208
// This accommodates the existing IA of the installation assemblies, while the improvement is implemented.
215209
// As part of the updates for the last provider, content between lines 277-292 can be completely removed.
216-
ifndef::bare,ibm-power,ibm-z,ash,vsphere,gcp,ibm-cloud[]
210+
ifndef::bare,ibm-power,ibm-z,ash,vsphere,gcp,ibm-cloud,alibaba-cloud[]
217211
Before you deploy an {product-title} cluster, you provide parameter values to describe your account on the cloud platform that hosts your cluster and optionally customize your cluster's platform. When you create the `install-config.yaml` installation configuration file, you provide values for the required parameters through the command line. If you customize your cluster, you can modify the `install-config.yaml` file to provide more details about the platform.
218-
endif::bare,ibm-power,ibm-z,ash,vsphere,gcp,ibm-cloud[]
212+
endif::bare,ibm-power,ibm-z,ash,vsphere,gcp,ibm-cloud,alibaba-cloud[]
219213

220214
// If the user manually creates install-config.yaml
221215
ifdef::ibm-power-vs[]
@@ -225,24 +219,24 @@ endif::ibm-power-vs[]
225219
// A condition for this note is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493.
226220
// This accommodates the existing content for installation assemblies, while the improvement is implemented.
227221
// As part of the updates for the last provider, this note can be removed from the module.
228-
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
222+
ifndef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud[]
229223
[NOTE]
230224
====
231225
After installation, you cannot modify these parameters in the `install-config.yaml` file.
232226
====
233-
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
227+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud[]
234228

235229
// This condition is required as part of the effort for https://issues.redhat.com/browse/OSDOCS-6493.
236230
// As part of the update for each provider, this content applies to the net new provider-specific installation configuration parameter assembly.
237231
// As part of the updates for the last provider, the conditions can be completely removed.
238-
ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
232+
ifdef::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud[]
239233
The following tables specify the required, optional, and {platform}-specific installation configuration parameters that you can set as part of the installation process.
240234

241235
[NOTE]
242236
====
243237
After installation, you cannot modify these parameters in the `install-config.yaml` file.
244238
====
245-
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud[]
239+
endif::vsphere,gcp,ibm-z,ibm-power,ash,bare,ibm-cloud,alibaba-cloud[]
246240

247241
[id="installation-configuration-parameters-required_{context}"]
248242
== Required configuration parameters
@@ -896,7 +890,7 @@ For clusters that use AWS Local Zones, you must add AWS Local Zone subnets to th
896890
|Valid subnet IDs.
897891

898892
|`PreserveBootstrapIgnition`
899-
|Prevents the S3 bucket from being deleted after completion of bootstrapping.
893+
|Prevents the S3 bucket from being deleted after completion of bootstrapping.
900894
|`true` or `false`. The default value is `false`, which results in the S3 bucket being deleted.
901895

902896
|====
@@ -1879,7 +1873,7 @@ configuring user-defined routing.
18791873
|====
18801874
endif::ash[]
18811875

1882-
ifdef::alibabacloud[]
1876+
ifdef::alibaba-cloud[]
18831877
//From: https://github.com/openshift/installer/blob/master/data/data/install.openshift.io_installconfigs.yaml#L20; https://github.com/openshift/openshift-docs/pull/40651/files#r792388476
18841878

18851879
[id="installation-configuration-parameters-additional-alibaba_{context}"]
@@ -1985,7 +1979,7 @@ If defined, the parameters `compute.platform.alibabacloud` and `controlPlane.pla
19851979

19861980
|====
19871981

1988-
endif::alibabacloud[]
1982+
endif::alibaba-cloud[]
19891983

19901984
ifdef::nutanix[]
19911985
[id="installation-configuration-parameters-additional-vsphere_{context}"]
@@ -2105,12 +2099,6 @@ Additional Nutanix configuration parameters are described in the following table
21052099
--
21062100
endif::nutanix[]
21072101

2108-
ifeval::["{context}" == "installing-alibaba-customizations"]
2109-
:!alibabacloud:
2110-
endif::[]
2111-
ifeval::["{context}" == "installing-alibaba-vpc"]
2112-
:!alibabacloud:
2113-
endif::[]
21142102
ifeval::["{context}" == "installing-aws-customizations"]
21152103
:!aws:
21162104
endif::[]
@@ -2238,4 +2226,7 @@ endif::[]
22382226
ifeval::["{context}" == "installation-config-parameters-ibm-cloud-vpc"]
22392227
:!ibm-cloud:
22402228
endif::[]
2229+
ifeval::["{context}" == "installation-config-parameters-alibaba"]
2230+
:!alibaba-cloud:
2231+
endif::[]
22412232
:!platform:

0 commit comments

Comments
 (0)