Skip to content

Commit

Permalink
Merge branch 'main' into 95831
Browse files Browse the repository at this point in the history
  • Loading branch information
@paigecalvert
paigecalvert authored Nov 13, 2024
2 parents 9b9feef + b5f116e commit 382670f
Show file tree
Hide file tree
Showing 132 changed files with 9,402 additions and 3,784 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/replicated-sdk-release-notes.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ jobs:
uses: replicatedhq/release-notes-generator@main
with:
owner-repo: replicatedhq/replicated-sdk
base: v$PREV_REPLICATED_SDK_VERSION
head: v$REPLICATED_SDK_VERSION
base: $PREV_REPLICATED_SDK_VERSION
head: $REPLICATED_SDK_VERSION
title: $REPLICATED_SDK_VERSION
include-pr-links: false
github-token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
92 changes: 43 additions & 49 deletions docs/enterprise/installing-embedded-air-gap.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,104 +46,98 @@ To install with Embedded Cluster in an air gap environment:
* If the **Automatically create airgap builds for newly promoted releases in this channel** setting is enabled on the channel, watch for the build status to complete.
* If automatic air gap builds are not enabled, go to the **Release history** page for the channel and build the air gap bundle manually.

For more information, see [Downloading Air Gap Bundles](/vendor/releases-download-airgap-bundles#air-gap-bundle).

:::note
Errors in building either the application air gap bundle or the Embedded Cluster infrastructure will be shown if present.
:::

1. Go to **Customers** and click on the target customer. Click **Install instructions > Embedded Cluster**.
1. Go to **Customers** and click on the target customer.

1. On the **Manage customer** tab, under **License options**, enable the **Airgap Download Enabled** license field.

1. At the top of the page, click **Install instructions > Embedded Cluster**.

![Customer install instructions drop down button](/images/customer-install-instructions-dropdown.png)

[View a larger version of this image](/images/customer-install-instructions-dropdown.png)

1. In the **Embedded Cluster install instructions** dialog, verify that the **Install in an air gap environment** checkbox is enabled.

The **Embedded Cluster install instructions** dialog is displayed.
<img alt="Embedded cluster install instruction dialog" src="/images/embedded-cluster-install-dialog-airgap.png" width="500px"/>

<img alt="Embedded cluster install instruction dialog" src="/images/embedded-cluster-install-dialog.png" width="500px"/>
[View a larger version of this image](/images/embedded-cluster-install-dialog-airgap.png)

[View a larger version of this image](/images/embedded-cluster-install-dialog.png)

1. (Optional) In the **Embedded Cluster install instructions** dialog, under **Select a version**, select a specific application version to install. By default, the latest version is selected.
1. (Optional) For **Select a version**, select a specific application version to install. By default, the latest version is selected.

1. SSH onto the machine where you will install.

1. Modify the curl command provided in the first step in the **Embedded Cluster installation instructions** dialog by adding the `?airgap=true` query parameter to the end of the `replicated.app` endpoint:

```bash
curl -f https://replicated.app/embedded/APP_SLUG/CHANNEL_SLUG?airgap=true -H "Authorization: LICENSE_ID" -o APP_SLUG-CHANNEL_SLUG.tgz
```

1. On a machine with internet access, run the modified curl command to download the air gap installation assets as a `.tgz`.
1. On a machine with internet access, run the curl command to download the air gap installation assets as a `.tgz`.

1. Move the downloaded `.tgz` to the air gapped machine where you will install.
1. Move the downloaded `.tgz` to the air-gapped machine where you will install.

1. On your air gapped machine, untar the `.tgz` following the instructions provided in the **Embedded Cluster installation instructions** dialog. This will produce three files:
1. On your air-gapped machine, untar the `.tgz` following the instructions provided in the **Embedded Cluster installation instructions** dialog. This will produce three files:
* The installer
* The license
* The air gap bundle (`APP_SLUG.airgap`)

1. Install the application with the installation command copied from the **Embedded Cluster installation instructions** dialog, adding `--airgap-bundle` flag to pass the `.airgap` bundle that you downloaded to the installation:
1. Install the application with the installation command copied from the **Embedded Cluster installation instructions** dialog:

```bash
sudo ./APP_SLUG install --license license.yaml --airgap-bundle APP_SLUG.airgap
```
Where `APP_SLUG` is the unique application slug.

:::note
Embedded Cluster supports installation options such as installing behind a proxy and changing the data directory used by Embedded Cluster. For the list of flags supported with the Embedded Cluster `install` command, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
:::

1. When prompted, enter a password for accessing the KOTS Admin Console.

The installation command takes a few minutes to complete. During installation, Embedded Cluster completes tasks to prepare the cluster and install KOTS in the cluster. Embedded Cluster also automatically runs a default set of [_host preflight checks_](/vendor/embedded-overview#about-host-preflight-checks) which verify that the environment meets the requirements for the installer.

1. When the installation command completes, go to the URL provided in the output to access the Admin Console.

**Example output:**
**Example output:**

```bash
✔ Host files materialized
? Enter an Admin Console password: ********
? Confirm password: ********
✔ Host files materialized!
✔ Host preflights succeeded!
✔ Node installation finished!
✔ Storage is ready!
✔ Embedded Cluster Operator is ready!
✔ Admin Console is ready!
✔ Additional components are ready!
Visit the admin console to configure and install gitea-kite: http://104.155.145.60:30000
```
At this point, the cluster is provisioned and the KOTS Admin Console is deployed, but the application is not yet installed.
```bash
? Enter an Admin Console password: ********
? Confirm password: ********
✔ Host files materialized!
✔ Running host preflights
✔ Node installation finished!
✔ Storage is ready!
✔ Embedded Cluster Operator is ready!
✔ Admin Console is ready!
✔ Additional components are ready!
Visit the Admin Console to configure and install gitea-kite: http://104.155.145.60:30000
```

At this point, the cluster is provisioned and the Admin Console is deployed, but the application is not yet installed.

1. Go to the URL provided in the output to access to the Admin Console.

1. Bypass the browser TLS warning by clicking **Continue to Setup**.
1. On the Admin Console landing page, click **Start**.

1. Click **Advanced > Proceed**.
1. On the **Secure the Admin Console** screen, review the instructions and click **Continue**. In your browser, follow the instructions that were provided on the **Secure the Admin Console** screen to bypass the warning.

1. On the HTTPS page, upload your own private key and certificacte or select **Self-signed**.
1. On the **Certificate type** screen, either select **Self-signed** to continue using the self-signed Admin Console certificate or click **Upload your own** to upload your own private key and certificacte.

By default, a self-signed TLS certificate is used to secure communication between your browser and the Admin Console. You will see a warning in your browser every time you access the Admin Console unless you upload your own certificate.

1. On the login page, enter the Admin Console password that you created during installation and click **Log in**.

1. On the **Nodes** page, you can view details about the machine where you installed, including its node role, status, CPU, and memory. Optionally, add nodes before deploying the application. Click **Continue**.
1. On the **Configure the cluster** screen, optionally add nodes to the cluster before deploying the application. Click **Continue**.

1. On the config screen, complete the fields for the application configuration options and then click **Continue**.
1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**.

1. On the **Preflight checks** page, the application-specific preflight checks run automatically. Preflight checks are conformance tests that run against the target namespace and cluster to ensure that the environment meets the minimum requirements to support the application. Click **Deploy**.
1. On the **Validate the environment & deploy [App Name]** screen, address any warnings or failures identified by the preflight checks and then click **Deploy**.

:::note
Replicated recommends that you address any warnings or failures, rather than dismissing them. Preflight checks help ensure that your environment meets the requirements for application deployment.
:::

:::note
If the application does not include preflight checks, you need to click **Deploy** then **Yes, Deploy** next to the target version on the Admin Console dashboard to install.
:::
Preflight checks are conformance tests that run against the target namespace and cluster to ensure that the environment meets the minimum requirements to support the application.

The Admin Console dashboard opens.

On the Admin Console dashboard, the application status changes from Missing to Unavailable while the application is being installed. When the installation is complete, the status changes to Ready. For example:

![Admin console dashboard showing ready status](/images/gitea-ec-ready.png)

[View a larger version of this image](/images/gitea-ec-ready.png)
[View a larger version of this image](/images/gitea-ec-ready.png)

## Add Nodes to Air Gap Clusters

Expand Down
Loading

0 comments on commit 382670f

Please sign in to comment.