Skip to content

Commit 733a680

Browse files
authored
Merge pull request #3512 from replicatedhq/headless-install-flags
Doc --ignore-app-preflights, --tls-cert, --tls-key
2 parents e5673e3 + 4bc0511 commit 733a680

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
@@ -41,14 +41,22 @@ To install with Embedded Cluster in an online environment:
4141
```bash
4242
sudo ./APP_SLUG install --license PATH_TO_LICENSE \
4343
--config-values PATH_TO_CONFIGVALUES \
44-
--admin-console-password ADMIN_CONSOLE_PASSWORD
44+
--admin-console-password ADMIN_CONSOLE_PASSWORD \
45+
[--ignore-app-preflights] \
46+
[--tls-cert CUSTOM_TLS_CERT] \
47+
[--tls-key CUSTOM_TLS_KEY]
4548
```
4649

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

5361
## Air Gap Installation
5462

@@ -62,7 +70,10 @@ To install with Embedded Cluster in an air-gapped environment:
6270
sudo ./APP_SLUG install --license PATH_TO_LICENSE \
6371
--config-values PATH_TO_CONFIGVALUES \
6472
--admin-console-password ADMIN_CONSOLE_PASSWORD \
65-
--airgap-bundle PATH_TO_AIRGAP_BUNDLE
73+
--airgap-bundle PATH_TO_AIRGAP_BUNDLE \
74+
[--ignore-app-preflights] \
75+
[--tls-cert CUSTOM_TLS_CERT] \
76+
[--tls-key CUSTOM_TLS_KEY]
6677
```
6778

6879
Replace:
@@ -71,3 +82,8 @@ To install with Embedded Cluster in an air-gapped environment:
7182
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file.
7283
* `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console.
7384
* `PATH_TO_AIRGAP_BUNDLE` with the path to the Embedded Cluster `.airgap` bundle for the release.
85+
* (Optional) `--ignore-app-preflights` is an optional flag that can be passed to ignore any warnings and failures in application-specific preflight checks.
86+
* (Optional) `CUSTOM_TLS_CERT` is the path to a custom TLS certificate for securing the Admin Console.
87+
* (Optional) `CUSTOM_TLS_KEY` is the TLS key for the custom certificate.
88+
89+
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 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>
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`, 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>
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`, 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>
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)