Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
31 changes: 31 additions & 0 deletions docs/reference/embedded-cluster-install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,15 @@ 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 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_</p>
<p>Ignoring host preflight checks is _not_ recommended for production installations.</p>
<p>The `--ignore-host-preflights` flag replaces the deprecated `--skip-host-preflights` flag.</p>
<p>**Requirement:** Embedded Cluster 1.21.0 and later</p>
</td>
</tr>
<tr>
<td>`--local-artifact-mirror-port`</td>
<td>
Expand Down Expand Up @@ -109,13 +118,35 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
<ProxyLimitations/>
</td>
</tr>
<tr>
<td>`--no-prompt` **(Deprecated)**</td>
<td>
<p>Prevents the command from showing user prompts.</p>
<p>The `--no-prompt` flag is deprecated and replaced with the `--yes` flag in Embedded Cluster 1.21.0 and later.</p>
</td>
</tr>
<tr>
<td>`--private-ca`</td>
<td>
<p>The path to trusted certificate authority (CA) certificates. Using the `--private-ca` flag ensures that the CA is trusted by the installation. KOTS writes the CA certificates provided with the `--private-ca` flag to a ConfigMap in the cluster.</p>
<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>`--skip-host-preflights` **(Deprecated)**</td>
<td>
<p>When `--skip-host-preflights` is passed, the Embedded Cluster host preflight checks are not run.</p>
<p>The `--skip-host-preflights` flag is deprecated and replaced with `--ignore-host-preflights` in Embedded Cluster 1.21.0 and later.</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>The `--yes` flag replaces the deprecated `--no-prompt` flag.</p>
<p>**Requirement:** Embedded Cluster 1.21.0 and later</p>
</td>
</tr>
</table>

## Examples
Expand Down
31 changes: 23 additions & 8 deletions docs/vendor/embedded-using.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.

```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.
Expand Down