|
1 | 1 | # Updating the Admin Console on an Existing Cluster |
2 | 2 |
|
3 | | -This document refers to upgrading the Replicated admin console on an existing cluster. |
4 | | -For information about how to upgrade the admin console on a Kubernetes installer-created cluster (embedded cluster), see [Updating the admin console on a Kubernetes installer-created cluster](updating-embedded-cluster). |
| 3 | +This topic explains how to update the Replicated admin console on an existing cluster. |
| 4 | +For information about how to update the admin console on a Kubernetes installer-created cluster (embedded cluster), see [Updating the admin console on a Kubernetes installer-created cluster](updating-embedded-cluster). |
5 | 5 |
|
6 | | -**Prerequisites** |
| 6 | +Updating the admin console requires updating the kots CLI first. You have the option to update to the latest version of the kots CLI or to a specific version. |
7 | 7 |
|
8 | | -As a prerequisite for any admin console upgrade, start by upgrading your kots CLI to the desired version. |
9 | | -* For online installations, follow the instructions after running `kubectl kots version` to download the latest binary. |
10 | | -* For air gapped installations or to use a previous Replicated app manager version, download the the latest app manager binary from [Github](https://github.com/replicatedhq/kots/releases) or the customer download page in the Replicated [vendor portal](https://vendor.replicated.com). |
| 8 | +Downgrading the admin console to a version earlier than what is currently deployed is not supported. |
11 | 9 |
|
12 | | -### Online Installations |
| 10 | +### Update an Online Installation |
13 | 11 |
|
14 | | -A `kots` command has been provided to update the admin console on an existing cluster. |
| 12 | +For online installations, the admin console is updated to the same version as the version of the kots CLI that you use to perform the update. For example, if you use v1.56.0 of the kots CLI to update the admin console, then the admin console is updated to v1.56.0. |
15 | 13 |
|
16 | | -```bash |
17 | | -kubectl kots admin-console upgrade -n <namespace> |
18 | | -``` |
| 14 | +To update an online installation of the admin console: |
19 | 15 |
|
20 | | -Additional usage information can be found by running the `kubectl kots admin-console upgrade -h` command. |
| 16 | +1. (Optional) Run the `kubectl kots version` command to see the current version of the kots CLI. |
21 | 17 |
|
22 | | -### Air Gap Installations |
| 18 | +1. Do _one_ of the following actions to update your kots CLI version: |
23 | 19 |
|
24 | | -Similar to the initial installation into an existing cluster, images must be pushed to a private registry first: |
| 20 | + - For the latest version, run `curl https://kots.io/install | bash`. |
25 | 21 |
|
26 | | -```shell |
27 | | -kubectl kots admin-console push-images ./kotsadm.tar.gz private.registry.host/application-name \ |
28 | | - --registry-username rw-username \ |
29 | | - --registry-password rw-password |
30 | | -``` |
| 22 | + - For a particular version, run `curl https://kots.io/install/<version> | bash`. |
31 | 23 |
|
32 | | -After images have been pushed, the upgrade command can be executed with registry read-only credentials: |
| 24 | +1. Run the following command to update the admin console on an existing cluster: |
33 | 25 |
|
34 | | -```bash |
35 | | -kubectl kots admin-console upgrade \ |
36 | | - --kotsadm-registry private.registry.host/application-name \ |
37 | | - --registry-username ro-username \ |
38 | | - --registry-password ro-password \ |
39 | | - -n <namespace> |
40 | | -``` |
| 26 | + ```bash |
| 27 | + kubectl kots admin-console upgrade -n <namespace> |
| 28 | + ``` |
| 29 | + |
| 30 | + :::note |
| 31 | + For help information, run `kubectl kots admin-console upgrade -h`. |
| 32 | + ::: |
| 33 | + |
| 34 | +### Update an Air Gap Installation |
| 35 | + |
| 36 | +For air gap installations, the version of the kots CLI that is used to perform the update must match the version of the Replicated app manager air gap bundle used for the update. |
| 37 | + |
| 38 | +To update an air gap installation of the admin console: |
| 39 | + |
| 40 | +1. Download your desired version of the app manager air gap bundle from [Github](https://github.com/replicatedhq/kots/releases) or from the customer download page provided by your vendor. The air gap bundle is named `kotsadm.tar.gz`. |
| 41 | + |
| 42 | +1. Do _one_ of the following actions to update your kots CLI version: |
| 43 | + |
| 44 | + - For the latest version, run `curl https://kots.io/install | bash`. |
| 45 | + |
| 46 | + - For a particular version, run `curl https://kots.io/install/<version> | bash`. |
| 47 | + |
| 48 | + :::important |
| 49 | + The kots CLI version must match the air gap bundle version. |
| 50 | + ::: |
| 51 | + |
| 52 | +1. Push images to a private registry: |
| 53 | + |
| 54 | + ```shell |
| 55 | + kubectl kots admin-console push-images ./kotsadm.tar.gz private.registry.host/application-name \ |
| 56 | + --registry-username rw-username \ |
| 57 | + --registry-password rw-password |
| 58 | + ``` |
| 59 | + |
| 60 | +1. Run the following command using registry read-only credentials to update the admin console: |
| 61 | + |
| 62 | + ```bash |
| 63 | + kubectl kots admin-console upgrade \ |
| 64 | + --kotsadm-registry private.registry.host/application-name \ |
| 65 | + --registry-username ro-username \ |
| 66 | + --registry-password ro-password \ |
| 67 | + -n <namespace> |
| 68 | + ``` |
0 commit comments