Offline Collector Package Installation and Upgrades

Enable Offline Collector Package Hosting and Upgrades

This feature allows BindPlane OP 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.

BPOP 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.

1name: default
2apiVersion: bindplane.observiq.com/v1
3
4# Enables "offline" mode, which disables syncing collector versions with GitHub, and enables
5# uploading upgrade packages for bindplane to host collector upgrade and install artifacts.
6offline: true
7auth:
8  # A random uuid which is used as a shared secret between bindplane and
9  # deployed collectors.
10  secretKey: your-secret-key
11
12  # Basic auth should use a username other than
13  # admin along with a secure password.
14  username: admin
15  password: password
16
17  # A random uuid which is used for generating web ui session cookies.
18  sessionSecret: your-session-secret
19network:
20  # Listen on port 3001, all interfaces.
21  host: 0.0.0.0
22  port: '3001'
23
24  # Endpoint for which clients and collectors will interfact
25  # with the server's http interface.
26  remoteURL: http://bindplane.c.bindplane.internal:3001
27agentVersions:
28  # The path where collector upgrades are stored when uploading collector upgrade packages in offline mode.
29  agentUpgradesFolder: /var/lib/bindplane/agent-upgrades
30store:
31  bbolt:
32    path: /var/lib/bindplane/storage/bindplane.db
33eventBus:
34  type: local
35logging:
36  filePath: /var/log/bindplane/bindplane.log

Upload a Collector Upgrade Artifact Package

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

1curl -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:

1bindplane profile set "example" \
2 --remote-url "http://192.168.1.10:3001" \
3 --username "user" \
4 --password "pass"
5
6bindplane 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 OP server. In this example, version 1.59.1 of the collector is being uploaded to BindPlane OP:

1bindplane 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:

1bindplane 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:

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

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