readme.md

Be aware of environment's state by using Zabbix solution

About

Repository contain docker-compose project for running zabbix and grafana servers on your own server.

1. Zabbix server 3.4
2. Zabbix frontend
3. Zabbix agent (will be installed on host, not run inside the docker container)
4. MariaDB 10.3
5. Exim4 SMTP service
6. Grafana Server

PS: It is used the official docker image: https://hub.docker.com/u/zabbix/ and https://hub.docker.com/r/grafana/grafana/

Requirements

1. Debian family OS (scripts limits)
2. docker-ce (1.13.0+)
3. docker-compose

Preparing configuration file for server

If default options are not enough, then please use .env.example to create own environment configuration file.

Run Zabbix server

$ ./x-setup-server.sh

After server will be launched, this script will call ./x-setup-agent.sh to install Zabbix agent on host machine, where Zabbix server works inside the docker environment.

Run and configured only server components

$ docker-compose up -d

Zabbix provisioned service is configurator, after succesfully configuring the server, configurator has to return exit code 0. To be sure that it is precisely so, execute such command and look at state column:

$ docker-compose ps configurator
        Name                    Command            State    Ports
-----------------------------------------------------------------
default_configurator_1   /configurator.py --debug   Exit 0

If something wrong, it is possible to debug provision by attaching to configurator service while it is running or look at its logs.

$ docker-compose logs configurator
...
$ docker-compose up configurator
default_db_1 is up-to-date
default_smtp_1 is up-to-date
default_server_1 is up-to-date
default_frontend_1 is up-to-date
Starting default_configurator_1 ...
Starting default_configurator_1 ... done
Attaching to default_configurator_1
configurator_1  | DEBUG:Configurator:SMTP_HELO value is: zabbix.
configurator_1  | INFO:Configurator:Waiting while Zabbix server will be reachable.
configurator_1  | DEBUG:Configurator:Server is reachable.
configurator_1  | INFO:Configurator:Connecting to Zabbix database.
...
configurator_1  | DEBUG:Configurator:Comparasing desired config with current.
configurator_1  | DEBUG:Configurator:Logout from Zabbix server.
default_configurator_1 exited with code 0

For enable debug mode, use configurator option --debug. It is possible to set this option by using configurator variable CONFIGURATOR_OPTIONS=--debug in .env environment config file.

Install and configured external agent

For server it is not necessary to run below described command, ./setup-server.sh will launch it by self.

$ ./x-setup-agent.sh --help
...
$ ./x-setup-agent.sh -m "Linux ${DEFAULT_HOST_SECRET}" -s zabbix.local --hostname $(hostname -f)

Frontend url is: http://localhost if you launch project on your local machine.

Default user for zabbix is: admin / zabbix

To run project with specific options, please see .env.example file. To apply non default option, copy .env.example file to .env and edit necessary values there.

About Grafana

Grafana conneted to zabbix server by https://grafana.com/plugins/alexanderzobnin-zabbix-app plugin.

All provisioning files for grafana are generated by configurator

The folder for Zabbix Dashboards are ./scripts/Zabbix_Dashboards/ You cat try to make your own dashboards and put to this folder, then restart your container of grafana, if you do all right, after restart you can see you dashboard in grafana

After all succesfully completed you can see grafana web in http://localhost/grafana

Default user and password are: admin/grafana, you also can change password in .env file

Testing a deployment of environment

Project contains Vagrantfile that can be used for testing running the project.

If VM does not exist yes, launch next command:

$ vagrant up

After succesfully completed provision scenario it is possible to get access to Zabbix UI by url: http://localhost:8080.

Repeat provision scenario

$ vagrant provision