From ac98c07439f822872a7f95184a33e00ccdb27390 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Fri, 5 Sep 2025 12:16:42 -0600 Subject: [PATCH 1/3] edits --- .../installing-embedded-automation.mdx | 30 ++++++++++++++----- docs/reference/embedded-cluster-install.mdx | 23 +++++++++++++- 2 files changed, 45 insertions(+), 8 deletions(-) diff --git a/docs/enterprise/installing-embedded-automation.mdx b/docs/enterprise/installing-embedded-automation.mdx index b08ffc1121..8db2c5a8ac 100644 --- a/docs/enterprise/installing-embedded-automation.mdx +++ b/docs/enterprise/installing-embedded-automation.mdx @@ -34,14 +34,22 @@ To install with Embedded Cluster in an online environment: ```bash sudo ./APP_SLUG install --license PATH_TO_LICENSE \ --config-values PATH_TO_CONFIGVALUES \ - --admin-console-password ADMIN_CONSOLE_PASSWORD + --admin-console-password ADMIN_CONSOLE_PASSWORD \ + [--ignore-app-preflights] \ + [--tls-cert CUSTOM_TLS_CERT] \ + [--tls-key CUSTOM_TLS_KEY] ``` - Replace: - * `APP_SLUG` with the unique slug for the application. - * `PATH_TO_LICENSE` with the path to the customer license. - * `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console. - * `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file. + Where: + * `APP_SLUG` is the unique slug for the application. + * `PATH_TO_LICENSE` is the path to the customer license. + * `ADMIN_CONSOLE_PASSWORD` is a password for accessing the Admin Console. + * `PATH_TO_CONFIGVALUES` is the path to the ConfigValues file. + * (Optional) `--ignore-app-preflights` is an optional flag that can be passed to ignore any warnings and failures in application-specific preflight checks. + * (Optional) `CUSTOM_TLS_CERT` is the path to a custom TLS certificate for securing the Admin Console. + * (Optional) `CUSTOM_TLS_KEY` is the TLS key for the custom certificate. + + For more information about the `install` command options, see [install](/reference/embedded-cluster-install). ## Air Gap Installation @@ -55,7 +63,10 @@ To install with Embedded Cluster in an air-gapped environment: sudo ./APP_SLUG install --license PATH_TO_LICENSE \ --config-values PATH_TO_CONFIGVALUES \ --admin-console-password ADMIN_CONSOLE_PASSWORD \ - --airgap-bundle PATH_TO_AIRGAP_BUNDLE + --airgap-bundle PATH_TO_AIRGAP_BUNDLE \ + [--ignore-app-preflights] \ + [--tls-cert CUSTOM_TLS_CERT] \ + [--tls-key CUSTOM_TLS_KEY] ``` Replace: @@ -64,3 +75,8 @@ To install with Embedded Cluster in an air-gapped environment: * `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file. * `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console. * `PATH_TO_AIRGAP_BUNDLE` with the path to the Embedded Cluster `.airgap` bundle for the release. + * (Optional) `--ignore-app-preflights` is an optional flag that can be passed to ignore any warnings and failures in application-specific preflight checks. + * (Optional) `CUSTOM_TLS_CERT` is the path to a custom TLS certificate for securing the Admin Console. + * (Optional) `CUSTOM_TLS_KEY` is the TLS key for the custom certificate. + + For more information about the `install` command options, see [install](/reference/embedded-cluster-install). diff --git a/docs/reference/embedded-cluster-install.mdx b/docs/reference/embedded-cluster-install.mdx index a641ad89a2..5270e8b041 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/docs/reference/embedded-cluster-install.mdx @@ -83,10 +83,17 @@ sudo ./ install --license [flags] + + `--ignore-app-preflights` + +

When `--ignore-app-preflights` is passed, the application-specific preflight checks are still run, but any failures or warnings are ignored and the installation proceeds. The `--ignore-app-preflights` flag is useful when performing automated (headless) installations from the command line.

+

**Requirement:** Embedded Cluster 2.11.0 or later.

+ + `--ignore-host-preflights` -

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_

+

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.

@@ -131,6 +138,20 @@ sudo ./ install --license [flags]

The path to trusted certificate authority (CA) certificates. In Embedded Cluster 2.4.0 and earlier, CAs provided with the `--private-ca` flag are written to a ConfigMap in the cluster that can then be accessed with the [PrivateCACert](/reference/template-functions-static-context#privatecacert) template function.

+ + `--tls-cert` + +

A custom TLS certificate for securing the Admin Console. When used with `--tls-key`, this is useful for performing automated (headless) installations where users need to provide a custom TLS certificate and key from the command line rather than through the Admin Console UI.

+

**Requirement:** Embedded Cluster 2.11.0 or later.

+ + + + `--tls-key` + +

A custom TLS key for securing the Admin Console. When used with `--tls-cert`, this is useful for performing automated (headless) installations where users need to provide a custom TLS certificate and key from the command line rather than through the Admin Console UI.

+

**Requirement:** Embedded Cluster 2.11.0 or later.

+ + `-y, --yes` From 5d27d9fe830c0a7662c2786baf783bfce208a00e Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Fri, 5 Sep 2025 12:18:49 -0600 Subject: [PATCH 2/3] edits --- docs/reference/embedded-cluster-install.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/embedded-cluster-install.mdx b/docs/reference/embedded-cluster-install.mdx index 5270e8b041..3eda154347 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/docs/reference/embedded-cluster-install.mdx @@ -141,14 +141,14 @@ sudo ./ install --license [flags] `--tls-cert` -

A custom TLS certificate for securing the Admin Console. When used with `--tls-key`, this is useful for performing automated (headless) installations where users need to provide a custom TLS certificate and key from the command line rather than through the Admin Console UI.

+

A custom TLS certificate for securing the Admin Console. When used with `--tls-key`, allows users performing automated (headless) installations to provide a custom TLS certificate and key from the command line rather than through the Admin Console UI.

**Requirement:** Embedded Cluster 2.11.0 or later.

`--tls-key` -

A custom TLS key for securing the Admin Console. When used with `--tls-cert`, this is useful for performing automated (headless) installations where users need to provide a custom TLS certificate and key from the command line rather than through the Admin Console UI.

+

A custom TLS key for securing the Admin Console. When used with `--tls-cert`, allows users performing automated (headless) installations to provide a custom TLS certificate and key from the command line rather than through the Admin Console UI.

**Requirement:** Embedded Cluster 2.11.0 or later.

From 4bc0511cbe2a3f66141a717a5a01f040cb00fba1 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Mon, 8 Sep 2025 10:22:23 -0600 Subject: [PATCH 3/3] edit description --- docs/reference/embedded-cluster-install.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/embedded-cluster-install.mdx b/docs/reference/embedded-cluster-install.mdx index 3eda154347..cc01a9ed3c 100644 --- a/docs/reference/embedded-cluster-install.mdx +++ b/docs/reference/embedded-cluster-install.mdx @@ -86,7 +86,7 @@ sudo ./ install --license [flags] `--ignore-app-preflights` -

When `--ignore-app-preflights` is passed, the application-specific preflight checks are still run, but any failures or warnings are ignored and the installation proceeds. The `--ignore-app-preflights` flag is useful when performing automated (headless) installations from the command line.

+

When `--ignore-app-preflights` is passed, the application-specific preflight checks are skipped. This is useful when performing automated (headless) installations because it ensures that any warnings or failures from application preflight checks do not prevent the installation from proceeding.

**Requirement:** Embedded Cluster 2.11.0 or later.