This guide will walk you through the recommended path to get Pachyderm running locally on macOS or Linux.
If you hit any errors not covered in this guide, check our general troubleshooting docs for common errors, submit an issue on GitHub, join our users channel on Slack, or email us at firstname.lastname@example.org and we can help you right away.
Kubernetes offers an excellent guide to install minikube. Follow the Kubernetes installation guide to install Virtual Box, Minikube, and Kubectl. Then come back here to start Minikube:
Note: Any time you want to stop and restart Pachyderm, you should start fresh with
minikube delete and
minikube start. Minikube isn’t meant to be a production environment and doesn’t handle being restarted well without a full wipe.
First you need to make sure kubernetes is enabled in the docker desktop settings
And then confirm things are running
$ kubectl get all NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE service/kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 56d
To reset your kubernetes cluster on Docker For Desktop just click the reset button in the preferences section
pachctl is a command-line utility used for interacting with a Pachyderm cluster.
# For macOS: $ brew tap pachyderm/tap && brew install email@example.com # For Debian based linux (64 bit) or Window 10+ on WSL: $ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.8.6/pachctl_1.8.6_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/v1.8.6/pachctl_1.8.6_linux_amd64.tar.gz && tar -xvf /tmp/pachctl.tar.gz -C /tmp && sudo cp /tmp/pachctl_1.8.6_linux_amd64/pachctl /usr/local/bin
Note: To install an older version of Pachyderm, navigate to that version using the menu in the bottom left.
To check that installation was successful, you can try running
pachctl help, which should return a list of Pachyderm commands.
Now that you have Minikube running, it’s incredibly easy to deploy Pachyderm.
$ pachctl deploy local
This generates a Pachyderm manifest and deploys Pachyderm on Kubernetes. It may take a few minutes for the Pachyderm pods to be in a
Running state, because the containers have to be pulled from DockerHub. You can see the status of the Pachyderm pods using
kubectl get pods. When Pachyderm is ready for use, this should return something similar to:
$ kubectl get pods NAME READY STATUS RESTARTS AGE dash-6c9dc97d9c-vb972 2/2 Running 0 6m etcd-7dbb489f44-9v5jj 1/1 Running 0 6m pachd-6c878bbc4c-f2h2c 1/1 Running 0 6m
Note: If you see a few restarts on the
pachd nodes, that’s ok. That simply means that Kubernetes tried to bring up those pods before
etcd was ready so it restarted them.
pachctl version to make sure everything is working.
$ pachctl version COMPONENT VERSION pachctl 1.8.2 pachd 1.8.2
We’re good to go!
pachctl uses port forwarding by default. This is slower than if you connect directly by the minikube instance, like so:
# Find the IP address $ minikube ip 192.168.99.100 # Set the `PACHD_ADDRESS` environment variable $ export PACHD_ADDRESS=192.168.99.100:30650 # Run a command $ pachctl version
ADDRESS was renamed to
PACHD_ADDRESS in 1.8.3. If you are using an older version of Pachyderm, use the
ADDRESS environment variable instead.
Now that you have everything installed and working, check out our Beginner Tutorial to learn the basics of Pachyderm such as adding data and building pipelines for analysis.
The Pachyderm Enterprise dashboard is deployed by default with Pachyderm. We offer a FREE trial token to experiment with this interface to Pachyderm. To check it out, first enable port forwarding via
pachctl port-forward, then point your web browser to
localhost:30080. Alternatively, if you set the
PACHD_ADDRESS environment variable like in the previous section, you can circumvent port forwarding by just pointing your web browser to port 30080 on your minikube IP address.