Update info on ignoring prefight checks for Embedded Cluster installs#3843
Update info on ignoring prefight checks for Embedded Cluster installs#3843paigecalvert merged 1 commit intomainfrom
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
paigecalvert
changed the title
| --admin-console-password ADMIN_CONSOLE_PASSWORD \ | ||
| [--ignore-app-preflights] \ | ||
| [--tls-cert CUSTOM_TLS_CERT] \ | ||
| [--tls-key CUSTOM_TLS_KEY] |
There was a problem hiding this comment.
^ it seemed weird to show just these options when there are several. also, this only mentioned ignoring app preflights for some reason. instead, just removed these and added a link to the install command reference for the full list of options
| For more information about the `install` command options, see [install](/reference/embedded-cluster-install). | ||
| For the complete list of `install` options, see [install](/reference/embedded-cluster-install). | ||
|
|
||
| ## (Optional) Ignore Preflight Checks During Installation |
There was a problem hiding this comment.
moved this info to the automated install page. seemed like that was where it was most relevant. from the other install pages, you can still find info about ignoring preflights by following the link to the install command reference with all the options
| * To ignore preflight checks: | ||
|
|
||
| ```bash | ||
| sudo ./APP_SLUG install --license license.yaml --ignore-host-preflights --ignore-app-preflights --yes |
There was a problem hiding this comment.
updated the example so it's showing both the ignore app and host preflight options
| <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-overview#about-host-preflight-checks) in _Using Embedded Cluster_.</p> |
There was a problem hiding this comment.
If there are no failed preflights, no user prompt is displayed.
seemed obvious enough to remove in favor of having fewer words
|
|
||
| * If you do not provide any query parameters, this endpoint downloads the Embedded Cluster binary for the latest release on the specified channel. You can provide the `channelSequence` query parameter to download the binary for a particular release. | ||
|
|
||
| ## Ignore Host Preflight Checks During Installation |
There was a problem hiding this comment.
removed from it's current home in the "Use Embedded Cluster" page
3 participants
https://deploy-preview-3843--replicated-docs.netlify.app/enterprise/installing-embedded-automation#optional-ignore-preflight-checks-during-installation