Beginner Tutorial

First-Time Setup

Connect to Existing Instance

Language Clients

Target Audience

Intro to Data Versioning

Intro to Pipelines

Developer Workflow

CI/CD Integration

Create a Machine Learning Workflow

The Push Images Flag

Working with Pipelines

High-Level Architecture Diagram

Azure Deployment

Set Up AWS Secret Manager

👉 Pachctl Auto-completion

Unified Deployment

Authentication & IdP Connectors

Authorization (RBAC)

Access Control (RBAC) Roles & Permissions

Manage RBAC via Console

Add Roles to User via PachCTL

Add Roles to Group via PachCTL

Environment Variables

Kubernetes RBAC

Import a Kubernetes Context

Log Aggregation (Loki)

Non-Default Namespaces

Enterprise Edition

Activate Enterprise via Helm

Activate Enterprise via PachCTL

Features Overview

Enterprise Server (ES)

Activate ES for Multi-Cluster

Activate ES for Single-Cluster

Register a Cluster via Helm

Register a Cluster via PachCTL

Server Management

TLS (SSL, HTTPS)

Tracing (Jaeger)

Blob/Object Storage

Defer Processing via Staging Branch

Skip Failed Datums

Time-Windowed Data

Build Pipelines & DAGs

Create a Pipeline

Delete a Pipeline

Draw a Pipeline

Inspect a Pipeline

Jsonnet Pipeline Specifications

Update a Pipeline

View Pipeline Jobs & Runtimes

Create a Project

Set a Project as Current

Add a Project Resource

Grant Project Access

Delete a Project

Process Specific Commits

Set Branch Triggers

Set Output Branch

List Global Commits & Jobs

List Global ID Sub Commits

Track Downstream

Delete Branch Head

Squash Non-Head Commits

Delete File From History

Standard ML Pipeline

AutoML Pipeline

Multi-Pipeline DAG

Data Parallelism Pipeline

Task Parallelism Pipeline

Docker Image + User Code

Egress To An SQL Database

Export via Egress

Export via PachCTL

Mount a Repo Locally

S3 Gateway Operations

Create S3 Bucket

Delete an S3 Object

Delete Empty S3 Bucket

Get an S3 Object

List S3 Buckets

List S3 Objects

Write an S3 Object

Google BigQuery

Docker Installation Guide

Run in Determined

Local Installation Guide

Troubleshooting

VS Code Auto-Completion

Weights and Biases

pachctl auth activate

pachctl auth check

pachctl auth check project

pachctl auth check repo

pachctl auth deactivate

pachctl auth get

pachctl auth get cluster

pachctl auth get enterprise

pachctl auth get project

pachctl auth get repo

pachctl auth get-config

pachctl auth get-groups

pachctl auth get-robot-token

pachctl auth login

pachctl auth logout

pachctl auth revoke

pachctl auth roles-for-permission

pachctl auth rotate-root-token

pachctl auth set

pachctl auth set cluster

pachctl auth set enterprise

pachctl auth set project

pachctl auth set repo

pachctl auth set-config

pachctl auth use-auth-token

pachctl auth whoami

pachctl buildinfo

pachctl check status

pachctl completion

pachctl completion bash

pachctl completion zsh

pachctl config delete

pachctl config delete context

pachctl config get

pachctl config get active-context

pachctl config get active-enterprise-context

pachctl config get context

pachctl config get metrics

pachctl config import-kube

pachctl config list

pachctl config list context

pachctl config set

pachctl config set active-context

pachctl config set active-enterprise-context

pachctl config set context

pachctl config set metrics

pachctl config update

pachctl config update context

pachctl connect

pachctl copy file

pachctl create branch

pachctl create defaults

pachctl create pipeline

pachctl create project

pachctl create repo

pachctl create secret

pachctl debug analyze

pachctl debug binary

pachctl debug dump

pachctl debug local

pachctl debug log-level

pachctl debug profile

pachctl debug template

pachctl delete all

pachctl delete branch

pachctl delete commit

pachctl delete commitV2

pachctl delete defaults

pachctl delete file

pachctl delete job

pachctl delete pipeline

pachctl delete project

pachctl delete repo

pachctl delete secret

pachctl delete transaction

pachctl diff file

pachctl draw pipeline

pachctl edit pipeline

pachctl enterprise

pachctl enterprise deactivate

pachctl enterprise get-state

pachctl enterprise heartbeat

pachctl enterprise pause

pachctl enterprise pause-status

pachctl enterprise register

pachctl enterprise sync-contexts

pachctl enterprise unpause

pachctl find commit

pachctl finish commit

pachctl finish transaction

pachctl get file

pachctl glob file

pachctl idp create-client

pachctl idp create-connector

pachctl idp delete-client

pachctl idp delete-connector

pachctl idp get-client

pachctl idp get-config

pachctl idp get-connector

pachctl idp list-client

pachctl idp list-connector

pachctl idp set-config

pachctl idp update-client

pachctl idp update-connector

pachctl inspect

pachctl inspect branch

pachctl inspect cluster

pachctl inspect commit

pachctl inspect datum

pachctl inspect defaults

pachctl inspect file

pachctl inspect job

pachctl inspect pipeline

pachctl inspect project

pachctl inspect repo

pachctl inspect secret

pachctl inspect transaction

pachctl kube-events

pachctl license

pachctl license activate

pachctl license add-cluster

pachctl license delete-all

pachctl license delete-cluster

pachctl license get-state

pachctl license list-clusters

pachctl license update-cluster

pachctl list branch

pachctl list commit

pachctl list datum

pachctl list file

pachctl list job

pachctl list pipeline

pachctl list project

pachctl list repo

pachctl list secret

pachctl list transaction

pachctl port-forward

pachctl put file

pachctl rerun pipeline

pachctl restart

pachctl restart datum

pachctl resume transaction

pachctl run cron

pachctl run pfs-load-test

pachctl run pps-load-test

pachctl squash commit

pachctl squash commitV2

pachctl start commit

pachctl start pipeline

pachctl start transaction

pachctl stop job

pachctl stop pipeline

pachctl stop transaction

pachctl subscribe

pachctl subscribe commit

pachctl unmount

pachctl update defaults

pachctl update pipeline

pachctl update project

pachctl update repo

pachctl validate

pachctl validate pipeline

pachctl version

pachctl wait commit

pachctl wait job

Debug Pipelines

Troubleshooting Deployments

View Audit Logs

View Kubernetes Logs

Client Initialization (Start Here)

Breast Cancer Detection

Distributed Image Processing

Spout Pipelines

Coding Conventions

Contributor Setup

Developing on Windows with VSCode

Documentation Style Guide

GitHub

Pachctl Auto-completion

Learn how to install our auto-completion helper tool (it's great for learning PachCTL commands).

Pachyderm auto-completion allows you to automatically finish partially typed commands by pressing TAB.

Before You Start #

You must already have PachCTL installed

How to Install Auto-Completion #

Command Shell:

Verify that bash-completion is installed on your machine. For example, if you have installed bash completion by using Homebrew, type:
```
brew info bash-completion
```
This command returns information about the directory in which bash-completion and bash completion scripts are installed. For example, /usr/local/etc/bash_completion.d/. You need to specify the path to bash_completion.d as the path to which install pachctl autocompletion. Also, the output of the info command might have a suggestion to include the path to bash-completion into your ~/.bash_profile file.
Install pachctl autocompletion:


pachctl completion bash --install --path <path/to/bash-completion>

For example, if you specify the path to bash-completion as /usr/local/etc/bash_completion.d/pachctl, your system response looks like this:

System response:

Bash completions installed in /usr/local/etc/bash_completion.d/pachctl, you must restart bash to enable completions.

Restart your terminal.
pachctl autocomplete should now be enabled in your system.

Install zsh-completions:
```
brew install zsh-completions
```
Install pachctl autocompletion:

💡

You’ll need to install this in the same directory your zsh-completions are installed in. You can run the following to find the correct path:

echo $fpath

pachctl completion bash --install --path /opt/homebrew/share/zsh-completions/_pachctl

Restart your terminal; pachctl autocomplete should now be enabled in your system.
If you run into warnings in your terminal related to zsh compinit: insecure directories, you can run the following to fix it:
```
chmod go-w /opt/homebrew/share
```

Testing #

You can perform the following tests to verify that pachctl autocompletion is working:

Open a new terminal.
Input the following:
```
pachctl v
```
Hit TAB. You should see the following output:

validate  -- Validate the specification of a Pachyderm resource.
version   -- Print Pachyderm version information.

👈 Pachctl Unified Deployment 👉