Get Started
Local Getting Started Guides
Docker Desktop
Minikube
Cloud Getting Started Guides
AWS + Pachyderm
Azure + Pachyderm
GCP + Pachyderm
Install Pachctl Auto-completion
Beginner Tutorial
Concepts
Advanced Concepts
Deferred Processing
Distributed Computing
Global Identifier
Pipeline Concepts
Datum
Cross & Union Inputs
Datum Processing
Datum Processing States
Glob Pattern
Group Input
Join Input
Metadata
Job
Pipeline
Cron Pipeline
Service
Spout
Versioned Data Concepts
Branch
Commit
File
History
Provenance
Repository
How Tos
Advanced Data Operations
Analyze Time-Windowed Data
Manage Secrets
Mount a Volume in a Pipeline
Skip Failed Datums
Transactions
Basic Data Operations
Export Data
Egress To An SQL Database
Export via Egress
Export via Pachctl
Mount a Repo Locally
Ingest Data
Manage Commits & Delete Data
SQL Ingest
Developer Workflow
CI/CD Integration
Create a Machine Learning Workflow
The Push Images Flag
Working with Pipelines
Pachyderm's JupyterLab Extension
Docker Installation Guide
Extension Walkthrough
Local Installation Guide
User Guide
Troubleshooting
Pipeline Operations
Create a Pipeline
Delete a Pipeline
Jsonnet Pipeline Specifications
Update a Pipeline
Deploy & Manage
Deploy
Azure
Configure Environment Variables
Configure Tracing with Jaeger
Connect to a Cluster
Console
Cloud Deployment
Local Deployment
Deploy Pachyderm on AWS
Deploy Pachyderm via Proxy (One Port)
Deploy Pachyderm with TLS (SSL, HTTPS)
Enable Logs Aggregation With Loki
Google Cloud Platform
Helm Deployment
Import a Kubernetes Context
Infrastructure Recommendations
Setup Ingress with Traefik
Monitor with Prometheus
Job Metrics
Pachd Metrics
Non-Default Namespaces
On Premises
Production Recommendations
Quickstart
RBAC
Set Up AWS Secret Manager
Manage
Backup & Restore Your Cluster
Disable Usage Metrics
Global S3 Gateway
Pachyderm S3 Gateway Supported Operations
S3 Client Configuration
Unsupported operations
Manage Cluster Access
Sidecar S3 Gateway
Storage Use Optimization
Uninstall Pachyderm
Upgrade Pachyderm
Use GPUs
Using the Pachyderm Shell
👉 Reference
PachCTL
pachctl auth
pachctl auth activate
pachctl auth check
pachctl auth check repo
pachctl auth deactivate
pachctl auth get
pachctl auth get cluster
pachctl auth get enterprise
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 repo
pachctl auth set-config
pachctl auth use-auth-token
pachctl auth whoami
pachctl buildinfo
pachctl completion
pachctl completion bash
pachctl completion zsh
pachctl config
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 copy
pachctl copy file
pachctl create
pachctl create branch
pachctl create pipeline
pachctl create repo
pachctl create secret
pachctl debug
pachctl debug analyze
pachctl debug binary
pachctl debug dump
pachctl debug profile
pachctl delete
pachctl delete all
pachctl delete branch
pachctl delete commit
pachctl delete file
pachctl delete job
pachctl delete pipeline
pachctl delete repo
pachctl delete secret
pachctl delete transaction
pachctl diff
pachctl diff file
pachctl draw
pachctl edit
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 exit
pachctl finish
pachctl finish commit
pachctl finish transaction
pachctl fsck
pachctl get
pachctl get file
pachctl glob
pachctl glob file
pachctl idp
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 file
pachctl inspect job
pachctl inspect pipeline
pachctl inspect repo
pachctl inspect secret
pachctl inspect transaction
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
pachctl list branch
pachctl list commit
pachctl list datum
pachctl list file
pachctl list job
pachctl list pipeline
pachctl list repo
pachctl list secret
pachctl list transaction
pachctl logs
pachctl mount
pachctl port-forward
pachctl put
pachctl put file
pachctl restart
pachctl restart datum
pachctl resume
pachctl resume transaction
pachctl run
pachctl run cron
pachctl run pfs-load-test
pachctl run pps-load-test
pachctl shell
pachctl squash
pachctl squash commit
pachctl start
pachctl start commit
pachctl start pipeline
pachctl start transaction
pachctl stop
pachctl stop job
pachctl stop pipeline
pachctl stop transaction
pachctl subscribe
pachctl subscribe commit
pachctl unmount
pachctl update
pachctl update pipeline
pachctl update repo
pachctl version
pachctl wait
pachctl wait commit
pachctl wait job
Configuration Specification
Helm Chart Values
Language Clients
Pachyderm Supported Releases & Features
Pipeline Scaling Limits (CE)
Pipeline Specification
S3 Gateway API
Enterprise Edition
Authentication & Authorization
Authentication
Authentication Flows
Connectors
Okta
Identity Providers
Authorization
Permissions by Role
Role Binding
Enterprise Server
Server Management
Server Setup
Deploy
Features Overview
Troubleshooting Guides
General Troubleshooting
Troubleshooting Deployments
Troubleshooting Pipelines
Contributing
Coding Conventions
Contributor Setup
Developing on Windows with VSCode
Documentation Style Guide
GitHub

Reference

Reference pachctl commands, helm chart values, pipeline spec options, and more.

March 24, 2023

This section includes references to various tools that enable you to interact with Pachyderm by using your favorite programming language.