Multi Project Migration

How to migrate resources from one project to another, on the same system or a different system

Multi Project

Multi-Project Bindplane is an Enterprise feature that allows users to create multiple tenants (projects). Each project can have its own users, configurations, and managed collectors. Multi-Project supports user invitations in order to support collaboration between multiple users.

Objective

Export resources from an individual Bindplane project and import them into another project on the same system or a different Bindplane system.

Prerequisites

The following requirements must be met:

• You are running Bindplane Enterprise. Contact the sales team for more information about upgrading to Bindplane Enterprise.
• Bindplane v1.25.0 or newer. If on an older version, upgrade before attempting a migration.
• Bindplane is configured with multi-project enabled.

Procedure

The migration procedure has the following steps:

1. Create API Keys
2. Configure Bindplane CLI profiles
3. Export resources from a project
4. Import resources to the new project
5. Validate
6. Migrate Collectors

Create API Keys

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

Note the API keys, but do not create their profiles. Follow the next section for profile instructions.

Configure CLI Profiles

Configure your Bindplane CLI with two profiles. One for the source project and server, and another for the target project and server.

Create export profile:

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

Create the import profile:

bindplane profile set "import" \
  --server-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.

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"

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 everything looks right, the migration is finished.

Migrate Collectors

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