Skip to content

Commit 9f3b01e

Browse files
authored
Merge pull request #102001 from dfitzmau/OSDOCS-17072-batch4
OSDOCS-17072-batch4
2 parents 9ca3860 + c4bfab3 commit 9f3b01e

16 files changed

+199
-136
lines changed

modules/installation-complete-user-infra.adoc

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
4949
:ibm-power:
5050
:restricted:
5151
endif::[]
52+
5253
:_mod-docs-content-type: PROCEDURE
5354
[id="installation-complete-user-infra_{context}"]
5455
= Completing installation on user-provisioned infrastructure
@@ -133,6 +134,7 @@ The command succeeds when the Cluster Version Operator finishes deploying the
133134
====
134135
135136
. Confirm that the Kubernetes API server is communicating with the pods.
137+
+
136138
.. To view a list of all pods, use the following command:
137139
+
138140
[source,terminal]
@@ -149,20 +151,17 @@ openshift-apiserver apiserver-67b9g
149151
openshift-apiserver apiserver-ljcmx 1/1 Running 0 1m
150152
openshift-apiserver apiserver-z25h4 1/1 Running 0 2m
151153
openshift-authentication-operator authentication-operator-69d5d8bf84-vh2n8 1/1 Running 0 5m
152-
...
153154
----
154-
155+
+
155156
.. View the logs for a pod that is listed in the output of the previous command by using the following command:
156157
+
157158
[source,terminal]
158159
----
159-
$ oc logs <pod_name> -n <namespace> <1>
160+
$ oc logs <pod_name> -n <namespace>
160161
----
161-
<1> Specify the pod name and namespace, as shown in the output of the previous
162-
command.
162+
* `<namespace>`: Specify the pod name and namespace, as shown in the output of an earlier command.
163163
+
164-
If the pod logs display, the Kubernetes API server can communicate with the
165-
cluster machines.
164+
If the pod logs display, the Kubernetes API server can communicate with the cluster machines.
166165
167166
ifndef::ibm-power[]
168167
. For an installation with Fibre Channel Protocol (FCP), additional steps are required to enable multipathing. Do not enable multipathing during installation.
@@ -187,23 +186,22 @@ If you have enabled secure boot during the {product-title} bootstrap process, th
187186
[source,terminal]
188187
----
189188
$ oc debug node/<node_name>
190-
chroot /host
191189
----
192190
+
193-
. Confirm that secure boot is enabled by running the following command:
194-
+
191+
.Example output
195192
[source,terminal]
196193
----
197-
$ cat /sys/firmware/ipl/secure
194+
chroot /host
198195
----
196+
197+
. Confirm that secure boot is enabled by running the following command. Example output states `1` if secure boot is enabled and `0` if secure boot is not enabled.
199198
+
200-
.Example output
201199
[source,terminal]
202200
----
203-
1 <1>
201+
$ cat /sys/firmware/ipl/secure
204202
----
205-
<1> The value is `1` if secure boot is enabled and `0` if secure boot is not enabled.
206203
endif::ibm-z,ibm-z-lpar[]
204+
207205
ifdef::ibm-z-lpar[]
208206
. List the re-IPL configuration by running the following command:
209207
+
@@ -213,7 +211,7 @@ ifdef::ibm-z-lpar[]
213211
----
214212
+
215213
.Example output for an FCP disk
216-
[source,terminal]
214+
[source,terminal,subs="attributes+"]
217215
----
218216
Re-IPL type: fcp
219217
WWPN: 0x500507630400d1e3
@@ -227,7 +225,7 @@ clear: 0
227225
----
228226
+
229227
.Example output for a DASD disk
230-
[source,terminal]
228+
[source,terminal,subs="attributes+"]
231229
----
232230
for DASD output:
233231
Re-IPL type: ccw

modules/installation-gcp-user-infra-adding-ingress.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,16 @@ router-default LoadBalancer 172.30.18.154 35.233.157.184 80:32288/TCP,44
5353
----
5454

5555
. Add the A record to your zones:
56+
+
5657
** To use A records:
58+
+
5759
... Export the variable for the router IP address:
5860
+
5961
[source,terminal]
6062
----
6163
$ export ROUTER_IP=`oc -n openshift-ingress get service router-default --no-headers | awk '{print $4}'`
6264
----
65+
+
6366
... Add the A record to the private zones:
6467
+
6568
ifndef::shared-vpc[]
@@ -83,6 +86,7 @@ $ gcloud dns record-sets transaction add ${ROUTER_IP} --name \*.apps.${CLUSTER_N
8386
$ gcloud dns record-sets transaction execute --zone ${INFRA_ID}-private-zone
8487
----
8588
endif::shared-vpc[]
89+
+
8690
ifdef::shared-vpc[]
8791
[source,terminal]
8892
----
@@ -127,6 +131,7 @@ $ gcloud dns record-sets transaction add ${ROUTER_IP} --name \*.apps.${CLUSTER_N
127131
$ gcloud dns record-sets transaction execute --zone ${BASE_DOMAIN_ZONE_NAME}
128132
----
129133
endif::shared-vpc[]
134+
+
130135
ifdef::shared-vpc[]
131136
[source,terminal]
132137
----

modules/installation-user-infra-exporting-common-variables-arm-templates.adoc

Lines changed: 12 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,11 @@ endif::[]
1919
[id="installation-user-infra-exporting-common-variables-arm-templates_{context}"]
2020
= Exporting common variables for ARM templates
2121

22-
You must export a common set of variables that are used with the provided Azure
23-
Resource Manager (ARM) templates used to assist in completing a user-provided
24-
infrastructure install on Microsoft {cp}.
22+
You must export a common set of variables that are used with the provided Azure Resource Manager (ARM) templates used to assist in completing a user-provided infrastructure install on Microsoft {cp}.
2523

2624
[NOTE]
2725
====
28-
Specific ARM templates can also require additional exported variables, which are
29-
detailed in their related procedures.
26+
Specific ARM templates can also require additional exported variables, which are detailed in their related procedures.
3027
====
3128

3229
.Prerequisites
@@ -35,67 +32,51 @@ detailed in their related procedures.
3532
3633
.Procedure
3734

38-
. Export common variables found in the `install-config.yaml` to be used by the
39-
provided ARM templates:
35+
. Export common variables found in the `install-config.yaml` to be used by the provided ARM templates:
4036
+
4137
[source,terminal]
4238
----
4339
$ export CLUSTER_NAME=<cluster_name>
4440
----
45-
+
46-
where:
47-
+
48-
`<cluster_name>`:: The value of the `.metadata.name` attribute from the `install-config.yaml` file.
41+
* `<cluster_name>`: The value of the `.metadata.name` attribute from the `install-config.yaml` file.
4942
+
5043
[source,terminal]
5144
----
5245
$ export AZURE_REGION=<azure_region>
5346
----
54-
+
55-
where:
56-
+
5747
ifndef::ash[]
58-
`<azure_region>`:: The region to deploy the cluster into, for example `centralus`. This is the value of the `.platform.azure.region` attribute from the `install-config.yaml` file.
48+
* `<azure_region>`: The region to deploy the cluster into, for example `centralus`. This is the value of the `.platform.azure.region` attribute from the `install-config.yaml` file.
5949
endif::ash[]
6050
ifdef::ash[]
61-
`<azure_region>`:: The region to deploy the cluster into. This is the value of the `.platform.azure.region` attribute from the `install-config.yaml` file.
51+
* `<azure_region>`: The region to deploy the cluster into. This is the value of the `.platform.azure.region` attribute from the `install-config.yaml` file.
6252
endif::ash[]
6353
+
6454
[source,terminal]
6555
----
6656
$ export SSH_KEY=<ssh_key>
6757
----
68-
+
69-
where:
70-
+
71-
`<ssh_key>`:: The SSH RSA public key file as a string. You must enclose the SSH key in quotes since it contains spaces. This is the value of the `.sshKey` attribute from the `install-config.yaml` file.
58+
* `<ssh_key>`: The SSH RSA public key file as a string. You must enclose the SSH key in quotes since it contains spaces. This is the value of the `.sshKey` attribute from the `install-config.yaml` file.
7259
+
7360
[source,terminal]
7461
----
7562
$ export BASE_DOMAIN=<base_domain>
7663
----
77-
+
78-
where:
79-
+
8064
ifndef::ash[]
81-
`<base_domain>`:: The base domain to deploy the cluster to. The base domain corresponds to the public DNS zone that you created for your cluster. This is the value of the `.baseDomain` attribute from the `install-config.yaml` file.
65+
* `<base_domain>`: The base domain to deploy the cluster to. The base domain corresponds to the public DNS zone that you created for your cluster. This is the value of the `.baseDomain` attribute from the `install-config.yaml` file.
8266
endif::ash[]
8367
ifdef::ash[]
84-
`<base_domain>`:: The base domain to deploy the cluster to. The base domain corresponds to the DNS zone that you created for your cluster. This is the value of the `.baseDomain` attribute from the `install-config.yaml` file.
68+
* `<base_domain>`: The base domain to deploy the cluster to. The base domain corresponds to the DNS zone that you created for your cluster. This is the value of the `.baseDomain` attribute from the `install-config.yaml` file.
8569
endif::ash[]
8670
+
8771
[source,terminal]
8872
----
8973
$ export BASE_DOMAIN_RESOURCE_GROUP=<base_domain_resource_group>
9074
----
91-
+
92-
where:
93-
+
9475
ifndef::ash[]
95-
`<base_domain_resource_group>`:: The resource group where the public DNS zone exists. This is the value of the `.platform.azure.baseDomainResourceGroupName` attribute from the `install-config.yaml` file.
76+
* `<base_domain_resource_group>`: The resource group where the public DNS zone exists. This is the value of the `.platform.azure.baseDomainResourceGroupName` attribute from the `install-config.yaml` file.
9677
endif::ash[]
9778
ifdef::ash[]
98-
`<base_domain_resource_group>`:: The resource group where the DNS zone exists. This is the value of the `.platform.azure.baseDomainResourceGroupName` attribute from the `install-config.yaml` file.
79+
* `<base_domain_resource_group>`: The resource group where the DNS zone exists. This is the value of the `.platform.azure.baseDomainResourceGroupName` attribute from the `install-config.yaml` file.
9980
endif::ash[]
10081
+
10182
For example:
@@ -131,10 +112,7 @@ $ export BASE_DOMAIN_RESOURCE_GROUP=ocp-cluster
131112
----
132113
$ export KUBECONFIG=<installation_directory>/auth/kubeconfig
133114
----
134-
+
135-
where:
136-
+
137-
`<installation_directory>`:: Specify the path to the directory that you stored the installation files in.
115+
* `<installation_directory>`: Specify the path to the directory that you stored the installation files in.
138116
139117
ifeval::["{context}" == "installing-azure-user-infra"]
140118
:!cp:

modules/installation-user-infra-exporting-common-variables.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ infrastructure install on {cp-first}.
4444

4545
[NOTE]
4646
====
47-
Specific {cp-template} templates can also require additional exported
48-
variables, which are detailed in their related procedures.
47+
Specific {cp-template} templates can also require additional exported variables, which are detailed in their related procedures.
4948
====
5049

5150
.Procedure
@@ -102,9 +101,7 @@ $ export PROJECT_NAME=`jq -r .gcp.projectID <installation_directory>/metadata.js
102101
----
103102
$ export REGION=`jq -r .gcp.region <installation_directory>/metadata.json`
104103
----
105-
106104
endif::shared-vpc[]
107-
//you need some of these variables for the VPC, and you do that
108105

109106
ifdef::shared-vpc[]
110107
[source,terminal]

modules/installation-user-infra-machines-advanced-customizing-live-network-config.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,30 @@ When creating a connection profile, you must use a `.nmconnection` filename exte
2020

2121
. Create a connection profile for a bonded interface. For example, create the `bond0.nmconnection` file in your local directory with the following content:
2222
+
23-
[source,ini]
23+
[source,terminal,subs="quotes,verbatim"]
2424
----
25-
[connection]
25+
/[connection]
2626
id=bond0
2727
type=bond
2828
interface-name=bond0
2929
multi-connect=1
3030

31-
[bond]
31+
/[bond]
3232
miimon=100
3333
mode=active-backup
3434

35-
[ipv4]
35+
/[ipv4]
3636
method=auto
3737

38-
[ipv6]
38+
/[ipv6]
3939
method=auto
4040
----
4141

4242
. Create a connection profile for a secondary interface to add to the bond. For example, create the `bond0-proxy-em1.nmconnection` file in your local directory with the following content:
4343
+
44-
[source,ini]
44+
[source,terminal,subs="quotes,verbatim"]
4545
----
46-
[connection]
46+
/[connection]
4747
id=em1
4848
type=ethernet
4949
interface-name=em1
@@ -54,9 +54,9 @@ slave-type=bond
5454

5555
. Create a connection profile for a secondary interface to add to the bond. For example, create the `bond0-proxy-em2.nmconnection` file in your local directory with the following content:
5656
+
57-
[source,ini]
57+
[source,terminal,subs="quotes,verbatim"]
5858
----
59-
[connection]
59+
/[connection]
6060
id=em2
6161
type=ethernet
6262
interface-name=em2
@@ -93,3 +93,4 @@ $ coreos-installer pxe customize rhcos-<version>-live-initramfs.x86_64.img \
9393
endif::[]
9494
+
9595
Network settings are applied to the live system and are carried over to the destination system.
96+

modules/installation-user-infra-machines-advanced-enabling-serial-console.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,26 @@ By default, the {op-system-first} serial console is disabled and all output is w
2020

2121
. Run the `coreos-installer` command to install the system, adding the `--console` option once to specify the graphical console, and a second time to specify the serial console:
2222
+
23+
ifndef::restricted[]
2324
[source,terminal]
2425
----
25-
ifndef::restricted[]
2626
$ coreos-installer install \
2727
--console=tty0 \//<1>
2828
--console=ttyS0,<options> \//<2>
2929
--ignition-url=http://host/worker.ign /dev/disk/by-id/scsi-<serial_number>
30+
----
3031
endif::[]
3132
ifdef::restricted[]
33+
[source,terminal]
34+
----
3235
$ coreos-installer install \
3336
--console=tty0 \//<1>
3437
--console=ttyS0,<options> \//<2>
3538
--ignition-url=http://host/worker.ign \
3639
--offline \
3740
/dev/disk/by-id/scsi-<serial_number>
38-
endif::[]
3941
----
42+
endif::[]
4043
+
4144
<1> The desired secondary console. In this case, the graphical console. Omitting this option will disable the graphical console.
4245
<2> The desired primary console. In this case the serial console. The `options` field defines the baud rate and other settings. A common value for this field is `115200n8`. If no options are provided, the default kernel value of `9600n8` is used. For more information on the format of this option, see link:https://www.kernel.org/doc/html/latest/admin-guide/serial-console.html[Linux kernel serial console] documentation.

0 commit comments

Comments
 (0)