mirror of
https://github.com/zabbix/zabbix-docker.git
synced 2024-11-21 23:33:31 +01:00
Changed structure of manual
This commit is contained in:
Alexey Pustovalov
parent
4c9e4554d2
commit
14e5781001
227
Dockerfiles/agent2/README.md
Normal file
227
Dockerfiles/agent2/README.md
Normal file
@ -0,0 +1,227 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix agent 2?
|
||||
|
||||
Zabbix agent 2 is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).
|
||||
|
||||
# Zabbix agent 2 images
|
||||
|
||||
These are the only official Zabbix agent 2 Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8, Oracle Linux 8, Windows 10 LTSC 2019 and Windows 11 LTSC 2022 images. The available versions of Zabbix agent 2 are:
|
||||
|
||||
Zabbix agent 2 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest , ltsc2019-5.0-latest, ltsc2022-5.0-latest)
|
||||
Zabbix agent 2 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*, ltsc2019-5.0.*, ltsc2022-5.0.*)
|
||||
Zabbix agent 2 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix agent 2 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*, ltsc2019-6.0.*, ltsc2022-6.0.*)
|
||||
Zabbix agent 2 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix agent 2 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*, ltsc2019-6.2.*, ltsc2022-6.2.*)
|
||||
Zabbix agent 2 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, ltsc2019-latest, ltsc2022-latest, latest)
|
||||
Zabbix agent 2 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*, ltsc2019-6.4.*, ltsc2022-6.4.*)
|
||||
Zabbix agent 2 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk, ltsc2019-trunk, ltsc2022-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-agent2`
|
||||
|
||||
Start a Zabbix agent 2 container as follows:
|
||||
|
||||
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent2:tag
|
||||
|
||||
Where `some-zabbix-agent2` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server or proxy and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-agent2/tags/).
|
||||
|
||||
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)
|
||||
|
||||
This image exposes the standard Zabbix agent 2 port (``10050``) to perform passive checks, so container linking makes Zabbix agent 2 instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent 2 container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent2 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server or Zabbix proxy containers (Active checks)
|
||||
|
||||
This image supports perform active checks, so container linking makes Zabbix server and Zabbix proxy containers available to Zabbix agent 2 instance. Start your application container like this in order to link Zabbix agent 2 to Zabbix server or Zabbix proxy containterns:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix agent 2 logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-agent2` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-agent /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix agent 2 log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-agent
|
||||
```
|
||||
|
||||
## Privileged mode
|
||||
|
||||
By default, Docker containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent 2 is designed to monitor system resources, to do that Zabbix agent 2 container must be privileged or you may mount some system-wide volumes. For example:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server --privileged -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -v /dev/sdc:/dev/sdc -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-agent2` image, you can adjust the configuration of the Zabbix agent 2 by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agent2.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_agent2.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_PASSIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of passive checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_PASSIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container.
|
||||
|
||||
### `ZBX_ACTIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of active checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_ACTIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container. You may specify port of Zabbix server or Zabbix proxy in such syntax: ``zabbix-server:10061,zabbix-proxy:10072``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agent2.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``3``.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEPERSISTENTBUFFER=false # Available since 5.0.0
|
||||
ZBX_PERSISTENTBUFFERPERIOD=1h # Available since 5.0.0
|
||||
ZBX_ENABLESTATUSPORT=
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HEARTBEAT_FREQUENCY=60 # Available since 6.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Deprecated since 5.0.0
|
||||
ZBX_LOGREMOTECOMMANDS=0
|
||||
ZBX_STARTAGENTS=3
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=120
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=100
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_agent2.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
|
||||
|
||||
Please use official documentation for [``zabbix_agent2.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agent2) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix agent 2 container
|
||||
|
||||
### ``/etc/zabbix/zabbix_agentd.d``
|
||||
|
||||
The volume allows include ``*.conf`` files and extend Zabbix agent 2 using ``UserParameter`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/buffer``
|
||||
|
||||
The volume is used to store the file, where Zabbix Agent2 should keep SQLite database. To enable the feature specify ``ZBX_ENABLEPERSISTENTBUFFER=true``. Available since 5.0.0.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-agent2` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-agent2:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-agent2:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-agent2:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`agent2/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/agent2) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/trunk/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable. Please use ``/etc/zabbix/zabbix_agent.d`` volume with additional configuration files with ``Alias`` options.
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,225 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix agent 2?
|
||||
|
||||
Zabbix agent 2 is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).
|
||||
|
||||
# Zabbix agent 2 images
|
||||
|
||||
These are the only official Zabbix agent 2 Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8, Oracle Linux 8, Windows 10 LTSC 2019 and Windows 11 LTSC 2022 images. The available versions of Zabbix agent 2 are:
|
||||
|
||||
Zabbix agent 2 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest , ltsc2019-5.0-latest, ltsc2022-5.0-latest)
|
||||
Zabbix agent 2 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*, ltsc2019-5.0.*, ltsc2022-5.0.*)
|
||||
Zabbix agent 2 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix agent 2 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*, ltsc2019-6.0.*, ltsc2022-6.0.*)
|
||||
Zabbix agent 2 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, ltsc2019-latest, ltsc2022-latest, latest)
|
||||
Zabbix agent 2 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.0.*, ltsc2019-6.2.*, ltsc2022-6.2.*)
|
||||
Zabbix agent 2 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk, ltsc2019-trunk, ltsc2022-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-agent2`
|
||||
|
||||
Start a Zabbix agent 2 container as follows:
|
||||
|
||||
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent2:tag
|
||||
|
||||
Where `some-zabbix-agent2` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server or proxy and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-agent2/tags/).
|
||||
|
||||
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)
|
||||
|
||||
This image exposes the standard Zabbix agent 2 port (``10050``) to perform passive checks, so container linking makes Zabbix agent 2 instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent 2 container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent2 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server or Zabbix proxy containers (Active checks)
|
||||
|
||||
This image supports perform active checks, so container linking makes Zabbix server and Zabbix proxy containers available to Zabbix agent 2 instance. Start your application container like this in order to link Zabbix agent 2 to Zabbix server or Zabbix proxy containterns:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix agent 2 logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-agent2` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-agent /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix agent 2 log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-agent
|
||||
```
|
||||
|
||||
## Privileged mode
|
||||
|
||||
By default, Docker containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent 2 is designed to monitor system resources, to do that Zabbix agent 2 container must be privileged or you may mount some system-wide volumes. For example:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server --privileged -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -v /dev/sdc:/dev/sdc -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-agent2` image, you can adjust the configuration of the Zabbix agent 2 by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agent2.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_agent2.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_PASSIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of passive checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_PASSIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container.
|
||||
|
||||
### `ZBX_ACTIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of active checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_ACTIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container. You may specify port of Zabbix server or Zabbix proxy in such syntax: ``zabbix-server:10061,zabbix-proxy:10072``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agent2.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``3``.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEPERSISTENTBUFFER=false # Available since 5.0.0
|
||||
ZBX_PERSISTENTBUFFERPERIOD=1h # Available since 5.0.0
|
||||
ZBX_ENABLESTATUSPORT=
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HEARTBEAT_FREQUENCY=60 # Available since 6.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Deprecated since 5.0.0
|
||||
ZBX_LOGREMOTECOMMANDS=0
|
||||
ZBX_STARTAGENTS=3
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=120
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=100
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_agent2.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
|
||||
|
||||
Please use official documentation for [``zabbix_agent2.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agent2) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix agent 2 container
|
||||
|
||||
### ``/etc/zabbix/zabbix_agentd.d``
|
||||
|
||||
The volume allows include ``*.conf`` files and extend Zabbix agent 2 using ``UserParameter`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/buffer``
|
||||
|
||||
The volume is used to store the file, where Zabbix Agent2 should keep SQLite database. To enable the feature specify ``ZBX_ENABLEPERSISTENTBUFFER=true``. Available since 5.0.0.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-agent2` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-agent2:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-agent2:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-agent2:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`agent2/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/agent2) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/trunk/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable. Please use ``/etc/zabbix/zabbix_agent.d`` volume with additional configuration files with ``Alias`` options.
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/agent2/alpine/README.md
Symbolic link
1
Dockerfiles/agent2/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,225 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix agent 2?
|
||||
|
||||
Zabbix agent 2 is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).
|
||||
|
||||
# Zabbix agent 2 images
|
||||
|
||||
These are the only official Zabbix agent 2 Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8, Oracle Linux 8, Windows 10 LTSC 2019 and Windows 11 LTSC 2022 images. The available versions of Zabbix agent 2 are:
|
||||
|
||||
Zabbix agent 2 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest , ltsc2019-5.0-latest, ltsc2022-5.0-latest)
|
||||
Zabbix agent 2 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*, ltsc2019-5.0.*, ltsc2022-5.0.*)
|
||||
Zabbix agent 2 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix agent 2 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*, ltsc2019-6.0.*, ltsc2022-6.0.*)
|
||||
Zabbix agent 2 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, ltsc2019-latest, ltsc2022-latest, latest)
|
||||
Zabbix agent 2 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.0.*, ltsc2019-6.2.*, ltsc2022-6.2.*)
|
||||
Zabbix agent 2 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk, ltsc2019-trunk, ltsc2022-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-agent2`
|
||||
|
||||
Start a Zabbix agent 2 container as follows:
|
||||
|
||||
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent2:tag
|
||||
|
||||
Where `some-zabbix-agent2` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server or proxy and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-agent2/tags/).
|
||||
|
||||
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)
|
||||
|
||||
This image exposes the standard Zabbix agent 2 port (``10050``) to perform passive checks, so container linking makes Zabbix agent 2 instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent 2 container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent2 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server or Zabbix proxy containers (Active checks)
|
||||
|
||||
This image supports perform active checks, so container linking makes Zabbix server and Zabbix proxy containers available to Zabbix agent 2 instance. Start your application container like this in order to link Zabbix agent 2 to Zabbix server or Zabbix proxy containterns:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix agent 2 logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-agent2` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-agent /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix agent 2 log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-agent
|
||||
```
|
||||
|
||||
## Privileged mode
|
||||
|
||||
By default, Docker containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent 2 is designed to monitor system resources, to do that Zabbix agent 2 container must be privileged or you may mount some system-wide volumes. For example:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server --privileged -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -v /dev/sdc:/dev/sdc -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-agent2` image, you can adjust the configuration of the Zabbix agent 2 by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agent2.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_agent2.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_PASSIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of passive checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_PASSIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container.
|
||||
|
||||
### `ZBX_ACTIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of active checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_ACTIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container. You may specify port of Zabbix server or Zabbix proxy in such syntax: ``zabbix-server:10061,zabbix-proxy:10072``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agent2.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``3``.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEPERSISTENTBUFFER=false # Available since 5.0.0
|
||||
ZBX_PERSISTENTBUFFERPERIOD=1h # Available since 5.0.0
|
||||
ZBX_ENABLESTATUSPORT=
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HEARTBEAT_FREQUENCY=60 # Available since 6.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Deprecated since 5.0.0
|
||||
ZBX_LOGREMOTECOMMANDS=0
|
||||
ZBX_STARTAGENTS=3
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=120
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=100
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_agent2.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
|
||||
|
||||
Please use official documentation for [``zabbix_agent2.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agent2) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix agent 2 container
|
||||
|
||||
### ``/etc/zabbix/zabbix_agentd.d``
|
||||
|
||||
The volume allows include ``*.conf`` files and extend Zabbix agent 2 using ``UserParameter`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/buffer``
|
||||
|
||||
The volume is used to store the file, where Zabbix Agent2 should keep SQLite database. To enable the feature specify ``ZBX_ENABLEPERSISTENTBUFFER=true``. Available since 5.0.0.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-agent2` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-agent2:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-agent2:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-agent2:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`agent2/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/agent2) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/trunk/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable. Please use ``/etc/zabbix/zabbix_agent.d`` volume with additional configuration files with ``Alias`` options.
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/agent2/centos/README.md
Symbolic link
1
Dockerfiles/agent2/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,225 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix agent 2?
|
||||
|
||||
Zabbix agent 2 is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).
|
||||
|
||||
# Zabbix agent 2 images
|
||||
|
||||
These are the only official Zabbix agent 2 Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8, Oracle Linux 8, Windows 10 LTSC 2019 and Windows 11 LTSC 2022 images. The available versions of Zabbix agent 2 are:
|
||||
|
||||
Zabbix agent 2 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest , ltsc2019-5.0-latest, ltsc2022-5.0-latest)
|
||||
Zabbix agent 2 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*, ltsc2019-5.0.*, ltsc2022-5.0.*)
|
||||
Zabbix agent 2 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix agent 2 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*, ltsc2019-6.0.*, ltsc2022-6.0.*)
|
||||
Zabbix agent 2 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, ltsc2019-latest, ltsc2022-latest, latest)
|
||||
Zabbix agent 2 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.0.*, ltsc2019-6.2.*, ltsc2022-6.2.*)
|
||||
Zabbix agent 2 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk, ltsc2019-trunk, ltsc2022-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-agent2`
|
||||
|
||||
Start a Zabbix agent 2 container as follows:
|
||||
|
||||
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent2:tag
|
||||
|
||||
Where `some-zabbix-agent2` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server or proxy and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-agent2/tags/).
|
||||
|
||||
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)
|
||||
|
||||
This image exposes the standard Zabbix agent 2 port (``10050``) to perform passive checks, so container linking makes Zabbix agent 2 instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent 2 container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent2 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server or Zabbix proxy containers (Active checks)
|
||||
|
||||
This image supports perform active checks, so container linking makes Zabbix server and Zabbix proxy containers available to Zabbix agent 2 instance. Start your application container like this in order to link Zabbix agent 2 to Zabbix server or Zabbix proxy containterns:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix agent 2 logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-agent2` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-agent /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix agent 2 log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-agent
|
||||
```
|
||||
|
||||
## Privileged mode
|
||||
|
||||
By default, Docker containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent 2 is designed to monitor system resources, to do that Zabbix agent 2 container must be privileged or you may mount some system-wide volumes. For example:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server --privileged -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -v /dev/sdc:/dev/sdc -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-agent2` image, you can adjust the configuration of the Zabbix agent 2 by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agent2.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_agent2.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_PASSIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of passive checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_PASSIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container.
|
||||
|
||||
### `ZBX_ACTIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of active checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_ACTIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container. You may specify port of Zabbix server or Zabbix proxy in such syntax: ``zabbix-server:10061,zabbix-proxy:10072``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agent2.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``3``.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEPERSISTENTBUFFER=false # Available since 5.0.0
|
||||
ZBX_PERSISTENTBUFFERPERIOD=1h # Available since 5.0.0
|
||||
ZBX_ENABLESTATUSPORT=
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HEARTBEAT_FREQUENCY=60 # Available since 6.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Deprecated since 5.0.0
|
||||
ZBX_LOGREMOTECOMMANDS=0
|
||||
ZBX_STARTAGENTS=3
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=120
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=100
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_agent2.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
|
||||
|
||||
Please use official documentation for [``zabbix_agent2.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agent2) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix agent 2 container
|
||||
|
||||
### ``/etc/zabbix/zabbix_agentd.d``
|
||||
|
||||
The volume allows include ``*.conf`` files and extend Zabbix agent 2 using ``UserParameter`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/buffer``
|
||||
|
||||
The volume is used to store the file, where Zabbix Agent2 should keep SQLite database. To enable the feature specify ``ZBX_ENABLEPERSISTENTBUFFER=true``. Available since 5.0.0.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-agent2` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-agent2:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-agent2:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-agent2:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`agent2/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/agent2) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/trunk/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable. Please use ``/etc/zabbix/zabbix_agent.d`` volume with additional configuration files with ``Alias`` options.
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/agent2/ol/README.md
Symbolic link
1
Dockerfiles/agent2/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,225 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix agent 2?
|
||||
|
||||
Zabbix agent 2 is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).
|
||||
|
||||
# Zabbix agent 2 images
|
||||
|
||||
These are the only official Zabbix agent 2 Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8, Oracle Linux 8, Windows 10 LTSC 2019 and Windows 11 LTSC 2022 images. The available versions of Zabbix agent 2 are:
|
||||
|
||||
Zabbix agent 2 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest , ltsc2019-5.0-latest, ltsc2022-5.0-latest)
|
||||
Zabbix agent 2 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*, ltsc2019-5.0.*, ltsc2022-5.0.*)
|
||||
Zabbix agent 2 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix agent 2 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*, ltsc2019-6.0.*, ltsc2022-6.0.*)
|
||||
Zabbix agent 2 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, ltsc2019-latest, ltsc2022-latest, latest)
|
||||
Zabbix agent 2 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.0.*, ltsc2019-6.2.*, ltsc2022-6.2.*)
|
||||
Zabbix agent 2 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk, ltsc2019-trunk, ltsc2022-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-agent2`
|
||||
|
||||
Start a Zabbix agent 2 container as follows:
|
||||
|
||||
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent2:tag
|
||||
|
||||
Where `some-zabbix-agent2` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server or proxy and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-agent2/tags/).
|
||||
|
||||
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)
|
||||
|
||||
This image exposes the standard Zabbix agent 2 port (``10050``) to perform passive checks, so container linking makes Zabbix agent 2 instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent 2 container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent2 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server or Zabbix proxy containers (Active checks)
|
||||
|
||||
This image supports perform active checks, so container linking makes Zabbix server and Zabbix proxy containers available to Zabbix agent 2 instance. Start your application container like this in order to link Zabbix agent 2 to Zabbix server or Zabbix proxy containterns:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix agent 2 logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-agent2` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-agent /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix agent 2 log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-agent
|
||||
```
|
||||
|
||||
## Privileged mode
|
||||
|
||||
By default, Docker containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent 2 is designed to monitor system resources, to do that Zabbix agent 2 container must be privileged or you may mount some system-wide volumes. For example:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server --privileged -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -v /dev/sdc:/dev/sdc -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-agent2` image, you can adjust the configuration of the Zabbix agent 2 by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agent2.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_agent2.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_PASSIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of passive checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_PASSIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container.
|
||||
|
||||
### `ZBX_ACTIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of active checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_ACTIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container. You may specify port of Zabbix server or Zabbix proxy in such syntax: ``zabbix-server:10061,zabbix-proxy:10072``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agent2.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``3``.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEPERSISTENTBUFFER=false # Available since 5.0.0
|
||||
ZBX_PERSISTENTBUFFERPERIOD=1h # Available since 5.0.0
|
||||
ZBX_ENABLESTATUSPORT=
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HEARTBEAT_FREQUENCY=60 # Available since 6.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Deprecated since 5.0.0
|
||||
ZBX_LOGREMOTECOMMANDS=0
|
||||
ZBX_STARTAGENTS=3
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=120
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=100
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_agent2.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
|
||||
|
||||
Please use official documentation for [``zabbix_agent2.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agent2) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix agent 2 container
|
||||
|
||||
### ``/etc/zabbix/zabbix_agentd.d``
|
||||
|
||||
The volume allows include ``*.conf`` files and extend Zabbix agent 2 using ``UserParameter`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/buffer``
|
||||
|
||||
The volume is used to store the file, where Zabbix Agent2 should keep SQLite database. To enable the feature specify ``ZBX_ENABLEPERSISTENTBUFFER=true``. Available since 5.0.0.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-agent2` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-agent2:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-agent2:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-agent2:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`agent2/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/agent2) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/trunk/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable. Please use ``/etc/zabbix/zabbix_agent.d`` volume with additional configuration files with ``Alias`` options.
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/agent2/rhel/README.md
Symbolic link
1
Dockerfiles/agent2/rhel/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,225 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix agent 2?
|
||||
|
||||
Zabbix agent 2 is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).
|
||||
|
||||
# Zabbix agent 2 images
|
||||
|
||||
These are the only official Zabbix agent 2 Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8, Oracle Linux 8, Windows 10 LTSC 2019 and Windows 11 LTSC 2022 images. The available versions of Zabbix agent 2 are:
|
||||
|
||||
Zabbix agent 2 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest , ltsc2019-5.0-latest, ltsc2022-5.0-latest)
|
||||
Zabbix agent 2 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*, ltsc2019-5.0.*, ltsc2022-5.0.*)
|
||||
Zabbix agent 2 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix agent 2 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*, ltsc2019-6.0.*, ltsc2022-6.0.*)
|
||||
Zabbix agent 2 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, ltsc2019-latest, ltsc2022-latest, latest)
|
||||
Zabbix agent 2 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.0.*, ltsc2019-6.2.*, ltsc2022-6.2.*)
|
||||
Zabbix agent 2 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk, ltsc2019-trunk, ltsc2022-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-agent2`
|
||||
|
||||
Start a Zabbix agent 2 container as follows:
|
||||
|
||||
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent2:tag
|
||||
|
||||
Where `some-zabbix-agent2` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server or proxy and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-agent2/tags/).
|
||||
|
||||
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)
|
||||
|
||||
This image exposes the standard Zabbix agent 2 port (``10050``) to perform passive checks, so container linking makes Zabbix agent 2 instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent 2 container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent2 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server or Zabbix proxy containers (Active checks)
|
||||
|
||||
This image supports perform active checks, so container linking makes Zabbix server and Zabbix proxy containers available to Zabbix agent 2 instance. Start your application container like this in order to link Zabbix agent 2 to Zabbix server or Zabbix proxy containterns:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix agent 2 logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-agent2` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-agent /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix agent 2 log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-agent
|
||||
```
|
||||
|
||||
## Privileged mode
|
||||
|
||||
By default, Docker containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent 2 is designed to monitor system resources, to do that Zabbix agent 2 container must be privileged or you may mount some system-wide volumes. For example:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server --privileged -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -v /dev/sdc:/dev/sdc -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-agent2` image, you can adjust the configuration of the Zabbix agent 2 by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agent2.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_agent2.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_PASSIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of passive checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_PASSIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container.
|
||||
|
||||
### `ZBX_ACTIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of active checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_ACTIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container. You may specify port of Zabbix server or Zabbix proxy in such syntax: ``zabbix-server:10061,zabbix-proxy:10072``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agent2.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``3``.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEPERSISTENTBUFFER=false # Available since 5.0.0
|
||||
ZBX_PERSISTENTBUFFERPERIOD=1h # Available since 5.0.0
|
||||
ZBX_ENABLESTATUSPORT=
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HEARTBEAT_FREQUENCY=60 # Available since 6.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Deprecated since 5.0.0
|
||||
ZBX_LOGREMOTECOMMANDS=0
|
||||
ZBX_STARTAGENTS=3
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=120
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=100
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_agent2.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
|
||||
|
||||
Please use official documentation for [``zabbix_agent2.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agent2) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix agent 2 container
|
||||
|
||||
### ``/etc/zabbix/zabbix_agentd.d``
|
||||
|
||||
The volume allows include ``*.conf`` files and extend Zabbix agent 2 using ``UserParameter`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/buffer``
|
||||
|
||||
The volume is used to store the file, where Zabbix Agent2 should keep SQLite database. To enable the feature specify ``ZBX_ENABLEPERSISTENTBUFFER=true``. Available since 5.0.0.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-agent2` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-agent2:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-agent2:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-agent2:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`agent2/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/agent2) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/trunk/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable. Please use ``/etc/zabbix/zabbix_agent.d`` volume with additional configuration files with ``Alias`` options.
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/agent2/ubuntu/README.md
Symbolic link
1
Dockerfiles/agent2/ubuntu/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,225 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix agent 2?
|
||||
|
||||
Zabbix agent 2 is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).
|
||||
|
||||
# Zabbix agent 2 images
|
||||
|
||||
These are the only official Zabbix agent 2 Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8, Oracle Linux 8, Windows 10 LTSC 2019 and Windows 11 LTSC 2022 images. The available versions of Zabbix agent 2 are:
|
||||
|
||||
Zabbix agent 2 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest , ltsc2019-5.0-latest, ltsc2022-5.0-latest)
|
||||
Zabbix agent 2 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*, ltsc2019-5.0.*, ltsc2022-5.0.*)
|
||||
Zabbix agent 2 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix agent 2 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*, ltsc2019-6.0.*, ltsc2022-6.0.*)
|
||||
Zabbix agent 2 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, ltsc2019-latest, ltsc2022-latest, latest)
|
||||
Zabbix agent 2 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.0.*, ltsc2019-6.2.*, ltsc2022-6.2.*)
|
||||
Zabbix agent 2 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk, ltsc2019-trunk, ltsc2022-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-agent2`
|
||||
|
||||
Start a Zabbix agent 2 container as follows:
|
||||
|
||||
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent2:tag
|
||||
|
||||
Where `some-zabbix-agent2` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server or proxy and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-agent2/tags/).
|
||||
|
||||
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)
|
||||
|
||||
This image exposes the standard Zabbix agent 2 port (``10050``) to perform passive checks, so container linking makes Zabbix agent 2 instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent 2 container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent2 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server or Zabbix proxy containers (Active checks)
|
||||
|
||||
This image supports perform active checks, so container linking makes Zabbix server and Zabbix proxy containers available to Zabbix agent 2 instance. Start your application container like this in order to link Zabbix agent 2 to Zabbix server or Zabbix proxy containterns:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix agent 2 logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-agent2` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-agent /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix agent 2 log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-agent
|
||||
```
|
||||
|
||||
## Privileged mode
|
||||
|
||||
By default, Docker containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent 2 is designed to monitor system resources, to do that Zabbix agent 2 container must be privileged or you may mount some system-wide volumes. For example:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server --privileged -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
```console
|
||||
$ docker run --name some-zabbix-agent --link some-zabbix-server:zabbix-server -v /dev/sdc:/dev/sdc -d zabbix/zabbix-agent2:latest
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-agent2` image, you can adjust the configuration of the Zabbix agent 2 by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agent2.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_agent2.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_PASSIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of passive checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_PASSIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container.
|
||||
|
||||
### `ZBX_ACTIVE_ALLOW`
|
||||
|
||||
This variable is boolean (``true`` or ``false``) and enables or disables feature of active checks. By default, value is `true`.
|
||||
|
||||
### `ZBX_ACTIVESERVERS`
|
||||
|
||||
The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container. You may specify port of Zabbix server or Zabbix proxy in such syntax: ``zabbix-server:10061,zabbix-proxy:10072``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agent2.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``3``.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEPERSISTENTBUFFER=false # Available since 5.0.0
|
||||
ZBX_PERSISTENTBUFFERPERIOD=1h # Available since 5.0.0
|
||||
ZBX_ENABLESTATUSPORT=
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HEARTBEAT_FREQUENCY=60 # Available since 6.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Deprecated since 5.0.0
|
||||
ZBX_LOGREMOTECOMMANDS=0
|
||||
ZBX_STARTAGENTS=3
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=120
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=100
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_agent2.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
|
||||
|
||||
Please use official documentation for [``zabbix_agent2.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agent2) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix agent 2 container
|
||||
|
||||
### ``/etc/zabbix/zabbix_agentd.d``
|
||||
|
||||
The volume allows include ``*.conf`` files and extend Zabbix agent 2 using ``UserParameter`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/buffer``
|
||||
|
||||
The volume is used to store the file, where Zabbix Agent2 should keep SQLite database. To enable the feature specify ``ZBX_ENABLEPERSISTENTBUFFER=true``. Available since 5.0.0.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-agent2` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-agent2:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-agent2:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-agent2:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`agent2/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/agent2) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/trunk/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable. Please use ``/etc/zabbix/zabbix_agent.d`` volume with additional configuration files with ``Alias`` options.
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/agent2/windows/README.md
Symbolic link
1
Dockerfiles/agent2/windows/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
79
Dockerfiles/build-base/README.md
Normal file
79
Dockerfiles/build-base/README.md
Normal file
@ -0,0 +1,79 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base?
|
||||
|
||||
Zabbix build base image is prepared build environment for building Zabbix components. It contains all required packages, binaries and tools.
|
||||
|
||||
# Zabbix build base images
|
||||
|
||||
These are the only official Zabbix build base Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*, ltsc2019-6.2.*, ltsc2022-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*, ltsc2019-6.4.*, ltsc2022-6.4.*)
|
||||
Zabbix build base 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk, ltsc2019-trunk, ltsc2022-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is required to build Zabbix components. It is base image for [MySQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-mysql), [PostgreSQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-pgsql) and [SQLite3](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-sqlite3) base images. While the image contains only required packages, MySQL, PostgreSQL and SQLite3 base images compile Zabbix component and prepare them for usage.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-base` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-base:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-base:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-base:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,77 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base?
|
||||
|
||||
Zabbix build base image is prepared build environment for building Zabbix components. It contains all required packages, binaries and tools.
|
||||
|
||||
# Zabbix build base images
|
||||
|
||||
These are the only official Zabbix build base Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is required to build Zabbix components. It is base image for [MySQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-mysql), [PostgreSQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-pgsql) and [SQLite3](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-sqlite3) base images. While the image contains only required packages, MySQL, PostgreSQL and SQLite3 base images compile Zabbix component and prepare them for usage.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-base` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-base:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-base:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-base:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-base/alpine/README.md
Symbolic link
1
Dockerfiles/build-base/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,77 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base?
|
||||
|
||||
Zabbix build base image is prepared build environment for building Zabbix components. It contains all required packages, binaries and tools.
|
||||
|
||||
# Zabbix build base images
|
||||
|
||||
These are the only official Zabbix build base Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is required to build Zabbix components. It is base image for [MySQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-mysql), [PostgreSQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-pgsql) and [SQLite3](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-sqlite3) base images. While the image contains only required packages, MySQL, PostgreSQL and SQLite3 base images compile Zabbix component and prepare them for usage.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-base` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-base:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-base:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-base:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-base/centos/README.md
Symbolic link
1
Dockerfiles/build-base/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,77 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base?
|
||||
|
||||
Zabbix build base image is prepared build environment for building Zabbix components. It contains all required packages, binaries and tools.
|
||||
|
||||
# Zabbix build base images
|
||||
|
||||
These are the only official Zabbix build base Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is required to build Zabbix components. It is base image for [MySQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-mysql), [PostgreSQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-pgsql) and [SQLite3](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-sqlite3) base images. While the image contains only required packages, MySQL, PostgreSQL and SQLite3 base images compile Zabbix component and prepare them for usage.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-base` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-base:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-base:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-base:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-base/ol/README.md
Symbolic link
1
Dockerfiles/build-base/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,77 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base?
|
||||
|
||||
Zabbix build base image is prepared build environment for building Zabbix components. It contains all required packages, binaries and tools.
|
||||
|
||||
# Zabbix build base images
|
||||
|
||||
These are the only official Zabbix build base Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is required to build Zabbix components. It is base image for [MySQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-mysql), [PostgreSQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-pgsql) and [SQLite3](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-sqlite3) base images. While the image contains only required packages, MySQL, PostgreSQL and SQLite3 base images compile Zabbix component and prepare them for usage.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-base` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-base:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-base:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-base:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-base/rhel/README.md
Symbolic link
1
Dockerfiles/build-base/rhel/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,77 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base?
|
||||
|
||||
Zabbix build base image is prepared build environment for building Zabbix components. It contains all required packages, binaries and tools.
|
||||
|
||||
# Zabbix build base images
|
||||
|
||||
These are the only official Zabbix build base Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is required to build Zabbix components. It is base image for [MySQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-mysql), [PostgreSQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-pgsql) and [SQLite3](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-sqlite3) base images. While the image contains only required packages, MySQL, PostgreSQL and SQLite3 base images compile Zabbix component and prepare them for usage.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-base` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-base:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-base:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-base:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-base/ubuntu/README.md
Symbolic link
1
Dockerfiles/build-base/ubuntu/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,77 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base?
|
||||
|
||||
Zabbix build base image is prepared build environment for building Zabbix components. It contains all required packages, binaries and tools.
|
||||
|
||||
# Zabbix build base images
|
||||
|
||||
These are the only official Zabbix build base Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is required to build Zabbix components. It is base image for [MySQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-mysql), [PostgreSQL](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-pgsql) and [SQLite3](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-sqlite3) base images. While the image contains only required packages, MySQL, PostgreSQL and SQLite3 base images compile Zabbix component and prepare them for usage.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-base` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-base:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-base:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-base:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-base/windows/README.md
Symbolic link
1
Dockerfiles/build-base/windows/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
83
Dockerfiles/build-mysql/README.md
Normal file
83
Dockerfiles/build-mysql/README.md
Normal file
@ -0,0 +1,83 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (MySQL)?
|
||||
|
||||
Zabbix build base (MySQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (MySQL) images
|
||||
|
||||
These are the only official Zabbix build base (MySQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*)
|
||||
Zabbix build base 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (MySQL)?
|
||||
|
||||
Zabbix build base (MySQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (MySQL) images
|
||||
|
||||
These are the only official Zabbix build base (MySQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-mysql/alpine/README.md
Symbolic link
1
Dockerfiles/build-mysql/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (MySQL)?
|
||||
|
||||
Zabbix build base (MySQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (MySQL) images
|
||||
|
||||
These are the only official Zabbix build base (MySQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-mysql/centos/README.md
Symbolic link
1
Dockerfiles/build-mysql/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (MySQL)?
|
||||
|
||||
Zabbix build base (MySQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (MySQL) images
|
||||
|
||||
These are the only official Zabbix build base (MySQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-mysql/ol/README.md
Symbolic link
1
Dockerfiles/build-mysql/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (MySQL)?
|
||||
|
||||
Zabbix build base (MySQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (MySQL) images
|
||||
|
||||
These are the only official Zabbix build base (MySQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-mysql/rhel/README.md
Symbolic link
1
Dockerfiles/build-mysql/rhel/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (MySQL)?
|
||||
|
||||
Zabbix build base (MySQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (MySQL) images
|
||||
|
||||
These are the only official Zabbix build base (MySQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-mysql/ubuntu/README.md
Symbolic link
1
Dockerfiles/build-mysql/ubuntu/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (MySQL)?
|
||||
|
||||
Zabbix build base (MySQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (MySQL) images
|
||||
|
||||
These are the only official Zabbix build base (MySQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-mysql/windows/README.md
Symbolic link
1
Dockerfiles/build-mysql/windows/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
83
Dockerfiles/build-pgsql/README.md
Normal file
83
Dockerfiles/build-pgsql/README.md
Normal file
@ -0,0 +1,83 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (PostgreSQL)?
|
||||
|
||||
Zabbix build base (PostgreSQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (PostgreSQL) images
|
||||
|
||||
These are the only official Zabbix build base (PostgreSQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*)
|
||||
Zabbix build base 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-pgsql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-pgsql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-pgsql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-pgsql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (PostgreSQL)?
|
||||
|
||||
Zabbix build base (PostgreSQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (PostgreSQL) images
|
||||
|
||||
These are the only official Zabbix build base (PostgreSQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-pgsql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-pgsql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-pgsql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-pgsql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-pgsql/alpine/README.md
Symbolic link
1
Dockerfiles/build-pgsql/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (PostgreSQL)?
|
||||
|
||||
Zabbix build base (PostgreSQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (PostgreSQL) images
|
||||
|
||||
These are the only official Zabbix build base (PostgreSQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-pgsql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-pgsql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-pgsql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-pgsql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-pgsql/centos/README.md
Symbolic link
1
Dockerfiles/build-pgsql/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (PostgreSQL)?
|
||||
|
||||
Zabbix build base (PostgreSQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (PostgreSQL) images
|
||||
|
||||
These are the only official Zabbix build base (PostgreSQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-pgsql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-pgsql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-pgsql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-pgsql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-pgsql/ol/README.md
Symbolic link
1
Dockerfiles/build-pgsql/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,81 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (PostgreSQL)?
|
||||
|
||||
Zabbix build base (PostgreSQL) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (PostgreSQL) images
|
||||
|
||||
These are the only official Zabbix build base (PostgreSQL) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-pgsql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-pgsql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-pgsql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-pgsql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-pgsql/ubuntu/README.md
Symbolic link
1
Dockerfiles/build-pgsql/ubuntu/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
89
Dockerfiles/build-sqlite3/README.md
Normal file
89
Dockerfiles/build-sqlite3/README.md
Normal file
@ -0,0 +1,89 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (SQLite3)?
|
||||
|
||||
Zabbix build base (SQLite3) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (SQLite3) images
|
||||
|
||||
These are the only official Zabbix build base (SQLite3) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*)
|
||||
Zabbix build base 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
It contains limited prepared Zabbix components while MySQL and PostgreSQL build base images contain all possible components:
|
||||
* zabbix-agent
|
||||
* zabbix-agent2
|
||||
* zabbix-proxy-sqlite3
|
||||
* zabbix-java-gateway
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,87 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (SQLite3)?
|
||||
|
||||
Zabbix build base (SQLite3) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (SQLite3) images
|
||||
|
||||
These are the only official Zabbix build base (SQLite3) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
It contains limited prepared Zabbix components while MySQL and PostgreSQL build base images contain all possible components:
|
||||
* zabbix-agent
|
||||
* zabbix-agent2
|
||||
* zabbix-proxy-sqlite3
|
||||
* zabbix-java-gateway
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-sqlite3/alpine/README.md
Symbolic link
1
Dockerfiles/build-sqlite3/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,87 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (SQLite3)?
|
||||
|
||||
Zabbix build base (SQLite3) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (SQLite3) images
|
||||
|
||||
These are the only official Zabbix build base (SQLite3) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
It contains limited prepared Zabbix components while MySQL and PostgreSQL build base images contain all possible components:
|
||||
* zabbix-agent
|
||||
* zabbix-agent2
|
||||
* zabbix-proxy-sqlite3
|
||||
* zabbix-java-gateway
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-sqlite3/centos/README.md
Symbolic link
1
Dockerfiles/build-sqlite3/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,87 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (SQLite3)?
|
||||
|
||||
Zabbix build base (SQLite3) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (SQLite3) images
|
||||
|
||||
These are the only official Zabbix build base (SQLite3) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
It contains limited prepared Zabbix components while MySQL and PostgreSQL build base images contain all possible components:
|
||||
* zabbix-agent
|
||||
* zabbix-agent2
|
||||
* zabbix-proxy-sqlite3
|
||||
* zabbix-java-gateway
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-sqlite3/ol/README.md
Symbolic link
1
Dockerfiles/build-sqlite3/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,87 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (SQLite3)?
|
||||
|
||||
Zabbix build base (SQLite3) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (SQLite3) images
|
||||
|
||||
These are the only official Zabbix build base (SQLite3) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
It contains limited prepared Zabbix components while MySQL and PostgreSQL build base images contain all possible components:
|
||||
* zabbix-agent
|
||||
* zabbix-agent2
|
||||
* zabbix-proxy-sqlite3
|
||||
* zabbix-java-gateway
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-sqlite3/rhel/README.md
Symbolic link
1
Dockerfiles/build-sqlite3/rhel/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,87 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix build base (SQLite3)?
|
||||
|
||||
Zabbix build base (SQLite3) image is used for building Zabbix components. It contains compiled Zabbix components.
|
||||
|
||||
# Zabbix build base (SQLite3) images
|
||||
|
||||
These are the only official Zabbix build base (SQLite3) Docker images. They are based on Alpine Linux v3.15, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of the image are:
|
||||
|
||||
Zabbix build base 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix build base 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix build base 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix build base 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix build base 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix build base 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix build base 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix build base 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix build base 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
The image is used to build / compile Zabbix components. Components are prepared for usage in any other images.
|
||||
|
||||
The image uses [Zabbix build base](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) image with prepared build environment as base image and build / compile Zabbix components only.
|
||||
|
||||
It contains limited prepared Zabbix components while MySQL and PostgreSQL build base images contain all possible components:
|
||||
* zabbix-agent
|
||||
* zabbix-agent2
|
||||
* zabbix-proxy-sqlite3
|
||||
* zabbix-java-gateway
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-build-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-build-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-build-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-build-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`build-base/` directory](https://github.com/zabbix/zabbix-docker/tree/trunk/Dockerfiles/build-base) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/build-sqlite3/ubuntu/README.md
Symbolic link
1
Dockerfiles/build-sqlite3/ubuntu/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
135
Dockerfiles/java-gateway/README.md
Normal file
135
Dockerfiles/java-gateway/README.md
Normal file
@ -0,0 +1,135 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix Java Gateway?
|
||||
|
||||
Zabbix Java Gateway performs native support for monitoring JMX applications. Java gateway accepts incoming connection from Zabbix server or Zabbix proxy and can only be used as a "passive proxy".
|
||||
|
||||
# Zabbix Java Gateway images
|
||||
|
||||
These are the only official Zabbix Java Gateway Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix Java Gateway are:
|
||||
|
||||
Zabbix Java Gateway 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix Java Gateway 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix Java Gateway 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix Java Gateway 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix Java Gateway 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix Java Gateway 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix Java Gateway 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix Java Gateway 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix Java Gateway 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix Java Gateway 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*)
|
||||
Zabbix Java Gateway 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-java-gateway`
|
||||
|
||||
Start a Zabbix Java Gateway container as follows:
|
||||
|
||||
docker run --name some-zabbix-java-gateway -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
Where `some-zabbix-java-gateway` is the name you want to assign to your container and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-java-gateway/tags/).
|
||||
|
||||
## Linking the container to Zabbix server or Zabbix proxy
|
||||
|
||||
docker run --name some-zabbix-java-gateway --link some-zabbix-server:zabbix-server -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
## Container shell access and viewing Zabbix Java Gateway logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-java-gateway` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-java-gateway /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix Java Gateway log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-java-gateway
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-java-gateway` image, you can adjust the configuration of the Zabbix Java Gateway by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_START_POLLERS`
|
||||
|
||||
This variable is specified amount of pollers. By default, value is `5`.
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
This variable is used to specify timeout for outgoing connections. By default, value is `3`.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
This variable is used to specify log level. By default, value is `info`. The variable allows next values: ``trace``, ``debug``, ``info``, ``want``, ``error``, ``all``, ``off``
|
||||
|
||||
### `ZBX_PROPERTIES_FILE`
|
||||
|
||||
Name of properties file. Can be used to set additional properties using a key-value format in such a way that they are not visible on a command line or to overwrite existing ones.
|
||||
|
||||
### `ZABBIX_OPTIONS`
|
||||
|
||||
Additional arguments for Zabbix Java Gateway. Useful to enable additional libraries and features.
|
||||
|
||||
## Allowed volumes for the Zabbix Java Gateway container
|
||||
|
||||
### ``/usr/sbin/zabbix_java/ext_lib``
|
||||
|
||||
The volume allows include additional JAR files to extend allowed protocols for Zabbix Java Gateway.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-java-gateway` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-java-gateway:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-java-gateway:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-java-gateway:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`java-gateway/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/java-gateway) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,133 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix Java Gateway?
|
||||
|
||||
Zabbix Java Gateway performs native support for monitoring JMX applications. Java gateway accepts incoming connection from Zabbix server or Zabbix proxy and can only be used as a "passive proxy".
|
||||
|
||||
# Zabbix Java Gateway images
|
||||
|
||||
These are the only official Zabbix Java Gateway Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix Java Gateway are:
|
||||
|
||||
Zabbix Java Gateway 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix Java Gateway 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix Java Gateway 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix Java Gateway 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix Java Gateway 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix Java Gateway 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix Java Gateway 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix Java Gateway 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix Java Gateway 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-java-gateway`
|
||||
|
||||
Start a Zabbix Java Gateway container as follows:
|
||||
|
||||
docker run --name some-zabbix-java-gateway -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
Where `some-zabbix-java-gateway` is the name you want to assign to your container and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-java-gateway/tags/).
|
||||
|
||||
## Linking the container to Zabbix server or Zabbix proxy
|
||||
|
||||
docker run --name some-zabbix-java-gateway --link some-zabbix-server:zabbix-server -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
## Container shell access and viewing Zabbix Java Gateway logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-java-gateway` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-java-gateway /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix Java Gateway log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-java-gateway
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-java-gateway` image, you can adjust the configuration of the Zabbix Java Gateway by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_START_POLLERS`
|
||||
|
||||
This variable is specified amount of pollers. By default, value is `5`.
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
This variable is used to specify timeout for outgoing connections. By default, value is `3`.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
This variable is used to specify log level. By default, value is `info`. The variable allows next values: ``trace``, ``debug``, ``info``, ``want``, ``error``, ``all``, ``off``
|
||||
|
||||
### `ZBX_PROPERTIES_FILE`
|
||||
|
||||
Name of properties file. Can be used to set additional properties using a key-value format in such a way that they are not visible on a command line or to overwrite existing ones.
|
||||
|
||||
### `ZABBIX_OPTIONS`
|
||||
|
||||
Additional arguments for Zabbix Java Gateway. Useful to enable additional libraries and features.
|
||||
|
||||
## Allowed volumes for the Zabbix Java Gateway container
|
||||
|
||||
### ``/usr/sbin/zabbix_java/ext_lib``
|
||||
|
||||
The volume allows include additional JAR files to extend allowed protocols for Zabbix Java Gateway.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-java-gateway` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-java-gateway:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-java-gateway:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-java-gateway:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`java-gateway/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/java-gateway) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/java-gateway/alpine/README.md
Symbolic link
1
Dockerfiles/java-gateway/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,133 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix Java Gateway?
|
||||
|
||||
Zabbix Java Gateway performs native support for monitoring JMX applications. Java gateway accepts incoming connection from Zabbix server or Zabbix proxy and can only be used as a "passive proxy".
|
||||
|
||||
# Zabbix Java Gateway images
|
||||
|
||||
These are the only official Zabbix Java Gateway Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix Java Gateway are:
|
||||
|
||||
Zabbix Java Gateway 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix Java Gateway 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix Java Gateway 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix Java Gateway 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix Java Gateway 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix Java Gateway 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix Java Gateway 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix Java Gateway 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix Java Gateway 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-java-gateway`
|
||||
|
||||
Start a Zabbix Java Gateway container as follows:
|
||||
|
||||
docker run --name some-zabbix-java-gateway -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
Where `some-zabbix-java-gateway` is the name you want to assign to your container and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-java-gateway/tags/).
|
||||
|
||||
## Linking the container to Zabbix server or Zabbix proxy
|
||||
|
||||
docker run --name some-zabbix-java-gateway --link some-zabbix-server:zabbix-server -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
## Container shell access and viewing Zabbix Java Gateway logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-java-gateway` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-java-gateway /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix Java Gateway log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-java-gateway
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-java-gateway` image, you can adjust the configuration of the Zabbix Java Gateway by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_START_POLLERS`
|
||||
|
||||
This variable is specified amount of pollers. By default, value is `5`.
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
This variable is used to specify timeout for outgoing connections. By default, value is `3`.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
This variable is used to specify log level. By default, value is `info`. The variable allows next values: ``trace``, ``debug``, ``info``, ``want``, ``error``, ``all``, ``off``
|
||||
|
||||
### `ZBX_PROPERTIES_FILE`
|
||||
|
||||
Name of properties file. Can be used to set additional properties using a key-value format in such a way that they are not visible on a command line or to overwrite existing ones.
|
||||
|
||||
### `ZABBIX_OPTIONS`
|
||||
|
||||
Additional arguments for Zabbix Java Gateway. Useful to enable additional libraries and features.
|
||||
|
||||
## Allowed volumes for the Zabbix Java Gateway container
|
||||
|
||||
### ``/usr/sbin/zabbix_java/ext_lib``
|
||||
|
||||
The volume allows include additional JAR files to extend allowed protocols for Zabbix Java Gateway.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-java-gateway` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-java-gateway:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-java-gateway:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-java-gateway:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`java-gateway/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/java-gateway) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/java-gateway/centos/README.md
Symbolic link
1
Dockerfiles/java-gateway/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,133 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix Java Gateway?
|
||||
|
||||
Zabbix Java Gateway performs native support for monitoring JMX applications. Java gateway accepts incoming connection from Zabbix server or Zabbix proxy and can only be used as a "passive proxy".
|
||||
|
||||
# Zabbix Java Gateway images
|
||||
|
||||
These are the only official Zabbix Java Gateway Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix Java Gateway are:
|
||||
|
||||
Zabbix Java Gateway 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix Java Gateway 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix Java Gateway 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix Java Gateway 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix Java Gateway 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix Java Gateway 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix Java Gateway 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix Java Gateway 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix Java Gateway 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-java-gateway`
|
||||
|
||||
Start a Zabbix Java Gateway container as follows:
|
||||
|
||||
docker run --name some-zabbix-java-gateway -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
Where `some-zabbix-java-gateway` is the name you want to assign to your container and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-java-gateway/tags/).
|
||||
|
||||
## Linking the container to Zabbix server or Zabbix proxy
|
||||
|
||||
docker run --name some-zabbix-java-gateway --link some-zabbix-server:zabbix-server -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
## Container shell access and viewing Zabbix Java Gateway logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-java-gateway` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-java-gateway /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix Java Gateway log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-java-gateway
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-java-gateway` image, you can adjust the configuration of the Zabbix Java Gateway by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_START_POLLERS`
|
||||
|
||||
This variable is specified amount of pollers. By default, value is `5`.
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
This variable is used to specify timeout for outgoing connections. By default, value is `3`.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
This variable is used to specify log level. By default, value is `info`. The variable allows next values: ``trace``, ``debug``, ``info``, ``want``, ``error``, ``all``, ``off``
|
||||
|
||||
### `ZBX_PROPERTIES_FILE`
|
||||
|
||||
Name of properties file. Can be used to set additional properties using a key-value format in such a way that they are not visible on a command line or to overwrite existing ones.
|
||||
|
||||
### `ZABBIX_OPTIONS`
|
||||
|
||||
Additional arguments for Zabbix Java Gateway. Useful to enable additional libraries and features.
|
||||
|
||||
## Allowed volumes for the Zabbix Java Gateway container
|
||||
|
||||
### ``/usr/sbin/zabbix_java/ext_lib``
|
||||
|
||||
The volume allows include additional JAR files to extend allowed protocols for Zabbix Java Gateway.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-java-gateway` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-java-gateway:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-java-gateway:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-java-gateway:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`java-gateway/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/java-gateway) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/java-gateway/ol/README.md
Symbolic link
1
Dockerfiles/java-gateway/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,133 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix Java Gateway?
|
||||
|
||||
Zabbix Java Gateway performs native support for monitoring JMX applications. Java gateway accepts incoming connection from Zabbix server or Zabbix proxy and can only be used as a "passive proxy".
|
||||
|
||||
# Zabbix Java Gateway images
|
||||
|
||||
These are the only official Zabbix Java Gateway Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix Java Gateway are:
|
||||
|
||||
Zabbix Java Gateway 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix Java Gateway 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix Java Gateway 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix Java Gateway 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix Java Gateway 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix Java Gateway 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix Java Gateway 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix Java Gateway 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix Java Gateway 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-java-gateway`
|
||||
|
||||
Start a Zabbix Java Gateway container as follows:
|
||||
|
||||
docker run --name some-zabbix-java-gateway -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
Where `some-zabbix-java-gateway` is the name you want to assign to your container and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-java-gateway/tags/).
|
||||
|
||||
## Linking the container to Zabbix server or Zabbix proxy
|
||||
|
||||
docker run --name some-zabbix-java-gateway --link some-zabbix-server:zabbix-server -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
## Container shell access and viewing Zabbix Java Gateway logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-java-gateway` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-java-gateway /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix Java Gateway log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-java-gateway
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-java-gateway` image, you can adjust the configuration of the Zabbix Java Gateway by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_START_POLLERS`
|
||||
|
||||
This variable is specified amount of pollers. By default, value is `5`.
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
This variable is used to specify timeout for outgoing connections. By default, value is `3`.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
This variable is used to specify log level. By default, value is `info`. The variable allows next values: ``trace``, ``debug``, ``info``, ``want``, ``error``, ``all``, ``off``
|
||||
|
||||
### `ZBX_PROPERTIES_FILE`
|
||||
|
||||
Name of properties file. Can be used to set additional properties using a key-value format in such a way that they are not visible on a command line or to overwrite existing ones.
|
||||
|
||||
### `ZABBIX_OPTIONS`
|
||||
|
||||
Additional arguments for Zabbix Java Gateway. Useful to enable additional libraries and features.
|
||||
|
||||
## Allowed volumes for the Zabbix Java Gateway container
|
||||
|
||||
### ``/usr/sbin/zabbix_java/ext_lib``
|
||||
|
||||
The volume allows include additional JAR files to extend allowed protocols for Zabbix Java Gateway.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-java-gateway` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-java-gateway:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-java-gateway:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-java-gateway:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`java-gateway/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/java-gateway) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/java-gateway/rhel/README.md
Symbolic link
1
Dockerfiles/java-gateway/rhel/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,133 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix Java Gateway?
|
||||
|
||||
Zabbix Java Gateway performs native support for monitoring JMX applications. Java gateway accepts incoming connection from Zabbix server or Zabbix proxy and can only be used as a "passive proxy".
|
||||
|
||||
# Zabbix Java Gateway images
|
||||
|
||||
These are the only official Zabbix Java Gateway Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix Java Gateway are:
|
||||
|
||||
Zabbix Java Gateway 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix Java Gateway 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix Java Gateway 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix Java Gateway 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix Java Gateway 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix Java Gateway 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix Java Gateway 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix Java Gateway 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix Java Gateway 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-java-gateway`
|
||||
|
||||
Start a Zabbix Java Gateway container as follows:
|
||||
|
||||
docker run --name some-zabbix-java-gateway -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
Where `some-zabbix-java-gateway` is the name you want to assign to your container and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-java-gateway/tags/).
|
||||
|
||||
## Linking the container to Zabbix server or Zabbix proxy
|
||||
|
||||
docker run --name some-zabbix-java-gateway --link some-zabbix-server:zabbix-server -d zabbix/zabbix-java-gateway:tag
|
||||
|
||||
## Container shell access and viewing Zabbix Java Gateway logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-java-gateway` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-java-gateway /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix Java Gateway log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-java-gateway
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-java-gateway` image, you can adjust the configuration of the Zabbix Java Gateway by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_START_POLLERS`
|
||||
|
||||
This variable is specified amount of pollers. By default, value is `5`.
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
This variable is used to specify timeout for outgoing connections. By default, value is `3`.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
This variable is used to specify log level. By default, value is `info`. The variable allows next values: ``trace``, ``debug``, ``info``, ``want``, ``error``, ``all``, ``off``
|
||||
|
||||
### `ZBX_PROPERTIES_FILE`
|
||||
|
||||
Name of properties file. Can be used to set additional properties using a key-value format in such a way that they are not visible on a command line or to overwrite existing ones.
|
||||
|
||||
### `ZABBIX_OPTIONS`
|
||||
|
||||
Additional arguments for Zabbix Java Gateway. Useful to enable additional libraries and features.
|
||||
|
||||
## Allowed volumes for the Zabbix Java Gateway container
|
||||
|
||||
### ``/usr/sbin/zabbix_java/ext_lib``
|
||||
|
||||
The volume allows include additional JAR files to extend allowed protocols for Zabbix Java Gateway.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-java-gateway` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-java-gateway:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-java-gateway:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-java-gateway:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`java-gateway/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/java-gateway) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/java-gateway/ubuntu/README.md
Symbolic link
1
Dockerfiles/java-gateway/ubuntu/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
319
Dockerfiles/proxy-mysql/README.md
Normal file
319
Dockerfiles/proxy-mysql/README.md
Normal file
@ -0,0 +1,319 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*)
|
||||
Zabbix proxy 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database to store collected data before sending it to Zabbix server. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix proxy database schema if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-mysql`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
|
||||
Where `some-zabbix-proxy-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-mysql/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-mysql:zabbix-proxy-mysql -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-mysql --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-mysql:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-mysql` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-mysql` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix proxy to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -e ZBX_SERVER_HOST="some-zabbix-server" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix_proxy`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### ``ZBX_DEBUGLEVEL``
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,317 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database to store collected data before sending it to Zabbix server. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix proxy database schema if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-mysql`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
|
||||
Where `some-zabbix-proxy-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-mysql/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-mysql:zabbix-proxy-mysql -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-mysql --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-mysql:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-mysql` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-mysql` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix proxy to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -e ZBX_SERVER_HOST="some-zabbix-server" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix_proxy`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### ``ZBX_DEBUGLEVEL``
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-mysql/alpine/README.md
Symbolic link
1
Dockerfiles/proxy-mysql/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,317 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database to store collected data before sending it to Zabbix server. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix proxy database schema if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-mysql`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
|
||||
Where `some-zabbix-proxy-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-mysql/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-mysql:zabbix-proxy-mysql -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-mysql --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-mysql:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-mysql` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-mysql` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix proxy to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -e ZBX_SERVER_HOST="some-zabbix-server" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix_proxy`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### ``ZBX_DEBUGLEVEL``
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-mysql/centos/README.md
Symbolic link
1
Dockerfiles/proxy-mysql/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,317 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database to store collected data before sending it to Zabbix server. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix proxy database schema if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-mysql`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
|
||||
Where `some-zabbix-proxy-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-mysql/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-mysql:zabbix-proxy-mysql -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-mysql --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-mysql:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-mysql` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-mysql` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix proxy to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -e ZBX_SERVER_HOST="some-zabbix-server" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix_proxy`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### ``ZBX_DEBUGLEVEL``
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-mysql/ol/README.md
Symbolic link
1
Dockerfiles/proxy-mysql/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,317 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database to store collected data before sending it to Zabbix server. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix proxy database schema if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-mysql`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
|
||||
Where `some-zabbix-proxy-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-mysql/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-mysql:zabbix-proxy-mysql -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-mysql --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-mysql:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-mysql` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-mysql` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix proxy to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -e ZBX_SERVER_HOST="some-zabbix-server" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix_proxy`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### ``ZBX_DEBUGLEVEL``
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-mysql/rhel/README.md
Symbolic link
1
Dockerfiles/proxy-mysql/rhel/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,317 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database to store collected data before sending it to Zabbix server. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix proxy database schema if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-mysql`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
|
||||
Where `some-zabbix-proxy-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-mysql/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-mysql:zabbix-proxy-mysql -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-mysql --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-mysql:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-mysql` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-mysql` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix proxy to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -e ZBX_SERVER_HOST="some-zabbix-server" -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix_proxy`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### ``ZBX_DEBUGLEVEL``
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-mysql/ubuntu/README.md
Symbolic link
1
Dockerfiles/proxy-mysql/ubuntu/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
277
Dockerfiles/proxy-sqlite3/README.md
Normal file
277
Dockerfiles/proxy-sqlite3/README.md
Normal file
@ -0,0 +1,277 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*)
|
||||
Zabbix proxy 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses SQLite3 database to store collected data before sending it to Zabbix server.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-sqlite3`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-sqlite3 -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-sqlite3:tag
|
||||
|
||||
Where `some-zabbix-proxy-sqlite3` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-sqlite3/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-sqlite3:zabbix-proxy-sqlite3 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-sqlite3 --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-sqlite3:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-sqlite3` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-sqlite3 /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-sqlite3
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-sqlite3` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-sqlite3` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/db_data``
|
||||
|
||||
The volume stores SQLite3 database file and could be used for external database file storage.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-sqlite3/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-sqlite3) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,275 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses SQLite3 database to store collected data before sending it to Zabbix server.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-sqlite3`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-sqlite3 -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-sqlite3:tag
|
||||
|
||||
Where `some-zabbix-proxy-sqlite3` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-sqlite3/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-sqlite3:zabbix-proxy-sqlite3 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-sqlite3 --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-sqlite3:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-sqlite3` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-sqlite3 /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-sqlite3
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-sqlite3` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-sqlite3` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/db_data``
|
||||
|
||||
The volume stores SQLite3 database file and could be used for external database file storage.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-sqlite3/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-sqlite3) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-sqlite3/alpine/README.md
Symbolic link
1
Dockerfiles/proxy-sqlite3/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,275 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses SQLite3 database to store collected data before sending it to Zabbix server.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-sqlite3`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-sqlite3 -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-sqlite3:tag
|
||||
|
||||
Where `some-zabbix-proxy-sqlite3` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-sqlite3/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-sqlite3:zabbix-proxy-sqlite3 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-sqlite3 --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-sqlite3:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-sqlite3` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-sqlite3 /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-sqlite3
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-sqlite3` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-sqlite3` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/db_data``
|
||||
|
||||
The volume stores SQLite3 database file and could be used for external database file storage.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-sqlite3/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-sqlite3) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-sqlite3/centos/README.md
Symbolic link
1
Dockerfiles/proxy-sqlite3/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,275 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses SQLite3 database to store collected data before sending it to Zabbix server.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-sqlite3`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-sqlite3 -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-sqlite3:tag
|
||||
|
||||
Where `some-zabbix-proxy-sqlite3` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-sqlite3/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-sqlite3:zabbix-proxy-sqlite3 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-sqlite3 --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-sqlite3:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-sqlite3` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-sqlite3 /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-sqlite3
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-sqlite3` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-sqlite3` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/db_data``
|
||||
|
||||
The volume stores SQLite3 database file and could be used for external database file storage.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-sqlite3/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-sqlite3) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-sqlite3/ol/README.md
Symbolic link
1
Dockerfiles/proxy-sqlite3/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,275 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses SQLite3 database to store collected data before sending it to Zabbix server.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-sqlite3`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-sqlite3 -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-sqlite3:tag
|
||||
|
||||
Where `some-zabbix-proxy-sqlite3` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-sqlite3/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-sqlite3:zabbix-proxy-sqlite3 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-sqlite3 --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-sqlite3:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-sqlite3` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-sqlite3 /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-sqlite3
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-sqlite3` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-sqlite3` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/db_data``
|
||||
|
||||
The volume stores SQLite3 database file and could be used for external database file storage.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-sqlite3/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-sqlite3) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-sqlite3/rhel/README.md
Symbolic link
1
Dockerfiles/proxy-sqlite3/rhel/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,275 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix proxy?
|
||||
|
||||
Zabbix proxy is a process that may collect monitoring data from one or more monitored devices and send the information to the Zabbix server, essentially working on behalf of the server. All collected data is buffered locally and then transferred to the Zabbix server the proxy belongs to.
|
||||
|
||||
# Zabbix proxy images
|
||||
|
||||
These are the only official Zabbix proxy Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix proxy are:
|
||||
|
||||
Zabbix proxy 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix proxy 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix proxy 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix proxy 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix proxy 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix proxy 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix proxy 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix proxy 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix proxy 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses SQLite3 database to store collected data before sending it to Zabbix server.
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-proxy-sqlite3`
|
||||
|
||||
Start a Zabbix proxy container as follows:
|
||||
|
||||
docker run --name some-zabbix-proxy-sqlite3 -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-sqlite3:tag
|
||||
|
||||
Where `some-zabbix-proxy-sqlite3` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix proxy configuration file, `some-zabbix-server` is IP or DNS name of Zabbix server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-proxy-sqlite3/tags/).
|
||||
|
||||
## Connects from Zabbix server (Passive proxy)
|
||||
|
||||
This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case `ZBX_PROXYMODE` = `1`. Start Zabbix server container like this in order to link it to the Zabbix proxy container:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-server --link some-zabbix-proxy-sqlite3:zabbix-proxy-sqlite3 -d zabbix/zabbix-server:latest
|
||||
```
|
||||
|
||||
## Connect to Zabbix server (Active proxy)
|
||||
|
||||
This image can operate as Active proxy (`default` mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:
|
||||
|
||||
```console
|
||||
$ docker run --name some-zabbix-proxy-sqlite3 --link some-zabbix-server:zabbix-server -d zabbix/zabbix-proxy-sqlite3:latest
|
||||
```
|
||||
|
||||
## Container shell access and viewing Zabbix proxy logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-proxy-sqlite3` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-proxy-sqlite3 /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix proxy log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-proxy-sqlite3
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-proxy-sqlite3` image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `ZBX_PROXYMODE`
|
||||
|
||||
The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - active proxy. Allowed values are `0` - active proxy and `1` - passive proxy.
|
||||
|
||||
### `ZBX_HOSTNAME`
|
||||
|
||||
This variable is unique, case sensitive hostname. By default, value is `zabbix-proxy-sqlite3` of the container. It is ``Hostname`` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### `ZBX_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is `zabbix-server`. It is ``Server`` parameter in ``zabbix_proxy.conf``. It is allowed to specify Zabbix server or Zabbix proxy port number using ``ZBX_SERVER_PORT`` variable. It make sense in case of non-default port for active checks.
|
||||
|
||||
### `ZBX_SERVER_PORT`
|
||||
|
||||
This variable is port Zabbix server listening on. By default, value is `10051`.
|
||||
|
||||
**Note:** This parameter is no longer used in version 6.0 and above. Instead, add a colon ``:`` followed by the port number to the end of ``ZBX_SERVER_HOST``.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_LOGREMOTECOMMANDS=0 # Available since 3.4.0
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_PROXYLOCALBUFFER=0
|
||||
ZBX_PROXYOFFLINEBUFFER=1
|
||||
ZBX_PROXYHEARTBEATFREQUENCY=60
|
||||
ZBX_CONFIGFREQUENCY=3600
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 4.2.0
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=1 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_proxy.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix proxy container
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/db_data``
|
||||
|
||||
The volume stores SQLite3 database file and could be used for external database file storage.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix proxy using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_proxy.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-proxy-sqlite3` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-proxy-sqlite3:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-proxy-sqlite3:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-proxy-sqlite3:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`proxy-sqlite3/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/proxy-sqlite3) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/proxy-sqlite3/ubuntu/README.md
Symbolic link
1
Dockerfiles/proxy-sqlite3/ubuntu/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
309
Dockerfiles/server-mysql/README.md
Normal file
309
Dockerfiles/server-mysql/README.md
Normal file
@ -0,0 +1,309 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix server?
|
||||
|
||||
Zabbix server is the central process of Zabbix software.
|
||||
|
||||
The server performs the polling and trapping of data, it calculates triggers, sends notifications to users. It is the central component to which Zabbix agents and proxies report data on availability and integrity of systems. The server can itself remotely check networked services (such as web servers and mail servers) using simple service checks.
|
||||
|
||||
# Zabbix server images
|
||||
|
||||
These are the only official Zabbix server Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix server are:
|
||||
|
||||
Zabbix server 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix server 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix server 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix server 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix server 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix server 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix server 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest)
|
||||
Zabbix server 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix server 6.4 (tags: alpine-6.4-latest, ubuntu-6.4-latest, ol-6.4-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix server 6.4.* (tags: alpine-6.4.*, ubuntu-6.4.*, ol-6.4.*)
|
||||
Zabbix server 7.0 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix server database schema and upload initial data sample if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-server-mysql`
|
||||
|
||||
Start a Zabbix server container as follows:
|
||||
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -d zabbix/zabbix-server-mysql:tag
|
||||
|
||||
Where `some-zabbix-server-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-server-mysql/tags/).
|
||||
|
||||
## Container shell access and viewing Zabbix server logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-server-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-server-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix server log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-server-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-server-mysql` image, you can adjust the configuration of the Zabbix server by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix server to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_STARTREPORTWRITERS=0 # Available since 5.4.0
|
||||
ZBX_WEBSERVICEURL=http://zabbix-web-service:10053/report # Available since 5.4.0
|
||||
ZBX_SERVICEMANAGERSYNCFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_HISTORYSTORAGEURL= # Available since 3.4.0
|
||||
ZBX_HISTORYSTORAGETYPES=uint,dbl,str,log,text # Available since 3.4.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 3.4.0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=5 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_STARTTIMERS=1
|
||||
ZBX_STARTESCALATORS=1
|
||||
ZBX_STARTALERTERS=3 # Available since 3.4.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=5
|
||||
ZBX_STARTLLDPROCESSORS=2 # Available since 4.2.0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_MAXHOUSEKEEPERDELETE=5000
|
||||
ZBX_PROBLEMHOUSEKEEPINGFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_SENDERFREQUENCY=30
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_CACHEUPDATEFREQUENCY=60
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_EXPORTFILESIZE=1G # Available since 4.0.0
|
||||
ZBX_EXPORTTYPE= # Available since 5.0.10 and 5.2.6
|
||||
ZBX_AUTOHANODENAME=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_HANODENAME= # Available since 6.0.0
|
||||
ZBX_AUTONODEADDRESS=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_NODEADDRESSPORT=10051 # Allowed to use with ZBX_AUTONODEADDRESS variable only. Available since 6.0.0
|
||||
ZBX_NODEADDRESS=localhost # Available since 6.0.0
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_HISTORYSTORAGEDATEINDEX=0 # Available since 4.0.0
|
||||
ZBX_TRENDCACHESIZE=4M
|
||||
ZBX_TRENDFUNCTIONCACHESIZE=4M
|
||||
ZBX_VALUECACHESIZE=8M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_STARTPROXYPOLLERS=1
|
||||
ZBX_PROXYCONFIGFREQUENCY=3600
|
||||
ZBX_PROXYDATAFREQUENCY=1
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_server.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_server.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix server container
|
||||
|
||||
### ``/usr/lib/zabbix/alertscripts``
|
||||
|
||||
The volume is used for custom alert scripts. It is `AlertScriptsPath` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix server using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix server.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
### ``/var/lib/zabbix/export``
|
||||
|
||||
Directory for real-time export of events, history and trends in newline-delimited JSON format. Could be enabled using ``ZBX_EXPORTFILESIZE`` environment variable.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-server-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-server-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-server-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-server-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`server-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/server-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
@ -1,307 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix server?
|
||||
|
||||
Zabbix server is the central process of Zabbix software.
|
||||
|
||||
The server performs the polling and trapping of data, it calculates triggers, sends notifications to users. It is the central component to which Zabbix agents and proxies report data on availability and integrity of systems. The server can itself remotely check networked services (such as web servers and mail servers) using simple service checks.
|
||||
|
||||
# Zabbix server images
|
||||
|
||||
These are the only official Zabbix server Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix server are:
|
||||
|
||||
Zabbix server 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix server 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix server 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix server 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix server 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix server 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix server 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix server 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix server 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix server database schema and upload initial data sample if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-server-mysql`
|
||||
|
||||
Start a Zabbix server container as follows:
|
||||
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -d zabbix/zabbix-server-mysql:tag
|
||||
|
||||
Where `some-zabbix-server-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-server-mysql/tags/).
|
||||
|
||||
## Container shell access and viewing Zabbix server logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-server-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-server-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix server log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-server-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-server-mysql` image, you can adjust the configuration of the Zabbix server by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix server to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_STARTREPORTWRITERS=0 # Available since 5.4.0
|
||||
ZBX_WEBSERVICEURL=http://zabbix-web-service:10053/report # Available since 5.4.0
|
||||
ZBX_SERVICEMANAGERSYNCFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_HISTORYSTORAGEURL= # Available since 3.4.0
|
||||
ZBX_HISTORYSTORAGETYPES=uint,dbl,str,log,text # Available since 3.4.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 3.4.0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=5 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_STARTTIMERS=1
|
||||
ZBX_STARTESCALATORS=1
|
||||
ZBX_STARTALERTERS=3 # Available since 3.4.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=5
|
||||
ZBX_STARTLLDPROCESSORS=2 # Available since 4.2.0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_MAXHOUSEKEEPERDELETE=5000
|
||||
ZBX_PROBLEMHOUSEKEEPINGFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_SENDERFREQUENCY=30
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_CACHEUPDATEFREQUENCY=60
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_EXPORTFILESIZE=1G # Available since 4.0.0
|
||||
ZBX_EXPORTTYPE= # Available since 5.0.10 and 5.2.6
|
||||
ZBX_AUTOHANODENAME=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_HANODENAME= # Available since 6.0.0
|
||||
ZBX_AUTONODEADDRESS=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_NODEADDRESSPORT=10051 # Allowed to use with ZBX_AUTONODEADDRESS variable only. Available since 6.0.0
|
||||
ZBX_NODEADDRESS=localhost # Available since 6.0.0
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_HISTORYSTORAGEDATEINDEX=0 # Available since 4.0.0
|
||||
ZBX_TRENDCACHESIZE=4M
|
||||
ZBX_TRENDFUNCTIONCACHESIZE=4M
|
||||
ZBX_VALUECACHESIZE=8M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_STARTPROXYPOLLERS=1
|
||||
ZBX_PROXYCONFIGFREQUENCY=3600
|
||||
ZBX_PROXYDATAFREQUENCY=1
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_server.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_server.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix server container
|
||||
|
||||
### ``/usr/lib/zabbix/alertscripts``
|
||||
|
||||
The volume is used for custom alert scripts. It is `AlertScriptsPath` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix server using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix server.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
### ``/var/lib/zabbix/export``
|
||||
|
||||
Directory for real-time export of events, history and trends in newline-delimited JSON format. Could be enabled using ``ZBX_EXPORTFILESIZE`` environment variable.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-server-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-server-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-server-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-server-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`server-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/server-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/server-mysql/alpine/README.md
Symbolic link
1
Dockerfiles/server-mysql/alpine/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,307 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix server?
|
||||
|
||||
Zabbix server is the central process of Zabbix software.
|
||||
|
||||
The server performs the polling and trapping of data, it calculates triggers, sends notifications to users. It is the central component to which Zabbix agents and proxies report data on availability and integrity of systems. The server can itself remotely check networked services (such as web servers and mail servers) using simple service checks.
|
||||
|
||||
# Zabbix server images
|
||||
|
||||
These are the only official Zabbix server Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix server are:
|
||||
|
||||
Zabbix server 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix server 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix server 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix server 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix server 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix server 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix server 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix server 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix server 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix server database schema and upload initial data sample if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-server-mysql`
|
||||
|
||||
Start a Zabbix server container as follows:
|
||||
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -d zabbix/zabbix-server-mysql:tag
|
||||
|
||||
Where `some-zabbix-server-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-server-mysql/tags/).
|
||||
|
||||
## Container shell access and viewing Zabbix server logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-server-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-server-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix server log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-server-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-server-mysql` image, you can adjust the configuration of the Zabbix server by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix server to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_STARTREPORTWRITERS=0 # Available since 5.4.0
|
||||
ZBX_WEBSERVICEURL=http://zabbix-web-service:10053/report # Available since 5.4.0
|
||||
ZBX_SERVICEMANAGERSYNCFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_HISTORYSTORAGEURL= # Available since 3.4.0
|
||||
ZBX_HISTORYSTORAGETYPES=uint,dbl,str,log,text # Available since 3.4.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 3.4.0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=5 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_STARTTIMERS=1
|
||||
ZBX_STARTESCALATORS=1
|
||||
ZBX_STARTALERTERS=3 # Available since 3.4.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=5
|
||||
ZBX_STARTLLDPROCESSORS=2 # Available since 4.2.0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_MAXHOUSEKEEPERDELETE=5000
|
||||
ZBX_PROBLEMHOUSEKEEPINGFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_SENDERFREQUENCY=30
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_CACHEUPDATEFREQUENCY=60
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_EXPORTFILESIZE=1G # Available since 4.0.0
|
||||
ZBX_EXPORTTYPE= # Available since 5.0.10 and 5.2.6
|
||||
ZBX_AUTOHANODENAME=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_HANODENAME= # Available since 6.0.0
|
||||
ZBX_AUTONODEADDRESS=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_NODEADDRESSPORT=10051 # Allowed to use with ZBX_AUTONODEADDRESS variable only. Available since 6.0.0
|
||||
ZBX_NODEADDRESS=localhost # Available since 6.0.0
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_HISTORYSTORAGEDATEINDEX=0 # Available since 4.0.0
|
||||
ZBX_TRENDCACHESIZE=4M
|
||||
ZBX_TRENDFUNCTIONCACHESIZE=4M
|
||||
ZBX_VALUECACHESIZE=8M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_STARTPROXYPOLLERS=1
|
||||
ZBX_PROXYCONFIGFREQUENCY=3600
|
||||
ZBX_PROXYDATAFREQUENCY=1
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_server.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_server.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix server container
|
||||
|
||||
### ``/usr/lib/zabbix/alertscripts``
|
||||
|
||||
The volume is used for custom alert scripts. It is `AlertScriptsPath` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix server using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix server.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
### ``/var/lib/zabbix/export``
|
||||
|
||||
Directory for real-time export of events, history and trends in newline-delimited JSON format. Could be enabled using ``ZBX_EXPORTFILESIZE`` environment variable.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-server-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-server-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-server-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-server-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`server-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/server-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/server-mysql/centos/README.md
Symbolic link
1
Dockerfiles/server-mysql/centos/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,307 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix server?
|
||||
|
||||
Zabbix server is the central process of Zabbix software.
|
||||
|
||||
The server performs the polling and trapping of data, it calculates triggers, sends notifications to users. It is the central component to which Zabbix agents and proxies report data on availability and integrity of systems. The server can itself remotely check networked services (such as web servers and mail servers) using simple service checks.
|
||||
|
||||
# Zabbix server images
|
||||
|
||||
These are the only official Zabbix server Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix server are:
|
||||
|
||||
Zabbix server 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix server 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix server 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix server 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix server 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix server 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix server 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix server 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix server 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix server database schema and upload initial data sample if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-server-mysql`
|
||||
|
||||
Start a Zabbix server container as follows:
|
||||
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -d zabbix/zabbix-server-mysql:tag
|
||||
|
||||
Where `some-zabbix-server-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-server-mysql/tags/).
|
||||
|
||||
## Container shell access and viewing Zabbix server logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-server-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-server-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix server log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-server-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-server-mysql` image, you can adjust the configuration of the Zabbix server by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix server to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_STARTREPORTWRITERS=0 # Available since 5.4.0
|
||||
ZBX_WEBSERVICEURL=http://zabbix-web-service:10053/report # Available since 5.4.0
|
||||
ZBX_SERVICEMANAGERSYNCFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_HISTORYSTORAGEURL= # Available since 3.4.0
|
||||
ZBX_HISTORYSTORAGETYPES=uint,dbl,str,log,text # Available since 3.4.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 3.4.0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=5 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_STARTTIMERS=1
|
||||
ZBX_STARTESCALATORS=1
|
||||
ZBX_STARTALERTERS=3 # Available since 3.4.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=5
|
||||
ZBX_STARTLLDPROCESSORS=2 # Available since 4.2.0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_MAXHOUSEKEEPERDELETE=5000
|
||||
ZBX_PROBLEMHOUSEKEEPINGFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_SENDERFREQUENCY=30
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_CACHEUPDATEFREQUENCY=60
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_EXPORTFILESIZE=1G # Available since 4.0.0
|
||||
ZBX_EXPORTTYPE= # Available since 5.0.10 and 5.2.6
|
||||
ZBX_AUTOHANODENAME=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_HANODENAME= # Available since 6.0.0
|
||||
ZBX_AUTONODEADDRESS=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_NODEADDRESSPORT=10051 # Allowed to use with ZBX_AUTONODEADDRESS variable only. Available since 6.0.0
|
||||
ZBX_NODEADDRESS=localhost # Available since 6.0.0
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_HISTORYSTORAGEDATEINDEX=0 # Available since 4.0.0
|
||||
ZBX_TRENDCACHESIZE=4M
|
||||
ZBX_TRENDFUNCTIONCACHESIZE=4M
|
||||
ZBX_VALUECACHESIZE=8M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_STARTPROXYPOLLERS=1
|
||||
ZBX_PROXYCONFIGFREQUENCY=3600
|
||||
ZBX_PROXYDATAFREQUENCY=1
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_server.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_server.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix server container
|
||||
|
||||
### ``/usr/lib/zabbix/alertscripts``
|
||||
|
||||
The volume is used for custom alert scripts. It is `AlertScriptsPath` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix server using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix server.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
### ``/var/lib/zabbix/export``
|
||||
|
||||
Directory for real-time export of events, history and trends in newline-delimited JSON format. Could be enabled using ``ZBX_EXPORTFILESIZE`` environment variable.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-server-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-server-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-server-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-server-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`server-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/server-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
1
Dockerfiles/server-mysql/ol/README.md
Symbolic link
1
Dockerfiles/server-mysql/ol/README.md
Symbolic link
@ -0,0 +1 @@
|
||||
../README.md
|
||||
@ -1,307 +0,0 @@
|
||||
|
||||
|
||||
# What is Zabbix?
|
||||
|
||||
Zabbix is an enterprise-class open source distributed monitoring solution.
|
||||
|
||||
Zabbix is software that monitors numerous parameters of a network and the health and integrity of servers. Zabbix uses a flexible notification mechanism that allows users to configure e-mail based alerts for virtually any event. This allows a fast reaction to server problems. Zabbix offers excellent reporting and data visualisation features based on the stored data. This makes Zabbix ideal for capacity planning.
|
||||
|
||||
For more information and related downloads for Zabbix components, please visit https://hub.docker.com/u/zabbix/ and https://zabbix.com
|
||||
|
||||
# What is Zabbix server?
|
||||
|
||||
Zabbix server is the central process of Zabbix software.
|
||||
|
||||
The server performs the polling and trapping of data, it calculates triggers, sends notifications to users. It is the central component to which Zabbix agents and proxies report data on availability and integrity of systems. The server can itself remotely check networked services (such as web servers and mail servers) using simple service checks.
|
||||
|
||||
# Zabbix server images
|
||||
|
||||
These are the only official Zabbix server Docker images. They are based on Alpine Linux v3.12, Ubuntu 20.04 (focal), 22.04 (jammy), CentOS Stream 8 and Oracle Linux 8 images. The available versions of Zabbix server are:
|
||||
|
||||
Zabbix server 4.0 (tags: alpine-4.0-latest, ubuntu-4.0-latest, centos-4.0-latest)
|
||||
Zabbix server 4.0.* (tags: alpine-4.0.*, ubuntu-4.0.*, centos-4.0.*)
|
||||
Zabbix server 5.0 (tags: alpine-5.0-latest, ubuntu-5.0-latest, ol-5.0-latest)
|
||||
Zabbix server 5.0.* (tags: alpine-5.0.*, ubuntu-5.0.*, ol-5.0.*)
|
||||
Zabbix server 6.0 (tags: alpine-6.0-latest, ubuntu-6.0-latest, ol-6.0-latest)
|
||||
Zabbix server 6.0.* (tags: alpine-6.0.*, ubuntu-6.0.*, ol-6.0.*)
|
||||
Zabbix server 6.2 (tags: alpine-6.2-latest, ubuntu-6.2-latest, ol-6.2-latest, alpine-latest, ubuntu-latest, ol-latest, latest)
|
||||
Zabbix server 6.2.* (tags: alpine-6.2.*, ubuntu-6.2.*, ol-6.2.*)
|
||||
Zabbix server 6.4 (tags: alpine-trunk, ubuntu-trunk, ol-trunk)
|
||||
|
||||
Images are updated when new releases are published. The image with ``latest`` tag is based on Alpine Linux.
|
||||
|
||||
The image uses MySQL database. It uses the next procedure to start:
|
||||
- Checking database availability
|
||||
- If ``MYSQL_ROOT_PASSWORD`` or ``MYSQL_ALLOW_EMPTY_PASSWORD`` are specified, the instance tries to create ``MYSQL_USER`` user with ``MYSQL_PASSWORD`` to use these credentials then for Zabbix server.
|
||||
- Checking of having `MYSQL_DATABASE` database. Creating `MYSQL_DATABASE` database name if it does not exist
|
||||
- Checking of having `dbversion` table. Creating Zabbix server database schema and upload initial data sample if no `dbversion` table
|
||||
|
||||
# How to use this image
|
||||
|
||||
## Start `zabbix-server-mysql`
|
||||
|
||||
Start a Zabbix server container as follows:
|
||||
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER="some-user" -e MYSQL_PASSWORD="some-password" -d zabbix/zabbix-server-mysql:tag
|
||||
|
||||
Where `some-zabbix-server-mysql` is the name you want to assign to your container, `some-mysql-server` is IP or DNS name of MySQL server, `some-user` is user to connect to Zabbix database on MySQL server, `some-password` is the password to connect to MySQL server and `tag` is the tag specifying the version you want. See the list above for relevant tags, or look at the [full list of tags](https://hub.docker.com/r/zabbix/zabbix-server-mysql/tags/).
|
||||
|
||||
## Container shell access and viewing Zabbix server logs
|
||||
|
||||
The `docker exec` command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside your `zabbix-server-mysql` container:
|
||||
|
||||
```console
|
||||
$ docker exec -ti some-zabbix-server-mysql /bin/bash
|
||||
```
|
||||
|
||||
The Zabbix server log is available through Docker's container log:
|
||||
|
||||
```console
|
||||
$ docker logs some-zabbix-server-mysql
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
|
||||
When you start the `zabbix-server-mysql` image, you can adjust the configuration of the Zabbix server by passing one or more environment variables on the `docker run` command line.
|
||||
|
||||
### `DB_SERVER_HOST`
|
||||
|
||||
This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'
|
||||
|
||||
### `DB_SERVER_PORT`
|
||||
|
||||
This variable is port of MySQL server. By default, value is '3306'.
|
||||
|
||||
### `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_USER_FILE`, `MYSQL_PASSWORD_FILE`
|
||||
|
||||
These variables are used by Zabbix server to connect to Zabbix database. With the `_FILE` variables you can instead provide the path to a file which contains the user / the password instead. Without Docker Swarm or Kubernetes you also have to map the files. Those are exclusive so you can just provide one type - either `MYSQL_USER` or `MYSQL_USER_FILE`!
|
||||
|
||||
```console
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -v ./.MYSQL_USER:/run/secrets/MYSQL_USER -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -v ./.MYSQL_PASSWORD:/run/secrets/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/var/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!
|
||||
|
||||
```console
|
||||
printf "zabbix" | docker secret create MYSQL_USER -
|
||||
printf "zabbix" | docker secret create MYSQL_PASSWORD -
|
||||
docker run --name some-zabbix-server-mysql -e DB_SERVER_HOST="some-mysql-server" -e MYSQL_USER_FILE=/run/secrets/MYSQL_USER -e MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD -d zabbix/zabbix-server-mysql:tag
|
||||
```
|
||||
|
||||
This method is also applicable for `MYSQL_ROOT_PASSWORD` with `MYSQL_ROOT_PASSWORD_FILE`.
|
||||
|
||||
By default, values for `MYSQL_USER` and `MYSQL_PASSWORD` are `zabbix`, `zabbix`.
|
||||
|
||||
### `MYSQL_DATABASE`
|
||||
|
||||
The variable is Zabbix database name. By default, value is `zabbix`.
|
||||
|
||||
### `ZBX_LOADMODULE`
|
||||
|
||||
The variable is list of comma separated loadable Zabbix modules. It works with volume ``/var/lib/zabbix/modules``. The syntax of the variable is ``dummy1.so,dummy2.so``.
|
||||
|
||||
### `ZBX_DEBUGLEVEL`
|
||||
|
||||
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_server.conf``. Allowed values are listed below:
|
||||
- ``0`` - basic information about starting and stopping of Zabbix processes;
|
||||
- ``1`` - critical information
|
||||
- ``2`` - error information
|
||||
- ``3`` - warnings
|
||||
- ``4`` - for debugging (produces lots of information)
|
||||
- ``5`` - extended debugging (produces even more information)
|
||||
|
||||
### `ZBX_TIMEOUT`
|
||||
|
||||
The variable is used to specify timeout for processing checks. By default, value is ``4``.
|
||||
|
||||
### `ZBX_JAVAGATEWAY_ENABLE`
|
||||
|
||||
The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.
|
||||
|
||||
### Other variables
|
||||
|
||||
Additionally the image allows to specify many other environment variables listed below:
|
||||
|
||||
```
|
||||
ZBX_ALLOWUNSUPPORTEDDBVERSIONS=0 # Available since 6.0.0
|
||||
ZBX_DBTLSCONNECT= # Available since 5.0.0
|
||||
ZBX_DBTLSCAFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCERTFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSKEYFILE= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER= # Available since 5.0.0
|
||||
ZBX_DBTLSCIPHER13= # Available since 5.0.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10051
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_STARTREPORTWRITERS=0 # Available since 5.4.0
|
||||
ZBX_WEBSERVICEURL=http://zabbix-web-service:10053/report # Available since 5.4.0
|
||||
ZBX_SERVICEMANAGERSYNCFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_HISTORYSTORAGEURL= # Available since 3.4.0
|
||||
ZBX_HISTORYSTORAGETYPES=uint,dbl,str,log,text # Available since 3.4.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_IPMIPOLLERS=0
|
||||
ZBX_STARTPREPROCESSORS=3 # Available since 3.4.0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=1
|
||||
ZBX_STARTHISTORYPOLLERS=5 # Available since 5.4.0
|
||||
ZBX_STARTHTTPPOLLERS=1
|
||||
ZBX_STARTODBCPOLLERS=1 # Available since 6.0.0
|
||||
ZBX_STARTTIMERS=1
|
||||
ZBX_STARTESCALATORS=1
|
||||
ZBX_STARTALERTERS=3 # Available since 3.4.0
|
||||
ZBX_JAVAGATEWAY=zabbix-java-gateway
|
||||
ZBX_JAVAGATEWAYPORT=10052
|
||||
ZBX_STARTJAVAPOLLERS=5
|
||||
ZBX_STARTLLDPROCESSORS=2 # Available since 4.2.0
|
||||
ZBX_STATSALLOWEDIP= # Available since 4.0.5
|
||||
ZBX_STARTVMWARECOLLECTORS=0
|
||||
ZBX_VMWAREFREQUENCY=60
|
||||
ZBX_VMWAREPERFFREQUENCY=60
|
||||
ZBX_VMWARECACHESIZE=8M
|
||||
ZBX_VMWARETIMEOUT=10
|
||||
ZBX_ENABLE_SNMP_TRAPS=false
|
||||
ZBX_SOURCEIP=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_MAXHOUSEKEEPERDELETE=5000
|
||||
ZBX_PROBLEMHOUSEKEEPINGFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_SENDERFREQUENCY=30
|
||||
ZBX_CACHESIZE=8M
|
||||
ZBX_CACHEUPDATEFREQUENCY=60
|
||||
ZBX_STARTDBSYNCERS=4
|
||||
ZBX_EXPORTFILESIZE=1G # Available since 4.0.0
|
||||
ZBX_EXPORTTYPE= # Available since 5.0.10 and 5.2.6
|
||||
ZBX_AUTOHANODENAME=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_HANODENAME= # Available since 6.0.0
|
||||
ZBX_AUTONODEADDRESS=fqdn # Allowed values: fqdn, hostname. Available since 6.0.0
|
||||
ZBX_NODEADDRESSPORT=10051 # Allowed to use with ZBX_AUTONODEADDRESS variable only. Available since 6.0.0
|
||||
ZBX_NODEADDRESS=localhost # Available since 6.0.0
|
||||
ZBX_HISTORYCACHESIZE=16M
|
||||
ZBX_HISTORYINDEXCACHESIZE=4M
|
||||
ZBX_HISTORYSTORAGEDATEINDEX=0 # Available since 4.0.0
|
||||
ZBX_TRENDCACHESIZE=4M
|
||||
ZBX_TRENDFUNCTIONCACHESIZE=4M
|
||||
ZBX_VALUECACHESIZE=8M
|
||||
ZBX_TRAPPERTIMEOUT=300
|
||||
ZBX_UNREACHABLEPERIOD=45
|
||||
ZBX_UNAVAILABLEDELAY=60
|
||||
ZBX_UNREACHABLEDELAY=15
|
||||
ZBX_LOGSLOWQUERIES=3000
|
||||
ZBX_STARTPROXYPOLLERS=1
|
||||
ZBX_PROXYCONFIGFREQUENCY=3600
|
||||
ZBX_PROXYDATAFREQUENCY=1
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSCIPHERALL= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERALL13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERCERT13= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK= # Available since 4.4.7
|
||||
ZBX_TLSCIPHERPSK13= # Available since 4.4.7
|
||||
|
||||
```
|
||||
|
||||
Default values of these variables are specified after equal sign.
|
||||
|
||||
The allowed variables are identical of parameters in official ``zabbix_server.conf``. For example, ``ZBX_LOGSLOWQUERIES`` = ``LogSlowQueries``.
|
||||
|
||||
Please use official documentation for [``zabbix_server.conf``](https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server) to get more information about the variables.
|
||||
|
||||
## Allowed volumes for the Zabbix server container
|
||||
|
||||
### ``/usr/lib/zabbix/alertscripts``
|
||||
|
||||
The volume is used for custom alert scripts. It is `AlertScriptsPath` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/usr/lib/zabbix/externalscripts``
|
||||
|
||||
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/modules``
|
||||
|
||||
The volume allows load additional modules and extend Zabbix server using ``LoadModule`` feature.
|
||||
|
||||
### ``/var/lib/zabbix/enc``
|
||||
|
||||
The volume is used to store TLS related files. These file names are specified using ``ZBX_TLSCAFILE``, ``ZBX_TLSCRLFILE``, ``ZBX_TLSKEY_FILE`` and ``ZBX_TLSPSKFILE`` variables.
|
||||
|
||||
### ``/var/lib/zabbix/ssh_keys``
|
||||
|
||||
The volume is used as location of public and private keys for SSH checks and actions. It is `SSHKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/certs``
|
||||
|
||||
The volume is used as location of of SSL client certificate files for client authentication. It is `SSLCertLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/keys``
|
||||
|
||||
The volume is used as location of SSL private key files for client authentication. It is `SSLKeyLocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/ssl/ssl_ca``
|
||||
|
||||
The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is `SSLCALocation` parameter in ``zabbix_server.conf``.
|
||||
|
||||
### ``/var/lib/zabbix/snmptraps``
|
||||
|
||||
The volume is used as location of ``snmptraps.log`` file. It could be shared by ``zabbix-snmptraps`` container and inherited using `volumes_from` Docker option while creating new instance of Zabbix server.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched ``ZBX_ENABLE_SNMP_TRAPS`` environment variable to `true`.
|
||||
|
||||
### ``/var/lib/zabbix/mibs``
|
||||
|
||||
The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to ``/var/lib/zabbix/mibs``.
|
||||
|
||||
### ``/var/lib/zabbix/export``
|
||||
|
||||
Directory for real-time export of events, history and trends in newline-delimited JSON format. Could be enabled using ``ZBX_EXPORTFILESIZE`` environment variable.
|
||||
|
||||
# The image variants
|
||||
|
||||
The `zabbix-server-mysql` images come in many flavors, each designed for a specific use case.
|
||||
|
||||
## `zabbix-server-mysql:alpine-<version>`
|
||||
|
||||
This image is based on the popular [Alpine Linux project](http://alpinelinux.org), available in [the `alpine` official image](https://hub.docker.com/_/alpine). Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
|
||||
|
||||
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use [musl libc](http://www.musl-libc.org) instead of [glibc and friends](http://www.etalabs.net/compare_libcs.html), so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See [this Hacker News comment thread](https://news.ycombinator.com/item?id=10782897) for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
|
||||
|
||||
To minimize image size, it's uncommon for additional related tools (such as `git` or `bash`) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the [`alpine` image description](https://hub.docker.com/_/alpine/) for examples of how to install packages if you are unfamiliar).
|
||||
|
||||
## `zabbix-server-mysql:ubuntu-<version>`
|
||||
|
||||
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
|
||||
|
||||
## `zabbix-server-mysql:ol-<version>`
|
||||
|
||||
Oracle Linux is an open-source operating system available under the GNU General Public License (GPLv2). Suitable for general purpose or Oracle workloads, it benefits from rigorous testing of more than 128,000 hours per day with real-world workloads and includes unique innovations such as Ksplice for zero-downtime kernel patching, DTrace for real-time diagnostics, the powerful Btrfs file system, and more.
|
||||
|
||||
# Supported Docker versions
|
||||
|
||||
This image is officially supported on Docker version 1.12.0.
|
||||
|
||||
Support for older versions (down to 1.6) is provided on a best-effort basis.
|
||||
|
||||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this image is stored in the [`server-mysql/` directory](https://github.com/zabbix/zabbix-docker/tree/3.0/server-mysql) of the [`zabbix/zabbix-docker` GitHub repo](https://github.com/zabbix/zabbix-docker/). Be sure to familiarize yourself with the [repository's `README.md` file](https://github.com/zabbix/zabbix-docker/blob/master/README.md) before attempting a pull request.
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues).
|
||||
|
||||
### Known issues
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
|
||||
|
||||
Before you start to code, we recommend discussing your plans through a [GitHub issue](https://github.com/zabbix/zabbix-docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user