Installation

Download and install the Bigeye Agent CLI

Prerequisites

Before installing the Agent CLI, ensure you have the following:

CredentialExampleDescription
Bigeye base URLhttps://app.bigeye.comURL of your Bigeye instance
Personal API Keybigeye_pak_123...API key for an Admin-level user. Generate in Bigeye under API Keys.
Agent API Keybigeye_agent_123...Company-level API key for agents. Generate in Bigeye under API Keys.

Infrastructure Requirements

Single VM Configuration

To run multiple agents on a single machine:

  • OS: Ubuntu 20.04+ or RHEL 8+ (preferred)
  • Memory: 32 GB
  • CPU: 4 cores
  • Disk: 80 GB

Separate VM Configuration

Lineage Plus agent:

  • Ubuntu 20.04+ or RHEL 8+
  • 25 GB RAM
  • 4 CPU
  • 55 GB disk space

Data Source agent:

  • 8 GB RAM (e.g., AWS t3.xlarge, GCP e2-standard-4, Azure B4/D4)
  • 4 CPU
  • 25 GB disk space on /var

Networking Requirements

  • Firewall access to:
    • app-metacenter-portal.bigeye.com
    • app-metacenter-solr.bigeye.com
  • Firewall rules must not strip Authorization headers
  • Egress access to your data sources
  • Egress access to your Bigeye SaaS environment (e.g., app.bigeye.com)
  • Egress access to the Bigeye licensing endpoint: https://caecsxb9bk.execute-api.us-west-2.amazonaws.com
  • Access to pull images from docker.io

Download

The Agent CLI is hosted in a public S3 bucket. Download the version for your operating system:

# Ubuntu
curl -O https://bigeye-public-web.s3.us-west-2.amazonaws.com/bigeye-agent-installer/latest/ubuntu/bigeye-agent.tar.gz

# Linux (generic)
curl -O https://bigeye-public-web.s3.us-west-2.amazonaws.com/bigeye-agent-installer/latest/linux/bigeye-agent.tar.gz

# RHEL
curl -O https://bigeye-public-web.s3.us-west-2.amazonaws.com/bigeye-agent-installer/latest/rhel/bigeye-agent.tar.gz

# Windows
curl -O https://bigeye-public-web.s3.us-west-2.amazonaws.com/bigeye-agent-installer/latest/windows/bigeye-agent.exe

# Mac
curl -O https://bigeye-public-web.s3.us-west-2.amazonaws.com/bigeye-agent-installer/latest/mac/bigeye-agent.tar.gz

To download a specific version, replace latest with the version number (e.g., 2.3.2).

Install

Extract the archive and set permissions:

# Extract (Linux/Mac)
tar -xf bigeye-agent.tar.gz

# Set permissions (Linux/Mac)
chmod +x bigeye-agent

# Windows — no additional steps needed

Verify the installation:

./bigeye-agent --help

First-Time Setup

Run the install command to walk through the interactive setup:

./bigeye-agent install

The installer will prompt you for:

  1. Your Bigeye base URL, API keys, and Docker PAT
  2. Optional proxy configuration
  3. Optional custom CA certificate path
  4. Optional secrets manager integration
  5. Deployment target (Docker or Kubernetes)
  6. Which agent type to install

After setup completes, a bigeye_agent.yml file is created in the current directory with your configuration.

Updating the Agent CLI

To update to the latest version, re-download the binary using the same download commands above and replace the existing bigeye-agent executable.