Skip to main content

Requirements

This guide describes the operating system, architecture, network, sizing, and packaging requirements for the Breeze Agent.

Supported Operating Systems​

  • Linux
    • Amazon Linux 1, 2, 2023
    • RHEL/CentOS 7+
    • Debian 8+
    • Ubuntu 14.04+
  • Windows
    • Windows Server 2012+ (Server Core not supported)
  • macOS
    • macOS 12+ (Monterey and newer)

If you run Breeze on older Linux distributions or desktop Windows editions, contact Cloudaware Support support@cloudaware.com to confirm compatibility for your specific version.

Supported Architectures​

  • Linux: x86‑64 and ARM64 (AArch64)
  • Windows: x86‑64
  • macOS: x86‑64

Network & Connectivity​

  • Outbound HTTPS over TCP 443 from each Breeze host to Cloudaware is required; no inbound firewall rules are needed for the agent itself. Refer to Ports & Endpoints for details.
  • IPv4 is supported.
  • On major public clouds (AWS, Azure, Google Cloud, Oracle Cloud), the instance metadata service must be reachable by the agent (for example, 169.254.169.254 on many platforms).

If your organization must restrict outbound access to specific hostnames or IP ranges, coordinate with your Technical Account Manager or Cloudaware Support support@cloudaware.com to obtain the current endpoint list.

For a consolidated list of Breeze and TunHub endpoints, IPs, and ports to allowlist, see the Service Endpoints & Public IPs guide.

Execution Model​

  • Breeze runs as a short‑lived job on a regular schedule (typically every 15 minutes) that retrieves the list of plugins from Breeze Server and executes them.
  • Linux: systemd timer or cron job invoking the agent under root/sudo.
  • Windows: Task Scheduler job created by the installer.
  • Kubernetes: DaemonSet pod per node, managed through the Kubernetes deployment manifests (see Kubernetes Installation).

Host Sizing & Resource Footprint​

  • Typical runtime <60s per execution; low CPU and memory utilization
  • For hosts dedicated to Breeze‑backed tunneling or integrations, plan for at least:
    • 1 vCPU
    • 256–512 MB RAM available for the agent and plugins
    • 200 MB free disk space
  • Installation paths:
    • Linux/macOS: /opt/breeze-agent
    • Windows: C:\Program Files\Breeze

Actual consumption depends on which Breeze plugins and integrations you enable; most environments see only a small impact on CPU, memory, and storage.

Permissions & Privileges​

  • Linux/macOS
    • Installation requires root access or sudo to run the installer script.
    • The agent typically runs with elevated privileges so it can collect OS‑level facts and manage services or packages where required.
  • Windows
    • Installation must be performed under a local administrator account.
    • The scheduled task runs with sufficient privileges to read system configuration and execute plugins.

Packaging​

  • Linux: signed tarball (breeze-agent*.tgz) with install.sh
  • macOS: signed tarball installer (breeze-*.tgz) with install.sh
  • Windows: signed executable installer (breeze-agent*.exe)

Installers are available in Cloudaware Admin through the dedicated Breeze integration. The Breeze Agent is designed to self‑update after it first connects to Breeze Server, so new installations automatically move to the latest supported version for that platform.