Skip to main content

Perform updates in embedded clusters (Beta)

This topic describes how to upgrade, redeploy, or reconfigure an application installed with Replicated Embedded Cluster 3.x. For an introduction to Embedded Cluster, see Embedded Cluster overview.

Overview​

Each Embedded Cluster binary that you download targets a particular application version. Running install or upgrade with that binary installs or upgrades to that version. Upgrades can update both your application and cluster infrastructure (including Kubernetes and Embedded Cluster components), depending on what changed in the release.

You can upgrade interactively in the browser or headlessly from the command line. To change configuration or redeploy without moving to a newer application version, run upgrade using the binary for the version that is already installed.

Upgrade using the Embedded Cluster UI​

Use the Enterprise Portal for a guided upgrade​

To use the guided upgrade experience in the Enterprise Portal:

  1. Log in to the Replicated Enterprise Portal with a user for your test customer.

  2. Open the Update tab and follow the instructions to upgrade the instance.

Upgrade using the instructions in the Vendor Portal​

To upgrade more directly from the Vendor Portal:

  1. In the Vendor Portal, open the Customers page and select a customer that you assigned to the channel you use for testing.

  2. At the top of the customer page, click Install instructions and select Embedded Cluster. (The control may appear as Embedded Cluster install instructions.)

    note

    You can also open the Enterprise Portal to get install and upgrade instructions.

  3. In the Select a version section (or equivalent), choose the application version to upgrade to.

  4. On a Linux machine, run the first two commands from the dialog (download the archive, then extract it).

  5. For the third command, use upgrade instead of install, then run the command. For example:

    sudo ./APP_SLUG upgrade --license LICENSE_FILE

    Replace APP_SLUG with your application slug and LICENSE_FILE with the path to the license file. Add any other flags you use for this environment. For the full set of flags, see upgrade.

  6. When prompted, enter the password you set during installation to log in to the installer. To set a different password for the installer, use the --installer-password flag.

  7. On the Configure page, change any application configuration you need.

  8. On the Upgrade page, start the upgrade and wait for it to finish.

  9. On the Finish page, confirm completion. Use the provided links to open your application if needed.

Upgrade using the CLI (headless)​

To perform a headless upgrade from the CLI:

  1. In the Vendor Portal, open the Customers page and select the target customer.

  2. At the top of the customer page, click Install instructions and select Embedded Cluster. (The label might also appear as Embedded Cluster install instructions).

  3. In the Select a version section, choose the application version to upgrade to.

  4. On a Linux machine, run the first two commands from the dialog to download the archive and extract it.

  5. For the third command, do the following:

    • Use upgrade instead of install.
    • Pass --headless to run without the interactive installer UI.
    • (Optional) Pass --config-values with the path to your ConfigValues file to change configuration.
    • (Optional) Pass --installer-password to change the installer password.

    Example:

    sudo ./APP_SLUG upgrade --license LICENSE_FILE --headless

  6. Monitor the command output until the upgrade completes.

Reconfigure an application without upgrading the application version​

To redeploy or reconfigure an instance without upgrading, include the installation assets for the currently installed version when you perform the upgrade.

UI-based upgrade​

To change an application's configuration without upgrading the application version:

  • In the Embedded Cluster UI, change the target values on the Configure page. Then, follow the interactive upgrade process in the UI.

Headless upgrade​

To change an application's configuration without upgrading the application version:

  1. Update the ConfigValues to make the application configuration changes.
  2. Run the upgrade command using the binary for the application version that you already have installed. For example, if you installed version 1.2.3, download and run upgrade with the assets for version 1.2.3. Pass the updated configuration values with --config-values.

Upgrade in air-gapped environments​

To perform an upgrade with Embedded Cluster in air-gapped environments:

  1. In the Vendor Portal, open the Customers page and select the target customer.

  2. At the top of the customer page, click Install instructions and select Embedded Cluster. (The label might also appear as Embedded Cluster install instructions).

  3. In the Install instructions dialog, enable the air gap option.

  4. Download the installations assets to a machine with internet access and transfer them to the air-gapped host.

  5. Run upgrade with the same air gap flags you use for install (for example, --airgap-bundle). For more information, see Air gap installation with Embedded Cluster.

On this page