Offline Collector Package Installation and Upgrades

How to set up Bindplane to host collector packages locally

IMPORTANT

🚧 This feature is only available in Bindplane Enterprise or Bindplane for Google. Learn more here.

Enable Offline Collector Package Hosting and Upgrades

This feature allows Bindplane to host the collector packages. This is used in environments where either Bindplane or the Collector system does not have external network access to GitHub.

Bindplane offline collector configuration

In order to use offline collector upgrades, the feature must first be enabled.

To enable offline collector upgrades, the offline option must be enabled. The folder where collector upgrade artifacts will be stored when uploaded may also be configured. By default, collector upgrade artifacts are stored in /var/lib/bindplane/agent-upgrades.

Here is an example config enabling offline mode, which has the 'offline: true' added right after the 'apiVersion' section.

name: default
apiVersion: bindplane.observiq.com/v1

# Enables "offline" mode, which disables syncing collector versions with GitHub, and enables
# uploading upgrade packages for bindplane to host collector upgrade and install artifacts.
offline: true
auth:
  # A random uuid which is used as a shared secret between bindplane and
  # deployed collectors.
  secretKey: your-secret-key

  # Basic auth should use a username other than
  # admin along with a secure password.
  username: admin
  password: password

  # A random uuid which is used for generating web ui session cookies.
  sessionSecret: your-session-secret
network:
  # Listen on port 3001, all interfaces.
  host: 0.0.0.0
  port: '3001'

  # Endpoint for which clients and collectors will interface
  # with the server's http interface.
  remoteURL: http://bindplane.c.bindplane.internal:3001
agentVersions:
  # The path where collector upgrades are stored when uploading collector upgrade packages in offline mode.
  agentUpgradesFolder: /var/lib/bindplane/agent-upgrades
store:
  type: postgres
  postgres:
    database: bindplane
eventBus:
  type: local
logging:
  filePath: /var/log/bindplane/bindplane.log

Upload a Collector Upgrade Artifact Package

Collector artifact packages can be uploaded to the Bindplane server to allow collectors to upgrade to new versions, as well as allow collectors to be installed through Bindplane while in offline mode. These packages can be found and downloaded from the releases page of the Bindplane Distro for OpenTelemetry GitHub repository. You can download the artifact package to the Bindplane server through SSH like the example below:

curl -LO https://github.com/observIQ/bindplane-otel-collector/releases/download/v1.59.1/observiq-otel-collector-v1.59.1-artifacts.tar.gz

To upload a collector upgrade artifact package, use the bindplane upload agent-upgrade command. This requires that you first set up the CLI. If you have not done so previously, you can set up a profile like the example below:

bindplane profile set "example" \
 --remote-url "http://192.168.1.10:3001" \
 --username "user" \
 --password "pass"

bindplane profile use "example"

The artifact package should be downloaded onto the machine from which you are running the bindplane cli, which may or may not be the Bindplane server. In this example, version 1.59.1 of the collector is being uploaded to Bindplane:

bindplane upload agent-upgrade ./observiq-otel-collector-v1.59.1-artifacts.tar.gz

If the file has been renamed, you must specify the --version flag with the version you are uploading:

bindplane upload agent-upgrade ./artifacts.tar.gz --version v1.59.1

Delete Old Collector Artifact Packages

Collector versions and agent artifact packages can be removed using the bindplane delete agent-version command:

bindplane delete agent-version observiq-otel-collector-v1.59.1

This will delete the version from Bindplane and remove the unpacked artifact package from the disk of the Bindplane server.