This guide will walk you through the recommended path to get Pachyderm running locally on OSX or Linux.
If you hit any errors not covered in this guide, check our 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 a fantastic 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.
pachctl is a command-line utility used for interacting with a Pachyderm cluster.
# For OSX: $ brew tap pachyderm/tap && brew install email@example.com # For Linux (64 bit) or Window 10+ on WSL: $ curl -o /tmp/pachctl.deb -L https://github.com/pachyderm/pachyderm/releases/download/v1.6.8/pachctl_1.6.8_amd64.deb && sudo dpkg -i /tmp/pachctl.deb
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 pachd nodes to be running because it’s pulling containers from DockerHub. You can see the cluster status by using
kubectl get all:
$ kubectl get all NAME READY STATUS RESTARTS AGE po/etcd-2142892294-l25tj 1/1 Running 0 10m po/pachd-915907039-z0hl2 1/1 Running 0 10m NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE svc/etcd 10.0.0.25 <nodes> 2379:32379/TCP 10m svc/kubernetes 10.0.0.1 <none> 443/TCP 11m svc/pachd 10.0.0.60 <nodes> 650:30650/TCP,651:30651/TCP,652:30652/TCP 10m NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE deploy/etcd 1 1 1 1 10m deploy/pachd 1 1 1 1 10m NAME DESIRED CURRENT READY AGE rs/etcd-2142892294 1 1 1 10m rs/pachd-915907039 1 1 1 10m
Note: If you see a few restarts on the pachd nodes, that’s ok. That simply means that Kubernetes tried to bring up those containers before etcd was ready so it restarted them.
The last step is to set up port forwarding so commands you send can reach Pachyderm within the VM. We background this process since port forwarding blocks.
$ pachctl port-forward &
Once port forwarding is complete, pachctl should automatically be connected. Try
pachctl version to make sure everything is working.
$ pachctl version COMPONENT VERSION pachctl 1.6.0 pachd 1.6.0
We’re good to go!
If for any reason
port-forward doesn’t work, you can connect directly by setting
ADDRESS to the minikube IP with port 30650.
$ minikube ip 192.168.99.100 $ export ADDRESS=192.168.99.100:30650