Bbolt to Postgres Migration

Bindplane BBolt store has been deprecated since February 2025 and will be removed in January 2026. Follow these steps to migrate to Postgres as soon as possible.

Objective

Export resources from a Bindplane project using a BBolt backing database and import them into the same project, but with a Postgres backing database.

Prerequisites

The following requirements must be met:

• Bindplane v1.25.0 or newer. If on an older version, upgrade before attempting a migration.

Procedure

The migration procedure has the following steps:

1. Create API Keys for the BBolt profile

2. Configure Bindplane CLI for the BBolt profile

3. Export resources from project

4. Install Postgres and update Bindplane Server configuration

5. Create API Keys for the Postgres profile

6. Configure Bindplane CLI for the Postgres profile

7. Import resources to the new project

8. Validate

9. Migrate Collectors

Create API Keys for the BBolt Profile

Following the API Keys documentation, create an API key for your source projects. We are going to refer to the BBolt profile as "export" and the new Postgres as "import".

Configure BBolt CLI Profile

Configure your Bindplane CLI with the BBolt profile.

Create export profile:

bindplane profile set "export" \
  --remote-url "http://192.168.1.9:3001" \
  --api-key "xxxx-xxxx-xxxx-xxxx-xxxxxx"

Replace the values for the remote URL and API key with your Bindplane server remote URL(s) and API keys.

Export Resources

Switch to the export profile:

bindplane profile use "export"

Export destinations, sources, processors, and configurations from the project:

touch migration-resources.yaml
bindplane get destination -o yaml --export > "migration-resources.yaml"
bindplane get source -o yaml --export >> "migration-resources.yaml"
bindplane get processor -o yaml --export >> "migration-resources.yaml"
bindplane get extension -o yaml --export >> "migration-resources.yaml"
bindplane get configuration -o yaml --export >> "migration-resources.yaml"

Install Postgres

Follow our Postgres Installation Guide for how to install Postgres.

In the server config.yaml, set the store.type to postgres and restart the server for the changes to take effect.

Create API Keys for the Postgres Profile

Log into Bindplane and create a new project to access the new instance. Following the API Keys documentation, create an API key for your new projects.

Configure CLI Profile for Postgres

Configure your Bindplane CLI with the BBolt profile.

Create the import profile:

bindplane profile set "import" \
  --remote-url "http://192.168.1.10:3001" \
  --api-key "xxxx-xxxx-xxxx-xxxx-xxxxxx"

Replace the values for the remote URL and API key with your Bindplane server remote URL(s) and API keys.

Import Resources

Switch to the import profile:

bindplane profile use "import"

Import destinations, sources, processors, and configurations using the apply command:

bindplane apply -f "migration-resources.yaml"

Validate

Log into the Bindplane project and ensure the configurations and destinations are present.

If you need to access the BBolt server, you can set store.type back to bbolt and restart the server to see the changes take effect.

Previously connected collectors will need to be updated with the new project's secret key. Follow the Migrate Collectors documentation.