Merge pull request #3129 from replicatedhq/121499

Document ignore-host-preflights instead of skip

Author: paigecalvert

docs/reference/embedded-cluster-install.mdx

@@ -82,6 +82,13 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
         <ProxyLimitations/>
      </td>
   </tr>
+  <tr>
+     <td>`--ignore-host-preflights`</td>
+     <td>
+        <p>When `--ignore-host-preflights` is passed, the host preflight checks are still run, but the user is prompted and can choose to continue with the installation if preflight failures occur. If there are no failed preflights, no user prompt is displayed. Additionally, the Admin Console still runs any application-specific preflight checks before the application is deployed. For more information about the Embedded Cluster host preflight checks, see [About Host Preflight Checks](/vendor/embedded-using#about-host-preflight-checks) in _Using Embedded Cluster_</p>
+        <p>Ignoring host preflight checks is _not_ recommended for production installations.</p>
+     </td>
+  </tr>
   <tr>
      <td>`--local-artifact-mirror-port`</td>
      <td>
@@ -116,6 +123,13 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
         <p>The KOTS [PrivateCACert](/reference/template-functions-static-context#privatecacert) template function returns the ConfigMap containing the private CA certificates supplied with the `--private-ca` flag. You can use this template function to mount the ConfigMap so your containers trust the CA too.</p>
      </td>
   </tr>
+  <tr>
+     <td>`--yes`</td>
+     <td>
+        <p>In Embedded Cluster 1.21.0 and later, pass the `--yes` flag to provide an affirmative response to any user prompts for the command. For example, you can pass `--yes` with the `--ignore-host-preflights` flag to ignore host preflight checks during automated installations.</p>
+        <p>**Requirement:** Embedded Cluster 1.21.0 and later</p>
+     </td>
+  </tr>
 </table>
 
 ## Examples

docs/vendor/embedded-using.mdx

@@ -109,20 +109,35 @@ Embedded Cluster host preflight checks have the following limitations:
 * The default host preflight checks for Embedded Cluster cannot be modified, and vendors cannot provide their own custom host preflight spec for Embedded Cluster.
 * Host preflight checks do not check that any application-specific requirements are met. For more information about defining preflight checks for your application, see [Defining Preflight Checks](/vendor/preflight-defining).
 
-#### Skip Host Preflight Checks
+#### Ignore Host Preflight Checks
 
-You can skip host preflight checks by passing the `--skip-host-preflights` flag with the Embedded Cluster `install` command. For example:
+You can pass the `--ignore-host-preflights` flag with the install command to ignore the Embedded Cluster host preflight checks. When `--ignore-host-preflights` is passed, the host preflight checks are still run, but the user is prompted and can choose to continue with the installation if preflight failures occur. If there are no failed preflights, no user prompt is displayed. The `--ignore-host-preflights` flag allows users to see any incompatibilities in their environment, while enabling them to bypass failures if necessary.
 
-```bash
-sudo ./my-app install --license license.yaml --skip-host-preflights
-```
-
-When you skip host preflight checks, the Admin Console still runs any application-specific preflight checks that are defined in the release before the application is deployed.
+Additionally, if users choose to ignore the host preflight checks during installation, the Admin Console still runs any application-specific preflight checks before the application is deployed.
 
 :::note
-Skipping host preflight checks is _not_ recommended for production installations.
+Ignoring host preflight checks is _not_ recommended for production installations.
 :::
 
+To ignore the Embedded Cluster host preflight checks:
+
+* **During installation:**
+
+     1. Pass the `--ignore-host-preflights` flag with the install command:
+          
+          ```bash
+          sudo ./APP_SLUG install --license license.yaml --ignore-host-preflights
+          ```
+          Where `APP_SLUG` is the unique slug for the application.
+
+     1. Review the results of the preflight checks. When prompted, type `yes` to ignore the preflight checks.      
+
+* **In automation:** Use both the `--ignore-host-preflights` and `--yes` flags to address the prompt for `--ignore-host-preflights`.
+
+          ```bash
+          sudo ./APP_SLUG install --license license.yaml --ignore-host-preflights --yes
+          ```
+
 ## About Managing Multi-Node Clusters with Embedded Cluster
 
 This section describes managing nodes in multi-node clusters created with Embedded Cluster.