Installing Auvik collector as a Docker image

Limitations

• 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

Note: If you would like to hide your API key, then Docker compose does support loading secrets from the environment or a file. For more details refer to Docker documentation: Secrets in Compose

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/auvik – recommended: Volume stores collector identifier information

• ./config – recommended: Volume stores configuration settings used by the collector

• ./logs – optional: Volume stores log files generated by the collector

Running the Docker Image

As a Docker Container

Note: Replace the information within the [] brackets (including the brackets) with the information appropriate for your network.

docker run --rm \
     --detach \
     --name auvik-collector \
     --hostname auvik-collector \
     --cap-add NET_ADMIN \
     -e AUVIK_USERNAME=[user email] \
     -e AUVIK_API_KEY=[API key] \
     -e AUVIK_DOMAIN_PREFIX=[domain prefix] \
     -v './config:/config' \
     -v './etc/auvik:/etc/auvik' \
     -v './logs/:/usr/share/agent/logs/' \
         auviknetworks/collector:latest

As a Docker Compose Service

services:
   collector:
     image: auviknetworks/collector:latest
     container_name: "auvik-collector"
     hostname: "auvik-collector"
     environment:
        AUVIK_USERNAME: [user email]
        AUVIK_API_KEY: [API key]
        AUVIK_DOMAIN_PREFIX: [domain prefix]
     cap_add:
        - NET_ADMIN
     volumes:
        - './config/:/config/'
        - './etc/auvik/:/etc/auvik/'
        - './logs/:/usr/share/agent/logs/'
     restart: unless-stopped