Skip to content

Commit afd72fb

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #76324 from jeana-redhat/machine-mgmt-build-issue
adoc tags troubleshooting: comment out tags in blocks
2 parents a880bf4 + ed95bf2 commit afd72fb

File tree

5 files changed

+68
-68
lines changed

5 files changed

+68
-68
lines changed

‎machine_management/cluster_api_machine_management/cluster_api_provider_configurations/_attributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../_attributes/
1+
../../../_attributes

‎machine_management/cluster_api_machine_management/cluster_api_provider_configurations/images

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../images
1+
../../../images

‎machine_management/cluster_api_machine_management/cluster_api_provider_configurations/modules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../modules
1+
../../../modules/

‎machine_management/cluster_api_machine_management/cluster_api_provider_configurations/snippets

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
../snippets
1+
../../../snippets/

‎modules/machineset-modifying.adoc

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -37,62 +37,62 @@ end::MAPI[]
3737
+
3838
[source,terminal]
3939
----
40-
tag::CAPI[]
40+
//tag::CAPI[]
4141
$ oc get machinesets.cluster.x-k8s.io -n openshift-cluster-api
42-
end::CAPI[]
43-
tag::MAPI[]
42+
//end::CAPI[]
43+
//tag::MAPI[]
4444
$ oc get machinesets.machine.openshift.io -n openshift-machine-api
45-
end::MAPI[]
45+
//end::MAPI[]
4646
----
4747
+
4848
.Example output
4949
[source,text]
5050
----
51-
tag::CAPI[]
51+
//tag::CAPI[]
5252
NAME CLUSTER REPLICAS READY AVAILABLE AGE VERSION
5353
<compute_machine_set_name_1> <cluster_name> 1 1 1 26m
5454
<compute_machine_set_name_2> <cluster_name> 1 1 1 26m
55-
end::CAPI[]
56-
tag::MAPI[]
55+
//end::CAPI[]
56+
//tag::MAPI[]
5757
NAME DESIRED CURRENT READY AVAILABLE AGE
5858
<compute_machine_set_name_1> 1 1 1 1 55m
5959
<compute_machine_set_name_2> 1 1 1 1 55m
60-
end::MAPI[]
60+
//end::MAPI[]
6161
----
6262

6363
. Edit a compute machine set by running the following command:
6464
+
6565
[source,terminal]
6666
----
67-
tag::CAPI[]
67+
//tag::CAPI[]
6868
$ oc edit machinesets.cluster.x-k8s.io <machine_set_name> \
6969
-n openshift-cluster-api
70-
end::CAPI[]
71-
tag::MAPI[]
70+
//end::CAPI[]
71+
//tag::MAPI[]
7272
$ oc edit machinesets.machine.openshift.io <machine_set_name> \
7373
-n openshift-machine-api
74-
end::MAPI[]
74+
//end::MAPI[]
7575
----
7676

7777
. Note the value of the `spec.replicas` field, because you need it when scaling the machine set to apply the changes.
7878
+
7979
[source,yaml]
8080
----
81-
tag::CAPI[]
81+
#tag::CAPI[]
8282
apiVersion: cluster.x-k8s.io/v1beta1
83-
end::CAPI[]
84-
tag::MAPI[]
83+
#end::CAPI[]
84+
#tag::MAPI[]
8585
apiVersion: machine.openshift.io/v1beta1
86-
end::MAPI[]
86+
#end::MAPI[]
8787
kind: MachineSet
8888
metadata:
8989
name: <machine_set_name>
90-
tag::CAPI[]
90+
#tag::CAPI[]
9191
namespace: openshift-cluster-api
92-
end::CAPI[]
93-
tag::MAPI[]
92+
#end::CAPI[]
93+
#tag::MAPI[]
9494
namespace: openshift-machine-api
95-
end::MAPI[]
95+
#end::MAPI[]
9696
spec:
9797
replicas: 2 # <1>
9898
# ...
@@ -105,98 +105,98 @@ spec:
105105
+
106106
[source,terminal]
107107
----
108-
tag::CAPI[]
108+
//tag::CAPI[]
109109
$ oc get machines.cluster.x-k8s.io \
110110
-n openshift-cluster-api \
111111
-l cluster.x-k8s.io/set-name=<machine_set_name>
112-
end::CAPI[]
113-
tag::MAPI[]
112+
//end::CAPI[]
113+
//tag::MAPI[]
114114
$ oc get machines.machine.openshift.io \
115115
-n openshift-machine-api \
116116
-l machine.openshift.io/cluster-api-machineset=<machine_set_name>
117-
end::MAPI[]
117+
//end::MAPI[]
118118
----
119119
+
120120
.Example output for an AWS cluster
121121
[source,text]
122122
----
123-
tag::CAPI[]
123+
//tag::CAPI[]
124124
NAME CLUSTER NODENAME PROVIDERID PHASE AGE VERSION
125125
<machine_name_original_1> <cluster_name> <original_1_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 4h
126126
<machine_name_original_2> <cluster_name> <original_2_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 4h
127-
end::CAPI[]
128-
tag::MAPI[]
127+
//end::CAPI[]
128+
//tag::MAPI[]
129129
NAME PHASE TYPE REGION ZONE AGE
130130
<machine_name_original_1> Running m6i.xlarge us-west-1 us-west-1a 4h
131131
<machine_name_original_2> Running m6i.xlarge us-west-1 us-west-1a 4h
132-
end::MAPI[]
132+
//end::MAPI[]
133133
----
134134

135135
. For each machine that is managed by the updated compute machine set, set the `delete` annotation by running the following command:
136136
+
137137
[source,terminal]
138138
----
139-
tag::CAPI[]
139+
//tag::CAPI[]
140140
$ oc annotate machines.cluster.x-k8s.io/<machine_name_original_1> \
141141
-n openshift-cluster-api \
142142
cluster.x-k8s.io/delete-machine="true"
143-
end::CAPI[]
144-
tag::MAPI[]
143+
//end::CAPI[]
144+
//tag::MAPI[]
145145
$ oc annotate machine.machine.openshift.io/<machine_name_original_1> \
146146
-n openshift-machine-api \
147147
machine.openshift.io/delete-machine="true"
148-
end::MAPI[]
148+
//end::MAPI[]
149149
----
150150

151151
. To create replacement machines with the new configuration, scale the compute machine set to twice the number of replicas by running the following command:
152152
+
153153
[source,terminal]
154154
----
155155
$ oc scale --replicas=4 \// <1>
156-
tag::CAPI[]
156+
//tag::CAPI[]
157157
machinesets.cluster.x-k8s.io <machine_set_name> \
158158
-n openshift-cluster-api
159-
end::CAPI[]
160-
tag::MAPI[]
159+
//end::CAPI[]
160+
//tag::MAPI[]
161161
machineset.machine.openshift.io <machine_set_name> \
162162
-n openshift-machine-api
163-
end::MAPI[]
163+
//end::MAPI[]
164164
----
165165
<1> The original example value of `2` is doubled to `4`.
166166

167167
. List the machines that are managed by the updated compute machine set by running the following command:
168168
+
169169
[source,terminal]
170170
----
171-
tag::CAPI[]
171+
//tag::CAPI[]
172172
$ oc get machines.cluster.x-k8s.io \
173173
-n openshift-cluster-api \
174174
-l cluster.x-k8s.io/set-name=<machine_set_name>
175-
end::CAPI[]
176-
tag::MAPI[]
175+
//end::CAPI[]
176+
//tag::MAPI[]
177177
$ oc get machines.machine.openshift.io \
178178
-n openshift-machine-api \
179179
-l machine.openshift.io/cluster-api-machineset=<machine_set_name>
180-
end::MAPI[]
180+
//end::MAPI[]
181181
----
182182
+
183183
.Example output for an AWS cluster
184184
[source,text]
185185
----
186-
tag::CAPI[]
186+
//tag::CAPI[]
187187
NAME CLUSTER NODENAME PROVIDERID PHASE AGE VERSION
188188
<machine_name_original_1> <cluster_name> <original_1_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 4h
189189
<machine_name_original_2> <cluster_name> <original_2_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 4h
190190
<machine_name_updated_1> <cluster_name> <updated_1_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Provisioned 55s
191191
<machine_name_updated_2> <cluster_name> <updated_2_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Provisioning 55s
192-
end::CAPI[]
193-
tag::MAPI[]
192+
//end::CAPI[]
193+
//tag::MAPI[]
194194
NAME PHASE TYPE REGION ZONE AGE
195195
<machine_name_original_1> Running m6i.xlarge us-west-1 us-west-1a 4h
196196
<machine_name_original_2> Running m6i.xlarge us-west-1 us-west-1a 4h
197197
<machine_name_updated_1> Provisioned m6i.xlarge us-west-1 us-west-1a 55s
198198
<machine_name_updated_2> Provisioning m6i.xlarge us-west-1 us-west-1a 55s
199-
end::MAPI[]
199+
//end::MAPI[]
200200
----
201201
+
202202
When the new machines are in the `Running` phase, you can scale the compute machine set to the original number of replicas.
@@ -206,14 +206,14 @@ When the new machines are in the `Running` phase, you can scale the compute mach
206206
[source,terminal]
207207
----
208208
$ oc scale --replicas=2 \// <1>
209-
tag::CAPI[]
209+
//tag::CAPI[]
210210
machinesets.cluster.x-k8s.io <machine_set_name> \
211211
-n openshift-cluster-api
212-
end::CAPI[]
213-
tag::MAPI[]
212+
//end::CAPI[]
213+
//tag::MAPI[]
214214
machineset.machine.openshift.io <machine_set_name> \
215215
-n openshift-machine-api
216-
end::MAPI[]
216+
//end::MAPI[]
217217
----
218218
<1> The original example value of `2`.
219219

@@ -223,62 +223,62 @@ end::MAPI[]
223223
+
224224
[source,terminal]
225225
----
226-
tag::CAPI[]
226+
//tag::CAPI[]
227227
$ oc describe machines.cluster.x-k8s.io <machine_name_updated_1> \
228228
-n openshift-cluster-api
229-
end::CAPI[]
230-
tag::MAPI[]
229+
//end::CAPI[]
230+
//tag::MAPI[]
231231
$ oc describe machine.machine.openshift.io <machine_name_updated_1> \
232232
-n openshift-machine-api
233-
end::MAPI[]
233+
//end::MAPI[]
234234
----
235235
236236
* To verify that the compute machines without the updated configuration are deleted, list the machines that are managed by the updated compute machine set by running the following command:
237237
+
238238
[source,terminal]
239239
----
240-
tag::CAPI[]
240+
//tag::CAPI[]
241241
$ oc get machines.cluster.x-k8s.io \
242242
-n openshift-cluster-api \
243243
cluster.x-k8s.io/set-name=<machine_set_name>
244-
end::CAPI[]
245-
tag::MAPI[]
244+
//end::CAPI[]
245+
//tag::MAPI[]
246246
$ oc get machines.machine.openshift.io \
247247
-n openshift-machine-api \
248248
-l machine.openshift.io/cluster-api-machineset=<machine_set_name>
249-
end::MAPI[]
249+
//end::MAPI[]
250250
----
251251
+
252252
.Example output while deletion is in progress for an AWS cluster
253253
[source,text]
254254
----
255-
tag::CAPI[]
255+
//tag::CAPI[]
256256
NAME CLUSTER NODENAME PROVIDERID PHASE AGE VERSION
257257
<machine_name_original_1> <cluster_name> <original_1_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 18m
258258
<machine_name_original_2> <cluster_name> <original_2_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 18m
259259
<machine_name_updated_1> <cluster_name> <updated_1_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 18m
260260
<machine_name_updated_2> <cluster_name> <updated_2_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 18m
261-
end::CAPI[]
262-
tag::MAPI[]
261+
//end::CAPI[]
262+
//tag::MAPI[]
263263
NAME PHASE TYPE REGION ZONE AGE
264264
<machine_name_original_1> Deleting m6i.xlarge us-west-1 us-west-1a 4h
265265
<machine_name_original_2> Deleting m6i.xlarge us-west-1 us-west-1a 4h
266266
<machine_name_updated_1> Running m6i.xlarge us-west-1 us-west-1a 5m41s
267267
<machine_name_updated_2> Running m6i.xlarge us-west-1 us-west-1a 5m41s
268-
end::MAPI[]
268+
//end::MAPI[]
269269
----
270270
+
271271
.Example output when deletion is complete for an AWS cluster
272272
[source,text]
273273
----
274-
tag::CAPI[]
274+
//tag::CAPI[]
275275
NAME CLUSTER NODENAME PROVIDERID PHASE AGE VERSION
276276
<machine_name_updated_1> <cluster_name> <updated_1_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 18m
277277
<machine_name_updated_2> <cluster_name> <updated_2_ip>.<region>.compute.internal aws:///us-east-2a/i-04e7b2cbd61fd2075 Running 18m
278-
end::CAPI[]
279-
tag::MAPI[]
278+
//end::CAPI[]
279+
//tag::MAPI[]
280280
NAME PHASE TYPE REGION ZONE AGE
281281
<machine_name_updated_1> Running m6i.xlarge us-west-1 us-west-1a 6m30s
282282
<machine_name_updated_2> Running m6i.xlarge us-west-1 us-west-1a 6m30s
283-
end::MAPI[]
283+
//end::MAPI[]
284284
----

0 commit comments

Comments
 (0)