Reference
pachctl

Console

Learn how to use Pachyderm's user interface, Console.

March 30, 2023

Console in action

What is Console #

Pachyderm Console is a complete web UI for visualizing running pipelines and exploring your data. By clicking on individual pipeline segments, users can check their jobs’ status, visualize their commits’ content, access logs, and much more! It is a valuable companion when troubleshooting pipelines.

Pachyderm Community Edition comes with Console per default. Upon upgrading to Pachyderm Enterprise, you will be able to:

ℹī¸

Request an Enterprise trial token directly from Console CE by hitting the “Upgrade to Enterprise” button at the bottom right of your Console, fill in this form, or get in touch with us at sales@pachyderm.io.

Before diving into Console installation steps, please look at Console’s various states, from the Community Edition to Enterprise. It should give you a mental model of the various paths to upgrade your Community Edition and what happens when your Enterprise token expires.

Console state diagram

Deploy Console #

Note that this section is an add-on to the deployment of Pachyderm, locally or in the cloud. It details the additional steps required to install and access your Console.

Deploy Locally #

📖

A local installation helps you learn some of the Pachyderm basics and experiment with the product. It is not designed to be a production environment.

We provide an easy “one line” deployment command to install Pachyderm with Console on a local environment. All you need is a Kubernetes cluster running locally.

Follow the deployment instructions in our Local Installation page. You are all set!

ℹī¸
  • Pachyderm local deployment comes with Console by default. To prevent Console from being installed, pass the following parameter to your helm install one line command --set console.enabled=false.
  • Console CE does not require any authentication.

Deploy In The Cloud #

The deployment of Console in your favorite Cloud usually requires, at a minimum, the set up an Ingress (see below), the activation of Authentication, and the setup of a DNS.

ℹī¸
  • You can “quick install” Pachyderm CE or Enterprise Edition.
  • Use the mock user (username:admin, password: password) to login to Console when authentication is enabled but no Identity provider was wired (Enterprise).
⚠ī¸
  • When enterprise is enabled through Helm, auth is automatically activated (i.e., you do not need to run pachctl auth activate) and a pachyderm-auth k8s secret is created containing a rootToken key. Use {{"kubectl get secret pachyderm-auth -o go-template='{{.data.rootToken | base64decode }}'"}} to retrieve it and save it where you see fit.

    However, this secret is only used when configuring through helm:

    • If you run pachctl auth activate, the secret is not updated. Instead, the rootToken is printed in your STDOUT for you to save.
    • Same behavior if you activate enterprise manually (pachctl license activate) then activate authentication (pachctl auth activate).
  • Set the helm value pachd.activateAuth to false to prevent the automatic bootstrap of auth on the cluster.

Connect to Console #

No Ingress set up (Local or Quick Install) #

Ingress / DNS set up #

You are all set! You should land on the Projects page of Console.

Console Landing Page