Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dotneft committed Aug 5, 2016
1 parent 52fb324 commit 3c6652e
Show file tree
Hide file tree
Showing 21 changed files with 260 additions and 184 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Please follow usage instructions of each Zabbix component image:
* [zabbix-server-pgsql](https://hub.docker.com/r/zabbix/zabbix-server-pgsql/) - Zabbix server with PostgreSQL database support
* [zabbix-web-apache-mysql](https://hub.docker.com/r/zabbix/zabbix-web-apache-mysql/) - Zabbix web interface on Apache2 web server with MySQL database support
* [zabbix-web-nginx-mysql](https://hub.docker.com/r/zabbix/zabbix-web-nginx-mysql/) - Zabbix web interface on Nginx web server with MySQL database support
* [zabbix-web-nginx-pgsql](https://hub.docker.com/r/zabbix/zabbix-server-pgsql/) - Zabbix web interface on Apache2 web server with PostgreSQL database support
* [zabbix-web-nginx-pgsql](https://hub.docker.com/r/zabbix/zabbix-server-pgsql/) - Zabbix web interface on Nginx web server with PostgreSQL database support
* [zabbix-proxy-sqlite3](https://hub.docker.com/r/zabbix/zabbix-proxy-sqlite3/) - Zabbix proxy with SQLite3 database support
* [zabbix-proxy-mysql](https://hub.docker.com/r/zabbix/zabbix-proxy-mysql/) - Zabbix proxy with MySQL database support
* [zabbix-java-gateway](https://hub.docker.com/r/zabbix/zabbix-java-gateway/) - Zabbix Java Gateway
Expand Down
28 changes: 17 additions & 11 deletions agent/alpine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ Images are updated when new releases are published. The image with ``latest`` ta

Start a Zabbix agent container as follows:

docker run --name some-zabbix-agent -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-agent:tag
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent:tag

Where `some-zabbix-agent` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 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-agent/tags/).

## Connects from Zabbix server or Zabbix proxy in other containers
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)

This image exposes the standard Zabbix agent port (10050) to perform passive checks, so container linking makes Zabbix agent instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent container:
This image exposes the standard Zabbix agent port (``10050``) to perform passive checks, so container linking makes Zabbix agent instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent container:

```console
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent -d zabbix/zabbix-server:latest
```

## Connect to Zabbix server or Zabbix proxy containers
## 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 instance. Start your application container like this in order to link Zabbix agent to Zabbix server or Zabbix proxy containterns:

Expand Down Expand Up @@ -79,7 +79,7 @@ When you start the `zabbix-agent` image, you can adjust the configuration of the

### `ZBX_HOSTNAME`

This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in zabbix_agentd.conf.
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agentd.conf``.

### `ZBX_SERVER_HOST`

Expand All @@ -105,11 +105,17 @@ The variable is comma separated list of allowed Zabbix server or proxy hosts for

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``
### `ZBX_DEBUGLEVEL`

The variable is used to specify debug level. By default, value is ``3``. Allowed values are ``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). It is ``DebugLevel`` parameter in zabbix_agentd.conf.
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agentd.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``
### `ZBX_TIMEOUT`

The variable is used to specify timeout for processing checks. By default, value is ``3``.

Expand Down Expand Up @@ -143,9 +149,9 @@ ZBX_TLSPSKFILE=

Default values of these variables are specified after equal sign.

The allowed variables are identical of parameters in official ``zabbix_agentd.conf``. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
The allowed variables are identical of parameters in official ``zabbix_agentd.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.

Please use official documentation for [`zabbix_agentd.conf`](https://www.zabbix.com/documentation/3.0/manual/appendix/config/zabbix_agentd) to get more information about the variables.
Please use official documentation for [``zabbix_agentd.conf``](https://www.zabbix.com/documentation/3.0/manual/appendix/config/zabbix_agentd) to get more information about the variables.

## Allowed volumes for the Zabbix agent container

Expand Down Expand Up @@ -197,7 +203,7 @@ If you have any problems with or questions about this image, please contact us t

### Known issues

Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable.
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

Expand Down
28 changes: 17 additions & 11 deletions agent/ubuntu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ Images are updated when new releases are published. The image with ``latest`` ta

Start a Zabbix agent container as follows:

docker run --name some-zabbix-agent -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-agent:tag
docker run --name some-zabbix-agent -e ZBX_HOSTNAME="some-hostname" -e ZBX_SERVER_HOST="some-zabbix-server" -d zabbix/zabbix-agent:tag

Where `some-zabbix-agent` is the name you want to assign to your container, `some-hostname` is the hostname, it is Hostname parameter in Zabbix agent 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-agent/tags/).

## Connects from Zabbix server or Zabbix proxy in other containers
## Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)

This image exposes the standard Zabbix agent port (10050) to perform passive checks, so container linking makes Zabbix agent instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent container:
This image exposes the standard Zabbix agent port (``10050``) to perform passive checks, so container linking makes Zabbix agent instance available to Zabbix server and Zabbix proxy containers. Start your application container like this in order to link it to the Zabbix agent container:

```console
$ docker run --name some-zabbix-server --link some-zabbix-agent:zabbix-agent -d zabbix/zabbix-server:latest
```

## Connect to Zabbix server or Zabbix proxy containers
## 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 instance. Start your application container like this in order to link Zabbix agent to Zabbix server or Zabbix proxy containterns:

Expand Down Expand Up @@ -79,7 +79,7 @@ When you start the `zabbix-agent` image, you can adjust the configuration of the

### `ZBX_HOSTNAME`

This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in zabbix_agentd.conf.
This variable is unique, case sensitive hostname. By default, value is `hostname` of the container. It is ``Hostname`` parameter in ``zabbix_agentd.conf``.

### `ZBX_SERVER_HOST`

Expand All @@ -105,11 +105,17 @@ The variable is comma separated list of allowed Zabbix server or proxy hosts for

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``
### `ZBX_DEBUGLEVEL`

The variable is used to specify debug level. By default, value is ``3``. Allowed values are ``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). It is ``DebugLevel`` parameter in zabbix_agentd.conf.
The variable is used to specify debug level. By default, value is ``3``. It is ``DebugLevel`` parameter in ``zabbix_agentd.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``
### `ZBX_TIMEOUT`

The variable is used to specify timeout for processing checks. By default, value is ``3``.

Expand Down Expand Up @@ -143,9 +149,9 @@ ZBX_TLSPSKFILE=

Default values of these variables are specified after equal sign.

The allowed variables are identical of parameters in official ``zabbix_agentd.conf``. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.
The allowed variables are identical of parameters in official ``zabbix_agentd.conf`` configuration file. For example, ``ZBX_REFRESHACTIVECHECKS`` = ``RefreshActiveChecks``.

Please use official documentation for [`zabbix_agentd.conf`](https://www.zabbix.com/documentation/3.0/manual/appendix/config/zabbix_agentd) to get more information about the variables.
Please use official documentation for [``zabbix_agentd.conf``](https://www.zabbix.com/documentation/3.0/manual/appendix/config/zabbix_agentd) to get more information about the variables.

## Allowed volumes for the Zabbix agent container

Expand Down Expand Up @@ -197,7 +203,7 @@ If you have any problems with or questions about this image, please contact us t

### Known issues

Currently it is not allowed to specify ``ZBX_ALIAS`` environment variable.
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

Expand Down
2 changes: 1 addition & 1 deletion java-gateway/alpine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ This variable is specified amount of pollers. By default, value is `5`.

This variable is used to specify timeout for outgoing connections. By default, value is `3`.

### ``ZBX_DEBUGLEVEL``
### `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``

Expand Down
2 changes: 1 addition & 1 deletion java-gateway/ubuntu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ This variable is specified amount of pollers. By default, value is `5`.

This variable is used to specify timeout for outgoing connections. By default, value is `3`.

### ``ZBX_DEBUGLEVEL``
### `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``

Expand Down
35 changes: 21 additions & 14 deletions proxy-mysql/alpine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Images are updated when new releases are published. The image with ``latest`` ta

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

Expand All @@ -33,9 +34,9 @@ The image uses MySQL database to store collected data before sending it to Zabbi

Start a Zabbix proxy container as follows:

docker run --name some-zabbix-proxy-mysql -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server -d zabbix/zabbix-proxy-mysql:tag
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-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/).
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)

Expand Down Expand Up @@ -77,7 +78,7 @@ The variable allows to switch Zabbix proxy mode. Bu default, value is `0` - acti

### `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.
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`

Expand All @@ -87,11 +88,11 @@ This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, va

This variable is port Zabbix server listening on. By default, value is `10051`.

### ``DB_SERVER_HOST``
### `DB_SERVER_HOST`

This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'

### ``DB_SERVER_PORT``
### `DB_SERVER_PORT`

This variable is port of MySQL server. By default, value is '3306'.

Expand All @@ -109,13 +110,19 @@ The variable is list of comma separated loadable Zabbix modules. It works with

### ``ZBX_DEBUGLEVEL``

The variable is used to specify debug level. By default, value is ``3``. Allowed values are ``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). It is ``DebugLevel`` parameter in zabbix_proxy.conf.
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``
### `ZBX_TIMEOUT`

The variable is used to specify timeout for processing checks. By default, value is ``4``.

### ``ZBX_JAVAGATEWAY_ENABLE``
### `ZBX_JAVAGATEWAY_ENABLE`

The variable enable communication with Zabbix Java Gateway to collect Java related checks. By default, value is `false`.

Expand Down Expand Up @@ -172,13 +179,13 @@ 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/3.0/manual/appendix/config/zabbix_proxy) to get more information about the variables.
Please use official documentation for [``zabbix_proxy.conf``](https://www.zabbix.com/documentation/3.0/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`.
The volume is used by External checks (type of items). It is `ExternalScripts` parameter in ``zabbix_proxy.conf``.

### ``/var/lib/zabbix/modules``

Expand All @@ -190,19 +197,19 @@ The volume is used to store TLS related files. These file names are specified us

### ``/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`.
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`.
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`.
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`.
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``

Expand Down
Loading

0 comments on commit 3c6652e

Please sign in to comment.