From 5d8ce8808ec4ade33a6474e89c4064e95d1ada90 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 24 Mar 2025 14:06:51 -0600 Subject: [PATCH 1/6] edit steps on ignoring preflights --- docs/vendor/embedded-using.mdx | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/vendor/embedded-using.mdx b/docs/vendor/embedded-using.mdx index 510e1df79e..dfd187629e 100644 --- a/docs/vendor/embedded-using.mdx +++ b/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: +When `--ignore-host-preflights` is passed, the built-in host preflight checks are still run, but the user is prompted and can choose to continue if failures occur. This ensures that users 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. +Replicated does not recommend ignoring preflight checks in 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. From f28f2f96e809abc3fab9d2c206dd38e6e023d366 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 24 Mar 2025 14:29:30 -0600 Subject: [PATCH 2/6] update ec install command options with missing flags --- docs/reference/embedded-cluster-install.mdx | 31 +++++++++++++++++++++ docs/vendor/embedded-using.mdx | 2 +- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/reference/embedded-cluster-install.mdx b/docs/reference/embedded-cluster-install.mdx index cf34bb75ca..7744165316 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/docs/reference/embedded-cluster-install.mdx @@ -82,6 +82,15 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags] + + `--ignore-host-preflights` + +

When `--ignore-host-preflights` is passed, the built-in host preflight checks are still run, but the user is prompted and can choose to continue with the installation if preflight failures occur. 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_

+

Replicated does not recommend ignoring preflight checks in production installations.

+

The `--ignore-host-preflights` flag replaces the deprecated `--skip-host-preflights` flag.

+

**Requirement:** Embedded Cluster 1.21.0 and later

+ + `--local-artifact-mirror-port` @@ -109,6 +118,13 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags] + + `--no-prompt` **(Deprecated)** + +

Prevents the command from showing user prompts.

+

The `--no-prompt` flag is deprecated and replaced with the `--yes` flag in Embedded Cluster 1.21.0 and later.

+ + `--private-ca` @@ -116,6 +132,21 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]

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.

+ + `--skip-host-preflights` **(Deprecated)** + +

When `--skip-host-preflights` is passed, the Embedded Cluster host preflight checks are not run.

+

The `--skip-host-preflights` flag is deprecated and replaced with `--ignore-host-preflights` in Embedded Cluster 1.21.0 and later.

+ + + + `--yes` + +

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.

+

The `--yes` flag replaces the deprecated `--no-prompt` flag.

+

**Requirement:** Embedded Cluster 1.21.0 and later

+ + ## Examples diff --git a/docs/vendor/embedded-using.mdx b/docs/vendor/embedded-using.mdx index dfd187629e..594553437a 100644 --- a/docs/vendor/embedded-using.mdx +++ b/docs/vendor/embedded-using.mdx @@ -111,7 +111,7 @@ Embedded Cluster host preflight checks have the following limitations: #### Ignore Host Preflight Checks -When `--ignore-host-preflights` is passed, the built-in host preflight checks are still run, but the user is prompted and can choose to continue if failures occur. This ensures that users see any incompatibilities in their environment, while enabling them to bypass failures if necessary. +When `--ignore-host-preflights` is passed, the built-in host preflight checks are still run, but the user is prompted and can choose to continue with the installation if preflight failures occur. This ensures that users see any incompatibilities in their environment, while enabling them to bypass failures if necessary. 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. From cb1690d688c325fa760bf5c49e79ffbb2fa53ee5 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 24 Mar 2025 14:33:13 -0600 Subject: [PATCH 3/6] edits not recommended note --- docs/reference/embedded-cluster-install.mdx | 2 +- docs/vendor/embedded-using.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/embedded-cluster-install.mdx b/docs/reference/embedded-cluster-install.mdx index 7744165316..7fe2500cc2 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/docs/reference/embedded-cluster-install.mdx @@ -86,7 +86,7 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags] `--ignore-host-preflights`

When `--ignore-host-preflights` is passed, the built-in host preflight checks are still run, but the user is prompted and can choose to continue with the installation if preflight failures occur. 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_

-

Replicated does not recommend ignoring preflight checks in production installations.

+

Ignoring host preflight checks is _not_ recommended for production installations.

The `--ignore-host-preflights` flag replaces the deprecated `--skip-host-preflights` flag.

**Requirement:** Embedded Cluster 1.21.0 and later

diff --git a/docs/vendor/embedded-using.mdx b/docs/vendor/embedded-using.mdx index 594553437a..c346e0d1bc 100644 --- a/docs/vendor/embedded-using.mdx +++ b/docs/vendor/embedded-using.mdx @@ -116,7 +116,7 @@ When `--ignore-host-preflights` is passed, the built-in host preflight checks ar 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 -Replicated does not recommend ignoring preflight checks in production installations. +Ignoring host preflight checks is _not_ recommended for production installations. ::: To ignore the Embedded Cluster host preflight checks: From a464896b594c7a762b07896f908fb3ec3e4800bf Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 24 Mar 2025 14:37:46 -0600 Subject: [PATCH 4/6] edit description --- docs/vendor/embedded-using.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vendor/embedded-using.mdx b/docs/vendor/embedded-using.mdx index c346e0d1bc..b458f34aac 100644 --- a/docs/vendor/embedded-using.mdx +++ b/docs/vendor/embedded-using.mdx @@ -111,7 +111,7 @@ Embedded Cluster host preflight checks have the following limitations: #### Ignore Host Preflight Checks -When `--ignore-host-preflights` is passed, the built-in host preflight checks are still run, but the user is prompted and can choose to continue with the installation if preflight failures occur. This ensures that users see any incompatibilities in their environment, while enabling them to bypass failures if necessary. +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. This ensures that users see any incompatibilities in their environment, while enabling them to bypass failures if necessary. 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. From e10ce940654cd87b56261ae12b963c36bbadafae Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 24 Mar 2025 14:42:36 -0600 Subject: [PATCH 5/6] edit flag description --- docs/reference/embedded-cluster-install.mdx | 2 +- docs/vendor/embedded-using.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/embedded-cluster-install.mdx b/docs/reference/embedded-cluster-install.mdx index 7fe2500cc2..012bb08719 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/docs/reference/embedded-cluster-install.mdx @@ -85,7 +85,7 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags] `--ignore-host-preflights` -

When `--ignore-host-preflights` is passed, the built-in host preflight checks are still run, but the user is prompted and can choose to continue with the installation if preflight failures occur. 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_

+

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_

Ignoring host preflight checks is _not_ recommended for production installations.

The `--ignore-host-preflights` flag replaces the deprecated `--skip-host-preflights` flag.

**Requirement:** Embedded Cluster 1.21.0 and later

diff --git a/docs/vendor/embedded-using.mdx b/docs/vendor/embedded-using.mdx index b458f34aac..62be2a3656 100644 --- a/docs/vendor/embedded-using.mdx +++ b/docs/vendor/embedded-using.mdx @@ -111,7 +111,7 @@ Embedded Cluster host preflight checks have the following limitations: #### Ignore Host Preflight Checks -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. This ensures that users see any incompatibilities in their environment, while enabling them to bypass failures if necessary. +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. 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. From 7374357de32195520d945530364d2ef450accc46 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 25 Mar 2025 09:40:16 -0600 Subject: [PATCH 6/6] remove deprecated flags --- docs/reference/embedded-cluster-install.mdx | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/docs/reference/embedded-cluster-install.mdx b/docs/reference/embedded-cluster-install.mdx index 012bb08719..42163ddb6c 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/docs/reference/embedded-cluster-install.mdx @@ -87,8 +87,6 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]

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_

Ignoring host preflight checks is _not_ recommended for production installations.

-

The `--ignore-host-preflights` flag replaces the deprecated `--skip-host-preflights` flag.

-

**Requirement:** Embedded Cluster 1.21.0 and later

@@ -118,13 +116,6 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags] - - `--no-prompt` **(Deprecated)** - -

Prevents the command from showing user prompts.

-

The `--no-prompt` flag is deprecated and replaced with the `--yes` flag in Embedded Cluster 1.21.0 and later.

- - `--private-ca` @@ -132,18 +123,10 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]

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.

- - `--skip-host-preflights` **(Deprecated)** - -

When `--skip-host-preflights` is passed, the Embedded Cluster host preflight checks are not run.

-

The `--skip-host-preflights` flag is deprecated and replaced with `--ignore-host-preflights` in Embedded Cluster 1.21.0 and later.

- - `--yes`

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.

-

The `--yes` flag replaces the deprecated `--no-prompt` flag.

**Requirement:** Embedded Cluster 1.21.0 and later