Merge pull request #63139 from skopacz1/OSDOCS-7291

OSDOCS#7291: Agent installer disk partitioning

Author: skrthomas

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

@@ -1,6 +1,6 @@
 :_content-type: ASSEMBLY
 [id="installing-with-agent-based-installer"]
-= Installing a {product-title} cluster with the Agent-based Installer
+= Installing an {product-title} cluster with the Agent-based Installer
 include::_attributes/common-attributes.adoc[]
 :context: installing-with-agent-based-installer
 
@@ -20,12 +20,29 @@ Use the following procedures to install an {product-title} cluster using the Age
 
 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.
 
+// Downloading the Agent-based Installer
 include::modules/installing-ocp-agent-download.adoc[leveloffset=+2]
 
+// Creating the preferred configuration inputs
+include::modules/installing-ocp-agent-inputs.adoc[leveloffset=+2]
+
+[id="installing-ocp-agent-opt-manifests_{context}"]
+=== Optional: Creating additional manifest files
+
+You can create additional manifests to further configure your cluster beyond the configurations available in the `install-config.yaml` and `agent-config.yaml` files.
+
+If you do not want to make additional configurations, proceed to xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-ocp-agent-boot_installing-with-agent-based-installer[Creating and booting the agent image].
+
+// Partitioning the disk
+include::modules/installation-user-infra-machines-advanced.adoc[leveloffset=+3]
+
+// Creating and booting the agent image
 include::modules/installing-ocp-agent-boot.adoc[leveloffset=+2]
 
+// Verifying that the current installation host can pull release images
 include::modules/installing-ocp-agent-tui.adoc[leveloffset=+2]
 
+// Tracking and verifying installation progress
 include::modules/installing-ocp-agent-verify.adoc[leveloffset=+2]
 
 [role="_additional-resources"]

modules/installation-user-infra-machines-advanced.adoc

@@ -2,9 +2,15 @@
 //
 // * installing/installing_bare_metal/installing-bare-metal.adoc
 // * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
-// * installing_bare_metal/installing-bare-metal-network-customizations.adoc
+// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
+// * installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc
+
+ifeval::["{context}" == "installing-with-agent-based-installer"]
+:agent:
+endif::[]
 
 :_content-type: PROCEDURE
+ifndef::agent[]
 [id="installation-user-infra-machines-advanced_{context}"]
 = Advanced {op-system} installation configuration
 
@@ -96,6 +102,13 @@ The use of custom partitions could result in those partitions not being monitore
 
 [id="installation-user-infra-machines-advanced_vardisk_{context}"]
 === Creating a separate `/var` partition
+endif::agent[]
+
+ifdef::agent[]
+[id="installing-ocp-agent-disk-partition_{context}"]
+= Disk partitioning
+endif::agent[]
+
 In general, you should use the default disk partitioning that is created during the {op-system} installation. However, there are cases where you might want to create a separate partition for a directory that you expect to grow.
 
 {product-title} supports the addition of a single partition to attach
@@ -120,12 +133,23 @@ The following procedure sets up a separate `/var` partition by adding a machine
 
 .Procedure
 
+ifndef::agent[]
 . On your installation host, change to the directory that contains the {product-title} installation program and generate the Kubernetes manifests for the cluster:
 +
 [source,terminal]
 ----
 $ openshift-install create manifests --dir <installation_directory>
 ----
+endif::agent[]
+
+ifdef::agent[]
+. On your installation host, create the `openshift` subdirectory within the installation directory:
++
+[source,terminal]
+----
+$ mkdir <installation_directory>/openshift
+----
+endif::agent[]
 
 . Create a Butane config that configures the additional partition. For example, name the file `$HOME/clusterconfig/98-var-partition.bu`, change the disk device name to the name of the storage device on the `worker` systems, and set the storage size as appropriate. This example places the `/var` directory on a separate partition:
 +
@@ -169,6 +193,7 @@ When creating a separate `/var` partition, you cannot use different instance typ
 $ butane $HOME/clusterconfig/98-var-partition.bu -o $HOME/clusterconfig/openshift/98-var-partition.yaml
 ----
 
+ifndef::agent[]
 . Create the Ignition config files:
 +
 [source,terminal]
@@ -289,3 +314,8 @@ For PXE or ISO boots, you can create the Ignition config
 and `APPEND` the `ignition.config.url=` option to identify the location of
 the Ignition config. You also need to append `ignition.firstboot ignition.platform.id=metal`
 or the `ignition.config.url` option will be ignored.
+endif::agent[]
+
+ifeval::["{context}" == "installing-with-agent-based-installer"]
+:!agent:
+endif::[]

modules/installing-ocp-agent-boot.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * installing-with-agent/installing-with-agent.adoc
+// * installing-with-agent/installing-with-agent-based-installer.adoc
 
 :_content-type: PROCEDURE
 [id="installing-ocp-agent-boot_{context}"]
@@ -10,158 +10,6 @@ Use this procedure to boot the agent image on your machines.
 
 .Procedure
 
-. Install `nmstate` dependency by running the following command:
-+
-[source,terminal]
-----
-$ sudo dnf install /usr/bin/nmstatectl -y
-----
-
-. Place the `openshift-install` binary in a directory that is on your PATH.
-
-. Create a directory to store the install configuration by running the following command:
-+
-[source,terminal]
-----
-$ mkdir ~/<directory_name>
-----
-
-+
-[NOTE]
-====
-This is the preferred method for the Agent-based installation. Using {ztp} manifests is optional.
-====
-
-. Create the `install-config.yaml` file:
-+
-[source,yaml]
-----
-cat << EOF > ./my-cluster/install-config.yaml
-apiVersion: v1
-baseDomain: test.example.com
-compute:
-  architecture: amd64 <1>
-  hyperthreading: Enabled
-  name: worker
-  replicas: 0
-controlPlane:
-  architecture: amd64
-  hyperthreading: Enabled
-  name: master
-  replicas: 1
-metadata:
-  name: sno-cluster <2>
-networking:
-  clusterNetwork:
-  - cidr: 10.128.0.0/14
-    hostPrefix: 23
-  machineNetwork:
-  - cidr: 192.168.111.0/16
-  networkType: OVNKubernetes <3>
-  serviceNetwork:
-  - 172.30.0.0/16
-platform:
-  none: {}
-pullSecret: '<pull_secret>' <4>
-sshKey: |
-  '<ssh_pub_key>' <5>
-  EOF
-----
-+
-<1> Specify the system architecture, valid values are `amd64` and `arm64`.
-<2> Required. Specify your cluster name.
-<3> State the cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
-<4> Specify your pull secret.
-<5> Specify your ssh public key.
-
-+
-[NOTE]
-====
-If you set the platform to `vSphere` or `baremetal`, you can configure IP address endpoints for cluster nodes in three ways:
-
-* IPv4
-* IPv6
-* IPv4 and IPv6 in parallel (dual-stack)
-
-IPv6 is supported only on bare metal platforms.
-====
-+
-.Example of dual-stack networking
-[source,yaml]
-----
-networking:
-  clusterNetwork:
-    - cidr: 172.21.0.0/16
-      hostPrefix: 23
-    - cidr: fd02::/48
-      hostPrefix: 64
-  machineNetwork:
-    - cidr: 192.168.11.0/16
-    - cidr: 2001:DB8::/32
-  serviceNetwork:
-    - 172.22.0.0/16
-    - fd03::/112
-  networkType: OVNKubernetes
-platform:
-  baremetal:
-    apiVIPs:
-    - 192.168.11.3
-    - 2001:DB8::4
-    ingressVIPs:
-    - 192.168.11.4
-    - 2001:DB8::5
-----
-
-. Create the `agent-config.yaml` file:
-+
-[source,yaml]
-----
-  cat > agent-config.yaml << EOF
-  apiVersion: v1alpha1
-  kind: AgentConfig
-  metadata:
-    name: sno-cluster
-  rendezvousIP: 192.168.111.80 <1>
-  hosts: <2>
-    - hostname: master-0 <3>
-      interfaces:
-        - name: eno1
-          macAddress: 00:ef:44:21:e6:a5
-      rootDeviceHints: <4>
-        deviceName: /dev/sdb
-      networkConfig: <5>
-        interfaces:
-          - name: eno1
-            type: ethernet
-            state: up
-            mac-address: 00:ef:44:21:e6:a5
-            ipv4:
-              enabled: true
-              address:
-                - ip: 192.168.111.80
-                  prefix-length: 23
-              dhcp: false
-        dns-resolver:
-          config:
-            server:
-              - 192.168.111.1
-        routes:
-          config:
-            - destination: 0.0.0.0/0
-              next-hop-address: 192.168.111.2
-              next-hop-interface: eno1
-              table-id: 254
-  EOF
-----
-+
-<1> This IP address is used to determine which node performs the bootstrapping process as well as running the `assisted-service` component.
-You must provide the rendezvous IP address when you do not specify at least one host's IP address in the `networkConfig` parameter. If this address is not provided, one IP address is selected from the provided hosts' `networkConfig`.
-<2> Host configuration is optional. The number of hosts defined must not exceed the total number of hosts defined in the `install-config.yaml` file, which is the sum of the values of the `compute.replicas` and `controlPlane.replicas` parameters.
-<3> The optional `hostname` parameter overrides the hostname obtained from either the Dynamic Host Configuration Protocol (DHCP) or a reverse DNS lookup. Each host must have a unique hostname supplied by one of these methods.
-<4> The `rootDeviceHints` parameter enables provisioning of the Red Hat Enterprise Linux CoreOS (RHCOS) image to a particular device. It examines the devices in the order it discovers them, and compares the discovered values with the hint values. It uses the first discovered device that matches the hint value.
-<5> Set this optional parameter to configure the network interface of a host in NMState format.
-
-+
 . Create the agent image by running the following command:
 
 +