Adds SME tech feedback on the whole agent content

Amrita · Amrita · commit b5adfb2f82dc · 2023-01-10T15:50:12.000+05:30
diff --git a/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc b/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc
@@ -6,13 +6,15 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
+[id="about-the-agent-based-installer"]
 == About the Agent-based Installer
-The Agent-based Installer provides the flexibility of user-provided infrastructure (UPI) installation and the ease of use of the Assisted Installer (AI). It is a subcommand that resides in the {product-title} installer, and also uses the {product-title} installer for the input asset management.
-It generates a bootable image containing all of the information required to deploy an {product-title} cluster.
 
-The Agent-based Installer is a sub-command that generates a live {op-system-first} ISO. The live ISO runs all of the required components that are running in containers pulled from the {product-title} release payload.
+The Agent-based installation method provides the flexibility to boot your on-premises servers in any way that you choose. It combines the ease of use of the Assisted Installation service with the ability to run offline, including in air-gapped environments.
+Agent-based installation is a subcommand of the {product-title} installer.
+It generates a bootable ISO image containing all of the information required to deploy an {product-title} cluster, with an available release image.
 
-The Agent-based Installer also utilizes Zero Touch Provisioning (ZTP) custom resources. ZTP allows you to provision new edge sites with declarative configurations of bare-metal equipment.
+The configuration is in the same format as for the installer-provisioned infrastructure and user-provisioned infrastructure installation methods.
+The Agent-based Installer can also optionally generate or accept Zero Touch Provisioning (ZTP) custom resources. ZTP allows you to provision new edge sites with declarative configurations of bare-metal equipment.
 
 include::modules/understanding-agent-install.adoc[leveloffset=+1]
 
diff --git a/modules/agent-install-ipi-install-root-device-hints.adoc b/modules/agent-install-ipi-install-root-device-hints.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// ipi-install-configuration-files.adoc
+// preparing-to-install-with-agent-based-installer.adoc
 
 :_content-type: REFERENCE
 [id='root-device-hints_{context}']
@@ -37,11 +37,6 @@ The `rootDeviceHints` parameter enables the installer to provision the {op-syste
 ----
      - name: master-0
        role: master
-       bmc:
-         address: ipmi://10.10.0.3:6203
-         username: admin
-         password: redhat
-       bootMACAddress: de:ad:be:ef:00:40
        rootDeviceHints:
          deviceName: "/dev/sda"
 ----
diff --git a/modules/agent-install-networking.adoc b/modules/agent-install-networking.adoc
@@ -6,36 +6,33 @@
 [id="agent-install-networking_{context}"]
 = About networking
 
-During the initial boot, the machines require an IP address configuration that is set either through a Dynamic Host Configuration Protocol(DHCP) server or statically by
-selecting the below options. If you provide the IP address for the `rendezvousIP` field through the DHCP option, then ensure that it is for the machine's IP address that is going to be used for deployment.
-This IP address is required for a node to be identified as ** node 0 **. A ** node 0 ** runs the required services for the Agent-based Installer.
+The *rendezvous IP* must be known at the time of generating the agent ISO, so that during the initial boot all the hosts can check in to the assisted service.
+If the IP addresses are assigned using a Dynamic Host Configuration Protocol (DHCP) server, then the `rendezvousIP` field must be set to an IP address of one of the hosts that will become part of the deployed control plane.
+In an environment without a DHCP server, you can define IP addresses statically.
+
+In addition to static IP addresses, you can apply any network configuration that is in NMState format. This includes VLANs and NIC bonds.
 
 == DHCP
 
 .Preferred method: `install-config.yaml` and `agent.config.yaml`
 
-You must specify only the value for the `rendezvousIP` field and `networkConfig` field must be left blank:
+You must specify the value for the `rendezvousIP` field. The `networkConfig` fields can be left blank:
 
 .Sample 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>
+apiVersion: v1alpha1
+kind: AgentConfig
+metadata:
+  name: sno-cluster
+rendezvousIP: 192.168.111.80 <1>
 ----
-<1> The IP address for ** node 0**.
+<1> The IP address for the rendezvous host.
 
 == Static networking
 
 .. Preferred method: `install-config.yaml` and `agent.config.yaml`
-+
-.Scenario-1
-
-When you specify the value for the `rendezvousIP` and `networkConfig` fields, the `rendezvousIP` field is utilized.
 
 +
 .Sample agent-config.yaml.file
@@ -47,39 +44,12 @@ When you specify the value for the `rendezvousIP` and `networkConfig` fields, th
   kind: AgentConfig
   metadata:
     name: sno-cluster
-  rendezvousIP: 192.168.111.80
-  hosts:
-    - hostname: master-0
-      interfaces:
-        - name: eno1
-          macAddress: 00:ef:44:21:e6:a5
-      networkConfig:
-        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
-----
-
-+
-.Scenario-2
-When you specify the values for the `networkConfig` field, the value from the `interfaces` field is utilized. This is when there is no `rendezvousIP` field.
-+
-[source,yaml]
-----
-  cat > agent-config.yaml << EOF
-  apiVersion: v1alpha1
-  kind: AgentConfig
+  rendezvousIP: 192.168.111.80 <1>
   hosts:
     - hostname: master-0
       interfaces:
         - name: eno1
-          macAddress: 00:ef:44:21:e6:a5
+          macAddress: 00:ef:44:21:e6:a5 <2>
       networkConfig:
         interfaces:
           - name: eno1
@@ -89,19 +59,32 @@ When you specify the values for the `networkConfig` field, the value from the `i
             ipv4:
               enabled: true
               address:
-                - ip: 192.168.111.80 <1>
-                  prefix-length: 23 <2>
+                - ip: 192.168.111.80 <3>
+                  prefix-length: 23 <4>
+              dhcp: false
+        dns-resolver:
+          config:
+            server:
+              - 192.168.111.1 <5>
+        routes:
+          config:
+            - destination: 0.0.0.0/0
+              next-hop-address: 192.168.111.1 <6>
+              next-hop-interface: eth0
+              table-id: 254
 ----
-<1> The static IP address of the target bare-metal host.
-<2> The static IP address’s subnet prefix for the target bare-metal host.
-+
-Note that the lowest value IP is utilized for the IP address of ** node 0**.
+<1> If a value is not specified for the `rendezvousIP` field, one address will be chosen from the static IP addresses specified in the `networkConfig` fields.
+<2> The MAC address of an interface on the host, used to determine which host to apply the configuration to.
+<3> The static IP address of the target bare metal host.
+<4> The static IP address’s subnet prefix for the target bare metal host.
+<5> The DNS server for the target bare metal host.
+<6> Next hop address for the node traffic. This must be in the same subnet as the IP address set for the specified interface.
 
 +
 .. Optional method: ZTP manifests
 
 +
-The optional method of the ZTP custom resources comprises 6 custom resources; you can configure static IPs in the `NMStateConfig.yaml.file`.
+The optional method of the ZTP custom resources comprises 6 custom resources; you can configure static IPs in the `nmstateconfig.yaml` file.
 
 +
 [source,yaml]
@@ -137,14 +120,13 @@ spec:
           next-hop-interface: eth0
           table-id: 254
   interfaces:
-    - name: "eth0" <5>
-      macAddress: 52:54:01:aa:aa:a1 <6>
+    - name: eth0
+      macAddress: 52:54:01:aa:aa:a1 <5>
 ----
-<1> The static IP address of the target bare-metal host.
-<2> The static IP address’s subnet prefix for the target bare-metal host.
-<3> The DNS server for the target bare-metal host.
+<1> The static IP address of the target bare metal host.
+<2> The static IP address’s subnet prefix for the target bare metal host.
+<3> The DNS server for the target bare metal host.
 <4> Next hop address for the node traffic. This must be in the same subnet as the IP address set for the specified interface.
-<5> The `interfaces` field must have the same name.
-<6> The mac address of the interface.
-+
-Note that the lowest value IP is utilized for the IP address of ** node 0**.
+<5> The MAC address of an interface on the host, used to determine which host to apply the configuration to.
+
+The rendezvous IP is chosen from the static IP addresses specified in the `config` fields.
diff --git a/modules/installing-ocp-agent.adoc b/modules/installing-ocp-agent.adoc
@@ -10,7 +10,7 @@ The following procedure deploys a single-node {product-title} in a disconnected
 
 .Procedure
 
-. Navigate to the link:https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/latest [OpenShift mirror site] and download the latest version of the tarball that matches your operating system.
+. Navigate to the link:https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/latest[OpenShift mirror site] and download the latest version of the installer and client tarballs that match your operating system.
 
 . Extract the binary by running the following command:
 +
@@ -30,7 +30,7 @@ $ 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 cluster manifests by running the following command:
+. Create a directory to store the install configuration by running the following command:
 +
 [source,terminal]
 ----
@@ -47,7 +47,7 @@ This is the preferred method for the Agent-based installation. Using ZTP manifes
 +
 [source,yaml]
 ----
-cat << EOF > ./cluster-manifests/install-config.yaml
+cat << EOF > ./my-cluster/install-config.yaml
 apiVersion: v1
 baseDomain: test.example.com
 compute:
@@ -162,65 +162,56 @@ platform:
 ----
 +
 <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 IP address when you do not specify the node's IP addresses in the `networkConfig` parameter. If this address is not provided, one IP address is selected from the provided nodes's `networkConfig`.
-<2> The number of hosts defined must match 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. When 3 master nodes and 0 worker nodes are defined in the `install-config.yaml` file,
-the number of hosts defined is 3. When 3 master nodes and 2 worker nodes are defined in the `install-config.yaml` file, the number of hosts defined is 5.
+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:
-+
-[NOTE]
-====
-Ensure that the image is created in the same path as the **auth** folder. You can verify this with the following command:
+. Create the agent image by running the following command:
 
-[source,terminal]
-----
-$ ls
-agent.iso  auth
-----
-====
 +
 [source,terminal]
 ----
-$ openshift-install agent create image
+$ openshift-install --dir <install_directory> agent create image
 ----
 +
-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.
+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.
+
+. Boot the `agent.x86_64.iso` image on the bare metal machines.
 
-. Optional: To know when the bootstrap node (** node 0 **) reboots, run the following command:
+. Optional: To know when the bootstrap host (which is the rendezvous host) reboots, run the following command:
 
 +
 [source,terminal]
 ----
-$ ./openshift-install --dir <manifests_directory> wait-for bootstrap-complete \ <1>
+$ ./openshift-install --dir <install_directory> agent wait-for bootstrap-complete \ <1>
     --log-level=info <2>
 ----
-<1> For `<manifests_directory>`, specify the path to the directory that you stored the manifest files in.
+<1> For `<install_directory>`, specify the path to the directory where the agent ISO was generated.
 <2> To view different installation details, specify `warn`, `debug`, or `error` instead of `info`.
 
 +
 .Example output
 [source,terminal]
 ----
-INFO Waiting up to 30m0s for the Kubernetes API at https://api.test.example.com:6443...
-INFO API v1.25.0 up
-INFO Waiting up to 30m0s for bootstrapping to complete...
-INFO It is now safe to remove the bootstrap resources
+...................................................................
+...................................................................
+INFO Bootstrap configMap status is complete
+INFO cluster bootstrap is complete
 ----
 +
 The command succeeds when the Kubernetes API server signals that it has been bootstrapped on the control plane machines.
 
-. Boot the `agent.iso` image on the bare metal machines. You can run the image on any Linux distribution.
-
 . To track the progress and verify sucessful installation, run the following command:
 +
 [source,terminal]
 ----
-$ openshift-install agent wait-for install-complete
+$ openshift-install --dir <install_directory> agent wait-for install-complete <1>
 ----
+<1> For `<install_directory>` directory, specify the path to the directory where the agent ISO was generated.
+
 +
 .Example output
 [source,terminal]
diff --git a/modules/sample-ztp-custom-resources.adoc b/modules/sample-ztp-custom-resources.adoc
@@ -10,7 +10,7 @@ Optional: You can use Zero touch provisioning (ZTP) custom resource (CR) objects
 
 You can customize the following ZTP custom resources to specify more details about your {product-title} cluster. The following sample ZTP custom resources are for a single-node cluster.
 
-**AgentClusterInstall.yaml**
+*agent-cluster-install.yaml*
 
 [source,yaml]
 ----
@@ -36,7 +36,7 @@ You can customize the following ZTP custom resources to specify more details abo
     sshPublicKey: <YOUR_SSH_PUBLIC_KEY>
 ----
 
-**ClusterDeployment.yaml**
+*cluster-deployment.yaml*
 
 [source,yaml]
 ----
@@ -64,7 +64,7 @@ spec:
     name: pull-secret
 ----
 
-**ClusterImageSet.yaml**
+*cluster-image-set.yaml*
 
 [source,yaml]
 ----
@@ -76,7 +76,7 @@ spec:
   releaseImage: registry.ci.openshift.org/ocp/release:4.12.0-0.nightly-2022-06-06-025509
 ----
 
-**InfraEnv.yaml**
+*infra-env.yaml*
 
 [source,yaml]
 ----
@@ -97,7 +97,7 @@ spec:
       cluster0-nmstate-label-name: cluster0-nmstate-label-value
 ----
 
-**NMStateConfig.yaml**
+*nmstateconfig.yaml*
 
 [source,yaml]
 ----
diff --git a/modules/understanding-agent-install.adoc b/modules/understanding-agent-install.adoc
diff --git a/modules/validations-before-agent-iso-creation.adoc b/modules/validations-before-agent-iso-creation.adoc
