Prerequisites

Installation Prerequisites

Prerequisites

Resource Requirements

BindPlane OP's resource requirements will differ based on the number of
managed agents. CPU, Memory, Disk throughput / iops, and network consumption
will scale linearly with the number of managed agents.

Instance Sizing

Follow this table for CPU, memory, and storage capacity sizing.

Agent CountCPUMemoryStorage Capacity
101*1GB10GB
10012GB10GB
2,00028GB20GB

* A shared "burstable" core is suitable for 1-10 agents.

Disk Performance Requirements

When using the default storage backend (bbolt), disk throughput and operations per second
will increase linearly with the number of managed agents. Enterprise deployments which are not using bbolt
can safely ignore this section.

To prevent disk performance bottlenecking, ensure that the underlying storage solution
can provide enough disk throughput and operations per second. Generally, cloud providers
will limit disk performance based on provisioned disk capacity.

Agent CountRead / Write ThroughputRead / Write IOPS
101MB/s72/s
1002 MB/s400/s
1,000113 MB/s5000/s

Network Requirements

Bandwidth

BindPlane OP maintains network connections for the following:

  • Agent Management
  • Agent Throughput Measurements
  • CLI and Web Interfaces

While BindPlane's observed network throughput is very low (less than 1mbps at 2,000 agents),
it is recommended to use a low latency network. Generally this means a modern network
interface supporting 1gpbs or greater speeds.

Firewall

BindPlane OP can run on a local area network and behind a firewall.

BindPlane OP does not need to be reachable from the internet, however, if agents. or users outside of your WAN require access, a VPN or inbound firewall rules must be configured to allow access.

Ports

BindPlane OP listens on port 3001 by default. This port is configurable. See the configuration documentation.

The BindPlane port is used for:

Browsers and API Clients

The firewall must allow HTTP traffic to reach BindPlane OP on the configured port.

Agents

Agents must be able to initiate connections to BindPlane OP for OpAMP (websocket) and throughput measurements (HTTP). BindPlane OP will never initiate connections to the agent. The firewall can be configured to prevent BindPlane OP from reaching the agent networks, however, agent networks must be able to reach BindPlane OP on the configured port.

Agent Updates

BindPlane OP will reach out to https://github.com/observIQ/observiq-otel-collector/releases in order to detect new agent releases. This feature is optional.

You can disable Github polling by setting server.syncAgentVersionsInterval to 0 in your BindPlane configuration.

server:
  syncAgentVersionsInterval: 0