Run Commands

First-Time Setup

Pachyderm can be deployed in Kubernetes using a wide variety of container orchestrators, but to get you set up for the very first time, we recommend using Docker Desktop. This installation method is very fast and will provide you with everything you need to start the Beginner Tutorial.

Before You Start #

Operating System:

1. Install Docker Desktop #

  1. Install Docker Desktop for your machine.
  2. Navigate to Settings for Mac, Windows, or Linux.
    • Adjust your resources (~4 CPUs and ~12GB Memory)
    • Enable Kubernetes
    • On Windows, enable Docker Desktop integration in Ubuntu if Ubuntu is not your default Linux distro.
  3. Select Apply & Restart.

2. Install Pachctl CLI #

Operating System:

3. Install & Configure Helm #

  1. Install Helm:
Operating System:
  1. Add the Pachyderm repo to Helm:
helm repo add pachyderm  
helm repo update  
  1. Install PachD:

Open your browser and check http://localhost before installing. If any other tools are using the same port as Pachyderm, add the following argument to the below command: --set proxy.service.httpPort=8080


This may take several minutes to complete.

4. Verify Installation #

  1. In a new terminal, run the following command to check the status of your pods:
kubectl get pods
NAME                                           READY   STATUS      RESTARTS   AGE
pod/console-5b67678df6-s4d8c                   1/1     Running     0          2m8s
pod/etcd-0                                     1/1     Running     0          2m8s
pod/pachd-c5848b5c7-zwb8p                      1/1     Running     0          2m8s
pod/pg-bouncer-7b855cb797-jqqpx                1/1     Running     0          2m8s
pod/postgres-0                                 1/1     Running     0          2m8s
  1. Re-run this command after a few minutes if pachd is not ready.

5. Connect to Cluster #

pachctl connect http://localhost:80

If you set the httpPort to a new value, such as 8080, use that value in the command. pachctl connect http://localhost:8080

Optionally open your browser and navigate to the Console UI.


You can check your Pachyderm version and connection to pachd at any time with the following command:

pachctl version

pachctl             2.9.4  
pachd               2.9.4