Skip to content

Commit 3889fe1

Browse files
committed
OSDOCS-4638: documenting the agent-tui
1 parent c61bd06 commit 3889fe1

File tree

9 files changed

+200
-112
lines changed

9 files changed

+200
-112
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,11 +320,11 @@ Topics:
320320
Dir: installing_with_agent_based_installer
321321
Distros: openshift-enterprise
322322
Topics:
323-
- Name: Preparing to install with Agent-based installer
323+
- Name: Preparing to install with Agent-based Installer
324324
File: preparing-to-install-with-agent-based-installer
325325
- Name: Understanding disconnected installation mirroring
326326
File: understanding-disconnected-installation-mirroring
327-
- Name: Installing a cluster with Agent-based installer
327+
- Name: Installing a cluster with Agent-based Installer
328328
File: installing-with-agent-based-installer
329329
- Name: Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes
330330
File: preparing-an-agent-based-installed-cluster-for-mce

images/agent-tui-home.png

51.7 KB
Loading

images/agent_install.png

-96.9 KB
Binary file not shown.

images/agent_install_bare_metal.png

-87.4 KB
Binary file not shown.

installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,32 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9+
Use the following procedures to install an {product-title} cluster using the Agent-based Installer.
10+
911
[id="prerequisites_installing-with-agent-based-installer"]
1012
== Prerequisites
1113

1214
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
1315
* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
1416

15-
include::modules/installing-ocp-agent.adoc[leveloffset=+1]
17+
// This anchor ID is extracted/replicated from the former installing-ocp-agent.adoc module to preserve links.
18+
[id="installing-ocp-agent_installing-with-agent-based-installer"]
19+
== Installing {product-title} with the Agent-based Installer
20+
21+
The following procedures deploy a single-node {product-title} in a disconnected environment. You can use these procedures as a basis and modify according to your requirements.
22+
23+
include::modules/installing-ocp-agent-download.adoc[leveloffset=+2]
24+
25+
include::modules/installing-ocp-agent-boot.adoc[leveloffset=+2]
26+
27+
include::modules/installing-ocp-agent-tui.adoc[leveloffset=+2]
28+
29+
include::modules/installing-ocp-agent-verify.adoc[leveloffset=+2]
1630

1731
[role="_additional-resources"]
1832
.Additional resources
19-
* See xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#ipi-install-installation-workflow[Deploying with dual-stack networking].
20-
* See xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#ipi-install-installation-workflow[Configuring the install-config yaml file].
33+
* See xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#modifying-install-config-for-dual-stack-network_ipi-install-installation-workflow[Deploying with dual-stack networking].
34+
* See xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#configuring-the-install-config-file_ipi-install-installation-workflow[Configuring the install-config yaml file].
2135
* See xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-three-node-cluster_installing-restricted-networks-bare-metal[Configuring a three-node cluster] to deploy three-node clusters in bare metal environments.
2236
* See xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#root-device-hints_preparing-to-install-with-agent-based-installer[About root device hints].
2337
* See link:https://nmstate.io/examples.html[NMState state examples].

modules/installing-ocp-agent.adoc renamed to modules/installing-ocp-agent-boot.adoc

Lines changed: 8 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,13 @@
33
// * installing-with-agent/installing-with-agent.adoc
44

55
:_content-type: PROCEDURE
6-
[id="installing-ocp-agent_{context}"]
7-
= Installing {product-title} with the Agent-based Installer
6+
[id="installing-ocp-agent-boot_{context}"]
7+
= Creating and booting the agent image
88

9-
The following procedure deploys a single-node {product-title} in a disconnected environment. You can use this procedure as a basis and modify according to your requirements.
9+
Use this procedure to boot the agent image on your machines.
1010

1111
.Procedure
1212

13-
. Log in to the {product-title} web console using your login credentials.
14-
15-
. Navigate to link:https://console.redhat.com/openshift/create/datacenter[Datacenter].
16-
+
17-
image::agent_install.png[]
18-
19-
. Click *Run Agent-based Installer locally*. You are directed to the *Install {product-title} on Bare Metal locally with Agent* page.
20-
21-
. Optional: Alternatively, you can also click *Bare Metal (x86_64)* on the *Select an {product-title} cluster type to create* page. You are directed to the *Create an {product-title} Cluster: Bare Metal* page.
22-
Then, select *Local Agent-based* to go to the *Install {product-title} on Bare Metal locally with Agent* page.
23-
+
24-
image::agent_install_bare_metal.png[]
25-
26-
. Select the operating system and architecture.
27-
28-
. Click *Download Installer* to download and extract the install program.
29-
30-
. You can either download or copy the pull secret by clicking on *Download pull secret* or *Copy pull secret*.
31-
32-
. Click *Download command-line tools* and place the `openshift-install` binary in a directory that is on your `PATH`.
33-
3413
. Install `nmstate` dependency by running the following command:
3514
+
3615
[source,terminal]
@@ -66,7 +45,7 @@ compute:
6645
name: worker
6746
replicas: 0
6847
controlPlane:
69-
architecture: amd64
48+
architecture: amd64
7049
hyperthreading: Enabled
7150
name: master
7251
replicas: 1
@@ -90,7 +69,7 @@ sshKey: |
9069
----
9170
+
9271
<1> Specify the system architecture, valid values are `amd64` and `arm64`.
93-
<2> Required. Specify your cluster name.
72+
<2> Required. Specify your cluster name.
9473
<3> State the cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
9574
<4> Specify your pull secret.
9675
<5> Specify your ssh public key.
@@ -104,6 +83,9 @@ If you set the platform to `vSphere` or `baremetal`, you can configure IP addres
10483
* IPv6
10584
* IPv4 and IPv6 in parallel (dual-stack)
10685
86+
IPv6 is supported only on bare metal platforms.
87+
====
88+
+
10789
.Example of dual-stack networking
10890
[source,yaml]
10991
----
@@ -129,8 +111,6 @@ platform:
129111
- 192.168.11.4
130112
- 2001:DB8::5
131113
----
132-
IPv6 is supported only on bare metal platforms.
133-
====
134114

135115
. Create the `agent-config.yaml` file:
136116
+
@@ -193,82 +173,3 @@ $ openshift-install --dir <install_directory> agent create image
193173
NOTE: Red Hat Enterprise Linux CoreOS (RHCOS) supports multipathing on the primary disk, allowing stronger resilience to hardware failure to achieve higher host availability. Multipathing is enabled by default in the agent ISO image, with a default `/etc/multipath.conf` configuration.
194174
195175
. Boot the `agent.x86_64.iso` or `agent.aarch64.iso` image on the bare metal machines.
196-
197-
. Optional: To know when the bootstrap host (which is the rendezvous host) reboots, run the following command:
198-
199-
+
200-
[source,terminal]
201-
----
202-
$ ./openshift-install --dir <install_directory> agent wait-for bootstrap-complete \ <1>
203-
--log-level=info <2>
204-
----
205-
<1> For `<install_directory>`, specify the path to the directory where the agent ISO was generated.
206-
<2> To view different installation details, specify `warn`, `debug`, or `error` instead of `info`.
207-
208-
+
209-
.Example output
210-
[source,terminal]
211-
----
212-
...................................................................
213-
...................................................................
214-
INFO Bootstrap configMap status is complete
215-
INFO cluster bootstrap is complete
216-
----
217-
+
218-
The command succeeds when the Kubernetes API server signals that it has been bootstrapped on the control plane machines.
219-
220-
. To track the progress and verify sucessful installation, run the following command:
221-
+
222-
[source,terminal]
223-
----
224-
$ openshift-install --dir <install_directory> agent wait-for install-complete <1>
225-
----
226-
<1> For `<install_directory>` directory, specify the path to the directory where the agent ISO was generated.
227-
228-
+
229-
.Example output
230-
[source,terminal]
231-
----
232-
...................................................................
233-
...................................................................
234-
INFO Cluster is installed
235-
INFO Install complete!
236-
INFO To access the cluster as the system:admin user when using 'oc', run
237-
INFO export KUBECONFIG=/home/core/installer/auth/kubeconfig
238-
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.sno-cluster.test.example.com
239-
----
240-
241-
242-
[NOTE]
243-
====
244-
If you are using the optional method of ZTP manifests, you can configure IP address endpoints for cluster nodes through the `AgentClusterInstall.yaml` file in three ways:
245-
246-
* IPv4
247-
* IPv6
248-
* IPv4 and IPv6 in parallel (dual-stack)
249-
250-
.Example of dual-stack networking
251-
[source,yaml]
252-
----
253-
apiVIP: 192.168.11.3
254-
ingressVIP: 192.168.11.4
255-
clusterDeploymentRef:
256-
name: mycluster
257-
imageSetRef:
258-
name: openshift-4.12
259-
networking:
260-
clusterNetwork:
261-
- cidr: 172.21.0.0/16
262-
hostPrefix: 23
263-
- cidr: fd02::/48
264-
hostPrefix: 64
265-
machineNetwork:
266-
- cidr: 192.168.11.0/16
267-
- cidr: 2001:DB8::/32
268-
serviceNetwork:
269-
- 172.22.0.0/16
270-
- fd03::/112
271-
networkType: OVNKubernetes
272-
----
273-
IPv6 is supported only on bare metal platforms.
274-
====
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing-with-agent/installing-with-agent.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="installing-ocp-agent-retrieve_{context}"]
7+
= Downloading the Agent-based Installer
8+
9+
.Procedure
10+
11+
Use this procedure to download the Agent-based Installer and the CLI needed for your installation.
12+
13+
. Log in to the {product-title} web console using your login credentials.
14+
15+
. Navigate to link:https://console.redhat.com/openshift/create/datacenter[Datacenter].
16+
17+
. Click *Run Agent-based Installer locally*.
18+
19+
. Select the operating system and architecture for the *OpenShift Installer* and *Command line interface*.
20+
21+
. Click *Download Installer* to download and extract the install program.
22+
23+
. You can either download or copy the pull secret by clicking on *Download pull secret* or *Copy pull secret*.
24+
25+
. Click *Download command-line tools* and place the `openshift-install` binary in a directory that is on your `PATH`.

modules/installing-ocp-agent-tui.adoc

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing-with-agent/installing-with-agent.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="installing-ocp-agent-tui_{context}"]
7+
= Verifying that the current installation host can pull release images
8+
9+
After you boot the agent image and network services are made available to the host, the agent console application performs a pull check to verify that the current host can retrieve release images.
10+
11+
If the primary pull check passes, you can quit the application to continue with the installation. If the pull check fails, the application performs additional checks, as seen in the `Additional checks` section of the TUI, to help you troubleshoot the problem. A failure for any of the additional checks is not necessarily critical as long as the primary pull check succeeds.
12+
13+
If there are host network configuration issues that might cause an installation to fail, you can use the console application to make adjustments to your network configurations.
14+
15+
[IMPORTANT]
16+
====
17+
If the agent console application detects host network configuration issues, the installation workflow will be halted until the user manually stops the console application and signals the intention to proceed.
18+
====
19+
20+
.Procedure
21+
22+
. Wait for the agent console application to check whether or not the configured release image can be pulled from a registry.
23+
24+
. If the agent console application states that the installer connectivity checks have passed, wait for the prompt to time out to continue with the installation.
25+
+
26+
[NOTE]
27+
====
28+
You can still choose to view or change network configuration settings even if the connectivity checks have passed.
29+
30+
However, if you choose to interact with the agent console application rather than letting it time out, you must manually quit the TUI to proceed with the installation.
31+
====
32+
33+
. If the agent console application checks have failed, which is indicated by a red icon beside the `Release image URL` pull check, use the following steps to reconfigure the host's network settings:
34+
35+
.. Read the `Check Errors` section of the TUI.
36+
This section displays error messages specific to the failed checks.
37+
+
38+
image::agent-tui-home.png[The home screen of the agent console application displaying check errors, indicating a failed check]
39+
40+
.. Select *Configure network* to launch the NetworkManager TUI.
41+
42+
.. Select *Edit a connection* and select the connection you want to reconfigure.
43+
44+
.. Edit the configuration and select *OK* to save your changes.
45+
46+
.. Select *Back* to return to the main screen of the NetworkManager TUI.
47+
48+
.. Select *Activate a Connection*.
49+
50+
.. Select the reconfigured network to deactivate it.
51+
52+
.. Select the reconfigured network again to reactivate it.
53+
54+
.. Select *Back* and then select *Quit* to return to the agent console application.
55+
56+
.. Wait at least five seconds for the continuous network checks to restart using the new network configuration.
57+
58+
.. If the `Release image URL` pull check succeeds and displays a green icon beside the URL, select *Quit* to exit the agent console application and continue with the installation.
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing-with-agent/installing-with-agent.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="installing-ocp-agent-verify_{context}"]
7+
= Tracking and verifying installation progress
8+
9+
Use the following procedure to track installation progress and to verify a successful installation.
10+
11+
.Procedure
12+
13+
. Optional: To know when the bootstrap host (rendezvous host) reboots, run the following command:
14+
15+
+
16+
[source,terminal]
17+
----
18+
$ ./openshift-install --dir <install_directory> agent wait-for bootstrap-complete \ <1>
19+
--log-level=info <2>
20+
----
21+
<1> For `<install_directory>`, specify the path to the directory where the agent ISO was generated.
22+
<2> To view different installation details, specify `warn`, `debug`, or `error` instead of `info`.
23+
24+
+
25+
.Example output
26+
[source,terminal]
27+
----
28+
...................................................................
29+
...................................................................
30+
INFO Bootstrap configMap status is complete
31+
INFO cluster bootstrap is complete
32+
----
33+
+
34+
The command succeeds when the Kubernetes API server signals that it has been bootstrapped on the control plane machines.
35+
36+
. To track the progress and verify successful installation, run the following command:
37+
+
38+
[source,terminal]
39+
----
40+
$ openshift-install --dir <install_directory> agent wait-for install-complete <1>
41+
----
42+
<1> For `<install_directory>` directory, specify the path to the directory where the agent ISO was generated.
43+
44+
+
45+
.Example output
46+
[source,terminal]
47+
----
48+
...................................................................
49+
...................................................................
50+
INFO Cluster is installed
51+
INFO Install complete!
52+
INFO To access the cluster as the system:admin user when using 'oc', run
53+
INFO export KUBECONFIG=/home/core/installer/auth/kubeconfig
54+
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.sno-cluster.test.example.com
55+
----
56+
57+
58+
[NOTE]
59+
====
60+
If you are using the optional method of ZTP manifests, you can configure IP address endpoints for cluster nodes through the `AgentClusterInstall.yaml` file in three ways:
61+
62+
* IPv4
63+
* IPv6
64+
* IPv4 and IPv6 in parallel (dual-stack)
65+
66+
IPv6 is supported only on bare metal platforms.
67+
====
68+
.Example of dual-stack networking
69+
[source,yaml]
70+
----
71+
apiVIP: 192.168.11.3
72+
ingressVIP: 192.168.11.4
73+
clusterDeploymentRef:
74+
name: mycluster
75+
imageSetRef:
76+
name: openshift-4.13
77+
networking:
78+
clusterNetwork:
79+
- cidr: 172.21.0.0/16
80+
hostPrefix: 23
81+
- cidr: fd02::/48
82+
hostPrefix: 64
83+
machineNetwork:
84+
- cidr: 192.168.11.0/16
85+
- cidr: 2001:DB8::/32
86+
serviceNetwork:
87+
- 172.22.0.0/16
88+
- fd03::/112
89+
networkType: OVNKubernetes
90+
----

0 commit comments

Comments
 (0)