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.

For production deployments, we recommend following these guides:

• On-Prem Deployment
• AWS Deployment
• GCP Deployment
• Azure Deployment

Before You Start #

Hardened Security and Dependency Considerations

If you are deploying in a hardened security environment, such as within the DoD community or other regulated sectors, consider downloading and installing Pachyderm from Iron Bank, a hardened container registry.

MLDM images may be pulled from Iron Bank by updating the global registry setting in the MLDM Helm chart values.yaml to use registry1.dso.mil/, e.g.

global:
  ...
  image:
    registry: registry1.dso.mil/

Copy

Additionally, note that the MLDM Helm chart relies on the Bitnami image and its associated sub-chart. If the Bitnami image is unavailable or if your available PostgreSQL image cannot be managed through the Bitnami sub-chart, you will need to install PostgreSQL separately. Refer to Global Helm Chart Values for details on specifying your separate PostgreSQL instance. Also, refer to Non-Bundled Database Setup for more detail on using your own PostgreSQL instance with MLDM.

If you have questions, please reach out to your Customer Support Engineer for assistance before proceeding.

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 #

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 #

3. Install & Configure Helm #

1. Install Helm:

2. Add the Pachyderm repo to Helm:

   helm repo add pachyderm https://helm.pachyderm.com  
   helm repo update  

   Copy

3. 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

   The arguments passed to the helm install command will vary depending how you wish to configure your installation.

   If you are not deploying locally (--set deployTarget=LOCAL), then you must specify a backend (--set pachd.storage.backend=<YOUR_BACKEND>) and storage url (--set pachd.storage.storageURL="s3://my-bucket").

   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

   Copy

   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
2. Re-run this command after a few minutes if pachd is not ready.

5. Connect to Cluster #

pachctl connect http://localhost:80

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:

pachctl version

Copy

COMPONENT           VERSION  

pachctl             2.11.4  
pachd               2.11.4  

Copy