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
#
MacOS
Windows
/ bin / bash - c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Copy
Manual Step Summary :
Open a PowerShell terminal.
Run each of the following:
dism.exe / online / enable - feature / featurename : Microsoft - Windows - Subsystem - Linux / all / norestart
dism.exe / online / enable - feature / featurename : VirtualMachinePlatform / all / norestart
Copy
Run each of the following:
wsl -- update
wsl -- set - default - version 2
wsl -- install - d Ubuntu
Copy
Restart your machine.
Start a WSL terminal and set up your first Ubuntu user.
Update Ubuntu.
sudo apt update
sudo apt upgrade - y
Copy
Install Homebrew in Ubuntu so you can complete the rest of this guide:
/ bin / bash - c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Copy
All installation steps after 1. Install Docker Desktop must be run through the WSL terminal (Ubuntu) and not in PowerShell.
You are now ready to continue to Step 1.
Kubernetes & Openshift Version Support
Kubernetes : Pachyderm supports the three most recent minor release versions of Kubernetes. If your Kubernetes version is not among these, it is End of Life (EOL) and unsupported. This ensures Pachyderm users access to the latest Kubernetes features and bug fixes.
Openshift : Pachyderm is compatible with OpenShift versions within the “Full Support” window.
1. Install Docker Desktop
#
Install Docker Desktop for your machine.
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.
Select Apply & Restart .
2. Install Pachctl CLI
#
MacOS
Debian & Ubuntu (Including WSL)
Other Linux
brew tap pachyderm / tap && brew install pachyderm / tap / pachctl @ 2.10
Copy
AMD
curl - o / tmp / pachctl.deb - L https :// github.com / pachyderm / pachyderm / releases / download / v2.10.7 / pachctl_2.10.7_amd64.deb && sudo dpkg - i / tmp / pachctl.deb
Copy
ARM
curl - o / tmp / pachctl.deb - L https :// github.com / pachyderm / pachyderm / releases / download / v2.10.7 / pachctl_2.10.7_arm64.deb && sudo dpkg - i / tmp / pachctl.deb
Copy
AMD
curl - L https :// github.com / pachyderm / pachyderm / releases / download / v2.10.7 / pachctl_2.10.7_linux_amd64.tar.gz | sudo tar - xzv -- strip - components = 1 - C / usr / local / bin
Copy
ARM
curl - L https :// github.com / pachyderm / pachyderm / releases / download / v2.10.7 / pachctl_2.10.7_linux_arm64.tar.gz | sudo tar - xzv -- strip - components = 1 - C / usr / local / bin
Copy
Install Helm :
MacOS
Debian & Ubuntu (Including WSL)
Other Linux
curl https :// raw.githubusercontent.com / helm / helm / main / scripts / get - helm -3 | bash
Copy
curl https :// raw.githubusercontent.com / helm / helm / main / scripts / get - helm -3 | bash
Copy
Add the Pachyderm repo to Helm:
helm repo add pachyderm https :// helm.pachyderm.com
helm repo update
Copy
Install PachD:
Tip
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
Community Edition
Enterprise
helm install pachyderm pachyderm / pachyderm \
-- set deployTarget = LOCAL \
-- set proxy.enabled = true \
-- set proxy.service.type = LoadBalancer \
-- set proxy.host = localhost
Copy
Are you using an Enterprise trial key? If so, you can set up Enterprise Pachyderm locally by storing your trial key in a license.txt
file and passing it into the following Helm command:
helm install pachyderm pachyderm / pachyderm \
-- set deployTarget = LOCAL \
-- set pachd.enterpriseLicenseKey = "$(cat license.txt)" \
-- set proxy.enabled = true \
-- set proxy.service.type = LoadBalancer \
-- set proxy.host = localhost \
-- set pachd.storage.backend =< YOUR_BACKEND > \
-- set pachd.storage.storageURL = "s3://my-bucket" or "gs://my-bucket" or "azure://my-container"
Copy
This unlocks Enterprise features but also requires user authentication to access Console. A mock user is created by default to get you started, with the username : admin
and password : password
.
This may take several minutes to complete.
4. Verify Installation
#
In a new terminal, run the following command to check the status of your 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
Copy
Re-run this command after a few minutes if pachd
is not ready.
5. Connect to Cluster
# pachctl connect http :// localhost : 80
Copy
Warning
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 .
Tip
You can check your Pachyderm version and connection to pachd
at any time with the following command:
COMPONENT VERSION
pachctl 2.10.7
pachd 2.10.7
Copy