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 increase as the number of managed agents increases.
Instance Sizing
Follow this table for CPU, memory, and storage capacity sizing.
| Agent Count | CPU | Memory |
|---|---|---|
| 100 | 2 | 4GB |
| 1,000 | 4 | 16GB |
| 2,000 | 4 | 16GB |
Back-end Sizing
BindPlane OP has two back-end options. Bolt Store (default) and PostgreSQL. Bolt store is recommended for single instance deployments of BindPlane OP. If you expect to deploy BindPlane on multiple instances, you should use PostgreSQL to avoid migrating from Bolt Store in the future.
Bolt Store
When using the default storage back-end (bbolt), disk throughput and operations per second
will increase linearly with the number of managed agents. Enterprise deployments that are not using bbolt
can safely ignore this section.
To prevent disk performance bottle-necking, ensure 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 Count | Read / Write Throughput | Read / Write IOPS | Storage Capacity |
|---|---|---|---|
| 100 | 15 MB/s | 500/s | 60GB |
| 1,000 | 150 MB/s | 5000/s | 120GB |
| 2,000 | 300 MB/s | 10000/s | 120GB |
Network Requirements
Bandwidth
BindPlane OP maintains network connections for the following:
- Agent Management
- Agent Throughput Measurements
- Command line and Web user interfaces
Maximum network throughput scales linearly with the number of connected agents. As a rule of thumb, expect to consume 4mbps for every 1,000 connected agents.
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:
- Agent command and control using the Open Agent Management Protocol (OpAMP) (Websocket)
- Agent throughput measurement requests (HTTP POST request)
- Browser and CLI users (HTTP and Websocket)
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 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 agentVersions.syncInterval to 0 in your BindPlane configuration.