Learn how to upgrade Pachyderm's pachctl and pachd.
March 22, 2023
Upgrading to a minor release (e.g.,
2.3.5 > 2.3.6) is simple and requires little downtime. As a good practice, we recommend that you check the release notes before an upgrade to get an understanding of the changes introduced between your current version and your target.
Do not use these steps to upgrade between major versions as it might result in data corruption.
Complete the following steps to upgrade Pachyderm from one minor release to another.
1. Backup Your Cluster #
As a general good practice, start with the backup of your cluster as described in the Backup and Restore section of this documentation.
2. Update Your Helm Values #
This phase depends on whether you need to modify your existing configuration (for example, enter an enterprise key, plug an identity provider, reference an enterprise server, etc…).
In the case of a simple upgrade of version on a cluster, and provided that you do not need to change any additional configuration, no change in the values.yaml should be required. The new version of Pachyderm will be directly set in the
helm upgrade command.
pachctl Version #
Upgrading from a pachd version older than 2.3.0? Do not skip this step.
To update to the latest version of Pachyderm, run the steps below depending on your operating system:
- For macOS, run:
brew tap pachyderm/tap && brew install email@example.com
- For a Debian-based Linux 64-bit or Windows 10 or later running on
curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v2.3.9/pachctl_2.3.9_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
- For all other Linux flavors:
curl -o /tmp/pachctl.tar.gz -L https://github.com/pachyderm/pachyderm/releases/download/v2.3.9/pachctl_2.3.9_linux_amd64.tar.gz && tar -xvf /tmp/pachctl.tar.gz -C /tmp && sudo cp /tmp/pachctl_2.3.9_linux_amd64/pachctl /usr/local/bin
For a specific target release, specify the targeted major/minor version of
pachctl for brew and major/minor/patch release for curl in the commands above.
Verify that the installation was successful by running
pachctl version --client-only:
pachctl version --client-only
COMPONENT VERSION pachctl <This should display the version you installed>
4. Helm Upgrade #
Redeploy Pachyderm by running the helm upgrade command with your updated values.yaml:
helm repo add pach https://helm.pachyderm.com helm repo update helm upgrade pachd -f my_pachyderm_values.yaml pach/pachyderm --version <your_chart_version>
Each chart version is associated with a given version of Pachyderm. You will find the list of all available chart versions and their associated version of Pachyderm on Artifacthub.
The upgrade can take some time. You can run
kubectl get podsperiodically in a separate tab to check the status of the deployment. When Pachyderm is deployed, the command shows all pods as
kubectl get pods
Once the pods are up, you should see a pod for
pachdrunning (alongside etcd, pg-bouncer, postgres, console etc… depending on your installation).
NAME READY STATUS RESTARTS AGE pachd-3677268306-9sqm0 1/1 Running 0 4m ...
Verify that the new version has been deployed:
COMPONENT VERSION pachctl 2.3.9 pachd 2.3.9
pachctlversions must both match the new version.