-
Notifications
You must be signed in to change notification settings - Fork 25
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.
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
Move EC to top level #2849
base: main
Are you sure you want to change the base?
Move EC to top level #2849
Changes from all commits
a273324
c853bcd
738262b
fd3ddb9
11673ad
c1d6735
d679872
8a1309c
d0975e2
8d6ea33
dc1563d
49d22e5
325a101
b4b770d
96af7c7
f898277
a930a70
2faac97
b49e2f0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx" | ||
import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx" | ||
|
||
# Installing with Embedded Cluster from the Command Line | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. EC gets its own install automation topic in its own section In a follow up PR, could also consider making sure that each of the command line install topics are discoverable from the CI/CD section of the docs where people might need the info |
||
|
||
This topic describes how to install an application with Replicated Embedded Cluster from the command line. | ||
|
||
## Overview | ||
|
||
You can use the command line to install an application with Replicated Embedded Cluster. A common use case for installing from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines. | ||
|
||
To install from the command line, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during headless installations from the command line rather than being displayed in the Admin Console. | ||
|
||
## Prerequisite | ||
|
||
Create a ConfigValues YAML file to define the configuration values for the application release. The ConfigValues file allows you to pass the configuration values for an application from the command line with the install command, rather than through the Admin Console UI. For air-gapped environments, ensure that the ConfigValues file can be accessed from the installation environment. | ||
|
||
The KOTS ConfigValues file includes the fields that are defined in the KOTS Config custom resource for an application release, along with the user-supplied and default values for each field, as shown in the example below: | ||
|
||
<ConfigValuesExample/> | ||
|
||
<ConfigValuesProcedure/> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ info about generating the configvalues file is added to a partial rather than being in its own topic. This solved the problem of trying to find a home for a topic that cut across three different installers |
||
|
||
## Online (Internet-Connected) Installation | ||
|
||
To install with Embedded Cluster in an online environment: | ||
|
||
1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster installation assets. For more information, see [Online Installation with Embedded Cluster](/enterprise/installing-embedded). | ||
|
||
1. Run the following command to install: | ||
|
||
```bash | ||
sudo ./APP_SLUG install --license-file PATH_TO_LICENSE \ | ||
--config-values PATH_TO_CONFIGVALUES \ | ||
--admin-console-password ADMIN_CONSOLE_PASSWORD | ||
``` | ||
|
||
Replace: | ||
* `APP_SLUG` with the unique slug for the application. | ||
* `LICENSE_FILE` with the customer license. | ||
* `ADMIN_CONSOLE_PASSWORD` with a password for accessing the Admin Console. | ||
* `PATH_TO_CONFIGVALUES` with the path to the ConfigValues file. | ||
|
||
## Air Gap Installation | ||
|
||
To install with Embedded Cluster in an air-gapped environment: | ||
|
||
1. Follow the steps provided in the Vendor Portal to download and untar the Embedded Cluster air gap installation assets. For more information, see [Air Gap Installation with Embedded Cluster](/enterprise/installing-embedded-air-gap). | ||
|
||
1. Ensure that the Embedded Cluster installation assets are available on the air-gapped machine, then run the following command to install: | ||
|
||
```bash | ||
sudo ./APP_SLUG install --license-file PATH_TO_LICENSE \ | ||
--config-values PATH_TO_CONFIGVALUES \ | ||
--admin-console-password ADMIN_CONSOLE_PASSWORD \ | ||
--airgap-bundle PATH_TO_AIRGAP_BUNDLE | ||
``` | ||
|
||
Replace: | ||
* `APP_SLUG` with the unique slug for the application. | ||
* `LICENSE_FILE` with the customer license. | ||
* `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. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
import EmbeddedClusterRequirements from "../partials/embedded-cluster/_requirements.mdx" | ||
import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx" | ||
import FirewallOpenings from "../partials/install/_firewall-openings.mdx" | ||
|
||
# Embedded Cluster Installation Requirements | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. New embedded cluster-specific installation requirements topic |
||
|
||
This topic lists the installation requirements for Replicated Embedded Cluster. Ensure that the installation environment meets these requirements before attempting to install. | ||
|
||
## System Requirements | ||
|
||
<EmbeddedClusterRequirements/> | ||
|
||
## Port Requirements | ||
|
||
<EmbeddedClusterPortRequirements/> | ||
|
||
## Firewall Openings for Online Installations | ||
|
||
<FirewallOpenings/> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ note that I decided to just put the firewall openings for online installs in a partial for now. It appears in each of the installer requirements topics |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed this info about the kURL reset command and moved that to its own topic (could also just removed info about the reset command from the docs all together and point people to the kurl site for that).
Now, this topic is just for existing cluster KOTS