Skip to content

Commit ac98c07

Browse files
committed
edits
1 parent 7045768 commit ac98c07

File tree

2 files changed

+45
-8
lines changed

2 files changed

+45
-8
lines changed

docs/enterprise/installing-embedded-automation.mdx

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,22 @@ To install with Embedded Cluster in an online environment:
3434
```bash
3535
sudo ./APP_SLUG install --license PATH_TO_LICENSE \
3636
--config-values PATH_TO_CONFIGVALUES \
37-
--admin-console-password ADMIN_CONSOLE_PASSWORD
37+
--admin-console-password ADMIN_CONSOLE_PASSWORD \
38+
[--ignore-app-preflights] \
39+
[--tls-cert CUSTOM_TLS_CERT] \
40+
[--tls-key CUSTOM_TLS_KEY]
3841
```
3942

40-
Replace:
41-
* `APP_SLUG` with the unique slug for the application.
42-
* `PATH_TO_LICENSE` with the path to the customer license.
43-
* `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console.
44-
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file.
43+
Where:
44+
* `APP_SLUG` is the unique slug for the application.
45+
* `PATH_TO_LICENSE` is the path to the customer license.
46+
* `ADMIN_CONSOLE_PASSWORD` is a password for accessing the Admin Console.
47+
* `PATH_TO_CONFIGVALUES` is the path to the ConfigValues file.
48+
* (Optional) `--ignore-app-preflights` is an optional flag that can be passed to ignore any warnings and failures in application-specific preflight checks.
49+
* (Optional) `CUSTOM_TLS_CERT` is the path to a custom TLS certificate for securing the Admin Console.
50+
* (Optional) `CUSTOM_TLS_KEY` is the TLS key for the custom certificate.
51+
52+
For more information about the `install` command options, see [install](/reference/embedded-cluster-install).
4553

4654
## Air Gap Installation
4755

@@ -55,7 +63,10 @@ To install with Embedded Cluster in an air-gapped environment:
5563
sudo ./APP_SLUG install --license PATH_TO_LICENSE \
5664
--config-values PATH_TO_CONFIGVALUES \
5765
--admin-console-password ADMIN_CONSOLE_PASSWORD \
58-
--airgap-bundle PATH_TO_AIRGAP_BUNDLE
66+
--airgap-bundle PATH_TO_AIRGAP_BUNDLE \
67+
[--ignore-app-preflights] \
68+
[--tls-cert CUSTOM_TLS_CERT] \
69+
[--tls-key CUSTOM_TLS_KEY]
5970
```
6071

6172
Replace:
@@ -64,3 +75,8 @@ To install with Embedded Cluster in an air-gapped environment:
6475
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file.
6576
* `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console.
6677
* `PATH_TO_AIRGAP_BUNDLE` with the path to the Embedded Cluster `.airgap` bundle for the release.
78+
* (Optional) `--ignore-app-preflights` is an optional flag that can be passed to ignore any warnings and failures in application-specific preflight checks.
79+
* (Optional) `CUSTOM_TLS_CERT` is the path to a custom TLS certificate for securing the Admin Console.
80+
* (Optional) `CUSTOM_TLS_KEY` is the TLS key for the custom certificate.
81+
82+
For more information about the `install` command options, see [install](/reference/embedded-cluster-install).

docs/reference/embedded-cluster-install.mdx

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,17 @@ sudo ./<app-slug> install --license <path-to-license> [flags]
8383
<ProxyLimitations/>
8484
</td>
8585
</tr>
86+
<tr>
87+
<td>`--ignore-app-preflights`</td>
88+
<td>
89+
<p>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.</p>
90+
<p>**Requirement:** Embedded Cluster 2.11.0 or later.</p>
91+
</td>
92+
</tr>
8693
<tr>
8794
<td>`--ignore-host-preflights`</td>
8895
<td>
89-
<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>
96+
<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>
9097
<p>Ignoring host preflight checks is _not_ recommended for production installations.</p>
9198
</td>
9299
</tr>
@@ -131,6 +138,20 @@ sudo ./<app-slug> install --license <path-to-license> [flags]
131138
<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>
132139
</td>
133140
</tr>
141+
<tr>
142+
<td>`--tls-cert`</td>
143+
<td>
144+
<p>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.</p>
145+
<p>**Requirement:** Embedded Cluster 2.11.0 or later.</p>
146+
</td>
147+
</tr>
148+
<tr>
149+
<td>`--tls-key`</td>
150+
<td>
151+
<p>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.</p>
152+
<p>**Requirement:** Embedded Cluster 2.11.0 or later.</p>
153+
</td>
154+
</tr>
134155
<tr>
135156
<td>`-y, --yes`</td>
136157
<td>

0 commit comments

Comments
 (0)