How can we help?

Installing Auvik collector as a Docker image

Follow

Limitations

  • Docker installation: Auvik is providing a Docker Container of its collector to allow flexibility for installation in different environments. We have two images built on x86_64 and ARM64 platforms.

  • Bridged mode: Currently we are not supporting Docker in bridged mode. Please use host mode or an OVA installation instead.
  • Image auto-updates: Due to the nature of docker images, we cannot offer auto-updates of the Auvik Networks collector image. It is recommended that users manually handle pulling and updating the docker image to ensure no breaking changes and that their collectors remain active.

FAQ

Auvik Docker Collector FAQ

Docker Configuration

Environment Variables

The Auvik collector Docker container can be configured with the following environment variables:

Required Variables

  • AUVIK_DOMAIN_PREFIX – The Auvik tenant name of where the collector should be connected and installed to.

  • AUVIK_USERNAME – The user email address used to authenticate the agent upon initial connection.

  • AUVIK_API_KEY – Either the user API key or the one-time registration key.

Optional Variables

  • AUVIK_FTP_PORT_RANGE – Used by FTP backups; indicates the first (default: 50100-50120)

  • AUVIK_SNMP_ENABLED - Control if the SNMP daemon service is enabled. When enabled, the collector will be able to identify itself as a collector on the Auvik network map (default: true)

Ports

  • 161 – Used by the collector to identify itself as an Auvik collector on the network map
  • 2055,2056,4432,4739,6343,9995,9996 – Used for receiving TrafficInsights data
  • 10021 – Used for initializing FTP backups
  • 10069 – Used for TFTP
  • 54059 – Used for receiving Syslog data

Volumes

  • ./etc/auvikrecommended: Volume stores collector identifier information

  • ./configrecommended: Volume stores configuration settings used by the collector

  • ./logsoptional: Volume stores log files generated by the collector

Running the Docker Image

As a Docker Container

docker run
docker run --rm \
--detach \
--name nanook \
--hostname nanook \
--cap-add NET_ADMIN \
-e AUVIK_USERNAME="nanook@auvik.com" \
-e AUVIK_API_KEY="nanook-test-key" \
-e AUVIK_DOMAIN_PREFIX="nanooksmsp" \
-v './config:/config' \
-v './etc/auvik:/etc/auvik' \
-v './logs/:/usr/share/agent/logs/' \
auviknetworks/collector:latest

As a Docker Compose Service

docker-compose.yml
services:
collector:
image: auviknetworks/collector:latest
container_name: "nanook"
hostname: "nanook"
environment:
AUVIK_USERNAME: "nanook@auvik.com"
AUVIK_API_KEY: "nanook-test-key"
AUVIK_DOMAIN_PREFIX: "nanooksmsp"
cap_add:
- NET_ADMIN
volumes:
- './config/:/config/'
- './etc/auvik/:/etc/auvik/'
- './logs/:/usr/share/agent/logs/'
restart: unless-stopped

Note: If you are installing it on ARM64 platform devices (ex: Raspberry Pi) with the recent ‘Beta’ image, then in the above Docker Desktop and Docker Compose file, use 'auviknetworks/collector:beta' (and not latest).

Once Auvik makes it it generally available (GA), you can then use the ‘latest'. For now use ‘beta' tag for arm64 devices.

See this for different tags.

Was this article helpful?
4 out of 5 found this helpful
Have more questions? Submit a request