> ## Documentation Index
> Fetch the complete documentation index at: https://anaconda.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Upgrading Workbench on Gravity

export const Danger = ({children}) => {
  return <div class="callout my-4 px-5 py-4 overflow-hidden rounded-2xl flex gap-3 border danger-admonition dark:danger-admonition" data-callout-type="danger">
      <div class="mt-0.5 w-4">
        <svg width="14" height="14" viewBox="0 0 14 14" fill="rgb(239, 68, 68)" xmlns="http://www.w3.org/2000/svg" class="w-4 h-4 text-sky-500" aria-label="Danger">
          <path fill-rule="evenodd" clip-rule="evenodd" d="M7 1.3C10.14 1.3 12.7 3.86 12.7 7C12.7 10.14 10.14 12.7 7 12.7C5.48908 12.6974 4.0408 12.096 2.97241 11.0276C1.90403 9.9592 1.30264 8.51092 1.3 7C1.3 3.86 3.86 1.3 7 1.3ZM7 0C3.14 0 0 3.14 0 7C0 10.86 3.14 14 7 14C10.86 14 14 10.86 14 7C14 3.14 10.86 0 7 0ZM8 3H6V8H8V3ZM8 9H6V11H8V9Z"></path>
        </svg>
      </div>
      <div class="text-sm prose min-w-0 w-full">
        {children}
      </div>
    </div>;
};

[Contact the Anaconda implementation team](https://anaconda.zendesk.com/hc/en-us/requests/new) before you begin for assistance upgrading your version of Data Science & AI Workbench. Follow along with these instructions as an Anaconda implementation team member guides you through the upgrade process.

## Prerequisites

* You must have `jq` installed.
* You must have a service account with `sudo` access on your Kubernetes (K8s) master node.
* Your K8s master node must be configured with a DNS A record. The A record sets the domain name you use for your Workbench instance.
* If you are upgrading Workbench on a system with multiple nodes, you must verify the clock on each node is in sync with the others. Anaconda recommends using Network Time Protocol (NTP) to synchronize computer system clocks automatically over your network. For more information on installing and using `Chrony` to manage the NTP, see the instructions provided [here](https://www.tecmint.com/synchronize-time-with-ntp-in-linux/).
* You must have the `ae-preflight` package installed. For more information, see [Workbench pre-flight check](../pre-flight).
* Create a backup of your `anaconda-enterprise-anaconda-platform.yml` ConfigMap by running the following command:

```
kubectl get cm anaconda-enterprise-anaconda-platform.yml -o json | jq -r '.data["anaconda-platform.yml"]' > configmap-backup.yml
```

## Upgrading

After you have verified that your system meets all of the installation requirements, you’re ready to upgrade the cluster.

There are two basic types of upgrades for Gravity users: in-place upgrades and fresh reinstallation upgrades. Follow along with the instructions here as your Anaconda implementation team member guides you through upgrading your software.

<Warning>
  * Project sessions are terminated during the upgrade process! Because of this, it is important to stop all sessions prior to upgrading. If you do not, sessions that are terminated as part of the upgrade process must be restarted manually post upgrade.
  * Sessions can be stopped programmatically using `ae5-tools` by running the following command in a terminal that has access your Workbench cluster over the network:

  ```
  ae5 session list --columns=id --no-header | xargs -n1 ae5 session stop --yes
  ```
</Warning>

<Tabs>
  <Tab title="In-place upgrade">
    <Warning>
      In-place upgrades of Workbench are not supported for versions that are moving from Gravity 6 to Gravity 7. Instead, you must perform a fresh reinstallation to upgrade your software. If you do not, your installation will break. Check the version of Gravity and Workbench before you begin, and choose the upgrade process that best suits your needs.

      In-place upgrades are also not supported when upgrading from Workbench 5.6.x to 5.6.2. Please perform a fresh reinstallation to upgrade between these versions.
    </Warning>

    In-place upgrades are performed while the software is still running. To perform an in-place upgrade:

    1. [Create a backup](./backup-restore) of your current instance of Workbench.

    2. Log in to a service account with `sudo` access on the master node running your Workbench software.

    3. Download the installer file by running the following command:

       ```
       # Replace <INSTALLER_LOCATION> with the provided location of the installer file
       curl -O <INSTALLER_LOCATION>

       ```

    4. Decompress the installer file by running the following command:

       ```
       # Replace <INSTALLER> with the installer file you just downloaded
       tar xvzf <INSTALLER>

       ```

    5. Enter the installer directory by running the following command:

       ```
       # Replace <INSTALLER> with the version of your installer
       cd <INSTALLER>

       ```

    6. Run the following command to verify your environment is properly prepared:

       ```
       ae-preflight
       ```

       If the check returns an overall result of WARN, you can view the results of the check by running the following command:

       ```
       cat results.txt
       ```

       If necessary, make applicable corrections to properly prepare your environment to meet the [installation requirements](../../environment-prep/gravity-prep). Once you’ve verified that your environment is properly configured, you can begin the upgrade process.

    7. To start the upload and upgrade process, run the following commands:

       ```
       sudo ./upload
       sudo ./gravity upgrade
       ```

       The upgrade process can take up to an hour or more to complete, primarily due to the upload step. You can view the status of the upgrade process at any time by running the following command:

       ```
       sudo watch ./gravity plan
       ```

       Once the upgrade process is complete, the pods begin to initialize on their own, but this process takes some time to finish. Monitor the pods’ status by running the following command:

       ```
       sudo watch kubectl get pods
       ```

       If you encounter errors while doing your in-place upgrade, you can view which phase of the upgrade failed by running the following command:

       ```
       sudo ./gravity plan
       ```

       You can return to any phase of the upgrade process by running the rollback command against the name of the phase as it’s listed in the **Phase** column of the `./gravity plan` commands’ return:

       ```
       # Replace <NAME_OF_PHASE> with the name listed in the Phase column
       sudo ./gravity plan rollback --phase=/<NAME_OF_PHASE>
       ```

       After addressing any errors, resume the upgrade by running the following command:

       ```
       sudo ./gravity upgrade --resume --force
       ```

       Once you have resolved your errors, or if no errors have occurred, it’s time to [verify your installation](#verifying-your-upgrade).
  </Tab>

  <Tab title="Fresh reinstallation upgrade">
    A fresh reinstallation upgrade backs up your current Workbench software configurations and settings, then uninstalls and reinstalls the software. After installation is complete, you can apply your saved configurations and settings to the new software version.

    To perform a fresh reinstallation upgrade:

    * Back up your configuration
    * Uninstall
    * Reinstall and apply your saved settings

    **Back up your configurations**

    1. [Create a backup](./backup-restore) of your current instance of Workbench.

    2. Log in to a service account with `sudo` access on the master node running your Workbench software.

    3. Download the installer file by running the following command:

       ```
       # Replace <INSTALLER_LOCATION> with the provided location of the installer file
       curl -O <INSTALLER_LOCATION>
       ```

    4. Decompress the installer file by running the following command:

       ```
       # Replace <INSTALLER> with the installer file you just downloaded
       tar xvzf <INSTALLER>
       ```

    5. Enter the installer directory by running the following command:

       ```
       # Replace <INSTALLER> with the installer file you just decompressed
       cd <INSTALLER>
       ```

           <Note>
             The installer bundle contains the `extract_config.sh` script, which retains the following files when run:

             * `anaconda-enterprise-certs.yaml`
             * `anaconda-enterprise-keycloak.yaml`
             * `helm_values.yaml`
             * `gravity_values.yaml`
           </Note>

    6. Create a directory to contain the configuration data extracted by the script and name it “reinstall”:
       ```
       mkdir reinstall
       ```

    7. Enter the directory you just created:

       ```
       cd reinstall
       ```

    8. Run the `extract_config.sh` script by running the following command:

       ```
       sudo bash extract_config.sh
       ```

       Once the script has completed, you will need to manually save some additional configurations and secrets to your `reinstall` directory.

    9. Export your configmap to a `.yaml` file by running the following command:

       ```
       sudo kubectl get cm -o yaml --export > configmap.yaml
       ```

    **Uninstall**

    [Uninstall Workbench](./uninstall) on all nodes and reboot your instance.

    Warning

    Do not run the command `sudo rm -rf /opt/anaconda/storage` on the master node as part of your uninstall process. If you do you, will lose your configuration settings and user data.

    **Reinstall and apply your saved settings**

    1. Run the following command to verify your environment is properly prepared:

       ```
       ae-preflight
       ```

       If the check returns an overall result of WARN, you can view the results of the check by running the following command:

       ```
       cat results.txt
       ```

       If necessary, make applicable corrections to properly prepare your environment to meet the [installation requirements](../../environment-prep/gravity-prep). Once you’ve verified that your environment is properly configured, you can begin the upgrade process.

    2. Run the Gravity installation command using the `gravity_values.yaml` file stored in the reinstall directory you created earlier instead of creating a new file during installation:

       ```
       # Replace <ADVERTISE_ADDR> with the IP address you want to be visible to the other nodes. If you have a private network and all nodes can communicate on it, use the private IP address for the advertise address
       # Replace <CLUSTER_NAME> with the name you're giving to your cluster. Alphanumeric characters and periods only
       # Replace <VALUES_PATH> with the filepath to the gravity_values.yaml file created from running the extract_config.sh script
       sudo ./gravity install --advertise-addr=<ADVERTISE_ADDR> --cluster=<CLUSTER_NAME> --config <VALUES_PATH> --service-uid=$(id -u) --cloud-provider=generic
       ```

           <Accordion title="Example command for single-node cluster">
             ```
             sudo ./gravity install --advertise-addr=192.168.1.1 --cluster=MyCluster --config ./gravity_values.yaml --service-uid=$(id -u) --cloud-provider=generic
             ```
           </Accordion>

    3. [Complete the rest of the installation process](../gravity).

    4. Replace your SSL certificate by running the following commands:
       ```
       sudo kubectl create -f anaconda-enterprise-certs.json
       sudo kubectl replace -n kube-system -f cluster-tls.json

       ```

    5. Restore your cluster configurations from the backup you created before you began upgrading by running the following command:

       ```
       # Replace <CONFIG_BACKUP> with the ae5_config_db_YYYYMMDDHHMM.tar.gz file created when you ran the backup script
       sudo bash ae_restore.sh <CONFIG_BACKUP> --config-only
       ```

    6. Open a web browser and log in to Workbench as an Administrator.

    7. Open the **User** dropdown menu and select **Admin Console**.

           <Frame>
             <img src="https://mintcdn.com/anaconda-29683c67/IBO7780zo4xe9zAp/images/admin_console_navigation_2.png?fit=max&auto=format&n=IBO7780zo4xe9zAp&q=85&s=5f8fbeca5ce56e0c621a7c107f273241" alt="" width="1922" height="946" data-path="images/admin_console_navigation_2.png" />
           </Frame>

    8. Select **Manage Resources** to open your Gravity Ops Center.

    9. Log in to your Gravity Ops Center. Contact your Gravity systems administrator if you need access.

    10. Select **Kubernetes** from the left-hand navigation menu.

    11. Select **Edit config map** under `anaconda-enterprise-anaconda-platform.yml` to open the file. Leave this browser open for now.

            <Frame>
              <img src="https://mintcdn.com/anaconda-29683c67/opbTXGcYjx4zM8zO/images/gravity_ops_center_configmap_location.png?fit=max&auto=format&n=opbTXGcYjx4zM8zO&q=85&s=87fccd50d0fa10f31fd4976a956b0463" alt="" width="3436" height="1852" data-path="images/gravity_ops_center_configmap_location.png" />
            </Frame>

    12. Return to your terminal and view the contents of your `configmap.yaml` file by running the following command:

        ```
        cat configmap.yaml
        ```

    13. Review the contents of the `anaconda-enterprise-anaconda-platform.yml` file and verify that your configuration values have been properly restored. If necessary, replace the applicable sections of the `anaconda-enterprise-anaconda-platform.yml` file with the configurations saved in your `configmap.yaml` file.

    14. Restart the Anaconda platform pods by running the following command:

        ```
        sudo kubectl get pods | grep ap- | cut -d ' ' -f 1 | xargs kubectl delete pods
        ```

    15. [Add the worker nodes to the cluster](../../admin/resources/add-remove-node).

    Once the upgrade process is complete, it’s time to [verify your installation](#verifying-your-upgrade).
  </Tab>
</Tabs>

## Verifying your upgrade

1. Verify all pods are running by running the following command:

   ```
   sudo kubectl get pods
   ```
2. Open a web browser and navigate to your Authentication Center.

   ```
   # Replace <FQDN> with the fully qualified domain name of your Workbench server
   https://<FQDN>/auth/admin
   ```
3. Select **Users** from the **Manage** menu, then click **View all users** and verify your users’ data is present.
4. Open a web browser and navigate to your Workbench URL. Log in using the same credentials you used for your previous installation.
5. Review the **Projects** list to verify that all project data has been restored.
6. Verify your deployments have returned to a **started** state.

## Additional configurations

### TLS/SSL certificates

If you did not configure SSL certificates as part of the post-install configuration, do so now. For more information, see [Updating TLS/SSL certificates](../certs).

### External version control repository

Workbench uses configurable parameters in the `git:` section of the `anaconda-enterprise-anaconda-platform.yml` configmap to connect to external version control repositories. Verify your parameters are mapped correctly, [as described here](../../admin/advanced/config-repo).

### Spark/Hadoop

After verifying your installation, run the following command on the *master node* of the Workbench server:

```
# Replace <PATH_TO_SECRETS.yaml> with the path to your anaconda secrets .yaml file
sudo kubectl replace -f <PATH_TO_SECRETS.yaml>
```

To verify that your configuration upgraded correctly:

1. Log in to Workbench.
2. If your configuration uses Kerberos authentication, open a Hadoop terminal and authenticate yourself through Kerberos using the same credentials you used previously. For example, `kinit <USERNAME>`.
3. Open a Jupyter Notebook that uses Sparkmagic and verify that it behaves as expected by running the `sc` command to connect to Sparkmagic and start Spark.

## Cleaning up

As part of the upgrade process, the script you run automatically removes the unused packages and images from the previous installation and repopulates the registry to include only those images required by the current installation. This helps prevent the cluster from running out of disk space on the master node.