Skip to main content

Upgrade

Upgrading your NudgeBee Server ensures you benefit from the latest features, security updates, and bug fixes.

Edition reminder

The chart location and registry differ by edition (see Editions):

  • Community Community — oci://ghcr.io/nudgebee/charts/nudgebee, no registry login.
  • Enterprise Enterprise — oci://registry.nudgebee.com/nudgebee, requires the license-key registry login.

Prerequisites​

Before upgrading, ensure:

  • Helm is installed and configured.
  • Kubernetes cluster is accessible and healthy.
  • kubectl is configured for your target cluster.
  • You have a backup of your current configuration.

You can always upgrade to the latest version of NudgeBee Server. You don't need to do incremental upgrades. If you want to upgrade to a specific version, please ensure that the version is compatible with your current setup (e.g., by consulting the official release notes or compatibility guide). NudgeBee does not support downgrades.

  • You have the latest values.yaml file from the NudgeBee repository or your custom configuration.
  • Enterprise only: You have the NudgeBee license key available as an environment variable NUDGEBEE_LICENSE_KEY.
  • You have the KUBE_CONTEXT environment variable set to the context of your Kubernetes cluster.
  • You have the CHART_VERSION environment variable set to the version of NudgeBee you want to upgrade to (if not using the latest version).
  • You have the nudgebee namespace created in your Kubernetes cluster. If not, it will be created during the upgrade process.

1. Backup Current Configuration​

Export your current Helm values:

helm get values nudgebee --namespace nudgebee > previous-values.yaml

Save any custom manifests or secrets you applied manually.

2. Select Your Edition​

Community images are public on ghcr.io/nudgebee — no registry login is required. Just set the chart location:

export NUDGEBEE_CHART=oci://ghcr.io/nudgebee/charts/nudgebee

3. Upgrade NudgeBee​

helm upgrade nudgebee $NUDGEBEE_CHART -f values.yaml --install --namespace nudgebee --create-namespace --wait --kube-context $KUBE_CONTEXT

To upgrade to a specific version of NudgeBee, use the command below. NudgeBee does not currently support downgrades, so ensure you are upgrading to a version compatible with your current setup.

helm upgrade nudgebee $NUDGEBEE_CHART --version $CHART_VERSION -f values.yaml --install --namespace nudgebee --create-namespace --wait --kube-context $KUBE_CONTEXT

4. Troubleshooting​

If upgrades failed ie. helm timeouts, then review the following steps and after resolving the issues, you can retry the upgrade command again.

  • Helm Release Status: 
    helm status nudgebee --namespace nudgebee
  • Pod Status: 
    kubectl get pods --namespace nudgebee
  • Events: 
    kubectl get events --namespace nudgebee

For more details, refer to the Installation Guide.