Deploy

Learn how to deploy the Enterprise edition of Pachyderm.

December 2, 2022

Retrieve Your Enterprise Token #

To activate Pachyderm’s enterprise features, you need to have your Pachyderm Enterprise activation code available. You should have received it from the Pachyderm sales team when registering for the Enterprise Edition.

📖

Activate The Enterprise Edition #

Enabling Pachyderm’s Enterprise Edition can be done in one of two flavors:

  • (Recommended) Provide the licensing configuration as a part of the Helm deployment

    • Provide your enterprise key in the pachd.enterpriseLicenseKey: "<ENTERPRISE-LICENSE-KEY>" field of your helm values (See the Helm deployment instructions that match your targeted platform). Pachyderm will store this value in the platform secret pachyderm-license in the key enterprise-license-key.

    • Alternatively, you can create a secret containing your License (Key: enterprise-license-key) and reference its name in the field pachd.enterpriseLicenseKeySecretName.

⚠️
  • When enabling the enterprise features through Helm, auth is automatically activated. In this case, a pachyderm-auth k8s secret is automatically created (Key: rootToken) containing an entry for your rootToken. Use {{"kubectl get secret pachyderm-auth -o go-template='{{.data.rootToken | base64decode }}'"}} to retrieve it and save it where you see fit.

  • Set the helm value pachd.activateAuth to false to prevent the bootstrap of auth on the cluster.

  • Note that you have the ability to provide your own rootToken value in the field pachd.rootToken or create your own secret holding the rootToken value in the key rootToken, then reference your secret name in pachd.rootTokenSecretName.

Generate your own value using:

openssl rand -hex 16
f438329fc98302779be65eef226d32c1
ℹ️

See the Helm Values reference for details.

Activate Pachyderm Enterprise Edition On An Existing Cluster #

To unlock Pachyderm Enterprise Features, complete the following steps:

  1. Activate the Enterprise Edition by running:

    echo <your-activation-token> | pachctl license activate
  2. Verify the status of the enterprise activation:

    pachctl enterprise get-state

    System response:

    ACTIVE

You unlocked Pachyderm’s enterprise features.