SNAS Collector Docker Install Steps
Collector container is used for collecting BMP messages from BMP senders, e.g. routers. This container can be distributed.
- Openbmpd - Latest collector (listening port is TCP 5000)
Recommended Current Linux Distributions:
- Ubuntu 16.04/Xenial
- CentOS 7/RHEL 7
1) Install docker
Docker host should be Linux x86_64. Follow the Docker Instructions to install docker.
2) Download the docker image
docker pull openbmp/collector
3) Add persistent configs [OPTIONAL]
On host create persistent config location:
mkdir -p /var/openbmp/config chmod 777 /var/openbmp/config
You can add custom host entries so that the collector will reverse lookup IP addresses using a persistent hosts file.
Run docker with
-v /var/openbmp/config:/config to make use of the persistent config files.
You can also add other hosts into a container’s /etc/hosts file by using one or more –add-host flags.
You can provide a customized openbmpd.conf. See Config Example in github.
4) Run docker container
Below table lists the environment variables that can be used with
docker run -e <name=value>
|KAFKA_FQDN||hostname||REQUIRED. Fully qualified hostname that can be resolved inside docker container (e.g.
|OPENBMP_ADMIN_ID||name or IP||Name or IP of the collector, default is the docker hostname.|
|OPENBMP_BUFFER||Size in MB||Defines the openbmpd buffer per router for BMP messages. Default is 16 MB.|
• You MUST define the KAFKA_FQDN as a ‘hostname’ that can be resolved inside the docker container.
• We recommend to set it to ‘localhost’ (or ‘127.0.0.1’) if you are not planning to have your own clients (consumers or producers) outside this container.
• KAFKA_FQDN is used by Kafka to advertise the leader (advertised.host.name) which handles all read and write requests for a partition. If it can not be resolved, there will be no messages published or consumed (without a clear error message in the logs).
• If you are planning to have your own clients outside the container that need access to Kafka running inside the docker container, then the ‘hostname’ must be resolvable inside the container as well as on the hosts where the container and the clients are running.
docker run -d --name=openbmp_collector -e KAFKA_FQDN=localhost \ -v /var/openbmp/config:/config \ -p 5000:5000 \ openbmp/collector
You can navigate all the log files from within the container. Connect to container using:
docker exec -it openbmp_collector bash
Or, you can use standard docker exec commands on host to monitor the log files. To monitor collector, use:
docker exec openbmp_collector tail -f /var/log/openbmpd.log
Or, you can monitor the docker container by getting the console logs. This is useful if the container exits due to invalid start or for another reason. To see console logs for collector, use:
docker logs openbmp_collector
System Start/Restart Config (Ubuntu 16.04/Xenial)
By default, the containers will not start automatically on system boot/startup. You can use the below example to instruct the openbmp/aio container to start automatically.
You can read more at Docker Admin Guide on how to start containers automatically. You can use the below example to instruct the container to start automatically.
--name=openbmp_collectorparameter given to the
docker runcommand is used with the
-a openbmp_collectorparameter below to start the container by name instead of container ID. You can use whatever name you want, but make sure to use the same name used in docker run.
cat <<END > /etc/init/collector-openbmp.conf description "SNAS Collector container" author "email@example.com" start on filesystem and started docker stop on runlevel [!2345] respawn script /usr/bin/docker start -a openbmp_collector end script END