BEAK Technical Specifications
Purpose of the Document
This document delineates the technical specifications of Beak Agents and the Beak Gateway, along with other essential prerequisites.
Audience
This document outlines software requirements and compatibility details for the Beak platform, intended for stakeholder reference.
Software Requirements and Compatibility
Supported Operating Systems
1. Windows
- Windows Server 2022
- Windows Server 2019
- Windows Server 2016
- Windows Server 2012
- Windows Server 2012 R2
- Windows 8.1
- Windows 10
- Windows 11
2. Linux
- Ubuntu 16.04
- Ubuntu 18.04
- Ubuntu 20.04
- Ubuntu 22.04 LTS
- CentOS 7.7
- CentOS 8
3. macOS
- Sequoia
- Sonoma
- Ventura
- Monterey
- Catalina
- High Sierra
System Requirements
| Component | Minimum Requirements | Recommended Requirements |
|---|---|---|
| Beak Agent | 2 cores, 8 GB RAM | 4 cores, 16 GB RAM |
| Beak Gateway | 4 cores, 16 GB RAM | 8 cores, 32 GB RAM |
Software Prerequisites
| Component | Beak Agent | Beak Gateway |
|---|---|---|
| .NET Framework | Version 4.6 or later | Version 4.6 or later |
| PowerShell | Version 5.0 or later | Version 5.0 or later |
| msiexec Utility | Must be included in PATH | Must be included in PATH |
| TLS Protocol | TLS 1.2 or higher | TLS 1.2 or higher |
| Visual C++ Redistributable | Not Applicable | Microsoft Visual C++ 2013 or later |
| WinRM (Windows Remote Management) | Not Applicable | Must be enabled |
| Remote Server Administration Tools (RSAT) | Not Applicable | Must be installed and enabled |
| Network Access Requirements | Outbound HTTPS (port 443) | Bidirectional HTTPS (port 443) |
| User Privileges | Local Admin rights required | Local Admin rights required |
Note: If the required version of the Visual C++ Redistributable is not already present on the system, it will be automatically installed as part of the Beak Gateway installation process.
Environment Variable Configuration
Ensure the PowerShell executable path is added to the system's PATH environment variable. This is required for the Beak Agent/Gateway to invoke PowerShell commands reliably during runtime.
PowerShell Execution Policy
- The PowerShell Execution Policy must be set to
RemoteSigned.
This execution policy acts as a safeguard against the execution of potentially harmful scripts. It allows Beak to run scripts on your endpoint.
RemoteSigned: Requires digital signatures for downloaded scripts.
This setting can be applied directly on the endpoint or managed centrally via Group Policy.
Network Whitelisting Requirements
It is advisable to include all subdomains of beakops.com (*.beakops.com) in the whitelist to ensure full connectivity with the Beak platform.
| Domain | Port(s) | Protocol |
|---|---|---|
app.beakops.com | 443 | TCP / HTTPS |
rasagent.beakops.com | 443 | TCP / WebSocket |
beakstream-bootstrap.beakops.com | 9094 | TCP |
beakstream-bk0.beakops.com | 9094 | TCP |
beakstream-bk1.beakops.com | 9094 | TCP |
beakstream-bk2.beakops.com | 9094 | TCP |
Agent Process Exclusions
To avoid false positives in antivirus applications, it is advisable to add exclusions for the following agent processes:
| Agent Component | Executable(s) to Exclude |
|---|---|
| Beak AIOps Agent | beakagent.exe, beakservicemanager.exe |
| Beak Gateway Agent | beakgateway.exe |
| Beak Automate | beakautomate.exe |
| Beak Observability Agent | beakiobs.exe, biobs_win_metrics.exe, biobs-win-metrics-exporter.exe |
| Beak Patch Manager Agent | beakpatchmanager.exe |
| Beak Remote Access Agent | beakrasagent.exe |