Skip to content

Commit 6dedca8

Browse files
skopacz1skopacz1
authored
Merge pull request #73553 from skopacz1/OSDOCS-10010
OSDOCS-10010: Agent basic install procedure
2 parents 08d7fcb + 55dd7a7 commit 6dedca8

10 files changed

+175
-4
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,9 @@ Topics:
413413
File: preparing-to-install-with-agent-based-installer
414414
- Name: Understanding disconnected installation mirroring
415415
File: understanding-disconnected-installation-mirroring
416-
- Name: Installing a cluster with Agent-based Installer
416+
- Name: Installing a cluster
417+
File: installing-with-agent-basic
418+
- Name: Installing a cluster with customizations
417419
File: installing-with-agent-based-installer
418420
- Name: Preparing PXE assets for OCP
419421
File: prepare-pxe-assets-agent

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="installing-with-agent-based-installer"]
3-
= Installing an {product-title} cluster with the Agent-based Installer
3+
= Installing a cluster with customizations
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-with-agent-based-installer
66

77
toc::[]
88

9-
Use the following procedures to install an {product-title} cluster using the Agent-based Installer.
9+
Use the following procedures to install an {product-title} cluster with customizations using the Agent-based Installer.
1010

1111
[id="prerequisites_{context}"]
1212
== Prerequisites

‎installing/installing_with_agent_based_installer/installing-with-agent-basic.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="installing-with-agent-basic"]
3+
= Installing a cluster
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installing-with-agent-basic
6+
7+
toc::[]
8+
9+
You can install a basic {product-title} cluster using the Agent-based Installer.
10+
11+
For procedures that include optional customizations you can make while using the Agent-based Installer, see xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing a cluster with customizations].
12+
13+
[id="prerequisites_{context}"]
14+
== Prerequisites
15+
16+
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
17+
* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
18+
* If you use a firewall or proxy, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
19+
20+
[id="installing-ocp-agent_{context}"]
21+
== Installing {product-title} with the Agent-based Installer
22+
23+
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.
24+
25+
// Downloading the Agent-based Installer
26+
include::modules/installing-ocp-agent-download.adoc[leveloffset=+2]
27+
28+
// Creating the configuration inputs
29+
include::modules/installing-ocp-agent-basic-inputs.adoc[leveloffset=+2]
30+
31+
// Creating and booting the agent image
32+
include::modules/installing-ocp-agent-boot.adoc[leveloffset=+2]
33+
34+
// Verifying that the current installation host can pull release images
35+
include::modules/installing-ocp-agent-tui.adoc[leveloffset=+2]
36+
37+
// Tracking and verifying installation progress
38+
include::modules/installing-ocp-agent-verify.adoc[leveloffset=+2]
39+
40+
// Gathering log data from a failed Agent-based installation
41+
include::modules/installing-ocp-agent-gather-log.adoc[leveloffset=+1]

‎installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,6 @@ include::modules/validations-before-agent-iso-creation.adoc[leveloffset=+1]
111111
[id="agent-based-installation-next-steps_{context}"]
112112
== Next steps
113113

114-
* xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing a cluster with the Agent-based Installer]
114+
* xref:../../installing/installing_with_agent_based_installer/installing-with-agent-basic.adoc#installing-with-agent-basic[Installing a cluster]
115+
116+
* xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing a cluster with customizations]

‎modules/installing-ocp-agent-basic-inputs.adoc

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_with_agent_based_installer/installing-with-agent-basic.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="installing-ocp-agent-basic-inputs_{context}"]
7+
= Creating the configuration inputs
8+
9+
10+
You must create the configuration files that are used by the installation program to create the agent image.
11+
12+
.Procedure
13+
14+
. Place the `openshift-install` binary in a directory that is on your PATH.
15+
16+
. Create a directory to store the install configuration by running the following command:
17+
+
18+
[source,terminal]
19+
----
20+
$ mkdir ~/<directory_name>
21+
----
22+
23+
. Create the `install-config.yaml` file by running the following command:
24+
+
25+
--
26+
[source,terminal]
27+
----
28+
$ cat << EOF > ./my-cluster/install-config.yaml
29+
apiVersion: v1
30+
baseDomain: test.example.com
31+
compute:
32+
- architecture: amd64 // <1>
33+
hyperthreading: Enabled
34+
name: worker
35+
replicas: 0
36+
controlPlane:
37+
architecture: amd64
38+
hyperthreading: Enabled
39+
name: master
40+
replicas: 1
41+
metadata:
42+
name: sno-cluster // <2>
43+
networking:
44+
clusterNetwork:
45+
- cidr: fd01::/48
46+
hostPrefix: 64
47+
machineNetwork:
48+
- cidr: fd2e:6f44:5dd8:c956::/120
49+
networkType: OVNKubernetes // <3>
50+
serviceNetwork:
51+
- fd02::/112
52+
platform: <4>
53+
none: {}
54+
pullSecret: '<pull_secret>' // <5>
55+
sshKey: '<ssh_pub_key>' // <6>
56+
additionalTrustBundle: | // <7>
57+
-----BEGIN CERTIFICATE-----
58+
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
59+
-----END CERTIFICATE-----
60+
imageContentSources: // <8>
61+
- mirrors:
62+
- <local_registry>/<local_repository_name>/release
63+
source: quay.io/openshift-release-dev/ocp-release
64+
- mirrors:
65+
- <local_registry>/<local_repository_name>/release
66+
source: quay.io/openshift-release-dev/ocp-v4.0-art-dev
67+
EOF
68+
----
69+
<1> Specify the system architecture. Valid values are `amd64`, `arm64`, `ppc64le`, and `s390x`.
70+
+
71+
If you are using the release image with the `multi` payload, you can install the cluster on different architectures such as `arm64`, `amd64`, `s390x`, and `ppc64le`. Otherwise, you can install the cluster only on the `release architecture` displayed in the output of the `openshift-install version` command. For more information, see "Verifying the supported architecture for installing an Agent-based Installer cluster".
72+
<2> Required. Specify your cluster name.
73+
<3> The cluster network plugin to install. The default value `OVNKubernetes` is the only supported value.
74+
<4> Specify your platform.
75+
+
76+
[NOTE]
77+
====
78+
For bare metal platforms, host settings made in the platform section of the `install-config.yaml` file are used by default, unless they are overridden by configurations made in the `agent-config.yaml` file.
79+
====
80+
<5> Specify your pull secret.
81+
<6> Specify your SSH public key.
82+
<7> Provide the contents of the certificate file that you used for your mirror registry.
83+
The certificate file can be an existing, trusted certificate authority or the self-signed certificate that you generated for the mirror registry.
84+
You must specify this parameter if you are using a disconnected mirror registry.
85+
<8> Provide the `imageContentSources` section according to the output of the command that you used to mirror the repository.
86+
You must specify this parameter if you are using a disconnected mirror registry.
87+
+
88+
[IMPORTANT]
89+
====
90+
* When using the `oc adm release mirror` command, use the output from the `imageContentSources` section.
91+
* When using the `oc mirror` command, use the `repositoryDigestMirrors` section of the `ImageContentSourcePolicy` file that results from running the command.
92+
* The `ImageContentSourcePolicy` resource is deprecated.
93+
====
94+
--
95+
96+
. Create the `agent-config.yaml` file by running the following command:
97+
+
98+
[source,terminal]
99+
----
100+
$ cat > agent-config.yaml << EOF
101+
apiVersion: v1beta1
102+
kind: AgentConfig
103+
metadata:
104+
name: sno-cluster
105+
rendezvousIP: fd2e:6f44:5dd8:c956::50 // <1>
106+
EOF
107+
----
108+
+
109+
<1> This IP address is used to determine which node performs the bootstrapping process as well as running the `assisted-service` component.
110+
You must provide the rendezvous IP address when you do not specify at least one host IP address in the `networkConfig` parameter. If this address is not provided, one IP address is selected from the provided host `networkConfig` parameter.

‎modules/installing-ocp-agent-boot.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing-with-agent-based-installer/installing-with-agent-based-installer.adoc
4+
// * installing/installing_with_agent_based_installer/installing-with-agent-basic.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="installing-ocp-agent-boot_{context}"]

‎modules/installing-ocp-agent-download.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
// * installing/installing-with-agent-based-installer/installing-with-agent-based-installer.adoc
44
// * installing/installing_with_agent_based_installer/prepare-pxe-infra-agent.adoc
55
// * installing/installing_with_agent_based_installer/installing-using-iscsi.adoc
6+
// * installing/installing_with_agent_based_installer/installing-with-agent-basic.adoc
67

78
:_mod-docs-content-type: PROCEDURE
89
[id="installing-ocp-agent-retrieve_{context}"]

‎modules/installing-ocp-agent-gather-log.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing-with-agent-based-installer/installing-with-agent-based-installer.adoc
4+
// * installing/installing_with_agent_based_installer/installing-with-agent-basic.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="installing-ocp-agent-gather-log_{context}"]

‎modules/installing-ocp-agent-tui.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing-with-agent-based-installer/installing-with-agent-based-installer.adoc
4+
// * installing/installing_with_agent_based_installer/installing-with-agent-basic.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="installing-ocp-agent-tui_{context}"]

‎modules/installing-ocp-agent-verify.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing-with-agent-based-installer/installing-with-agent-based-installer.adoc
4+
// * installing/installing_with_agent_based_installer/installing-with-agent-basic.adoc
5+
6+
ifeval::["{context}" == "installing-with-agent-basic"]
7+
:basic:
8+
endif::[]
49

510
:_mod-docs-content-type: PROCEDURE
611
[id="installing-ocp-agent-verify_{context}"]
@@ -59,6 +64,8 @@ INFO Access the OpenShift web-console here: https://console-openshift-console.ap
5964
----
6065

6166

67+
// Note for a later doc effort - now that there is a section for ztp manifests, maybe this NOTE can be moved to that section?
68+
ifndef::basic[]
6269
[NOTE]
6370
====
6471
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:
@@ -92,3 +99,8 @@ networking:
9299
- fd03::/112
93100
networkType: OVNKubernetes
94101
----
102+
endif::basic[]
103+
104+
ifeval::["{context}" == "installing-with-agent-basic"]
105+
:!basic:
106+
endif::[]

0 commit comments

Comments
 (0)