Skip to main content
Version: development

Bare Metal/VM

The Aperture Agent can be installed as a system service on any Linux system that is supported.

Download

The Aperture Agent can be installed using packages made for your system's package manager, such as dpkg or rpm.

To install Aperture Agent, first download the package for your manager from the Releases Page.

Alternatively, download it using the following script:

VERSION="main"
ARCH="amd64"
PACKAGER="deb"
url="https://github.com/fluxninja/aperture/releases/download/v${VERSION}/aperture-agent_${VERSION}_${ARCH}.${PACKAGER}"
echo "Will download ${PACKAGER} package version ${VERSION} compiled for ${ARCH} machine"
curl --fail --location --remote-name "${url}"

Installation

sudo dpkg -i aperture-agent_main*.deb

To point the Aperture Agent to the Aperture Controller, edit the configuration file located at /etc/aperture/aperture-agent/config/aperture-agent.yaml. Follow the steps for Aperture Cloud Controller or Self-Hosted Aperture Controller, depending on your setup.

caution

It is mandatory to keep the below configuration block in the configuration file.

otel:
disable_kubernetes_scraper: true
disable_kubelet_scraper: true

auto_scale:
kubernetes:
enabled: false

service_discovery:
kubernetes:
enabled: false

Verify that the above configuration block is present in the configuration file /etc/aperture/aperture-agent/config/aperture-agent.yaml.

All the configuration parameters for the Aperture Agent are available here.

After installing, you should enable the aperture-agent systemd service, and make it start after system boot:

sudo systemctl enable --now aperture-agent
caution

Currently, configuration watcher and automatic reload aren't supported. If you modify the configuration file, do restart the service:

sudo systemctl restart aperture-agent

You can then view service status:

sudo systemctl status aperture-agent

To view the logs, when the default log configuration is used, you can use journalctl:

journalctl -u aperture-agent --since "15 minutes ago"

Upgrade

Download the updated package and follow installation steps. Remember to restart the service after installation is complete.

Uninstall

Stop the Aperture Agent service:

sudo systemctl stop aperture-agent

Optional: Remove the agent configuration:

sudo rm /etc/aperture/aperture-agent/config/aperture-agent.yaml

Uninstall the package:

sudo dpkg -r aperture-agent