Skip to content

Commit

Permalink
Merge pull request #2809 from replicatedhq/ec-new-install-flow
Browse files Browse the repository at this point in the history
Updating EC install experience in Admin Console
  • Loading branch information
paigecalvert authored Nov 12, 2024
2 parents dfb180c + fba1857 commit a98f01e
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 72 deletions.
56 changes: 25 additions & 31 deletions docs/enterprise/installing-embedded-air-gap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,56 +94,50 @@ To install with Embedded Cluster in an air gap environment:

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
54 changes: 24 additions & 30 deletions docs/enterprise/installing-embedded.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,48 +56,42 @@ To install an application with Embedded Cluster:

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. Bypass the browser TLS warning by clicking **Continue to Setup**.
1. Go to the URL provided in the output to access to the Admin Console.

1. Click **Advanced > Proceed**.
1. On the Admin Console landing page, click **Start**.

1. On the HTTPS page, upload your own private key and certificacte or select **Self-signed**.
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 **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 VM 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, next to the target version on the dashboard, click **Deploy** then **Yes, Deploy** to install the application.
:::
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.

Expand Down
2 changes: 1 addition & 1 deletion docs/partials/embedded-cluster/_ec-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
apiVersion: embeddedcluster.replicated.com/v1beta1
kind: Config
spec:
version: 1.16.0+k8s-1.30
version: 1.17.0+k8s-1.30
```
2 changes: 1 addition & 1 deletion docs/partials/getting-started/_gitea-ec-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
apiVersion: embeddedcluster.replicated.com/v1beta1
kind: Config
spec:
version: 1.16.0+k8s-1.30
version: 1.17.0+k8s-1.30
```
2 changes: 1 addition & 1 deletion docs/reference/embedded-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ For additional property-specific limitations, see the sections below.
apiVersion: embeddedcluster.replicated.com/v1beta1
kind: Config
spec:
version: 1.16.0+k8s-1.30
version: 1.17.0+k8s-1.30
roles:
controller:
name: management
Expand Down
18 changes: 10 additions & 8 deletions docs/vendor/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -242,19 +242,21 @@ Before you begin, ensure that you have access to a VM that meets the requirement

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 for the Gitea Admin Console** page, select **Self-signed** and click **Continue**.
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.

1. On the login page, enter the Admin Console password that you created during installation and click **Log In**.
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 **Nodes** page, you can view details about the VM where you installed, including its node role, status, CPU, and memory. Users can also optionally add additional nodes on this page before deploying the application. Click **Continue**.
1. On the login page, enter the Admin Console password that you created during installation and click **Log in**.

The Admin Console dashboard opens.

1. In the **Version** section, next to the new version, click **Deploy** and then **Yes, Deploy**.
1. On the **Configure the cluster** screen, you can view details about the VM where you installed, including its node role, status, CPU, and memory. Users can also optionally add additional nodes on this page before deploying the application. Click **Continue**.

The Admin Console dashboard opens.

1. On the Admin Console dashboard, next to the version, click **Deploy** and then **Yes, Deploy**.

The application status changes from Missing to Unavailable while the `gitea` Deployment is being created.

Expand Down

0 comments on commit a98f01e

Please sign in to comment.