Local Getting Started Guides

Cloud Getting Started Guides

Azure Deployment

Install PachCTL Auto-completion

Beginner Tutorial

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 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 file

pachctl create branch

pachctl create pipeline

pachctl create repo

pachctl create secret

pachctl debug analyze

pachctl debug binary

pachctl debug dump

pachctl debug profile

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 file

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 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 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 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 port-forward

pachctl put file

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 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 pipeline

pachctl update repo

pachctl version

pachctl wait commit

pachctl wait job

Configuration Specification

Helm Chart Values

Language Clients

Pipeline Scaling Limits (CE)

Pipeline Specification

Supported Releases & Features

Enterprise Edition

Authentication & Authorization

Authentication Flows

Identity Providers

Permissions by Role

Enterprise Server

Server Management

Features Overview

Troubleshooting Guides

General Troubleshooting

Troubleshooting Deployments

Troubleshooting Pipelines

Coding Conventions

Contributor Setup

Developing on Windows with VSCode

Documentation Style Guide

Deploy & Manage

Learn how to deploy and manage locally, on-prem, or in the cloud.

This section describes how to deploy Pachyderm in a production environment. Additionally, you will find information about basic Pachyderm operations, including upgrading to minor and major versions, autoscaling…

Before you start… The following high-level architecture diagram lays out Pachyderm’s main components. It might help you build a quick mental model of Pachyderm.

Operator High Level Arch

⚠️

We are now shipping Pachyderm with an embedded proxy allowing your cluster to expose one single port externally. This deployment setup is optional.

If you choose to deploy Pachyderm with a Proxy, check out our new recommended architecture and deployment instructions.