Move FalkorDB deployments to a newer addon release

Each FalkorDB Enterprise release ships one release of the FalkorDB addon, which defines how KubeBlocks runs FalkorDB pods. The addon release a deployment runs on is its spec.componentDefinition, for example falkordb-4-1.7.11. Upgrading FalkorDB Enterprise installs the new addon release, but it doesn’t move any deployment to it. Each deployment stays on the release it was created with until you move it. The older release stays installed, so nothing breaks in the meantime. A deployment only gets what a newer addon brings once it runs on it. For example, emptying a setting needs addon 1.7.11 or later.

Before you start

Take a backup, and confirm it restores. See Backups.
Check which addon releases you’re moving between. A move goes straight to the new release: nothing an addon release in between would have done runs. Tested upgrade paths lists the jumps CI tests. When yours is longer, move through an intermediate release first.
The deployment must not be in a Failed state.

See which release a deployment runs:

curl -s -b cookies.txt \
  "http://localhost:3000/api/clusters/<name>?namespace=<namespace>&schemaVersion=1" |
  jq -r '.spec.componentDefinition'

See which releases are installed:

kubectl get componentdefinitions.apps.kubeblocks.io | grep '^falkordb-4-'

Move a deployment

Admin UI
CLI
API

Open Deployments, then the deployment.
Select Upgrade.
Choose the addon component definition. The newest installed one is selected.
Select Confirm Upgrade.

falkordb-admin deployments upgrade <name> \
  --namespace <namespace> \
  --component-definition falkordb-4-1.7.11

Send falkordb-4 alone for the newest installed release. The Admin Server replaces it with that release’s full name.

curl -s -b cookies.txt -X PATCH \
  "http://localhost:3000/api/clusters/<name>?namespace=<namespace>" \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'If-Match: "<metadata.generation>"' \
  -d '{ "schemaVersion": 1, "spec": { "componentDefinition": "falkordb-4" } }'

Every component moves together: the data nodes, the Sentinels of a replicated deployment, and every shard of a sharded one.

Validate

The deployment is back to Running once every component runs on the new release. Check each component’s definition:

kubectl get components.apps.kubeblocks.io -n <namespace> \
  -l app.kubernetes.io/instance=<name> \
  -o custom-columns=NAME:.metadata.name,DEFINITION:.spec.compDef,PHASE:.status.phase

Then confirm your data is intact, as you would after a FalkorDB version upgrade.

Get started

Install

Authentication

Deploy databases

Operations

Licensing

Security

Releases

Upgrade and uninstall

Troubleshooting

Move FalkorDB deployments to a newer addon release

Before you start

Move a deployment

Validate

​Before you start

​Move a deployment

​Validate

Before you start

Move a deployment

Validate