blopezpi / prefect-helm

Helm charts for deploying Prefect Services

Prefect Helm Charts

Usage

TL;DR

$ helm repo add prefect https://prefecthq.github.io/prefect-helm
$ helm search repo prefect
$ helm install my-release prefecthq/<chart>

Installing released versions

Charts are automatically versioned and released together. The appVersion & prefectTag version are pinned at package time to the latest release of prefect 2.0.

The charts are hosted in a Helm repository deployed to the web courtesy of Github Pages.

1. Let you local Helm manager know about the repository.

   $ helm repo add prefecthq https://prefecthq.github.io/prefect-helm/
   

2. Sync versions available in the repo to your local cache.

   $ helm repo update
   

3. Search for available charts and versions

   $ helm search repo prefecthq
   

4. Install the Helm chart

   Using default options

   $ helm install prefecthq/prefect-orion --generate-name
   

   Setting some typical flags for customization

   # The kubernetes namespace to install into, can be anything or excluded to install in the default namespace
   NAMESPACE=prefect-orion
   # The Helm "release" name, can be anything but we recommend matching the chart name
   NAME=prefect-orion
   # The path to your config that overrides values in `values.yaml`
   CONFIG_PATH=path/to/your/config.yaml
   # The chart version to install
   VERSION=2022.09.21
   
   helm install \
       --namespace $NAMESPACE \
       --version $VERSION \
       --values $CONFIG_PATH \
       $NAME \
       prefecthq/prefect-orion

If chart installation fails, --debug can provide more information_

See Helm install docs for all options.

Installing development versions

Development versions of the Helm chart will always be available directly from this Github repository.

1. Clone repository

2. Change to this directory

3. Download the chart dependencies

   $ helm dependency update
   

4. Install the chart

   $ helm install . --generate-name
   

Upgrading

1. Look up the name of the last release

   $ helm list
   

2. Run the upgrade

   # Set this name to the name of your last Helm release
   NAME=prefect-orion
   # Choose a version to upgrade to or omit the flag to use the latest version
   VERSION=2022.09.21
   
   helm upgrade $NAME prefecthq/prefect-orion --version $VERSION

   For development versions, make sure your cloned repository is updated (git pull) and reference the local chart

   $ helm upgrade $NAME .
   

3. Upgrades can also be used enable features or change options

   NAME=prefect-orion
   
   helm upgrade \
       $NAME \
       prefecthq/prefect-orion

Important notes about upgrading

• Updates will only update infrastructure that is modified.
• You will need to continue to set any values that you set during the original install (e.g. --set agent.enabled=true or --values path/to/config.yaml).
• If you are using the postgresql subchart with an autogenerated password, it will complain that you have not provided that password for the upgrade. Export the password as the error asks then set it within the subchart using

  $ helm upgrade ... --set postgresql.postgresqlPassword=$POSTGRESQL_PASSWORD
  

Options:

See comments in values.yaml.

Troubleshooting

The database deploys correctly but other services fail with "bad password"

If you are using the subchart deployed database with persistence enabled, it is likely the password for the user has persisted between deployments in the PVC for the database but the secret has been regenerated by the Helm chart and does not match. Deploy and set the 'postgresql.auth.existingSecret' option or set a constant password at postgresql.auth.password.