Skip to content

Doc --ignore-app-preflights, --tls-cert, --tls-key #3512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 10, 2025
Merged

Doc --ignore-app-preflights, --tls-cert, --tls-key #3512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac98c07
edits
paigecalvert Sep 5, 2025
5d27d9f
edits
paigecalvert Sep 5, 2025
4bc0511
edit description
paigecalvert Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions docs/enterprise/installing-embedded-automation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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:
Expand All @@ -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).
23 changes: 22 additions & 1 deletion docs/reference/embedded-cluster-install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,17 @@ sudo ./<app-slug> install --license <path-to-license> [flags]
<ProxyLimitations/>
</td>
</tr>
<tr>
<td>`--ignore-app-preflights`</td>
<td>
<p>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.</p>
Copy link
Contributor Author

@paigecalvert paigecalvert Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ajp-io corrected this description to say that preflights are actually skipped

Copy link
Member

@ajp-io ajp-io Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool, i'm good if this was the only change i needed to review

<p>**Requirement:** Embedded Cluster 2.11.0 or later.</p>
</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>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>
Expand Down Expand Up @@ -131,6 +138,20 @@ sudo ./<app-slug> install --license <path-to-license> [flags]
<p>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.</p>
</td>
</tr>
<tr>
<td>`--tls-cert`</td>
<td>
<p>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.</p>
<p>**Requirement:** Embedded Cluster 2.11.0 or later.</p>
</td>
</tr>
<tr>
<td>`--tls-key`</td>
<td>
<p>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.</p>
<p>**Requirement:** Embedded Cluster 2.11.0 or later.</p>
</td>
</tr>
<tr>
<td>`-y, --yes`</td>
<td>
Expand Down