Update wording for host preflights (#772)

* Update wording for host preflights

* Change host preflight failure/warning message

* Improve host preflight error messaging

* Improve host preflight error messaging

Author: ajp-io

cmd/embedded-cluster/install.go

@@ -109,15 +109,15 @@ func runHostPreflights(c *cli.Context, hpf *v1beta2.HostPreflightSpec) error {
 	}
 	pb := spinner.Start()
 	if c.Bool("skip-host-preflights") {
-		pb.Infof("Skipping host preflights")
+		pb.Infof("Host preflights skipped")
 		pb.Close()
 		return nil
 	}
 	pb.Infof("Running host preflights")
 	output, err := preflights.Run(c.Context, hpf)
 	if err != nil {
 		pb.CloseWithError()
-		return fmt.Errorf("host preflights failed: %w", err)
+		return fmt.Errorf("host preflights failed to run: %w", err)
 	}
 
 	err = output.SaveToDisk()
@@ -128,32 +128,28 @@ func runHostPreflights(c *cli.Context, hpf *v1beta2.HostPreflightSpec) error {
 
 	// Failures found
 	if output.HasFail() {
-		s := "failures"
+		s := "preflights"
 		if len(output.Fail) == 1 {
-			s = "failure"
+			s = "preflight"
 		}
-		msg := fmt.Sprintf("Host preflights have %d %s", len(output.Fail), s)
+		msg := fmt.Sprintf("%d host %s failed", len(output.Fail), s)
 		if output.HasWarn() {
-			s = "warnings"
-			if len(output.Warn) == 1 {
-				s = "warning"
-			}
-			msg += fmt.Sprintf(" and %d %s", len(output.Warn), s)
+			msg += fmt.Sprintf(" and %d warned", len(output.Warn))
 		}
 
 		pb.Errorf(msg)
 		pb.CloseWithError()
 		output.PrintTableWithoutInfo()
-		return fmt.Errorf("preflights haven't passed on the host")
+		return fmt.Errorf("host preflight failures detected")
 	}
 
 	// Warnings found
 	if output.HasWarn() {
-		s := "warnings"
+		s := "preflights"
 		if len(output.Warn) == 1 {
-			s = "warning"
+			s = "preflight"
 		}
-		pb.Warnf("Host preflights have %d %s", len(output.Warn), s)
+		pb.Warnf("%d host %s warned", len(output.Warn), s)
 		if c.Bool("no-prompt") {
 			// We have warnings but we are not in interactive mode
 			// so we just print the warnings and continue
@@ -674,7 +670,6 @@ var installCommand = &cli.Command{
 		}
 		logrus.Debugf("running host preflights")
 		if err := RunHostPreflights(c); err != nil {
-			err := fmt.Errorf("unable to finish preflight checks: %w", err)
 			metrics.ReportApplyFinished(c, err)
 			return err
 		}

pkg/preflights/host-preflight.yaml

@@ -29,72 +29,72 @@ spec:
         command: "ip"
         args: ["route"]
   analyzers:
-    - textAnalyze:
-        checkName: Default route
-        fileName: host-collectors/run-host/ip-route-table.txt
-        regex: "default"
+    - cpu:
+        checkName: 'CPU'
         outcomes:
           - fail:
-              when: "false"
-              message: "No default route found. A default route is required for cluster initialization."
+              when: 'count < 2'
+              message: At least 2 CPU cores are required
           - pass:
-              when: "true"
-              message: "Host has a default route."
-    - cpu:
-        checkName: 'Number of CPUs in the system'
+              message: At least 2 CPU cores are present
+    - memory:
+        checkName: Memory
         outcomes:
           - fail:
-              when: 'count < 2'
-              message: At least 2 CPU cores is required
+              when: '< 2G'
+              message: At least 2GB of memory is required
           - pass:
-              message: This node has at least 2 CPU cores
+              message: At least 2GB of memory is present
     - diskUsage:
-        checkName: embedded-cluster path usage
+        checkName: Embedded Cluster Disk Space
         collectorName: embedded-cluster-path-usage
         outcomes:
           - fail:
               when: 'total < 40Gi'
-              message: The filesystem at the path /var/lib/embedded-cluster has less than 40Gi of total space
+              message: The filesystem at /var/lib/embedded-cluster has less than 40Gi of total space
           - pass:
-              message: The filesystem at the path /var/lib/embedded-cluster has sufficient space
+              message: The filesystem at /var/lib/embedded-cluster has sufficient space
     - diskUsage:
-        checkName: k0s path usage
+        checkName: k0s Disk Space
         collectorName: k0s-path-usage
         outcomes:
           - fail:
               when: 'total < 40Gi'
-              message: The filesystem at the path /var/lib/k0s has less than 40Gi of total space
+              message: The filesystem at /var/lib/k0s has less than 40Gi of total space
           - fail:
               when: 'used/total > 80%'
-              message: The filesystem at the path /var/lib/k0s is more than 80% full
+              message: The filesystem at /var/lib/k0s is more than 80% full
           - pass:
-              message: The filesystem at the path /var/lib/k0s has sufficient space
+              message: The filesystem at /var/lib/k0s has sufficient space
     - diskUsage:
-        checkName: openebs path usage
+        checkName: OpenEBS Disk Space
         collectorName: openebs-path-usage
         outcomes:
           - fail:
               when: 'total < 5Gi'
-              message: The filesystem at the path /opt/openebs has less than 5Gi of total space
+              message: The filesystem at /opt/openebs has less than 5Gi of total space
           - pass:
-              message: The filesystem at the path /opt/openebs has sufficient space
+              message: The filesystem at /opt/openebs has sufficient space
     - diskUsage:
-        checkName: tmp path usage
+        checkName: tmp Disk Space
         collectorName: tmp-path-usage
         outcomes:
           - fail:
               when: 'total < 5Gi'
-              message: The filesystem at the path /tmp has less than 5Gi of total space
+              message: The filesystem at /tmp has less than 5Gi of total space
           - pass:
-              message: The filesystem at the path /tmp has sufficient space
-    - memory:
-        checkName: Amount of memory on the system
+              message: The filesystem at /tmp has sufficient space
+    - textAnalyze:
+        checkName: Default Route
+        fileName: host-collectors/run-host/ip-route-table.txt
+        regex: "default"
         outcomes:
           - fail:
-              when: '< 2G'
-              message: At least 2G of memory is recommended
+              when: "false"
+              message: "No default route found. A default route is required."
           - pass:
-              message: The system has at least 2G of memory
+              when: "true"
+              message: "Host has a default route"
     - ipv4Interfaces:
         outcomes:
           - fail:
@@ -104,14 +104,14 @@ spec:
               when: 'count >= 1'
               message: IPv4 interface detected
     - time:
-        checkName: 'Time synchronization'
+        checkName: System Clock
         outcomes:
           - fail:
               when: 'ntp == unsynchronized+inactive'
               message: 'System clock is not synchronized'
           - fail:
               when: 'ntp == unsynchronized+active'
-              message: System clock not yet synchronized
+              message: System clock is not yet synchronized
           - pass:
               when: 'ntp == synchronized+active'
               message: 'System clock is synchronized'