Skip to content

Commit 9bddcad

Browse files
Testing /refactor-callouts slash command on installing_aws subdir
1 parent 8173127 commit 9bddcad

14 files changed

+155
-117
lines changed

modules/install-creating-install-config-aws-edge-zones.adoc

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,20 @@ ifdef::local-zone[]
3838
# ...
3939
platform:
4040
aws:
41-
region: <region_name> <1>
41+
region: <region_name>
4242
compute:
4343
- name: edge
4444
platform:
4545
aws:
46-
zones: <2>
46+
zones:
4747
- <local_zone_name>
4848
#...
4949
----
50+
+
51+
where:
52+
+
53+
<region_name>:: The AWS Region name.
54+
<zones>:: The list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field.
5055
endif::local-zone[]
5156
ifdef::wavelength-zone[]
5257
+
@@ -55,18 +60,21 @@ ifdef::wavelength-zone[]
5560
# ...
5661
platform:
5762
aws:
58-
region: <region_name> <1>
63+
region: <region_name>
5964
compute:
6065
- name: edge
6166
platform:
6267
aws:
63-
zones: <2>
68+
zones:
6469
- <wavelength_zone_name>
6570
#...
6671
----
72+
+
73+
where:
74+
+
75+
<region_name>:: The AWS Region name.
76+
<zones>:: The list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field.
6777
endif::wavelength-zone[]
68-
<1> The AWS Region name.
69-
<2> The list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field.
7078
+
7179
.Example of a configuration to install a cluster in the `us-west-2` AWS Region that extends edge nodes to {zone-type} in `Los Angeles` and `Las Vegas` locations
7280
+

modules/installation-launching-installer.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -322,18 +322,20 @@ endif::single-step,azure-restricted[]
322322
+
323323
[source,terminal]
324324
----
325-
$ ./openshift-install create cluster --dir <installation_directory> \ <1>
326-
--log-level=info <2>
325+
$ ./openshift-install create cluster --dir <installation_directory> \
326+
--log-level=info
327327
----
328-
<1> For `<installation_directory>`, specify the
328+
+
329+
where:
330+
+
331+
<installation_directory>::
329332
ifdef::custom-config[]
330-
location of your customized `./install-config.yaml` file.
333+
Specify the location of your customized `./install-config.yaml` file.
331334
endif::custom-config[]
332335
ifdef::no-config[]
333-
directory name to store the files that the installation program creates.
336+
Specify the directory name to store the files that the installation program creates.
334337
endif::no-config[]
335-
<2> To view different installation details, specify `warn`, `debug`, or
336-
`error` instead of `info`.
338+
--log-level:: To view different installation details, specify `warn`, `debug`, or `error` instead of `info`.
337339

338340
ifdef::azure-gov,azure-private[]
339341
+

modules/installation-uninstall-clouds.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,13 @@ endif::ibm-cloud,ibm-power-vs[]
119119
[source,terminal]
120120
----
121121
$ ./openshift-install destroy cluster \
122-
--dir <installation_directory> --log-level info <1> <2>
122+
--dir <installation_directory> --log-level info
123123
----
124-
<1> For `<installation_directory>`, specify the path to the directory that you
125-
stored the installation files in.
126-
<2> To view different details, specify `warn`, `debug`, or `error` instead of `info`.
124+
+
125+
where:
126+
+
127+
<installation_directory>:: Specify the path to the directory that you stored the installation files in.
128+
--log-level:: To view different details, specify `warn`, `debug`, or `error` instead of `info`.
127129
ifndef::ibm-power-vs[]
128130
+
129131
[NOTE]

modules/installing-a-cluster-with-multiarch-support.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,20 @@ The output must contain `release architecture multi` to indicate that the `opens
4040
apiVersion: v1
4141
baseDomain: example.openshift.com
4242
compute:
43-
- architecture: amd64 <1>
43+
- architecture: amd64
4444
hyperthreading: Enabled
4545
name: worker
4646
platform: {}
4747
replicas: 3
4848
controlPlane:
49-
architecture: arm64 <2>
49+
architecture: arm64
5050
name: master
5151
platform: {}
5252
replicas: 3
5353
# ...
5454
----
55-
<1> Specify the architecture of the worker node. You can set this field to either `arm64` or `amd64`.
56-
<2> Specify the control plane node architecture. You can set this field to either `arm64` or `amd64`.
55+
+
56+
where:
57+
+
58+
compute.architecture:: Specify the architecture of the worker node. You can set this field to either `arm64` or `amd64`.
59+
controlPlane.architecture:: Specify the control plane node architecture. You can set this field to either `arm64` or `amd64`.

modules/installing-aws-edge-zones-custom-vpc-config.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ ifdef::local-zone[]
3737
platform:
3838
aws:
3939
region: us-west-2
40-
subnets: <1>
40+
subnets:
4141
- publicSubnetId-1
4242
- publicSubnetId-2
4343
- publicSubnetId-3
@@ -47,7 +47,8 @@ platform:
4747
- publicSubnetId-LocalZone-1
4848
# ...
4949
----
50-
<1> List of subnet IDs created in the zones: Availability and {zone-type}.
50+
+
51+
List of subnet IDs created in the zones: Availability and {zone-type}.
5152
endif::local-zone[]
5253
ifdef::wavelength-zone[]
5354
.Example installation configuration file with {zone-type} subnets
@@ -57,7 +58,7 @@ ifdef::wavelength-zone[]
5758
platform:
5859
aws:
5960
region: us-west-2
60-
subnets: <1>
61+
subnets:
6162
- publicSubnetId-1
6263
- publicSubnetId-2
6364
- publicSubnetId-3
@@ -67,7 +68,8 @@ platform:
6768
- publicOrPrivateSubnetID-Wavelength-1
6869
# ...
6970
----
70-
<1> List of subnet IDs created in the zones: Availability and {zone-type}.
71+
+
72+
List of subnet IDs created in the zones: Availability and {zone-type}.
7173
endif::wavelength-zone[]
7274
7375
ifeval::["{context}" == "installing-aws-localzone"]

modules/machineset-creating.adoc

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ apiVersion: machine.openshift.io/v1beta1
111111
kind: MachineSet
112112
metadata:
113113
labels:
114-
machine.openshift.io/cluster-api-cluster: <infrastructure_id> <1>
115-
name: <infrastructure_id>-<role> <2>
114+
machine.openshift.io/cluster-api-cluster: <infrastructure_id>
115+
name: <infrastructure_id>-<role>
116116
namespace: openshift-machine-api
117117
spec:
118118
replicas: 1
@@ -128,17 +128,20 @@ spec:
128128
machine.openshift.io/cluster-api-machine-type: <role>
129129
machine.openshift.io/cluster-api-machineset: <infrastructure_id>-<role>
130130
spec:
131-
providerSpec: <3>
131+
providerSpec:
132132
...
133133
----
134-
<1> The cluster infrastructure ID.
135-
<2> A default node label.
134+
+
135+
where:
136+
+
137+
<infrastructure_id>:: The cluster infrastructure ID.
138+
<role>:: A default node label.
136139
+
137140
[NOTE]
138141
====
139142
For clusters that have user-provisioned infrastructure, a compute machine set can only create `worker` and `infra` type machines.
140143
====
141-
<3> The values in the `<providerSpec>` section of the compute machine set CR are platform-specific. For more information about `<providerSpec>` parameters in the CR, see the sample compute machine set CR configuration for your provider.
144+
providerSpec:: The values in the `<providerSpec>` section of the compute machine set CR are platform-specific. For more information about `<providerSpec>` parameters in the CR, see the sample compute machine set CR configuration for your provider.
142145
--
143146

144147
ifdef::vsphere[]
@@ -157,8 +160,8 @@ template:
157160
value:
158161
apiVersion: machine.openshift.io/v1beta1
159162
credentialsSecret:
160-
name: vsphere-cloud-credentials <1>
161-
dataDisks: <2>
163+
name: vsphere-cloud-credentials
164+
dataDisks:
162165
- name: <disk_name>
163166
provisioningMode: <mode>
164167
sizeGiB: 10
@@ -171,22 +174,24 @@ template:
171174
numCPUs: 4
172175
numCoresPerSocket: 4
173176
snapshot: ""
174-
template: <vm_template_name> <3>
177+
template: <vm_template_name>
175178
userDataSecret:
176-
name: worker-user-data <4>
179+
name: worker-user-data
177180
workspace:
178181
datacenter: <vcenter_data_center_name>
179182
datastore: <vcenter_datastore_name>
180183
folder: <vcenter_vm_folder_path>
181184
resourcepool: <vsphere_resource_pool>
182-
server: <vcenter_server_address> <5>
185+
server: <vcenter_server_address>
183186
----
184-
<1> The name of the secret in the `openshift-machine-api` namespace that contains the required vCenter credentials.
185-
<2> The collection of data disk definitions.
186-
For more information, see "Configuring data disks by using machine sets".
187-
<3> The name of the {op-system} VM template for your cluster that was created during installation.
188-
<4> The name of the secret in the `openshift-machine-api` namespace that contains the required Ignition configuration credentials.
189-
<5> The IP address or fully qualified domain name (FQDN) of the vCenter server.
187+
+
188+
where:
189+
+
190+
credentialsSecret.name:: The name of the secret in the `openshift-machine-api` namespace that contains the required vCenter credentials.
191+
dataDisks:: The collection of data disk definitions. For more information, see "Configuring data disks by using machine sets".
192+
template:: The name of the {op-system} VM template for your cluster that was created during installation.
193+
userDataSecret.name:: The name of the secret in the `openshift-machine-api` namespace that contains the required Ignition configuration credentials.
194+
workspace.server:: The IP address or fully qualified domain name (FQDN) of the vCenter server.
190195
endif::vsphere[]
191196

192197
. Create a `MachineSet` CR by running the following command:

0 commit comments

Comments
 (0)