Prerequisites

1. Obtain a license. Reach out to support or your sales rep if you do not have a license.
2. Be prepared to accept the EULA. The EULA can be found here.

Fresh Installation

If installing BindPlane OP Enterprise on a new system that has not had BindPlane OP installed on it before, follow the Install BindPlane OP Server documentation.

Upgrade Procedure

Limitations

🚧

Open Source to Enterprise upgrades do not support multi account at this time.

In order to remain compatible with BindPlane Open Source's single account, Enterprise cannot be configured in multi account mode. A guide for single account to multi account migrations is available here.

Backup Configuration and Storage

BindPlane OP's configuration file must be backed up before the upgrade can proceed. Additionally, the BindPlane OP storage directory should be backed up as a precaution.

To perform the backup, stop the service and run the following cp commands:

sudo systemctl stop bindplane
mkdir backup
sudo cp /etc/bindplane/config.yaml backup/
sudo cp -r /var/lib/bindplane backup/

Uninstall BindPlane OP Open Source

The BindPlane OP package must be uninstalled before the enterprise SKU can be installed.

Debian based systems

sudo apt-get remove bindplane
sudo apt-get purge bindplane

Yum based systems

sudo yum remove bindplane

Dnf based systems

sudo dnf remove bindplane

Install BindPlane OP Enterprise

The installation script with the --enterprise flag will install the latest version of BindPlane OP Enterprise:

curl -fsSlL https://github.com/observiq/bindplane-op/releases/latest/download/install-linux.sh | bash -s -- --enterprise

If you need to install a specific version of BindPlane OP, pass the --version flag:

curl -fsSlL https://github.com/observiq/bindplane-op/releases/latest/download/install-linux.sh | bash -s -- --enterprise --version 1.19.1

Restore Configuration and Initialize

Restore the previous installations configuration:

sudo cp backup/config.yaml /etc/bindplane/config.yaml
sudo chown bindplane:bindplane /etc/bindplane/config.yaml

Initialize BindPlane OP:

sudo BINDPLANE_CONFIG_HOME="/var/lib/bindplane" \
  /usr/local/bin/bindplane init server \
  --config "/etc/bindplane/config.yaml"

The init server command will ask several new questions that must be answered correctly:

1. License: The license key provided to you by the observIQ sales representative.
2. Enable Multi Account: Choose no here, in order to remain compatible with the previous installation of BindPlane OP
3. Authentication method: Choose single user.
4. EULA: Choose yes if you want to accept the EULA

Restart BindPlane Service

Once the configuration is restored and re-initialized, you can restart the service.

sudo systemctl restart bindplane
sudo systemctl status bindplane

This is the last step, BindPlane OP Enterprise is now installed with the same configuration and database as the previous Open Source installation.