Fixed variable descriptions
This commit is contained in:
parent
2f2fb7d7ed
commit
c342362002
|
|
@ -1,55 +1,78 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-agent-">What is Zabbix agent?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix agent?</h2>
|
||||
<p>Zabbix agent is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).</p>
|
||||
<h1 id="zabbix-agent-images">Zabbix agent images</h1>
|
||||
<p>These are the only official Zabbix agent Docker images.</p>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-agent-">Start <code>zabbix-agent</code></h2>
|
||||
<h2>Zabbix agent images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-agent</code></h3>
|
||||
<p>Start a Zabbix agent container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-agent <span class="hljs-_">-e</span> ZBX_HOSTNAME=<span class="hljs-string">"some-hostname"</span> <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> --init <span class="hljs-_">-d</span> zabbix/zabbix-agent:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-agent</code> is the name you want to assign to your container, <code>some-hostname</code> is the hostname, it is Hostname parameter in Zabbix agent configuration file, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server or proxy and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h2 id="connects-from-zabbix-server-or-zabbix-proxy-in-other-containers-passive-checks-">Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)</h2>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-agent \
|
||||
-e ZBX_HOSTNAME="some-hostname" \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-agent-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-agent</code> is the name you want to assign to your container, <code>some-hostname</code> is the hostname, it is Hostname parameter in Zabbix agent configuration file, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server or proxy and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h3>Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)</h3>
|
||||
<p>This image exposes the standard Zabbix agent port (<code>10050</code>) 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:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:latest</span>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-server \
|
||||
--link some-zabbix-agent:zabbix-agent \
|
||||
--init \
|
||||
-d zabbix/zabbix-server:latest
|
||||
</code></pre>
|
||||
<h2 id="connect-to-zabbix-server-or-zabbix-proxy-containers-active-checks-">Connect to Zabbix server or Zabbix proxy containers (Active checks)</h2>
|
||||
<p>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:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent:latest</span>
|
||||
<h3>Connect to Zabbix server or Zabbix proxy containers (Active checks)</h3>
|
||||
<p>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 containers:</p>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-agent \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-agent-74:latest
|
||||
</code></pre>
|
||||
<h2 id="container-shell-access-and-viewing-zabbix-agent-logs">Container shell access and viewing Zabbix agent logs</h2>
|
||||
<h3>Container shell access and viewing Zabbix agent logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-agent</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman <span class="hljs-built_in">exec</span> -ti some-zabbix-<span class="hljs-built_in">agent</span> /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-agent /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix agent log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-agent
|
||||
<p>The Zabbix agent log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-agent
|
||||
</code></pre>
|
||||
<h2 id="privileged-mode">Privileged mode</h2>
|
||||
<p>By default, Podman containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent is designed to monitor system resources, to do that Zabbix agent container must be privileged or you may mount some system-wide volumes. For example:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">privileged</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent:latest</span>
|
||||
<h3>Privileged mode</h3>
|
||||
<p>By default, Podman containers are "unprivileged" and do not have access to the most of host resources. Zabbix agent is designed to monitor system resources, to do that Zabbix agent container must be privileged or you may mount some system-wide volumes. For example:</p>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-agent \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
--privileged \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-agent-74:latest
|
||||
</code></pre>
|
||||
<pre><code class="lang-console">$ podman run --name some-zabbix-agent --link some-zabbix-<span class="hljs-string">server:</span>zabbix-server -v <span class="hljs-regexp">/dev/</span><span class="hljs-string">sdc:</span><span class="hljs-regexp">/dev/</span>sdc --init -d zabbix/zabbix-<span class="hljs-string">agent:</span>latest
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-agent \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
-v /dev/sdc:/dev/sdc \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-agent-74:latest
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-agent</code> image, you can adjust the configuration of the Zabbix agent by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_hostname-"><code>ZBX_HOSTNAME</code></h3>
|
||||
<h4><code>ZBX_HOSTNAME</code></h4>
|
||||
<p>This variable is unique, case sensitive hostname. By default, value is <code>hostname</code> of the container. It is <code>Hostname</code> parameter in <code>zabbix_agentd.conf</code>.</p>
|
||||
<h3 id="-zbx_server_host-"><code>ZBX_SERVER_HOST</code></h3>
|
||||
<h4><code>ZBX_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is <code>zabbix-server</code>. It is <code>Server</code> parameter in <code>zabbix_agentd.conf</code>. It is allowed to specify Zabbix server or Zabbix proxy port number using <code>ZBX_SERVER_PORT</code> variable. It make sense in case of non-default port for active checks.</p>
|
||||
<h3 id="-zbx_passive_allow-"><code>ZBX_PASSIVE_ALLOW</code></h3>
|
||||
<h4><code>ZBX_PASSIVE_ALLOW</code></h4>
|
||||
<p>This variable is boolean (<code>true</code> or <code>false</code>) and enables or disables feature of passive checks. By default, value is <code>true</code>.</p>
|
||||
<h3 id="-zbx_passiveservers-"><code>ZBX_PASSIVESERVERS</code></h3>
|
||||
<h4><code>ZBX_PASSIVESERVERS</code></h4>
|
||||
<p>The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent container.</p>
|
||||
<h3 id="-zbx_active_allow-"><code>ZBX_ACTIVE_ALLOW</code></h3>
|
||||
<h4><code>ZBX_ACTIVE_ALLOW</code></h4>
|
||||
<p>This variable is boolean (<code>true</code> or <code>false</code>) and enables or disables feature of active checks. By default, value is <code>true</code>.</p>
|
||||
<h3 id="-zbx_activeservers-"><code>ZBX_ACTIVESERVERS</code></h3>
|
||||
<h4><code>ZBX_ACTIVESERVERS</code></h4>
|
||||
<p>The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent container. You may specify port of Zabbix server or Zabbix proxy in such syntax: <code>zabbix-server:10061,zabbix-proxy:10072</code>.</p>
|
||||
<h3 id="-zbx_loadmodule-"><code>ZBX_LOADMODULE</code></h3>
|
||||
<h4><code>ZBX_LOADMODULE</code></h4>
|
||||
<p>The variable is list of comma separated loadable Zabbix modules. It works with volume <code>/var/lib/zabbix/modules</code>. The syntax of the variable is <code>dummy1.so,dummy2.so</code>.</p>
|
||||
<h3 id="-zbx_debuglevel-"><code>ZBX_DEBUGLEVEL</code></h3>
|
||||
<h4><code>ZBX_DEBUGLEVEL</code></h4>
|
||||
<p>The variable is used to specify debug level. By default, value is <code>3</code>. It is <code>DebugLevel</code> parameter in <code>zabbix_agentd.conf</code>. Allowed values are listed below:</p>
|
||||
<ul>
|
||||
<li><code>0</code> - basic information about starting and stopping of Zabbix processes;</li>
|
||||
|
|
@ -59,68 +82,69 @@
|
|||
<li><code>4</code> - for debugging (produces lots of information)</li>
|
||||
<li><code>5</code> - extended debugging (produces even more information)</li>
|
||||
</ul>
|
||||
<h3 id="-zbx_timeout-"><code>ZBX_TIMEOUT</code></h3>
|
||||
<h4><code>ZBX_TIMEOUT</code></h4>
|
||||
<p>The variable is used to specify timeout for processing checks. By default, value is <code>3</code>.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_SOURCEIP</span>=
|
||||
<span class="hljs-attr">ZBX_ENABLEREMOTECOMMANDS</span>=<span class="hljs-number">0</span> # Deprecated since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_LOGREMOTECOMMANDS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HEARTBEAT_FREQUENCY</span>=<span class="hljs-number">60</span> # Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HOSTINTERFACE</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HOSTINTERFACEITEM</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTAGENTS</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_HOSTNAMEITEM</span>=system.hostname
|
||||
<span class="hljs-attr">ZBX_METADATA</span>=
|
||||
<span class="hljs-attr">ZBX_METADATAITEM</span>=
|
||||
<span class="hljs-attr">ZBX_REFRESHACTIVECHECKS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_BUFFERSEND</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_BUFFERSIZE</span>=<span class="hljs-number">100</span>
|
||||
<span class="hljs-attr">ZBX_MAXLINESPERSECOND</span>=<span class="hljs-number">20</span>
|
||||
<span class="hljs-attr">ZBX_LISTENIP</span>=
|
||||
<span class="hljs-attr">ZBX_LISTENPORT</span>=<span class="hljs-number">10050</span>
|
||||
<span class="hljs-attr">ZBX_LISTENBACKLOG</span>=
|
||||
<span class="hljs-attr">ZBX_UNSAFEUSERPARAMETERS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSCONNECT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSACCEPT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSCAFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCA</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRLFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRL</span>=
|
||||
<span class="hljs-attr">ZBX_TLSSERVERCERTISSUER</span>=
|
||||
<span class="hljs-attr">ZBX_TLSSERVERCERTSUBJECT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERTFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEYFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSKIDENTITY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSKFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSK</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_DENYKEY</span>=system.run[*] # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ALLOWKEY</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
</code></pre><p>Default values of these variables are specified after equal sign.</p>
|
||||
<pre><code>ZBX_SOURCEIP=
|
||||
ZBX_ENABLEREMOTECOMMANDS=0 # Deprecated since 5.0.0
|
||||
ZBX_LOGREMOTECOMMANDS=0
|
||||
ZBX_HEARTBEAT_FREQUENCY=60 # Available since 6.2.0
|
||||
ZBX_HOSTINTERFACE= # Available since 4.4.0
|
||||
ZBX_HOSTINTERFACEITEM= # Available since 4.4.0
|
||||
ZBX_STARTAGENTS=10
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=5
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=100
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10050
|
||||
ZBX_LISTENBACKLOG=
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCA=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCRL=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSCERT=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSKEY=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSPSK=
|
||||
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
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
</code></pre>
|
||||
<p>Default values of these variables are specified after equal sign.</p>
|
||||
<p>The allowed variables are identical of parameters in official <code>zabbix_agentd.conf</code> configuration file. For example, <code>ZBX_REFRESHACTIVECHECKS</code> = <code>RefreshActiveChecks</code>.</p>
|
||||
<p>Please use official documentation for <a href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agentd"><code>zabbix_agentd.conf</code></a> to get more information about the variables.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-agent-container">Allowed volumes for the Zabbix agent container</h2>
|
||||
<h3 id="-etc-zabbix-zabbix_agentd-d-"><code>/etc/zabbix/zabbix_agentd.d</code></h3>
|
||||
<h3>Allowed volumes for the Zabbix agent container</h3>
|
||||
<h4><code>/etc/zabbix/zabbix_agentd.d</code></h4>
|
||||
<p>The volume allows include <code>*.conf</code> files and extend Zabbix agent using <code>UserParameter</code> feature.</p>
|
||||
<h3 id="-var-lib-zabbix-modules-"><code>/var/lib/zabbix/modules</code></h3>
|
||||
<h4><code>/var/lib/zabbix/modules</code></h4>
|
||||
<p>The volume allows load additional modules and extend Zabbix agent using <code>LoadModule</code> feature.</p>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_TLSCAFILE</code>, <code>ZBX_TLSCRLFILE</code>, <code>ZBX_TLSCERTFILE</code>, <code>ZBX_TLSKEYFILE</code> and <code>ZBX_TLSPSKFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_TLSCA</code>, <code>ZBX_TLSCRL</code>, <code>ZBX_TLSCERT</code>, <code>ZBX_TLSKEY</code> and <code>ZBX_TLSPSK</code> with plaintext values.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/agent"><code>agent/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/agent"><code>agent/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h4>Known issues</h4>
|
||||
<p>Currently it is not allowed to specify <code>ZBX_ALIAS</code> environment variable. Please use <code>/etc/zabbix/zabbix_agentd.d</code> volume with additional configuration files with <code>Alias</code> options.</p>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,53 +1,76 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-agent-2-">What is Zabbix agent 2?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix agent 2?</h2>
|
||||
<p>Zabbix agent 2 is deployed on a monitoring target to actively monitor local resources and applications (hard drives, memory, processor statistics etc).</p>
|
||||
<h1 id="zabbix-agent-2-images">Zabbix agent 2 images</h1>
|
||||
<h2>Zabbix agent 2 images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-agent2-">Start <code>zabbix-agent2</code></h2>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-agent2</code></h3>
|
||||
<p>Start a Zabbix agent 2 container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-agent <span class="hljs-_">-e</span> ZBX_HOSTNAME=<span class="hljs-string">"some-hostname"</span> <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> --init <span class="hljs-_">-d</span> zabbix/zabbix-agent2:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-agent2</code> is the name you want to assign to your container, <code>some-hostname</code> is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server or proxy and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h2 id="connects-from-zabbix-server-or-zabbix-proxy-in-other-containers-passive-checks-">Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)</h2>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-agent \
|
||||
-e ZBX_HOSTNAME="some-hostname" \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-agent2-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-agent2</code> is the name you want to assign to your container, <code>some-hostname</code> is the hostname, it is Hostname parameter in Zabbix agent 2 configuration file, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server or proxy and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h3>Connects from Zabbix server or Zabbix proxy in other containers (Passive checks)</h3>
|
||||
<p>This image exposes the standard Zabbix agent 2 port (<code>10050</code>) 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:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent2</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:latest</span>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-server \
|
||||
--link some-zabbix-agent:zabbix-agent2 \
|
||||
--init \
|
||||
-d zabbix/zabbix-server:latest
|
||||
</code></pre>
|
||||
<h2 id="connect-to-zabbix-server-or-zabbix-proxy-containers-active-checks-">Connect to Zabbix server or Zabbix proxy containers (Active checks)</h2>
|
||||
<p>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:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent2:latest</span>
|
||||
<h3>Connect to Zabbix server or Zabbix proxy containers (Active checks)</h3>
|
||||
<p>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 containers:</p>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-agent \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-agent2-74:latest
|
||||
</code></pre>
|
||||
<h2 id="container-shell-access-and-viewing-zabbix-agent-2-logs">Container shell access and viewing Zabbix agent 2 logs</h2>
|
||||
<h3>Container shell access and viewing Zabbix agent 2 logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-agent2</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman <span class="hljs-built_in">exec</span> -ti some-zabbix-<span class="hljs-built_in">agent</span> /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-agent /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix agent 2 log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-agent
|
||||
<p>The Zabbix agent 2 log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-agent
|
||||
</code></pre>
|
||||
<h2 id="privileged-mode">Privileged mode</h2>
|
||||
<p>By default, Podman 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:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">privileged</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">agent2:latest</span>
|
||||
<h3>Privileged mode</h3>
|
||||
<p>By default, Podman 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:</p>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-agent \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
--privileged \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-agent2-74:latest
|
||||
</code></pre>
|
||||
<pre><code class="lang-console">$ podman run --name some-zabbix-agent --link some-zabbix-<span class="hljs-string">server:</span>zabbix-server -v <span class="hljs-regexp">/dev/</span><span class="hljs-string">sdc:</span><span class="hljs-regexp">/dev/</span>sdc --init -d zabbix/zabbix-<span class="hljs-string">agent2:</span>latest
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-agent \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
-v /dev/sdc:/dev/sdc \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-agent2-74:latest
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-agent2</code> image, you can adjust the configuration of the Zabbix agent 2 by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_hostname-"><code>ZBX_HOSTNAME</code></h3>
|
||||
<h4><code>ZBX_HOSTNAME</code></h4>
|
||||
<p>This variable is unique, case sensitive hostname. By default, value is <code>hostname</code> of the container. It is <code>Hostname</code> parameter in <code>zabbix_agent2.conf</code>.</p>
|
||||
<h3 id="-zbx_server_host-"><code>ZBX_SERVER_HOST</code></h3>
|
||||
<h4><code>ZBX_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of Zabbix server or Zabbix proxy. By default, value is <code>zabbix-server</code>. It is <code>Server</code> parameter in <code>zabbix_agent2.conf</code>. It is allowed to specify Zabbix server or Zabbix proxy port number using <code>ZBX_SERVER_PORT</code> variable. It make sense in case of non-default port for active checks.</p>
|
||||
<h3 id="-zbx_passive_allow-"><code>ZBX_PASSIVE_ALLOW</code></h3>
|
||||
<h4><code>ZBX_PASSIVE_ALLOW</code></h4>
|
||||
<p>This variable is boolean (<code>true</code> or <code>false</code>) and enables or disables feature of passive checks. By default, value is <code>true</code>.</p>
|
||||
<h3 id="-zbx_passiveservers-"><code>ZBX_PASSIVESERVERS</code></h3>
|
||||
<h4><code>ZBX_PASSIVESERVERS</code></h4>
|
||||
<p>The variable is comma separated list of allowed Zabbix server or proxy hosts for connections to Zabbix agent 2 container.</p>
|
||||
<h3 id="-zbx_active_allow-"><code>ZBX_ACTIVE_ALLOW</code></h3>
|
||||
<h4><code>ZBX_ACTIVE_ALLOW</code></h4>
|
||||
<p>This variable is boolean (<code>true</code> or <code>false</code>) and enables or disables feature of active checks. By default, value is <code>true</code>.</p>
|
||||
<h3 id="-zbx_activeservers-"><code>ZBX_ACTIVESERVERS</code></h3>
|
||||
<h4><code>ZBX_ACTIVESERVERS</code></h4>
|
||||
<p>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: <code>zabbix-server:10061,zabbix-proxy:10072</code>.</p>
|
||||
<h3 id="-zbx_debuglevel-"><code>ZBX_DEBUGLEVEL</code></h3>
|
||||
<h4><code>ZBX_DEBUGLEVEL</code></h4>
|
||||
<p>The variable is used to specify debug level. By default, value is <code>3</code>. It is <code>DebugLevel</code> parameter in <code>zabbix_agent2.conf</code>. Allowed values are listed below:</p>
|
||||
<ul>
|
||||
<li><code>0</code> - basic information about starting and stopping of Zabbix processes;</li>
|
||||
|
|
@ -57,72 +80,73 @@
|
|||
<li><code>4</code> - for debugging (produces lots of information)</li>
|
||||
<li><code>5</code> - extended debugging (produces even more information)</li>
|
||||
</ul>
|
||||
<h3 id="-zbx_timeout-"><code>ZBX_TIMEOUT</code></h3>
|
||||
<h4><code>ZBX_TIMEOUT</code></h4>
|
||||
<p>The variable is used to specify timeout for processing checks. By default, value is <code>3</code>.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_ENABLEPERSISTENTBUFFER</span>=<span class="hljs-literal">false</span> # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PERSISTENTBUFFERPERIOD</span>=<span class="hljs-number">1</span>h # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ENABLESTATUSPORT</span>=
|
||||
<span class="hljs-attr">ZBX_SOURCEIP</span>=
|
||||
<span class="hljs-attr">ZBX_HEARTBEAT_FREQUENCY</span>=<span class="hljs-number">60</span> # Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ENABLEREMOTECOMMANDS</span>=<span class="hljs-number">0</span> # Deprecated since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_LOGREMOTECOMMANDS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_FORCEACTIVECHECKSONSTART</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">2</span>
|
||||
<span class="hljs-attr">ZBX_HOSTINTERFACE</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HOSTINTERFACEITEM</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HOSTNAMEITEM</span>=system.hostname
|
||||
<span class="hljs-attr">ZBX_METADATA</span>=
|
||||
<span class="hljs-attr">ZBX_METADATAITEM</span>=
|
||||
<span class="hljs-attr">ZBX_REFRESHACTIVECHECKS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_BUFFERSEND</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_BUFFERSIZE</span>=<span class="hljs-number">1000</span>
|
||||
<span class="hljs-attr">ZBX_MAXLINESPERSECOND</span>=<span class="hljs-number">20</span>
|
||||
<span class="hljs-attr">ZBX_EVENTLOGMAXLINESPERSECOND</span>=<span class="hljs-number">20</span> # Windows only
|
||||
<span class="hljs-attr">ZBX_LISTENIP</span>=
|
||||
<span class="hljs-attr">ZBX_LISTENPORT</span>=<span class="hljs-number">10050</span>
|
||||
<span class="hljs-attr">ZBX_PLUGINTIMEOUT</span>=
|
||||
<span class="hljs-attr">ZBX_UNSAFEUSERPARAMETERS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSCONNECT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSACCEPT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSCAFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCA</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRLFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRL</span>=
|
||||
<span class="hljs-attr">ZBX_TLSSERVERCERTISSUER</span>=
|
||||
<span class="hljs-attr">ZBX_TLSSERVERCERTSUBJECT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERTFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEYFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSKIDENTITY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSKFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSK</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL13</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT13</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK13</span>=
|
||||
<span class="hljs-attr">ZBX_DENYKEY</span>=system.run[*] # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ALLOWKEY</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
</code></pre><p>Default values of these variables are specified after equal sign.</p>
|
||||
<pre><code>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_FORCEACTIVECHECKSONSTART=0 # Available since 6.0.2
|
||||
ZBX_HOSTINTERFACE= # Available since 4.4.0
|
||||
ZBX_HOSTINTERFACEITEM= # Available since 4.4.0
|
||||
ZBX_HOSTNAMEITEM=system.hostname
|
||||
ZBX_METADATA=
|
||||
ZBX_METADATAITEM=
|
||||
ZBX_REFRESHACTIVECHECKS=5
|
||||
ZBX_BUFFERSEND=5
|
||||
ZBX_BUFFERSIZE=1000
|
||||
ZBX_MAXLINESPERSECOND=20
|
||||
ZBX_EVENTLOGMAXLINESPERSECOND=20 # Windows only
|
||||
ZBX_LISTENIP=
|
||||
ZBX_LISTENPORT=10050
|
||||
ZBX_PLUGINTIMEOUT=
|
||||
ZBX_UNSAFEUSERPARAMETERS=0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCA=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCRL=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSCERT=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSKEY=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSPSK=
|
||||
ZBX_TLSCIPHERALL=
|
||||
ZBX_TLSCIPHERALL13=
|
||||
ZBX_TLSCIPHERCERT=
|
||||
ZBX_TLSCIPHERCERT13=
|
||||
ZBX_TLSCIPHERPSK=
|
||||
ZBX_TLSCIPHERPSK13=
|
||||
ZBX_DENYKEY=system.run[*] # Available since 5.0.0
|
||||
ZBX_ALLOWKEY= # Available since 5.0.0
|
||||
</code></pre>
|
||||
<p>Default values of these variables are specified after equal sign.</p>
|
||||
<p>The allowed variables are identical of parameters in official <code>zabbix_agent2.conf</code> configuration file. For example, <code>ZBX_REFRESHACTIVECHECKS</code> = <code>RefreshActiveChecks</code>.</p>
|
||||
<p>Please use official documentation for <a href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agent2"><code>zabbix_agent2.conf</code></a> to get more information about the variables.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-agent-2-container">Allowed volumes for the Zabbix agent 2 container</h2>
|
||||
<h3 id="-etc-zabbix-zabbix_agentd-d-"><code>/etc/zabbix/zabbix_agentd.d</code></h3>
|
||||
<h3>Allowed volumes for the Zabbix agent 2 container</h3>
|
||||
<h4><code>/etc/zabbix/zabbix_agentd.d</code></h4>
|
||||
<p>The volume allows include <code>*.conf</code> files and extend Zabbix agent 2 using <code>UserParameter</code> feature.</p>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_TLSCAFILE</code>, <code>ZBX_TLSCRLFILE</code>, <code>ZBX_TLSCERTFILE</code>, <code>ZBX_TLSKEYFILE</code> and <code>ZBX_TLSPSKFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_TLSCA</code>, <code>ZBX_TLSCRL</code>, <code>ZBX_TLSCERT</code>, <code>ZBX_TLSKEY</code> and <code>ZBX_TLSPSK</code> with plaintext values.</p>
|
||||
<h3 id="-var-lib-zabbix-buffer-"><code>/var/lib/zabbix/buffer</code></h3>
|
||||
<h4><code>/var/lib/zabbix/buffer</code></h4>
|
||||
<p>The volume is used to store the file, where Zabbix Agent2 should keep SQLite database. To enable the feature specify <code>ZBX_ENABLEPERSISTENTBUFFER=true</code>. Available since 5.0.0.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/agent2"><code>agent2/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/agent2"><code>agent2/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h4>Known issues</h4>
|
||||
<p>Currently it is not allowed to specify <code>ZBX_ALIAS</code> environment variable. Please use <code>/etc/zabbix/zabbix_agentd.d</code> volume with additional configuration files with <code>Alias</code> options.</p>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,47 +1,53 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-java-gateway-">What is Zabbix Java Gateway?</h1>
|
||||
<p>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".</p>
|
||||
<h1 id="zabbix-java-gateway-images">Zabbix Java Gateway images</h1>
|
||||
<p>These are the only official Zabbix Java Gateway Podman images. Images are updated when new releases are published.</p>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-java-gateway-">Start <code>zabbix-java-gateway</code></h2>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix Java Gateway?</h2>
|
||||
<p>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".</p>
|
||||
<h2>Zabbix Java Gateway images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-java-gateway</code></h3>
|
||||
<p>Start a Zabbix Java Gateway container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-java-gateway <span class="hljs-_">-d</span> zabbix/zabbix-java-gateway:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-java-gateway</code> is the name you want to assign to your container and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h2 id="linking-the-container-to-zabbix-server-or-zabbix-proxy">Linking the container to Zabbix server or Zabbix proxy</h2>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-java-gateway --link some-zabbix-server:zabbix-server <span class="hljs-_">-d</span> zabbix/zabbix-java-gateway:tag</span>
|
||||
</code></pre><h2 id="container-shell-access-and-viewing-zabbix-java-gateway-logs">Container shell access and viewing Zabbix Java Gateway logs</h2>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-java-gateway \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-java-gateway-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-java-gateway</code> is the name you want to assign to your container and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h3>Linking the container to Zabbix server or Zabbix proxy</h3>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-java-gateway \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-java-gateway-74:tag
|
||||
</code></pre>
|
||||
<h3>Container shell access and viewing Zabbix Java Gateway logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-java-gateway</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-java-gateway /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-java-gateway /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix Java Gateway log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-java-gateway
|
||||
<p>The Zabbix Java Gateway log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-java-gateway
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-java-gateway</code> image, you can adjust the configuration of the Zabbix Java Gateway by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_start_pollers-"><code>ZBX_START_POLLERS</code></h3>
|
||||
<h4><code>ZBX_START_POLLERS</code></h4>
|
||||
<p>This variable is specified amount of pollers. By default, value is <code>5</code>.</p>
|
||||
<h3 id="-zbx_timeout-"><code>ZBX_TIMEOUT</code></h3>
|
||||
<h4><code>ZBX_TIMEOUT</code></h4>
|
||||
<p>This variable is used to specify timeout for outgoing connections. By default, value is <code>3</code>.</p>
|
||||
<h3 id="-zbx_debuglevel-"><code>ZBX_DEBUGLEVEL</code></h3>
|
||||
<p>This variable is used to specify log level. By default, value is <code>info</code>. The variable allows next values: <code>trace</code>, <code>debug</code>, <code>info</code>, <code>want</code>, <code>error</code>, <code>all</code>, <code>off</code></p>
|
||||
<h3 id="-zbx_properties_file-"><code>ZBX_PROPERTIES_FILE</code></h3>
|
||||
<h4><code>ZBX_DEBUGLEVEL</code></h4>
|
||||
<p>This variable is used to specify log level. By default, value is <code>info</code>. The variable allows next values: <code>trace</code>, <code>debug</code>, <code>info</code>, <code>warn</code>, <code>error</code>, <code>all</code>, <code>off</code></p>
|
||||
<h4><code>ZBX_PROPERTIES_FILE</code></h4>
|
||||
<p>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.</p>
|
||||
<h3 id="-zabbix_options-"><code>ZABBIX_OPTIONS</code></h3>
|
||||
<h4><code>ZABBIX_OPTIONS</code></h4>
|
||||
<p>Additional arguments for Zabbix Java Gateway. Useful to enable additional libraries and features.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-java-gateway-container">Allowed volumes for the Zabbix Java Gateway container</h2>
|
||||
<h3 id="-usr-sbin-zabbix_java-ext_lib-"><code>/usr/sbin/zabbix_java/ext_lib</code></h3>
|
||||
<h3>Allowed volumes for the Zabbix Java Gateway container</h3>
|
||||
<h4><code>/usr/sbin/zabbix_java/ext_lib</code></h4>
|
||||
<p>The volume allows include additional JAR files to extend allowed protocols for Zabbix Java Gateway.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/java-gateway"><code>java-gateway/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/java-gateway"><code>java-gateway/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h4>Known issues</h4>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-proxy-">What is Zabbix proxy?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix proxy?</h2>
|
||||
<p>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.</p>
|
||||
<h1 id="zabbix-proxy-images">Zabbix proxy images</h1>
|
||||
<p>These are the only official Zabbix proxy Podman images. Images are updated when new releases are published. The image with <code>latest</code> tag is based on Alpine Linux.</p>
|
||||
<h2>Zabbix proxy images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<p>The image uses MySQL database to store collected data before sending it to Zabbix server. It uses the next procedure to start:</p>
|
||||
<ul>
|
||||
<li>Checking database availability</li>
|
||||
|
|
@ -14,13 +13,22 @@
|
|||
<li>Checking of having <code>MYSQL_DATABASE</code> database. Creating <code>MYSQL_DATABASE</code> database name if it does not exist</li>
|
||||
<li>Checking of having <code>dbversion</code> table. Creating Zabbix proxy database schema if no <code>dbversion</code> table</li>
|
||||
</ul>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-proxy-mysql-">Start <code>zabbix-proxy-mysql</code></h2>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-proxy-mysql</code></h3>
|
||||
<p>Start a Zabbix proxy container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-proxy-mysql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> <span class="hljs-_">-e</span> MYSQL_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> MYSQL_PASSWORD=<span class="hljs-string">"some-password"</span> <span class="hljs-_">-e</span> ZBX_HOSTNAME=some-hostname <span class="hljs-_">-e</span> ZBX_SERVER_HOST=some-zabbix-server --init <span class="hljs-_">-d</span> zabbix/zabbix-proxy-mysql:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-proxy-mysql</code> is the name you want to assign to your container, <code>some-mysql-server</code> is IP or DNS name of MySQL server, <code>some-user</code> is user to connect to Zabbix database on MySQL server, <code>some-password</code> is the password to connect to MySQL server, <code>some-hostname</code> is the hostname, it is Hostname parameter in Zabbix proxy configuration file, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<pre><code>podman 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 \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-proxy-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-proxy-mysql</code> is the name you want to assign to your container, <code>some-mysql-server</code> is IP or DNS name of MySQL server, <code>some-user</code> is user to connect to Zabbix database on MySQL server, <code>some-password</code> is the password to connect to MySQL server, <code>some-hostname</code> is the hostname, it is Hostname parameter in Zabbix proxy configuration file, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<blockquote>
|
||||
<p>[!NOTE]
|
||||
<p><strong>Note:</strong>
|
||||
Zabbix server has possibility to execute <code>fping</code> utility to perform ICMP checks. When containers are running in rootless mode or with specific restrictions environment, you may face errors related to fping:
|
||||
<code>fping: Operation not permitted</code>
|
||||
or
|
||||
|
|
@ -30,49 +38,75 @@ Additionally fping executing in non-root environments can require sysctl modific
|
|||
<code>net.ipv4.ping_group_range=0 1995</code>
|
||||
where 1995 is <code>zabbix</code> GID.</p>
|
||||
</blockquote>
|
||||
<h2 id="connects-from-zabbix-server-passive-proxy-">Connects from Zabbix server (Passive proxy)</h2>
|
||||
<h3>Connects from Zabbix server (Passive proxy)</h3>
|
||||
<p>This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case <code>ZBX_PROXYMODE</code> = <code>1</code>. Start Zabbix server container like this in order to link it to the Zabbix proxy container:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">proxy</span><span class="hljs-literal">-</span><span class="hljs-comment">mysql:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">proxy</span><span class="hljs-literal">-</span><span class="hljs-comment">mysql</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:latest</span>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-server \
|
||||
--link some-zabbix-proxy-mysql:zabbix-proxy-mysql \
|
||||
--init \
|
||||
-d zabbix/zabbix-server:latest
|
||||
</code></pre>
|
||||
<h2 id="connect-to-zabbix-server-active-proxy-">Connect to Zabbix server (Active proxy)</h2>
|
||||
<p>This image can operate as Active proxy (<code>default</code> mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">proxy</span><span class="hljs-literal">-</span><span class="hljs-comment">mysql</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">proxy</span><span class="hljs-literal">-</span><span class="hljs-comment">mysql:latest</span>
|
||||
<h3>Connect to Zabbix server (Active proxy)</h3>
|
||||
<p>This image can operate as Active proxy (<code>default</code> mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containers:</p>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-proxy-mysql \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-proxy-mysql-74:latest
|
||||
</code></pre>
|
||||
<h2 id="container-shell-access-and-viewing-zabbix-proxy-logs">Container shell access and viewing Zabbix proxy logs</h2>
|
||||
<h3>Container shell access and viewing Zabbix proxy logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-proxy-mysql</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-proxy-mysql /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-proxy-mysql /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix proxy log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-proxy-mysql
|
||||
<p>The Zabbix proxy log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-proxy-mysql
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-proxy-mysql</code> image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_proxymode-"><code>ZBX_PROXYMODE</code></h3>
|
||||
<p>The variable allows to switch Zabbix proxy mode. Bu default, value is <code>0</code> - active proxy. Allowed values are <code>0</code> - active proxy and <code>1</code> - passive proxy.</p>
|
||||
<h3 id="-zbx_hostname-"><code>ZBX_HOSTNAME</code></h3>
|
||||
<h4><code>ZBX_PROXYMODE</code></h4>
|
||||
<p>The variable allows to switch Zabbix proxy mode. By default, value is <code>0</code> - active proxy. Allowed values are <code>0</code> - active proxy and <code>1</code> - passive proxy.</p>
|
||||
<h4><code>ZBX_HOSTNAME</code></h4>
|
||||
<p>This variable is unique, case sensitive hostname. By default, value is <code>zabbix-proxy-mysql</code> of the container. It is <code>Hostname</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-zbx_server_host-"><code>ZBX_SERVER_HOST</code></h3>
|
||||
<h4><code>ZBX_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of Zabbix server. By default, value is <code>zabbix-server</code>. It is <code>Server</code> parameter in <code>zabbix_proxy.conf</code>. For a non-default port, append it to the host using <code>host:port</code> syntax.</p>
|
||||
<h3 id="-db_server_host-"><code>DB_SERVER_HOST</code></h3>
|
||||
<p>This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'</p>
|
||||
<h3 id="-db_server_port-"><code>DB_SERVER_PORT</code></h3>
|
||||
<p>This variable is port of MySQL server. By default, value is '3306'.</p>
|
||||
<h3 id="-mysql_user-mysql_password-mysql_user_file-mysql_password_file-"><code>MYSQL_USER</code>, <code>MYSQL_PASSWORD</code>, <code>MYSQL_USER_FILE</code>, <code>MYSQL_PASSWORD_FILE</code></h3>
|
||||
<h4><code>DB_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'</p>
|
||||
<h4><code>DB_SERVER_PORT</code></h4>
|
||||
<p>This variable is port of MySQL server. By default, value is '3306'.</p>
|
||||
<h4><code>MYSQL_USER</code>, <code>MYSQL_PASSWORD</code>, <code>MYSQL_USER_FILE</code>, <code>MYSQL_PASSWORD_FILE</code></h4>
|
||||
<p>These variables are used by Zabbix proxy to connect to Zabbix database. With the <code>_FILE</code> 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 <code>MYSQL_USER</code> or <code>MYSQL_USER_FILE</code>!</p>
|
||||
<pre><code class="lang-console">podman run --name some-zabbix-proxy-mysql -e DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> -v .<span class="hljs-regexp">/.MYSQL_USER:/</span>run<span class="hljs-regexp">/secrets/</span>MYSQL_USER -e MYSQL_USER_FILE=<span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_USER -v ./</span>.<span class="hljs-string">MYSQL_PASSWORD:</span><span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/</span>var<span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_PASSWORD -e ZBX_HOSTNAME=some-hostname -e ZBX_SERVER_HOST=some-zabbix-server --init -d zabbix/</span>zabbix-proxy-<span class="hljs-string">mysql:</span>tag
|
||||
<pre><code>podman 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 \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-proxy-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!</p>
|
||||
<pre><code class="lang-console"><span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create MYSQL_USER -
|
||||
<span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create MYSQL_PASSWORD -
|
||||
podman run --name some-zabbix-proxy-mysql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> <span class="hljs-_">-e</span> MYSQL_USER_FILE=/run/secrets/MYSQL_USER <span class="hljs-_">-e</span> MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> ZBX_HOSTNAME=some-hostname --init <span class="hljs-_">-d</span> zabbix/zabbix-proxy-mysql:tag
|
||||
<pre><code>printf "zabbix" | podman secret create MYSQL_USER -
|
||||
printf "zabbix" | podman secret create MYSQL_PASSWORD -
|
||||
podman 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 \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-proxy-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>This method is also applicable for <code>MYSQL_ROOT_PASSWORD</code> with <code>MYSQL_ROOT_PASSWORD_FILE</code>.</p>
|
||||
<p>By default, values for <code>MYSQL_USER</code> and <code>MYSQL_PASSWORD</code> are <code>zabbix</code>, <code>zabbix</code>.</p>
|
||||
<h3 id="-mysql_database-"><code>MYSQL_DATABASE</code></h3>
|
||||
<h4><code>MYSQL_DATABASE</code></h4>
|
||||
<p>The variable is Zabbix database name. By default, value is <code>zabbix_proxy</code>.</p>
|
||||
<h3 id="-zbx_loadmodule-"><code>ZBX_LOADMODULE</code></h3>
|
||||
<h4><code>ZBX_LOADMODULE</code></h4>
|
||||
<p>The variable is list of comma separated loadable Zabbix modules. It works with volume <code>/var/lib/zabbix/modules</code>. The syntax of the variable is <code>dummy1.so,dummy2.so</code>.</p>
|
||||
<h3 id="-zbx_debuglevel-"><code>ZBX_DEBUGLEVEL</code></h3>
|
||||
<h4><code>ZBX_DEBUGLEVEL</code></h4>
|
||||
<p>The variable is used to specify debug level. By default, value is <code>3</code>. It is <code>DebugLevel</code> parameter in <code>zabbix_server.conf</code>. Allowed values are listed below:</p>
|
||||
<ul>
|
||||
<li><code>0</code> - basic information about starting and stopping of Zabbix processes;</li>
|
||||
|
|
@ -82,124 +116,126 @@ podman run --name some-zabbix-proxy-mysql <span class="hljs-_">-e</span> DB_SERV
|
|||
<li><code>4</code> - for debugging (produces lots of information)</li>
|
||||
<li><code>5</code> - extended debugging (produces even more information)</li>
|
||||
</ul>
|
||||
<h3 id="-zbx_timeout-"><code>ZBX_TIMEOUT</code></h3>
|
||||
<h4><code>ZBX_TIMEOUT</code></h4>
|
||||
<p>The variable is used to specify timeout for processing checks. By default, value is <code>4</code>.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_ALLOWUNSUPPORTEDDBVERSIONS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCONNECT</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCAFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCERTFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSKEYFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCIPHER</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCIPHER13</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULT</span>=HashiCorp # Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTDBPATH</span>= # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTPREFIX</span>= # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTURL</span>=https://<span class="hljs-number">127.0</span>.<span class="hljs-number">0.1</span>:<span class="hljs-number">8200</span> # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">VAULT_TOKEN</span>= # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTTLSCERTFILE</span>= # Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTTLSKEYFILE</span>= # Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ENABLEREMOTECOMMANDS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_LOGREMOTECOMMANDS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HOSTNAMEITEM</span>=system.hostname
|
||||
<span class="hljs-attr">ZBX_SOURCEIP</span>=
|
||||
<span class="hljs-attr">ZBX_PROXYLOCALBUFFER</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PROXYOFFLINEBUFFER</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_PROXYBUFFERMODE</span>=disk # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PROXYMEMORYBUFFERAGE</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PROXYMEMORYBUFFERSIZE</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PROXYCONFIGFREQUENCY</span>=<span class="hljs-number">10</span> # Available since <span class="hljs-number">6.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DATASENDERFREQUENCY</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_MAXCONCURRENTCHECKSPERPOLLER</span>=<span class="hljs-number">1000</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTAGENTPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTHTTPAGENTPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPOLLERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTPREPROCESSORS</span>=<span class="hljs-number">16</span> # Available since <span class="hljs-number">4.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTIPMIPOLLERS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPOLLERSUNREACHABLE</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTTRAPPERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTPINGERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTDISCOVERERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTHTTPPOLLERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTODBCPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_JAVAGATEWAY</span>=zabbix-java-gateway
|
||||
<span class="hljs-attr">ZBX_JAVAGATEWAYPORT</span>=<span class="hljs-number">10052</span>
|
||||
<span class="hljs-attr">ZBX_STARTJAVAPOLLERS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STATSALLOWEDIP</span>= # Available since <span class="hljs-number">4.0</span>.<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTVMWARECOLLECTORS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VMWAREFREQUENCY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_VMWAREPERFFREQUENCY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_VMWARECACHESIZE</span>=<span class="hljs-number">8</span>M
|
||||
<span class="hljs-attr">ZBX_VMWARETIMEOUT</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_ENABLE_SNMP_TRAPS</span>=<span class="hljs-literal">false</span>
|
||||
<span class="hljs-attr">ZBX_LISTENIP</span>=
|
||||
<span class="hljs-attr">ZBX_LISTENPORT</span>=<span class="hljs-number">10051</span>
|
||||
<span class="hljs-attr">ZBX_LISTENBACKLOG</span>=
|
||||
<span class="hljs-attr">ZBX_HOUSEKEEPINGFREQUENCY</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_CACHESIZE</span>=<span class="hljs-number">32</span>M
|
||||
<span class="hljs-attr">ZBX_STARTDBSYNCERS</span>=<span class="hljs-number">4</span>
|
||||
<span class="hljs-attr">ZBX_HISTORYCACHESIZE</span>=<span class="hljs-number">16</span>M
|
||||
<span class="hljs-attr">ZBX_HISTORYINDEXCACHESIZE</span>=<span class="hljs-number">4</span>M
|
||||
<span class="hljs-attr">ZBX_TRAPPERTIMEOUT</span>=<span class="hljs-number">300</span>
|
||||
<span class="hljs-attr">ZBX_UNREACHABLEPERIOD</span>=<span class="hljs-number">45</span>
|
||||
<span class="hljs-attr">ZBX_UNAVAILABLEDELAY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_UNREACHABLEDELAY</span>=<span class="hljs-number">15</span>
|
||||
<span class="hljs-attr">ZBX_LOGSLOWQUERIES</span>=<span class="hljs-number">3000</span>
|
||||
<span class="hljs-attr">ZBX_TLSLISTEN</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSCONNECT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSACCEPT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSCAFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCA</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRLFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRL</span>=
|
||||
<span class="hljs-attr">ZBX_TLSSERVERCERTISSUER</span>=
|
||||
<span class="hljs-attr">ZBX_TLSSERVERCERTSUBJECT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERTFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEYFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSKIDENTITY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSKFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSK</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_WEBDRIVERURL</span>= # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTBROWSERPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTSNMPPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
</code></pre><p>Default values of these variables are specified after equal sign.</p>
|
||||
<pre><code>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_VAULT=HashiCorp # Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since 6.2.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTPREFIX= # Available since 7.0.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_VAULTTLSCERTFILE= # Available since 6.2.0
|
||||
ZBX_VAULTTLSKEYFILE= # Available since 6.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_PROXYBUFFERMODE=disk # Available since 7.0.0
|
||||
ZBX_PROXYMEMORYBUFFERAGE=0 # Available since 7.0.0
|
||||
ZBX_PROXYMEMORYBUFFERSIZE=0 # Available since 7.0.0
|
||||
ZBX_PROXYCONFIGFREQUENCY=10 # Available since 6.4.0
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_MAXCONCURRENTCHECKSPERPOLLER=1000 # Available since 7.0.0
|
||||
ZBX_STARTAGENTPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTHTTPAGENTPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=16 # Available since 4.2.0
|
||||
ZBX_STARTIPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=5
|
||||
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=32M
|
||||
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_TLSLISTEN= # Available since 7.4.0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCA=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCRL=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSCERT=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSKEY=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSPSK=
|
||||
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
|
||||
ZBX_WEBDRIVERURL= # Available since 7.0.0
|
||||
ZBX_STARTBROWSERPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTSNMPPOLLERS=1 # Available since 7.0.0
|
||||
|
||||
</code></pre>
|
||||
<p>Default values of these variables are specified after equal sign.</p>
|
||||
<p>The allowed variables are identical of parameters in official <code>zabbix_proxy.conf</code>. For example, <code>ZBX_LOGSLOWQUERIES</code> = <code>LogSlowQueries</code>.</p>
|
||||
<p>Please use official documentation for <a href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy"><code>zabbix_proxy.conf</code></a> to get more information about the variables.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-proxy-container">Allowed volumes for the Zabbix proxy container</h2>
|
||||
<h3 id="-usr-lib-zabbix-externalscripts-"><code>/usr/lib/zabbix/externalscripts</code></h3>
|
||||
<h3>Allowed volumes for the Zabbix proxy container</h3>
|
||||
<h4><code>/usr/lib/zabbix/externalscripts</code></h4>
|
||||
<p>The volume is used by External checks (type of items). It is <code>ExternalScripts</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-modules-"><code>/var/lib/zabbix/modules</code></h3>
|
||||
<h4><code>/var/lib/zabbix/modules</code></h4>
|
||||
<p>The volume allows load additional modules and extend Zabbix proxy using <code>LoadModule</code> feature.</p>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_TLSCAFILE</code>, <code>ZBX_TLSCRLFILE</code>, <code>ZBX_TLSCERTFILE</code>, <code>ZBX_TLSKEYFILE</code> and <code>ZBX_TLSPSKFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_TLSCA</code>, <code>ZBX_TLSCRL</code>, <code>ZBX_TLSCERT</code>, <code>ZBX_TLSKEY</code> and <code>ZBX_TLSPSK</code> with plaintext values.</p>
|
||||
<h3 id="-var-lib-zabbix-ssh_keys-"><code>/var/lib/zabbix/ssh_keys</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssh_keys</code></h4>
|
||||
<p>The volume is used as location of public and private keys for SSH checks and actions. It is <code>SSHKeyLocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-certs-"><code>/var/lib/zabbix/ssl/certs</code></h3>
|
||||
<p>The volume is used as location of of SSL client certificate files for client authentication. It is <code>SSLCertLocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-keys-"><code>/var/lib/zabbix/ssl/keys</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssl/certs</code></h4>
|
||||
<p>The volume is used as location of SSL client certificate files for client authentication. It is <code>SSLCertLocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h4><code>/var/lib/zabbix/ssl/keys</code></h4>
|
||||
<p>The volume is used as location of SSL private key files for client authentication. It is <code>SSLKeyLocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-ssl_ca-"><code>/var/lib/zabbix/ssl/ssl_ca</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssl/ssl_ca</code></h4>
|
||||
<p>The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is <code>SSLCALocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-snmptraps-"><code>/var/lib/zabbix/snmptraps</code></h3>
|
||||
<h4><code>/var/lib/zabbix/snmptraps</code></h4>
|
||||
<p>The volume is used as location of <code>snmptraps.log</code> file. It could be shared by <code>zabbix-snmptraps</code> container and inherited using <code>volumes_from</code> Podman option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched <code>ZBX_ENABLE_SNMP_TRAPS</code> environment variable to <code>true</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-mibs-"><code>/var/lib/zabbix/mibs</code></h3>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/proxy-mysql"><code>proxy-mysql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h4><code>/var/lib/zabbix/mibs</code></h4>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed in <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/proxy-mysql"><code>proxy-mysql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h4>Known issues</h4>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,20 +1,25 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-proxy-">What is Zabbix proxy?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix proxy?</h2>
|
||||
<p>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.</p>
|
||||
<h1 id="zabbix-proxy-images">Zabbix proxy images</h1>
|
||||
<p>These are the only official Zabbix proxy Podman images. Images are updated when new releases are published.</p>
|
||||
<h2>Zabbix proxy images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<p>The image uses SQLite3 database to store collected data before sending it to Zabbix server.</p>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-proxy-sqlite3-">Start <code>zabbix-proxy-sqlite3</code></h2>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-proxy-sqlite3</code></h3>
|
||||
<p>Start a Zabbix proxy container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-proxy-sqlite3 <span class="hljs-_">-e</span> ZBX_HOSTNAME=some-hostname <span class="hljs-_">-e</span> ZBX_SERVER_HOST=some-zabbix-server --init <span class="hljs-_">-d</span> zabbix/zabbix-proxy-sqlite3:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-proxy-sqlite3</code> is the name you want to assign to your container, <code>some-hostname</code> is the hostname, it is Hostname parameter in Zabbix proxy configuration file, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-proxy-sqlite3 \
|
||||
-e ZBX_HOSTNAME=some-hostname \
|
||||
-e ZBX_SERVER_HOST=some-zabbix-server \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-proxy-sqlite-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-proxy-sqlite3</code> is the name you want to assign to your container, <code>some-hostname</code> is the hostname, it is Hostname parameter in Zabbix proxy configuration file, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<blockquote>
|
||||
<p>[!NOTE]
|
||||
<p><strong>Note:</strong>
|
||||
Zabbix server has possibility to execute <code>fping</code> utility to perform ICMP checks. When containers are running in rootless mode or with specific restrictions environment, you may face errors related to fping:
|
||||
<code>fping: Operation not permitted</code>
|
||||
or
|
||||
|
|
@ -24,32 +29,40 @@ Additionally fping executing in non-root environments can require sysctl modific
|
|||
<code>net.ipv4.ping_group_range=0 1995</code>
|
||||
where 1995 is <code>zabbix</code> GID.</p>
|
||||
</blockquote>
|
||||
<h2 id="connects-from-zabbix-server-passive-proxy-">Connects from Zabbix server (Passive proxy)</h2>
|
||||
<h3>Connects from Zabbix server (Passive proxy)</h3>
|
||||
<p>This image exposes the standard Zabbix proxy port (10051) and can operate as Passive proxy in case <code>ZBX_PROXYMODE</code> = <code>1</code>. Start Zabbix server container like this in order to link it to the Zabbix proxy container:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">proxy</span><span class="hljs-literal">-</span><span class="hljs-comment">sqlite3:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">proxy</span><span class="hljs-literal">-</span><span class="hljs-comment">sqlite3</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:latest</span>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-server \
|
||||
--link some-zabbix-proxy-sqlite3:zabbix-proxy-sqlite3 \
|
||||
--init \
|
||||
-d zabbix/zabbix-server:latest
|
||||
</code></pre>
|
||||
<h2 id="connect-to-zabbix-server-active-proxy-">Connect to Zabbix server (Active proxy)</h2>
|
||||
<h3>Connect to Zabbix server (Active proxy)</h3>
|
||||
<p>This image can operate as Active proxy (<code>default</code> mode). Start your application container like this in order to link Zabbix proxy to Zabbix server containters:</p>
|
||||
<pre><code class="lang-console"><span class="hljs-comment">$</span> <span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">proxy</span><span class="hljs-literal">-</span><span class="hljs-comment">sqlite3</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">init</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">proxy</span><span class="hljs-literal">-</span><span class="hljs-comment">sqlite3:latest</span>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-proxy-sqlite3 \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-proxy-sqlite-74:latest
|
||||
</code></pre>
|
||||
<h2 id="container-shell-access-and-viewing-zabbix-proxy-logs">Container shell access and viewing Zabbix proxy logs</h2>
|
||||
<h3>Container shell access and viewing Zabbix proxy logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-proxy-sqlite3</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-proxy-sqlite3 /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-proxy-sqlite3 /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix proxy log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-proxy-sqlite3
|
||||
<p>The Zabbix proxy log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-proxy-sqlite3
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-proxy-sqlite3</code> image, you can adjust the configuration of the Zabbix proxy by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_proxymode-"><code>ZBX_PROXYMODE</code></h3>
|
||||
<h4><code>ZBX_PROXYMODE</code></h4>
|
||||
<p>The variable allows to switch Zabbix proxy mode. Bu default, value is <code>0</code> - active proxy. Allowed values are <code>0</code> - active proxy and <code>1</code> - passive proxy.</p>
|
||||
<h3 id="-zbx_hostname-"><code>ZBX_HOSTNAME</code></h3>
|
||||
<h4><code>ZBX_HOSTNAME</code></h4>
|
||||
<p>This variable is unique, case sensitive hostname. By default, value is <code>zabbix-proxy-sqlite3</code> of the container. It is <code>Hostname</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-zbx_server_host-"><code>ZBX_SERVER_HOST</code></h3>
|
||||
<h4><code>ZBX_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of Zabbix server. By default, value is <code>zabbix-server</code>. It is <code>Server</code> parameter in <code>zabbix_proxy.conf</code>. For a non-default port, append it to the host using <code>host:port</code> syntax.</p>
|
||||
<h3 id="-zbx_loadmodule-"><code>ZBX_LOADMODULE</code></h3>
|
||||
<h4><code>ZBX_LOADMODULE</code></h4>
|
||||
<p>The variable is list of comma separated loadable Zabbix modules. It works with volume <code>/var/lib/zabbix/modules</code>. The syntax of the variable is <code>dummy1.so,dummy2.so</code>.</p>
|
||||
<h3 id="-zbx_debuglevel-"><code>ZBX_DEBUGLEVEL</code></h3>
|
||||
<h4><code>ZBX_DEBUGLEVEL</code></h4>
|
||||
<p>The variable is used to specify debug level. By default, value is <code>3</code>. It is <code>DebugLevel</code> parameter in <code>zabbix_server.conf</code>. Allowed values are listed below:</p>
|
||||
<ul>
|
||||
<li><code>0</code> - basic information about starting and stopping of Zabbix processes;</li>
|
||||
|
|
@ -59,113 +72,114 @@ where 1995 is <code>zabbix</code> GID.</p>
|
|||
<li><code>4</code> - for debugging (produces lots of information)</li>
|
||||
<li><code>5</code> - extended debugging (produces even more information)</li>
|
||||
</ul>
|
||||
<h3 id="-zbx_timeout-"><code>ZBX_TIMEOUT</code></h3>
|
||||
<h4><code>ZBX_TIMEOUT</code></h4>
|
||||
<p>The variable is used to specify timeout for processing checks. By default, value is <code>4</code>.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_USE_NODE_NAME_AS_DB_NAME</span>=<span class="hljs-literal">false</span>
|
||||
<span class="hljs-attr">ZBX_ENABLEREMOTECOMMANDS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_LOGREMOTECOMMANDS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_SOURCEIP</span>=
|
||||
<span class="hljs-attr">ZBX_HOSTNAMEITEM</span>=system.hostname
|
||||
<span class="hljs-attr">ZBX_PROXYLOCALBUFFER</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PROXYOFFLINEBUFFER</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_PROXYBUFFERMODE</span>=disk # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PROXYMEMORYBUFFERAGE</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PROXYMEMORYBUFFERSIZE</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_PROXYCONFIGFREQUENCY</span>=<span class="hljs-number">10</span> # Available since <span class="hljs-number">6.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DATASENDERFREQUENCY</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_MAXCONCURRENTCHECKSPERPOLLER</span>=<span class="hljs-number">1000</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTAGENTPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTHTTPAGENTPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPOLLERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTPREPROCESSORS</span>=<span class="hljs-number">16</span> # Available since <span class="hljs-number">4.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTIPMIPOLLERS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPOLLERSUNREACHABLE</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTTRAPPERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTPINGERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTDISCOVERERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTHTTPPOLLERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTODBCPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_JAVAGATEWAY</span>=zabbix-java-gateway
|
||||
<span class="hljs-attr">ZBX_JAVAGATEWAYPORT</span>=<span class="hljs-number">10052</span>
|
||||
<span class="hljs-attr">ZBX_STARTJAVAPOLLERS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STATSALLOWEDIP</span>= # Available since <span class="hljs-number">4.0</span>.<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTVMWARECOLLECTORS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VMWAREFREQUENCY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_VMWAREPERFFREQUENCY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_VMWARECACHESIZE</span>=<span class="hljs-number">8</span>M
|
||||
<span class="hljs-attr">ZBX_VMWARETIMEOUT</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_ENABLE_SNMP_TRAPS</span>=<span class="hljs-literal">false</span>
|
||||
<span class="hljs-attr">ZBX_LISTENIP</span>=
|
||||
<span class="hljs-attr">ZBX_LISTENPORT</span>=<span class="hljs-number">10051</span>
|
||||
<span class="hljs-attr">ZBX_LISTENBACKLOG</span>=
|
||||
<span class="hljs-attr">ZBX_HOUSEKEEPINGFREQUENCY</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_CACHESIZE</span>=<span class="hljs-number">32</span>M
|
||||
<span class="hljs-attr">ZBX_STARTDBSYNCERS</span>=<span class="hljs-number">4</span>
|
||||
<span class="hljs-attr">ZBX_HISTORYCACHESIZE</span>=<span class="hljs-number">16</span>M
|
||||
<span class="hljs-attr">ZBX_HISTORYINDEXCACHESIZE</span>=<span class="hljs-number">4</span>M
|
||||
<span class="hljs-attr">ZBX_TRAPPERTIMEOUT</span>=<span class="hljs-number">300</span>
|
||||
<span class="hljs-attr">ZBX_UNREACHABLEPERIOD</span>=<span class="hljs-number">45</span>
|
||||
<span class="hljs-attr">ZBX_UNAVAILABLEDELAY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_UNREACHABLEDELAY</span>=<span class="hljs-number">15</span>
|
||||
<span class="hljs-attr">ZBX_LOGSLOWQUERIES</span>=<span class="hljs-number">3000</span>
|
||||
<span class="hljs-attr">ZBX_TLSLISTEN</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSCONNECT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSACCEPT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSCAFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCA</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRLFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRL</span>=
|
||||
<span class="hljs-attr">ZBX_TLSSERVERCERTISSUER</span>=
|
||||
<span class="hljs-attr">ZBX_TLSSERVERCERTSUBJECT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERTFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEYFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSKIDENTITY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSKFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSPSK</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_WEBDRIVERURL</span>= # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTBROWSERPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTSNMPPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
</code></pre><p>Default values of these variables are specified after equal sign.</p>
|
||||
<pre><code>ZBX_USE_NODE_NAME_AS_DB_NAME=false
|
||||
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_PROXYBUFFERMODE=disk # Available since 7.0.0
|
||||
ZBX_PROXYMEMORYBUFFERAGE=0 # Available since 7.0.0
|
||||
ZBX_PROXYMEMORYBUFFERSIZE=0 # Available since 7.0.0
|
||||
ZBX_PROXYCONFIGFREQUENCY=10 # Available since 6.4.0
|
||||
ZBX_DATASENDERFREQUENCY=1
|
||||
ZBX_MAXCONCURRENTCHECKSPERPOLLER=1000 # Available since 7.0.0
|
||||
ZBX_STARTAGENTPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTHTTPAGENTPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTPREPROCESSORS=16 # Available since 4.2.0
|
||||
ZBX_STARTIPMIPOLLERS=0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=5
|
||||
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=32M
|
||||
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_TLSLISTEN= # Available since 7.4.0
|
||||
ZBX_TLSCONNECT=unencrypted
|
||||
ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCA=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCRL=
|
||||
ZBX_TLSSERVERCERTISSUER=
|
||||
ZBX_TLSSERVERCERTSUBJECT=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSCERT=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSKEY=
|
||||
ZBX_TLSPSKIDENTITY=
|
||||
ZBX_TLSPSKFILE=
|
||||
ZBX_TLSPSK=
|
||||
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
|
||||
ZBX_WEBDRIVERURL= # Available since 7.0.0
|
||||
ZBX_STARTBROWSERPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTSNMPPOLLERS=1 # Available since 7.0.0
|
||||
</code></pre>
|
||||
<p>Default values of these variables are specified after equal sign.</p>
|
||||
<p>The allowed variables are identical of parameters in official <code>zabbix_proxy.conf</code>. For example, <code>ZBX_LOGSLOWQUERIES</code> = <code>LogSlowQueries</code>.</p>
|
||||
<p>Please use official documentation for <a href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy"><code>zabbix_proxy.conf</code></a> to get more information about the variables.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-proxy-container">Allowed volumes for the Zabbix proxy container</h2>
|
||||
<h3 id="-usr-lib-zabbix-externalscripts-"><code>/usr/lib/zabbix/externalscripts</code></h3>
|
||||
<h3>Allowed volumes for the Zabbix proxy container</h3>
|
||||
<h4><code>/usr/lib/zabbix/externalscripts</code></h4>
|
||||
<p>The volume is used by External checks (type of items). It is <code>ExternalScripts</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-db_data-"><code>/var/lib/zabbix/db_data</code></h3>
|
||||
<h4><code>/var/lib/zabbix/db_data</code></h4>
|
||||
<p>The volume stores SQLite3 database file and could be used for external database file storage.</p>
|
||||
<h3 id="-var-lib-zabbix-modules-"><code>/var/lib/zabbix/modules</code></h3>
|
||||
<h4><code>/var/lib/zabbix/modules</code></h4>
|
||||
<p>The volume allows load additional modules and extend Zabbix proxy using <code>LoadModule</code> feature.</p>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_TLSCAFILE</code>, <code>ZBX_TLSCRLFILE</code>, <code>ZBX_TLSCERTFILE</code>, <code>ZBX_TLSKEYFILE</code> and <code>ZBX_TLSPSKFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_TLSCA</code>, <code>ZBX_TLSCRL</code>, <code>ZBX_TLSCERT</code>, <code>ZBX_TLSKEY</code> and <code>ZBX_TLSPSK</code> with plaintext values.</p>
|
||||
<h3 id="-var-lib-zabbix-ssh_keys-"><code>/var/lib/zabbix/ssh_keys</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssh_keys</code></h4>
|
||||
<p>The volume is used as location of public and private keys for SSH checks and actions. It is <code>SSHKeyLocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-certs-"><code>/var/lib/zabbix/ssl/certs</code></h3>
|
||||
<p>The volume is used as location of of SSL client certificate files for client authentication. It is <code>SSLCertLocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-keys-"><code>/var/lib/zabbix/ssl/keys</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssl/certs</code></h4>
|
||||
<p>The volume is used as location of SSL client certificate files for client authentication. It is <code>SSLCertLocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h4><code>/var/lib/zabbix/ssl/keys</code></h4>
|
||||
<p>The volume is used as location of SSL private key files for client authentication. It is <code>SSLKeyLocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-ssl_ca-"><code>/var/lib/zabbix/ssl/ssl_ca</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssl/ssl_ca</code></h4>
|
||||
<p>The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is <code>SSLCALocation</code> parameter in <code>zabbix_proxy.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-snmptraps-"><code>/var/lib/zabbix/snmptraps</code></h3>
|
||||
<h4><code>/var/lib/zabbix/snmptraps</code></h4>
|
||||
<p>The volume is used as location of <code>snmptraps.log</code> file. It could be shared by <code>zabbix-snmptraps</code> container and inherited using <code>volumes_from</code> Podman option while creating new instance of Zabbix proxy.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched <code>ZBX_ENABLE_SNMP_TRAPS</code> environment variable to <code>true</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-mibs-"><code>/var/lib/zabbix/mibs</code></h3>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/proxy-sqlite3"><code>proxy-sqlite3/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h4><code>/var/lib/zabbix/mibs</code></h4>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed in <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/proxy-sqlite3"><code>proxy-sqlite3/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h4>Known issues</h4>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-server-">What is Zabbix server?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix server?</h2>
|
||||
<p>Zabbix server is the central process of Zabbix software.</p>
|
||||
<p>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.</p>
|
||||
<h1 id="zabbix-server-images">Zabbix server images</h1>
|
||||
<h2>Zabbix server images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<p>The image uses MySQL database. It uses the next procedure to start:</p>
|
||||
<ul>
|
||||
|
|
@ -15,13 +14,20 @@
|
|||
<li>Checking of having <code>MYSQL_DATABASE</code> database. Creating <code>MYSQL_DATABASE</code> database name if it does not exist</li>
|
||||
<li>Checking of having <code>dbversion</code> table. Creating Zabbix server database schema and upload initial data sample if no <code>dbversion</code> table</li>
|
||||
</ul>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-server-mysql-">Start <code>zabbix-server-mysql</code></h2>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-server-mysql</code></h3>
|
||||
<p>Start a Zabbix server container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-server-mysql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> <span class="hljs-_">-e</span> MYSQL_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> MYSQL_PASSWORD=<span class="hljs-string">"some-password"</span> --init <span class="hljs-_">-d</span> zabbix/zabbix-server-mysql-74:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-server-mysql</code> is the name you want to assign to your container, <code>some-mysql-server</code> is IP or DNS name of MySQL server, <code>some-user</code> is user to connect to Zabbix database on MySQL server, <code>some-password</code> is the password to connect to MySQL server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-server-mysql \
|
||||
-e DB_SERVER_HOST="some-mysql-server" \
|
||||
-e MYSQL_USER="some-user" \
|
||||
-e MYSQL_PASSWORD="some-password" \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-server-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-server-mysql</code> is the name you want to assign to your container, <code>some-mysql-server</code> is IP or DNS name of MySQL server, <code>some-user</code> is user to connect to Zabbix database on MySQL server, <code>some-password</code> is the password to connect to MySQL server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<blockquote>
|
||||
<p>[!NOTE]
|
||||
<p><strong>Note:</strong>
|
||||
Zabbix server has possibility to execute <code>fping</code> utility to perform ICMP checks. When containers are running in rootless mode or with specific restrictions environment, you may face errors related to fping:
|
||||
<code>fping: Operation not permitted</code>
|
||||
or
|
||||
|
|
@ -31,35 +37,49 @@ Additionally fping executing in non-root environments can require sysctl modific
|
|||
<code>net.ipv4.ping_group_range=0 1995</code>
|
||||
where 1995 is <code>zabbix</code> GID.</p>
|
||||
</blockquote>
|
||||
<h2 id="container-shell-access-and-viewing-zabbix-server-logs">Container shell access and viewing Zabbix server logs</h2>
|
||||
<h3>Container shell access and viewing Zabbix server logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-server-mysql</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-server-mysql /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-server-mysql /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix server log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-server-mysql
|
||||
<p>The Zabbix server log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-server-mysql
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-server-mysql</code> image, you can adjust the configuration of the Zabbix server by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-db_server_host-"><code>DB_SERVER_HOST</code></h3>
|
||||
<p>This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'</p>
|
||||
<h3 id="-db_server_port-"><code>DB_SERVER_PORT</code></h3>
|
||||
<p>This variable is port of MySQL server. By default, value is '3306'.</p>
|
||||
<h3 id="-mysql_user-mysql_password-mysql_user_file-mysql_password_file-"><code>MYSQL_USER</code>, <code>MYSQL_PASSWORD</code>, <code>MYSQL_USER_FILE</code>, <code>MYSQL_PASSWORD_FILE</code></h3>
|
||||
<h4><code>DB_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'</p>
|
||||
<h4><code>DB_SERVER_PORT</code></h4>
|
||||
<p>This variable is port of MySQL server. By default, value is '3306'.</p>
|
||||
<h4><code>MYSQL_USER</code>, <code>MYSQL_PASSWORD</code>, <code>MYSQL_USER_FILE</code>, <code>MYSQL_PASSWORD_FILE</code></h4>
|
||||
<p>These variables are used by Zabbix server to connect to Zabbix database. With the <code>_FILE</code> 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 <code>MYSQL_USER</code> or <code>MYSQL_USER_FILE</code>!</p>
|
||||
<pre><code class="lang-console">podman run --name some-zabbix-server-mysql -e DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> -v .<span class="hljs-regexp">/.MYSQL_USER:/</span>run<span class="hljs-regexp">/secrets/</span>MYSQL_USER -e MYSQL_USER_FILE=<span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_USER -v ./</span>.<span class="hljs-string">MYSQL_PASSWORD:</span><span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/</span>var<span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_PASSWORD --init -d zabbix/</span>zabbix-server-<span class="hljs-string">mysql:</span>tag
|
||||
<pre><code>podman 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 \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-server-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!</p>
|
||||
<pre><code class="lang-console"><span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create MYSQL_USER -
|
||||
<span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create MYSQL_PASSWORD -
|
||||
podman run --name some-zabbix-server-mysql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> <span class="hljs-_">-e</span> MYSQL_USER_FILE=/run/secrets/MYSQL_USER <span class="hljs-_">-e</span> MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD --init <span class="hljs-_">-d</span> zabbix/zabbix-server-mysql:tag
|
||||
<pre><code>printf "zabbix" | podman secret create MYSQL_USER -
|
||||
printf "zabbix" | podman secret create MYSQL_PASSWORD -
|
||||
podman 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 \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-server-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>This method is also applicable for <code>MYSQL_ROOT_PASSWORD</code> with <code>MYSQL_ROOT_PASSWORD_FILE</code>.</p>
|
||||
<p>By default, values for <code>MYSQL_USER</code> and <code>MYSQL_PASSWORD</code> are <code>zabbix</code>, <code>zabbix</code>.</p>
|
||||
<h3 id="-mysql_database-"><code>MYSQL_DATABASE</code></h3>
|
||||
<h4><code>MYSQL_DATABASE</code></h4>
|
||||
<p>The variable is Zabbix database name. By default, value is <code>zabbix</code>.</p>
|
||||
<h3 id="-zbx_loadmodule-"><code>ZBX_LOADMODULE</code></h3>
|
||||
<h4><code>ZBX_LOADMODULE</code></h4>
|
||||
<p>The variable is list of comma separated loadable Zabbix modules. It works with volume <code>/var/lib/zabbix/modules</code>. The syntax of the variable is <code>dummy1.so,dummy2.so</code>.</p>
|
||||
<h3 id="-zbx_debuglevel-"><code>ZBX_DEBUGLEVEL</code></h3>
|
||||
<h4><code>ZBX_DEBUGLEVEL</code></h4>
|
||||
<p>The variable is used to specify debug level. By default, value is <code>3</code>. It is <code>DebugLevel</code> parameter in <code>zabbix_server.conf</code>. Allowed values are listed below:</p>
|
||||
<ul>
|
||||
<li><code>0</code> - basic information about starting and stopping of Zabbix processes;</li>
|
||||
|
|
@ -69,146 +89,148 @@ podman run --name some-zabbix-server-mysql <span class="hljs-_">-e</span> DB_SER
|
|||
<li><code>4</code> - for debugging (produces lots of information)</li>
|
||||
<li><code>5</code> - extended debugging (produces even more information)</li>
|
||||
</ul>
|
||||
<h3 id="-zbx_timeout-"><code>ZBX_TIMEOUT</code></h3>
|
||||
<h4><code>ZBX_TIMEOUT</code></h4>
|
||||
<p>The variable is used to specify timeout for processing checks. By default, value is <code>4</code>.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_ALLOWUNSUPPORTEDDBVERSIONS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCONNECT</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCAFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCERTFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSKEYFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCIPHER</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCIPHER13</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTPREFIX</span>= # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULT</span>=HashiCorp # Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTDBPATH</span>= # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTURL</span>=https://<span class="hljs-number">127.0</span>.<span class="hljs-number">0.1</span>:<span class="hljs-number">8200</span> # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">VAULT_TOKEN</span>= # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTTLSCERTFILE</span>= # Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTTLSKEYFILE</span>= # Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_LISTENIP</span>=
|
||||
<span class="hljs-attr">ZBX_LISTENPORT</span>=<span class="hljs-number">10051</span>
|
||||
<span class="hljs-attr">ZBX_LISTENBACKLOG</span>=
|
||||
<span class="hljs-attr">ZBX_STARTREPORTWRITERS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">5.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_WEBSERVICEURL</span>=http://zabbix-web-service:<span class="hljs-number">10053</span>/report # Available since <span class="hljs-number">5.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_SERVICEMANAGERSYNCFREQUENCY</span>=<span class="hljs-number">60</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HISTORYSTORAGEURL</span>= # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HISTORYSTORAGETYPES</span>=uint,dbl,str,log,text # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ENABLEGLOBALSCRIPTS</span>=0 # Available since <span class="hljs-number">7.0.0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPOLLERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_MAXCONCURRENTCHECKSPERPOLLER</span>=<span class="hljs-number">1000</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTAGENTPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTHTTPAGENTPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTIPMIPOLLERS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPREPROCESSORS</span>=<span class="hljs-number">16</span> # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTCONNECTORS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">6.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPOLLERSUNREACHABLE</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTTRAPPERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTPINGERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTDISCOVERERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTHISTORYPOLLERS</span>=<span class="hljs-number">5</span> # Available since <span class="hljs-number">5.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTHTTPPOLLERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTODBCPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTTIMERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTESCALATORS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTALERTERS</span>=<span class="hljs-number">3</span> # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_JAVAGATEWAY</span>=zabbix-java-gateway
|
||||
<span class="hljs-attr">ZBX_JAVAGATEWAYPORT</span>=<span class="hljs-number">10052</span>
|
||||
<span class="hljs-attr">ZBX_STARTJAVAPOLLERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTLLDPROCESSORS</span>=<span class="hljs-number">2</span> # Available since <span class="hljs-number">4.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STATSALLOWEDIP</span>= # Available since <span class="hljs-number">4.0</span>.<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTVMWARECOLLECTORS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VMWAREFREQUENCY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_VMWAREPERFFREQUENCY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_VMWARECACHESIZE</span>=<span class="hljs-number">8</span>M
|
||||
<span class="hljs-attr">ZBX_VMWARETIMEOUT</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_ENABLE_SNMP_TRAPS</span>=<span class="hljs-literal">false</span>
|
||||
<span class="hljs-attr">ZBX_SOURCEIP</span>=
|
||||
<span class="hljs-attr">ZBX_SMSDEVICES</span>=
|
||||
<span class="hljs-attr">ZBX_HOUSEKEEPINGFREQUENCY</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_MAXHOUSEKEEPERDELETE</span>=<span class="hljs-number">5000</span>
|
||||
<span class="hljs-attr">ZBX_PROBLEMHOUSEKEEPINGFREQUENCY</span>=<span class="hljs-number">60</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_CACHESIZE</span>=<span class="hljs-number">32</span>M
|
||||
<span class="hljs-attr">ZBX_CACHEUPDATEFREQUENCY</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_STARTDBSYNCERS</span>=<span class="hljs-number">4</span>
|
||||
<span class="hljs-attr">ZBX_EXPORTFILESIZE</span>=<span class="hljs-number">1</span>G # Available since <span class="hljs-number">4.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_EXPORTTYPE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">10</span> and <span class="hljs-number">5.2</span>.<span class="hljs-number">6</span>
|
||||
<span class="hljs-attr">ZBX_AUTOHANODENAME</span>=fqdn # Allowed values: fqdn, hostname. Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HANODENAME</span>= # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_AUTONODEADDRESS</span>=fqdn # Allowed values: fqdn, hostname. Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_NODEADDRESSPORT</span>=<span class="hljs-number">10051</span> # Allowed to use with ZBX_AUTONODEADDRESS variable <span class="hljs-literal">on</span>ly. Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_NODEADDRESS</span>=localhost # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HISTORYCACHESIZE</span>=<span class="hljs-number">16</span>M
|
||||
<span class="hljs-attr">ZBX_HISTORYINDEXCACHESIZE</span>=<span class="hljs-number">4</span>M
|
||||
<span class="hljs-attr">ZBX_HISTORYSTORAGEDATEINDEX</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">4.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TRENDCACHESIZE</span>=<span class="hljs-number">4</span>M
|
||||
<span class="hljs-attr">ZBX_TRENDFUNCTIONCACHESIZE</span>=<span class="hljs-number">4</span>M
|
||||
<span class="hljs-attr">ZBX_VALUECACHESIZE</span>=<span class="hljs-number">8</span>M
|
||||
<span class="hljs-attr">ZBX_TRAPPERTIMEOUT</span>=<span class="hljs-number">300</span>
|
||||
<span class="hljs-attr">ZBX_UNREACHABLEPERIOD</span>=<span class="hljs-number">45</span>
|
||||
<span class="hljs-attr">ZBX_UNAVAILABLEDELAY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_UNREACHABLEDELAY</span>=<span class="hljs-number">15</span>
|
||||
<span class="hljs-attr">ZBX_LOGSLOWQUERIES</span>=<span class="hljs-number">3000</span>
|
||||
<span class="hljs-attr">ZBX_STARTPROXYPOLLERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_PROXYCONFIGFREQUENCY</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_PROXYDATAFREQUENCY</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_TLSLISTEN</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSCAFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCA</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRLFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRL</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERTFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEYFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLS_FRONTENDACCEPT</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_FRONTENDALLOWEDIP</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSFRONTENDCERTISSUER</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSFRONTENDCERTSUBJECT</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ALLOWSOFTWAREUPDATECHECK</span>=1 # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_WEBDRIVERURL</span>= # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTBROWSERPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTSNMPPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
</code></pre><p>Default values of these variables are specified after equal sign.</p>
|
||||
<pre><code>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_VAULT=HashiCorp # Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since 6.2.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTPREFIX= # Available since 7.0.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_VAULTTLSCERTFILE= # Available since 6.2.0
|
||||
ZBX_VAULTTLSKEYFILE= # Available since 6.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_ENABLEGLOBALSCRIPTS=0 # Available since 7.0.0
|
||||
ZBX_ALLOWSOFTWAREUPDATECHECK=1 # Available since 7.0.0
|
||||
ZBX_MAXCONCURRENTCHECKSPERPOLLER=1000 # Available since 7.0.0
|
||||
ZBX_STARTAGENTPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTHTTPAGENTPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTIPMIPOLLERS=0
|
||||
ZBX_STARTPREPROCESSORS=16 # Available since 3.4.0
|
||||
ZBX_STARTCONNECTORS=0 # Available since 6.4.0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=5
|
||||
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_SMSDEVICES=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_MAXHOUSEKEEPERDELETE=5000
|
||||
ZBX_PROBLEMHOUSEKEEPINGFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_CACHESIZE=32M
|
||||
ZBX_CACHEUPDATEFREQUENCY=10
|
||||
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=10
|
||||
ZBX_PROXYDATAFREQUENCY=1
|
||||
ZBX_TLSLISTEN= # Available since 7.4.0
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCA=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCRL=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSCERT=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSKEY=
|
||||
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
|
||||
ZBX_TLS_FRONTENDACCEPT= # Available since 7.4.0
|
||||
ZBX_FRONTENDALLOWEDIP= # Available since 7.4.0
|
||||
ZBX_TLSFRONTENDCERTISSUER= # Available since 7.4.0
|
||||
ZBX_TLSFRONTENDCERTSUBJECT= # Available since 7.4.0
|
||||
ZBX_WEBDRIVERURL= # Available since 7.0.0
|
||||
ZBX_STARTBROWSERPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTSNMPPOLLERS=1 # Available since 7.0.0
|
||||
|
||||
</code></pre>
|
||||
<p>Default values of these variables are specified after equal sign.</p>
|
||||
<p>The allowed variables are identical of parameters in official <code>zabbix_server.conf</code>. For example, <code>ZBX_LOGSLOWQUERIES</code> = <code>LogSlowQueries</code>.</p>
|
||||
<p>Please use official documentation for <a href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server"><code>zabbix_server.conf</code></a> to get more information about the variables.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-server-container">Allowed volumes for the Zabbix server container</h2>
|
||||
<h3 id="-usr-lib-zabbix-alertscripts-"><code>/usr/lib/zabbix/alertscripts</code></h3>
|
||||
<h3>Allowed volumes for the Zabbix server container</h3>
|
||||
<h4><code>/usr/lib/zabbix/alertscripts</code></h4>
|
||||
<p>The volume is used for custom alert scripts. It is <code>AlertScriptsPath</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-usr-lib-zabbix-externalscripts-"><code>/usr/lib/zabbix/externalscripts</code></h3>
|
||||
<h4><code>/usr/lib/zabbix/externalscripts</code></h4>
|
||||
<p>The volume is used by External checks (type of items). It is <code>ExternalScripts</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-modules-"><code>/var/lib/zabbix/modules</code></h3>
|
||||
<h4><code>/var/lib/zabbix/modules</code></h4>
|
||||
<p>The volume allows load additional modules and extend Zabbix server using <code>LoadModule</code> feature.</p>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_TLSCAFILE</code>, <code>ZBX_TLSCRLFILE</code>, <code>ZBX_TLSCERTFILE</code> and <code>ZBX_TLSKEYFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_TLSCA</code>, <code>ZBX_TLSCRL</code>, <code>ZBX_TLSCERT</code> and <code>ZBX_TLSKEY</code> with plaintext values.</p>
|
||||
<h3 id="-var-lib-zabbix-ssh_keys-"><code>/var/lib/zabbix/ssh_keys</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssh_keys</code></h4>
|
||||
<p>The volume is used as location of public and private keys for SSH checks and actions. It is <code>SSHKeyLocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-certs-"><code>/var/lib/zabbix/ssl/certs</code></h3>
|
||||
<p>The volume is used as location of of SSL client certificate files for client authentication. It is <code>SSLCertLocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-keys-"><code>/var/lib/zabbix/ssl/keys</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssl/certs</code></h4>
|
||||
<p>The volume is used as location of SSL client certificate files for client authentication. It is <code>SSLCertLocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h4><code>/var/lib/zabbix/ssl/keys</code></h4>
|
||||
<p>The volume is used as location of SSL private key files for client authentication. It is <code>SSLKeyLocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-ssl_ca-"><code>/var/lib/zabbix/ssl/ssl_ca</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssl/ssl_ca</code></h4>
|
||||
<p>The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is <code>SSLCALocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-snmptraps-"><code>/var/lib/zabbix/snmptraps</code></h3>
|
||||
<h4><code>/var/lib/zabbix/snmptraps</code></h4>
|
||||
<p>The volume is used as location of <code>snmptraps.log</code> file. It could be shared by <code>zabbix-snmptraps</code> container and inherited using <code>volumes_from</code> Podman option while creating new instance of Zabbix server.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched <code>ZBX_ENABLE_SNMP_TRAPS</code> environment variable to <code>true</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-mibs-"><code>/var/lib/zabbix/mibs</code></h3>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-export-"><code>/var/lib/zabbix/export</code></h3>
|
||||
<h4><code>/var/lib/zabbix/mibs</code></h4>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed in <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h4><code>/var/lib/zabbix/export</code></h4>
|
||||
<p>Directory for real-time export of events, history and trends in newline-delimited JSON format. Could be enabled using <code>ZBX_EXPORTFILESIZE</code> environment variable.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/server-mysql/rhel/"><code>server-mysql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/server-mysql"><code>server-mysql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h4>Known issues</h4>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-server-">What is Zabbix server?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix server?</h2>
|
||||
<p>Zabbix server is the central process of Zabbix software.</p>
|
||||
<p>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.</p>
|
||||
<h1 id="zabbix-server-images">Zabbix server images</h1>
|
||||
<h2>Zabbix server images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<p>The image uses PostgreSQL database. It uses the next procedure to start:</p>
|
||||
<ul>
|
||||
|
|
@ -14,52 +13,73 @@
|
|||
<li>Checking of having <code>POSTGRES_DB</code> database. Creating <code>POSTGRES_DB</code> database name if it does not exist</li>
|
||||
<li>Checking of having <code>dbversion</code> table. Creating Zabbix server database schema and upload initial data sample if no <code>dbversion</code> table</li>
|
||||
</ul>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-server-pgsql-">Start <code>zabbix-server-pgsql</code></h2>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-server-pgsql</code></h3>
|
||||
<p>Start a Zabbix server container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-server-pgsql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-postgres-server"</span> <span class="hljs-_">-e</span> POSTGRES_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> POSTGRES_PASSWORD=<span class="hljs-string">"some-password"</span> <span class="hljs-_">-d</span> zabbix/zabbix-server-pgsql:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-server-pgsql</code> is the name you want to assign to your container, <code>some-postgres-server</code> is IP or DNS name of PostgreSQL server, <code>some-user</code> is user to connect to Zabbix database on PostgreSQL server, <code>some-password</code> is the password to connect to PostgreSQL server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-server-pgsql \
|
||||
-e DB_SERVER_HOST="some-postgres-server" \
|
||||
-e POSTGRES_USER="some-user" \
|
||||
-e POSTGRES_PASSWORD="some-password" \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-server-pgsql-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-server-pgsql</code> is the name you want to assign to your container, <code>some-postgres-server</code> is IP or DNS name of PostgreSQL server, <code>some-user</code> is user to connect to Zabbix database on PostgreSQL server, <code>some-password</code> is the password to connect to PostgreSQL server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<blockquote>
|
||||
<p>[!NOTE]
|
||||
<p><strong>Note:</strong>
|
||||
Zabbix server has possibility to execute <code>fping</code> utility to perform ICMP checks. When containers are running in rootless mode or with specific restrictions environment, you may face errors related to fping:
|
||||
<code>fping: Operation not permitted</code>
|
||||
or
|
||||
lost all packets to all resources
|
||||
in this case add <code>--cap-add=net_raw</code> to <code>podman run</code> or <code>podman run</code> commands.
|
||||
in this case add <code>--cap-add=net_raw</code> to <code>docker run</code> or <code>podman run</code> commands.
|
||||
Additionally fping executing in non-root environments can require sysctl modification:
|
||||
<code>net.ipv4.ping_group_range=0 1995</code>
|
||||
where 1995 is <code>zabbix</code> GID.</p>
|
||||
</blockquote>
|
||||
<h2 id="container-shell-access-and-viewing-zabbix-server-logs">Container shell access and viewing Zabbix server logs</h2>
|
||||
<h3>Container shell access and viewing Zabbix server logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-server-pgsql</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-server-pgsql /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-server-pgsql /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix server log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-server-pgsql
|
||||
<p>The Zabbix server log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-server-pgsql
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-server-pgsql</code> image, you can adjust the configuration of the Zabbix server by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-db_server_host-"><code>DB_SERVER_HOST</code></h3>
|
||||
<p>This variable is IP or DNS name of PostgreSQL server. By default, value is 'postgres-server'</p>
|
||||
<h3 id="-db_server_port-"><code>DB_SERVER_PORT</code></h3>
|
||||
<p>This variable is port of PostgreSQL server. By default, value is '5432'.</p>
|
||||
<h3 id="-postgres_user-postgres_password-postgres_user_file-postgres_password_file-"><code>POSTGRES_USER</code>, <code>POSTGRES_PASSWORD</code>, <code>POSTGRES_USER_FILE</code>, <code>POSTGRES_PASSWORD_FILE</code></h3>
|
||||
<h4><code>DB_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of PostgreSQL server. By default, value is 'postgres-server'</p>
|
||||
<h4><code>DB_SERVER_PORT</code></h4>
|
||||
<p>This variable is port of PostgreSQL server. By default, value is '5432'.</p>
|
||||
<h4><code>POSTGRES_USER</code>, <code>POSTGRES_PASSWORD</code>, <code>POSTGRES_USER_FILE</code>, <code>POSTGRES_PASSWORD_FILE</code></h4>
|
||||
<p>These variables are used by Zabbix server to connect to Zabbix database. With the <code>_FILE</code> 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 <code>POSTGRES_USER</code> or <code>POSTGRES_USER_FILE</code>!</p>
|
||||
<pre><code class="lang-console">podman run --name some-zabbix-server-pgsql -e DB_SERVER_HOST=<span class="hljs-string">"some-postgres-server"</span> -v .<span class="hljs-regexp">/.POSTGRES_USER:/</span>run<span class="hljs-regexp">/secrets/</span>POSTGRES_USER -e POSTGRES_USER_FILE=<span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/POSTGRES_USER -v ./</span>.<span class="hljs-string">POSTGRES_PASSWORD:</span><span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/POSTGRES_PASSWORD -e POSTGRES_PASSWORD_FILE=/</span>var<span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/POSTGRES_PASSWORD -d zabbix/</span>zabbix-server-<span class="hljs-string">pgsql:</span>tag
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-server-pgsql \
|
||||
-e DB_SERVER_HOST="some-postgres-server" \
|
||||
-v ./.POSTGRES_USER:/run/secrets/POSTGRES_USER \
|
||||
-e POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER \
|
||||
-v ./.POSTGRES_PASSWORD:/run/secrets/POSTGRES_PASSWORD \
|
||||
-e POSTGRES_PASSWORD_FILE=/var/run/secrets/POSTGRES_PASSWORD \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-server-pgsql-74:tag
|
||||
</code></pre>
|
||||
<p>With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!</p>
|
||||
<pre><code class="lang-console"><span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create POSTGRES_USER -
|
||||
<span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create POSTGRES_PASSWORD -
|
||||
podman run --name some-zabbix-server-pgsql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-postgres-server"</span> <span class="hljs-_">-e</span> POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER <span class="hljs-_">-e</span> POSTGRES_PASSWORD_FILE=/run/secrets/POSTGRES_PASSWORD <span class="hljs-_">-d</span> zabbix/zabbix-server-pgsql:tag
|
||||
<pre><code>printf "zabbix" | podman secret create POSTGRES_USER -
|
||||
printf "zabbix" | podman secret create POSTGRES_PASSWORD -
|
||||
podman run \
|
||||
--name some-zabbix-server-pgsql \
|
||||
-e DB_SERVER_HOST="some-postgres-server" \
|
||||
-e POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER \
|
||||
-e POSTGRES_PASSWORD_FILE=/run/secrets/POSTGRES_PASSWORD \
|
||||
--init \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-server-pgsql-74:tag
|
||||
</code></pre>
|
||||
<p>By default, values for <code>POSTGRES_USER</code> and <code>POSTGRES_PASSWORD</code> are <code>zabbix</code>, <code>zabbix</code>.</p>
|
||||
<h3 id="-postgres_db-"><code>POSTGRES_DB</code></h3>
|
||||
<h4><code>POSTGRES_DB</code></h4>
|
||||
<p>The variable is Zabbix database name. By default, value is <code>zabbix</code>.</p>
|
||||
<h3 id="-postgres_use_implicit_search_path-"><code>POSTGRES_USE_IMPLICIT_SEARCH_PATH</code></h3>
|
||||
<p>In some setups, for example including <a href="https://www.pgbouncer.org">PgBouncer</a>, setting the <code>search_path</code> via connection parameters fails. If this variable is set to <code>"true"</code>, the image skips setting the <code>search_path</code> and trusts that the <code>search_path</code> of the Zabbix user is setup correctly in PostgreSQL database.</p>
|
||||
<h3 id="-zbx_loadmodule-"><code>ZBX_LOADMODULE</code></h3>
|
||||
<h4><code>POSTGRES_USE_IMPLICIT_SEARCH_PATH</code></h4>
|
||||
<p>In some setups, for example including <a href="https://www.pgbouncer.org">PgBouncer</a>, setting the <code>search_path</code> via connection parameters fails. If this variable is set to <code>"true"</code>, the image skips setting the <code>search_path</code> and trusts that the <code>search_path</code> of the Zabbix user is setup correctly in PostgreSQL database.</p>
|
||||
<h4><code>ZBX_LOADMODULE</code></h4>
|
||||
<p>The variable is list of comma separated loadable Zabbix modules. It works with volume <code>/var/lib/zabbix/modules</code>. The syntax of the variable is <code>dummy1.so,dummy2.so</code>.</p>
|
||||
<h3 id="-zbx_debuglevel-"><code>ZBX_DEBUGLEVEL</code></h3>
|
||||
<h4><code>ZBX_DEBUGLEVEL</code></h4>
|
||||
<p>The variable is used to specify debug level. By default, value is <code>3</code>. It is <code>DebugLevel</code> parameter in <code>zabbix_server.conf</code>. Allowed values are listed below:</p>
|
||||
<ul>
|
||||
<li><code>0</code> - basic information about starting and stopping of Zabbix processes;</li>
|
||||
|
|
@ -69,146 +89,149 @@ podman run --name some-zabbix-server-pgsql <span class="hljs-_">-e</span> DB_SER
|
|||
<li><code>4</code> - for debugging (produces lots of information)</li>
|
||||
<li><code>5</code> - extended debugging (produces even more information)</li>
|
||||
</ul>
|
||||
<h3 id="-zbx_timeout-"><code>ZBX_TIMEOUT</code></h3>
|
||||
<h4><code>ZBX_TIMEOUT</code></h4>
|
||||
<p>The variable is used to specify timeout for processing checks. By default, value is <code>4</code>.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_ALLOWUNSUPPORTEDDBVERSIONS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCONNECT</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCAFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCERTFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSKEYFILE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCIPHER</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_DBTLSCIPHER13</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTPREFIX</span>= # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULT</span>=HashiCorp # Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTDBPATH</span>= # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTURL</span>=https://<span class="hljs-number">127.0</span>.<span class="hljs-number">0.1</span>:<span class="hljs-number">8200</span> # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">VAULT_TOKEN</span>= # Available since <span class="hljs-number">5.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTTLSCERTFILE</span>= # Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTTLSKEYFILE</span>= # Available since <span class="hljs-number">6.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_LISTENIP</span>=
|
||||
<span class="hljs-attr">ZBX_LISTENPORT</span>=<span class="hljs-number">10051</span>
|
||||
<span class="hljs-attr">ZBX_LISTENBACKLOG</span>=
|
||||
<span class="hljs-attr">ZBX_STARTREPORTWRITERS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">5.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_WEBSERVICEURL</span>=http://zabbix-web-service:<span class="hljs-number">10053</span>/report # Available since <span class="hljs-number">5.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_SERVICEMANAGERSYNCFREQUENCY</span>=<span class="hljs-number">60</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HISTORYSTORAGEURL</span>= # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HISTORYSTORAGETYPES</span>=uint,dbl,str,log,text # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ENABLEGLOBALSCRIPTS</span>=0 # Available since <span class="hljs-number">7.0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPOLLERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_MAXCONCURRENTCHECKSPERPOLLER</span>=<span class="hljs-number">1000</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTAGENTPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTHTTPAGENTPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTIPMIPOLLERS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTCONNECTORS</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">6.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPREPROCESSORS</span>=<span class="hljs-number">16</span> # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTPOLLERSUNREACHABLE</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTTRAPPERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTPINGERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTDISCOVERERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTHISTORYPOLLERS</span>=<span class="hljs-number">5</span> # Available since <span class="hljs-number">5.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTHTTPPOLLERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTODBCPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTTIMERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTESCALATORS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_STARTALERTERS</span>=<span class="hljs-number">3</span> # Available since <span class="hljs-number">3.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_JAVAGATEWAY</span>=zabbix-java-gateway
|
||||
<span class="hljs-attr">ZBX_JAVAGATEWAYPORT</span>=<span class="hljs-number">10052</span>
|
||||
<span class="hljs-attr">ZBX_STARTJAVAPOLLERS</span>=<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTLLDPROCESSORS</span>=<span class="hljs-number">2</span> # Available since <span class="hljs-number">4.2</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STATSALLOWEDIP</span>= # Available since <span class="hljs-number">4.0</span>.<span class="hljs-number">5</span>
|
||||
<span class="hljs-attr">ZBX_STARTVMWARECOLLECTORS</span>=<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_VMWAREFREQUENCY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_VMWAREPERFFREQUENCY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_VMWARECACHESIZE</span>=<span class="hljs-number">8</span>M
|
||||
<span class="hljs-attr">ZBX_VMWARETIMEOUT</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_ENABLE_SNMP_TRAPS</span>=<span class="hljs-literal">false</span>
|
||||
<span class="hljs-attr">ZBX_SMSDEVICES</span>=
|
||||
<span class="hljs-attr">ZBX_SOURCEIP</span>=
|
||||
<span class="hljs-attr">ZBX_HOUSEKEEPINGFREQUENCY</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_MAXHOUSEKEEPERDELETE</span>=<span class="hljs-number">5000</span>
|
||||
<span class="hljs-attr">ZBX_PROBLEMHOUSEKEEPINGFREQUENCY</span>=<span class="hljs-number">60</span> # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_CACHESIZE</span>=<span class="hljs-number">32</span>M
|
||||
<span class="hljs-attr">ZBX_CACHEUPDATEFREQUENCY</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_STARTDBSYNCERS</span>=<span class="hljs-number">4</span>
|
||||
<span class="hljs-attr">ZBX_EXPORTFILESIZE</span>=<span class="hljs-number">1</span>G # Available since <span class="hljs-number">4.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_EXPORTTYPE</span>= # Available since <span class="hljs-number">5.0</span>.<span class="hljs-number">10</span> and <span class="hljs-number">5.2</span>.<span class="hljs-number">6</span>
|
||||
<span class="hljs-attr">ZBX_AUTOHANODENAME</span>=fqdn # Allowed values: fqdn, hostname. Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HANODENAME</span>= # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_AUTONODEADDRESS</span>=fqdn # Allowed values: fqdn, hostname. Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_NODEADDRESSPORT</span>=<span class="hljs-number">10051</span> # Allowed to use with ZBX_AUTONODEADDRESS variable <span class="hljs-literal">on</span>ly. Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_NODEADDRESS</span>=localhost # Available since <span class="hljs-number">6.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_HISTORYCACHESIZE</span>=<span class="hljs-number">16</span>M
|
||||
<span class="hljs-attr">ZBX_HISTORYINDEXCACHESIZE</span>=<span class="hljs-number">4</span>M
|
||||
<span class="hljs-attr">ZBX_HISTORYSTORAGEDATEINDEX</span>=<span class="hljs-number">0</span> # Available since <span class="hljs-number">4.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TRENDCACHESIZE</span>=<span class="hljs-number">4</span>M
|
||||
<span class="hljs-attr">ZBX_TRENDFUNCTIONCACHESIZE</span>=<span class="hljs-number">4</span>M
|
||||
<span class="hljs-attr">ZBX_VALUECACHESIZE</span>=<span class="hljs-number">8</span>M
|
||||
<span class="hljs-attr">ZBX_TRAPPERTIMEOUT</span>=<span class="hljs-number">300</span>
|
||||
<span class="hljs-attr">ZBX_UNREACHABLEPERIOD</span>=<span class="hljs-number">45</span>
|
||||
<span class="hljs-attr">ZBX_UNAVAILABLEDELAY</span>=<span class="hljs-number">60</span>
|
||||
<span class="hljs-attr">ZBX_UNREACHABLEDELAY</span>=<span class="hljs-number">15</span>
|
||||
<span class="hljs-attr">ZBX_LOGSLOWQUERIES</span>=<span class="hljs-number">3000</span>
|
||||
<span class="hljs-attr">ZBX_STARTPROXYPOLLERS</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_PROXYCONFIGFREQUENCY</span>=<span class="hljs-number">10</span>
|
||||
<span class="hljs-attr">ZBX_PROXYDATAFREQUENCY</span>=<span class="hljs-number">1</span>
|
||||
<span class="hljs-attr">ZBX_TLSLISTEN</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSCAFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCA</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRLFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCRL</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERTFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEYFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEY</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERALL13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERCERT13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLSCIPHERPSK13</span>= # Available since <span class="hljs-number">4.4</span>.<span class="hljs-number">7</span>
|
||||
<span class="hljs-attr">ZBX_TLS_FRONTENDACCEPT</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_FRONTENDALLOWEDIP</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSFRONTENDCERTISSUER</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_TLSFRONTENDCERTSUBJECT</span>= # Available since <span class="hljs-number">7.4</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_ALLOWSOFTWAREUPDATECHECK</span>=1 # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_WEBDRIVERURL</span>= # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTBROWSERPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
<span class="hljs-attr">ZBX_STARTSNMPPOLLERS</span>=<span class="hljs-number">1</span> # Available since <span class="hljs-number">7.0</span>.<span class="hljs-number">0</span>
|
||||
</code></pre><p>Default values of these variables are specified after equal sign.</p>
|
||||
<pre><code>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_VAULT=HashiCorp # Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since 6.2.0
|
||||
ZBX_VAULTDBPATH= # Available since 5.2.0
|
||||
ZBX_VAULTPREFIX= # Available since 7.0.0
|
||||
ZBX_VAULTURL=https://127.0.0.1:8200 # Available since 5.2.0
|
||||
VAULT_TOKEN= # Available since 5.2.0
|
||||
ZBX_VAULTTLSCERTFILE= # Available since 6.2.0
|
||||
ZBX_VAULTTLSKEYFILE= # Available since 6.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_ENABLEGLOBALSCRIPTS=0 # Available since 7.0.0
|
||||
ZBX_ALLOWSOFTWAREUPDATECHECK=1 # Available since 7.0.0
|
||||
ZBX_MAXCONCURRENTCHECKSPERPOLLER=1000 # Available since 7.0.0
|
||||
ZBX_STARTAGENTPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTHTTPAGENTPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTPOLLERS=5
|
||||
ZBX_STARTIPMIPOLLERS=0
|
||||
ZBX_STARTCONNECTORS=0 # Available since 6.4.0
|
||||
ZBX_STARTPREPROCESSORS=16 # Available since 3.4.0
|
||||
ZBX_STARTPOLLERSUNREACHABLE=1
|
||||
ZBX_STARTTRAPPERS=5
|
||||
ZBX_STARTPINGERS=1
|
||||
ZBX_STARTDISCOVERERS=5
|
||||
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_SMSDEVICES=
|
||||
ZBX_HOUSEKEEPINGFREQUENCY=1
|
||||
ZBX_MAXHOUSEKEEPERDELETE=5000
|
||||
ZBX_PROBLEMHOUSEKEEPINGFREQUENCY=60 # Available since 6.0.0
|
||||
ZBX_CACHESIZE=32M
|
||||
ZBX_CACHEUPDATEFREQUENCY=10
|
||||
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=10
|
||||
ZBX_PROXYDATAFREQUENCY=1
|
||||
ZBX_TLSLISTEN= # Available since 7.4.0
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCA=
|
||||
ZBX_TLSCRLFILE=
|
||||
ZBX_TLSCRL=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSCERT=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSKEY=
|
||||
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
|
||||
ZBX_TLS_FRONTENDACCEPT= # Available since 7.4.0
|
||||
ZBX_FRONTENDALLOWEDIP= # Available since 7.4.0
|
||||
ZBX_TLSFRONTENDCERTISSUER= # Available since 7.4.0
|
||||
ZBX_TLSFRONTENDCERTSUBJECT= # Available since 7.4.0
|
||||
ZBX_WEBDRIVERURL= # Available since 7.0.0
|
||||
ZBX_STARTBROWSERPOLLERS=1 # Available since 7.0.0
|
||||
ZBX_STARTSNMPPOLLERS=1 # Available since 7.0.0
|
||||
|
||||
</code></pre>
|
||||
<p>Default values of these variables are specified after equal sign.</p>
|
||||
<p>The allowed variables are identical of parameters in official <code>zabbix_server.conf</code>. For example, <code>ZBX_LOGSLOWQUERIES</code> = <code>LogSlowQueries</code>.</p>
|
||||
<p>Please use official documentation for <a href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server"><code>zabbix_server.conf</code></a> to get more information about the variables.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-server-container">Allowed volumes for the Zabbix server container</h2>
|
||||
<h3 id="-usr-lib-zabbix-alertscripts-"><code>/usr/lib/zabbix/alertscripts</code></h3>
|
||||
<h3>Allowed volumes for the Zabbix server container</h3>
|
||||
<h4><code>/usr/lib/zabbix/alertscripts</code></h4>
|
||||
<p>The volume is used for custom alert scripts. It is <code>AlertScriptsPath</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-usr-lib-zabbix-externalscripts-"><code>/usr/lib/zabbix/externalscripts</code></h3>
|
||||
<h4><code>/usr/lib/zabbix/externalscripts</code></h4>
|
||||
<p>The volume is used by External checks (type of items). It is <code>ExternalScripts</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-modules-"><code>/var/lib/zabbix/modules</code></h3>
|
||||
<h4><code>/var/lib/zabbix/modules</code></h4>
|
||||
<p>The volume allows load additional modules and extend Zabbix server using <code>LoadModule</code> feature.</p>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_TLSCAFILE</code>, <code>ZBX_TLSCRLFILE</code>, <code>ZBX_TLSCERTFILE</code> and <code>ZBX_TLSKEYFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_TLSCA</code>, <code>ZBX_TLSCRL</code>, <code>ZBX_TLSCERT</code> and <code>ZBX_TLSKEY</code> with plaintext values.</p>
|
||||
<h3 id="-var-lib-zabbix-ssh_keys-"><code>/var/lib/zabbix/ssh_keys</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssh_keys</code></h4>
|
||||
<p>The volume is used as location of public and private keys for SSH checks and actions. It is <code>SSHKeyLocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-certs-"><code>/var/lib/zabbix/ssl/certs</code></h3>
|
||||
<p>The volume is used as location of of SSL client certificate files for client authentication. It is <code>SSLCertLocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-keys-"><code>/var/lib/zabbix/ssl/keys</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssl/certs</code></h4>
|
||||
<p>The volume is used as location of SSL client certificate files for client authentication. It is <code>SSLCertLocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h4><code>/var/lib/zabbix/ssl/keys</code></h4>
|
||||
<p>The volume is used as location of SSL private key files for client authentication. It is <code>SSLKeyLocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-ssl-ssl_ca-"><code>/var/lib/zabbix/ssl/ssl_ca</code></h3>
|
||||
<h4><code>/var/lib/zabbix/ssl/ssl_ca</code></h4>
|
||||
<p>The volume is used as location of certificate authority (CA) files for SSL server certificate verification. It is <code>SSLCALocation</code> parameter in <code>zabbix_server.conf</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-snmptraps-"><code>/var/lib/zabbix/snmptraps</code></h3>
|
||||
<h4><code>/var/lib/zabbix/snmptraps</code></h4>
|
||||
<p>The volume is used as location of <code>snmptraps.log</code> file. It could be shared by <code>zabbix-snmptraps</code> container and inherited using <code>volumes_from</code> Podman option while creating new instance of Zabbix server.
|
||||
SNMP traps processing feature could be enabled using shared volume and switched <code>ZBX_ENABLE_SNMP_TRAPS</code> environment variable to <code>true</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-mibs-"><code>/var/lib/zabbix/mibs</code></h3>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-export-"><code>/var/lib/zabbix/export</code></h3>
|
||||
<h4><code>/var/lib/zabbix/mibs</code></h4>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed in <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h4><code>/var/lib/zabbix/export</code></h4>
|
||||
<p>Directory for real-time export of events, history and trends in newline-delimited JSON format. Could be enabled using <code>ZBX_EXPORTFILESIZE</code> environment variable.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/server-pgsql"><code>server-pgsql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/server-pgsql"><code>server-pgsql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h4>Known issues</h4>
|
||||
<p>Zabbix server does not support Jabber notifications on Alpine Linux because of <code>iksemel</code> package is in testing repository and not available in stable repository.</p>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,47 +1,58 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-the-image-">What is the image?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is the image?</h2>
|
||||
<p>The image is used to receive SNMP traps, store them to a log file and provide access to Zabbix to collected SNMP trap messsages.</p>
|
||||
<h1 id="zabbix-snmptraps-images">Zabbix snmptraps images</h1>
|
||||
<p>These are the only official Zabbix snmptraps Podman images. Images are updated when new releases are published.</p>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-snmptraps-">Start <code>zabbix-snmptraps</code></h2>
|
||||
<h2>Zabbix snmptraps images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-snmptraps</code></h3>
|
||||
<p>Start a Zabbix snmptraps container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-snmptraps -p 162:1162/udp <span class="hljs-_">-d</span> zabbix/zabbix-snmptraps:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-snmptraps</code> is the name you want to assign to your container and <code>tag</code> is the tag specifying the version you want. See the list above for relevant tags, or look at the <a href="https://hub.docker.com/r/zabbix/zabbix-snmptraps/tags/">full list of tags</a>.</p>
|
||||
<h2 id="linking-zabbix-server-or-zabbix-proxy-with-the-container">Linking Zabbix server or Zabbix proxy with the container</h2>
|
||||
<pre><code><span class="hljs-comment">podman</span> <span class="hljs-comment">run</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">name</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">link</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">snmptraps:zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">snmptraps</span> <span class="hljs-literal">-</span><span class="hljs-literal">-</span><span class="hljs-comment">volumes</span><span class="hljs-literal">-</span><span class="hljs-comment">from</span> <span class="hljs-comment">some</span><span class="hljs-literal">-</span><span class="hljs-comment">zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">snmptraps</span> <span class="hljs-literal">-</span><span class="hljs-comment">d</span> <span class="hljs-comment">zabbix/zabbix</span><span class="hljs-literal">-</span><span class="hljs-comment">server:tag</span>
|
||||
</code></pre><h2 id="container-shell-access-and-viewing-zabbix-snmptraps-logs">Container shell access and viewing Zabbix snmptraps logs</h2>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-snmptraps \
|
||||
-p 162:1162/udp \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-snmptraps-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-snmptraps</code> is the name you want to assign to your container and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h3>Linking Zabbix server or Zabbix proxy with the container</h3>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-server \
|
||||
--link some-zabbix-snmptraps:zabbix-snmptraps \
|
||||
--volumes-from some-zabbix-snmptraps \
|
||||
-d zabbix/zabbix-server:tag
|
||||
</code></pre>
|
||||
<h3>Container shell access and viewing Zabbix snmptraps logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-snmptraps</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-snmptraps /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-snmptraps /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix snmptraps log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-snmptraps
|
||||
<p>The Zabbix snmptraps log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-snmptraps
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-snmptraps</code> image, you can adjust the configuration by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_snmp_trap_date_format-"><code>ZBX_SNMP_TRAP_DATE_FORMAT</code></h3>
|
||||
<h4><code>ZBX_SNMP_TRAP_DATE_FORMAT</code></h4>
|
||||
<p>This variable is represent date and time format in the output <code>snmptraps.log</code> file. By default, value is <code>+%Y-%m-%dT%T%z</code>. Please, refer to <code>date</code> command man for more details about date and time format.</p>
|
||||
<h3 id="-zbx_snmp_trap_format-"><code>ZBX_SNMP_TRAP_FORMAT</code></h3>
|
||||
<h4><code>ZBX_SNMP_TRAP_FORMAT</code></h4>
|
||||
<p>This variable is SNMP trap format in the output <code>snmptraps.log</code> file. By default, value is <code>\n</code>, in this case each new variable is placed on new line.</p>
|
||||
<h3 id="-zbx_snmp_trap_use_dns-"><code>ZBX_SNMP_TRAP_USE_DNS</code></h3>
|
||||
<p>This variable manages source network address representation. It can be IP address or DNS of SNMP trap sender. The variable works only when container command is modified and "-n" command argument is removed from argument list. By default, value is <code>false</code>.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-snmptraps-container">Allowed volumes for the Zabbix snmptraps container</h2>
|
||||
<h3 id="-var-lib-zabbix-snmptraps-"><code>/var/lib/zabbix/snmptraps</code></h3>
|
||||
<h4><code>ZBX_SNMP_TRAP_USE_DNS</code></h4>
|
||||
<p>This variable manages source network address representation. It can be IP address or DNS of SNMP trap sender. The variable works only when container command is modified and "-n" command argument is removed from argument list. By default, value is <code>false</code>.</p>
|
||||
<h4><code>SNMPTRAP_OUTPUT_OPTIONS</code></h4>
|
||||
<p>Modify standard output options for SNMP traps. By default, value is <code>STte</code>. Corresponding to "OUTPUT OPTIONS" ("-O" command line argument).</p>
|
||||
<h3>Allowed volumes for the Zabbix snmptraps container</h3>
|
||||
<h4><code>/var/lib/zabbix/snmptraps</code></h4>
|
||||
<p>The volume contains log file <code>snmptraps.log</code> named with received SNMP traps.</p>
|
||||
<h3 id="-var-lib-zabbix-mibs-"><code>/var/lib/zabbix/mibs</code></h3>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed to <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h3 id="-var-lib-zabbix-snmptrapd_config-"><code>/var/lib/zabbix/snmptrapd_config</code></h3>
|
||||
<h4><code>/var/lib/zabbix/mibs</code></h4>
|
||||
<p>The volume allows to add new MIB files. It does not support subdirectories, all MIBs must be placed in <code>/var/lib/zabbix/mibs</code>.</p>
|
||||
<h4><code>/var/lib/zabbix/snmptrapd_config</code></h4>
|
||||
<p>The volume various persistent configuration files generated by snmptrapd daemon. The volume is required usually only for SNMPv3 traps. Do not modify manually anything stored in the volume.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/snmptraps"><code>snmptraps/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<p>The volume also can be used for custom configuration file <code>snmptrapd_custom.conf</code>. The configuration file can be used for SNMPv3 authentification details.</p>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/snmptraps"><code>snmptraps/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h4>Known issues</h4>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-web-interface-">What is Zabbix web interface?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix web interface?</h2>
|
||||
<p>Zabbix web interface is a part of Zabbix software. It is used to manage resources under monitoring and view monitoring statistics.</p>
|
||||
<h1 id="zabbix-web-interface-images">Zabbix web interface images</h1>
|
||||
<p>These are the only official Zabbix web interface Podman images. Images are updated when new releases are published.</p>
|
||||
<p>Zabbix web interface available in four editions, but only one as Red Hat Certified container:</p>
|
||||
<h2>Zabbix web interface images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<p>Zabbix web interface available in four editions:</p>
|
||||
<ul>
|
||||
<li>Zabbix web-interface based on Apache2 web server with MySQL database support</li>
|
||||
<li>Zabbix web-interface based on Apache2 web server with PostgreSQL database support</li>
|
||||
|
|
@ -15,153 +14,195 @@
|
|||
<li>Zabbix web-interface based on Nginx web server with PostgreSQL database support</li>
|
||||
</ul>
|
||||
<p>The image based on Nginx web server with MySQL database support.</p>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-web-nginx-mysql-">Start <code>zabbix-web-nginx-mysql</code></h2>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-web-nginx-mysql</code></h3>
|
||||
<p>Start a Zabbix web-interface container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-web-nginx-mysql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> <span class="hljs-_">-e</span> MYSQL_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> MYSQL_PASSWORD=<span class="hljs-string">"some-password"</span> <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-mysql:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-web-nginx-mysql</code> is the name you want to assign to your container, <code>some-mysql-server</code> is IP or DNS name of MySQL server, <code>some-user</code> is user to connect to Zabbix database on MySQL server, <code>some-password</code> is the password to connect to MySQL server, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server or proxy, <code>some-timezone</code> is PHP like timezone name and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h2 id="linking-the-container-to-zabbix-server">Linking the container to Zabbix server</h2>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-web-nginx-mysql --link some-zabbix-server:zabbix-server <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> <span class="hljs-_">-e</span> MYSQL_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> MYSQL_PASSWORD=<span class="hljs-string">"some-password"</span> <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-mysql:tag</span>
|
||||
</code></pre><h2 id="linking-the-container-to-mysql-database">Linking the container to MySQL database</h2>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-web-nginx-mysql --link some-mysql-server:mysql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> <span class="hljs-_">-e</span> MYSQL_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> MYSQL_PASSWORD=<span class="hljs-string">"some-password"</span> <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-mysql:tag</span>
|
||||
</code></pre><h2 id="container-shell-access-and-viewing-zabbix-web-interface-logs">Container shell access and viewing Zabbix web interface logs</h2>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-nginx-mysql \
|
||||
-e DB_SERVER_HOST="some-mysql-server" \
|
||||
-e MYSQL_USER="some-user" \
|
||||
-e MYSQL_PASSWORD="some-password" \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
-e PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-web-nginx-mysql</code> is the name you want to assign to your container, <code>some-mysql-server</code> is IP or DNS name of MySQL server, <code>some-user</code> is user to connect to Zabbix database on MySQL server, <code>some-password</code> is the password to connect to MySQL server, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server or proxy, <code>some-timezone</code> is PHP like timezone name and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h3>Linking the container to Zabbix server</h3>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-nginx-mysql \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
-e DB_SERVER_HOST="some-mysql-server" \
|
||||
-e MYSQL_USER="some-user" \
|
||||
-e MYSQL_PASSWORD="some-password" \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
-e PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-mysql-74:tag
|
||||
</code></pre>
|
||||
<h3>Linking the container to MySQL database</h3>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-nginx-mysql \
|
||||
--link some-mysql-server:mysql \
|
||||
-e DB_SERVER_HOST="some-mysql-server" \
|
||||
-e MYSQL_USER="some-user" \
|
||||
-e MYSQL_PASSWORD="some-password" \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
-e PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-mysql-74:tag
|
||||
</code></pre>
|
||||
<h3>Container shell access and viewing Zabbix web interface logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-web-nginx-mysql</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-web-nginx-mysql /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-web-nginx-mysql /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix web interface log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-web-nginx-mysql
|
||||
<p>The Zabbix web interface log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-web-nginx-mysql
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-web-nginx-mysql</code> image, you can adjust the configuration of the Zabbix web interface by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_server_host-"><code>ZBX_SERVER_HOST</code></h3>
|
||||
<h4><code>ZBX_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of Zabbix server. By default, value is <code>zabbix-server</code>.</p>
|
||||
<h3 id="-zbx_server_port-"><code>ZBX_SERVER_PORT</code></h3>
|
||||
<h4><code>ZBX_SERVER_PORT</code></h4>
|
||||
<p>This variable is port Zabbix server listening on. By default, value is <code>10051</code>.</p>
|
||||
<h3 id="-db_server_host-"><code>DB_SERVER_HOST</code></h3>
|
||||
<p>This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'</p>
|
||||
<h3 id="-db_server_port-"><code>DB_SERVER_PORT</code></h3>
|
||||
<p>This variable is port of MySQL server. By default, value is '3306'.</p>
|
||||
<h3 id="-mysql_user-mysql_password-mysql_user_file-mysql_password_file-"><code>MYSQL_USER</code>, <code>MYSQL_PASSWORD</code>, <code>MYSQL_USER_FILE</code>, <code>MYSQL_PASSWORD_FILE</code></h3>
|
||||
<h4><code>DB_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of MySQL server. By default, value is 'mysql-server'</p>
|
||||
<h4><code>DB_SERVER_PORT</code></h4>
|
||||
<p>This variable is port of MySQL server. By default, value is '3306'.</p>
|
||||
<h4><code>MYSQL_USER</code>, <code>MYSQL_PASSWORD</code>, <code>MYSQL_USER_FILE</code>, <code>MYSQL_PASSWORD_FILE</code></h4>
|
||||
<p>These variables are used by Zabbix web-interface to connect to Zabbix database. With the <code>_FILE</code> 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 <code>MYSQL_USER</code> or <code>MYSQL_USER_FILE</code>!</p>
|
||||
<pre><code class="lang-console">podman run --name some-zabbix-web-nginx-mysql -e DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> -v .<span class="hljs-regexp">/.MYSQL_USER:/</span>run<span class="hljs-regexp">/secrets/</span>MYSQL_USER -e MYSQL_USER_FILE=<span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_USER -v ./</span>.<span class="hljs-string">MYSQL_PASSWORD:</span><span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_PASSWORD -e MYSQL_PASSWORD_FILE=/</span>var<span class="hljs-regexp">/run/</span>secrets<span class="hljs-regexp">/MYSQL_PASSWORD -e PHP_TZ="some-timezone" -d zabbix/</span>zabbix-web-nginx-<span class="hljs-string">mysql:</span>tag
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-nginx-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 PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!</p>
|
||||
<pre><code class="lang-console"><span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create MYSQL_USER -
|
||||
<span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create MYSQL_PASSWORD -
|
||||
podman run --name some-zabbix-web-nginx-mysql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-mysql-server"</span> <span class="hljs-_">-e</span> MYSQL_USER_FILE=/run/secrets/MYSQL_USER <span class="hljs-_">-e</span> MYSQL_PASSWORD_FILE=/run/secrets/MYSQL_PASSWORD <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-mysql:tag
|
||||
<pre><code>printf "zabbix" | podman secret create MYSQL_USER -
|
||||
printf "zabbix" | podman secret create MYSQL_PASSWORD -
|
||||
podman run \
|
||||
--name some-zabbix-web-nginx-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 PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-mysql-74:tag
|
||||
</code></pre>
|
||||
<p>By default, values for <code>MYSQL_USER</code> and <code>MYSQL_PASSWORD</code> are <code>zabbix</code>, <code>zabbix</code>.</p>
|
||||
<h3 id="-mysql_database-"><code>MYSQL_DATABASE</code></h3>
|
||||
<h4><code>MYSQL_DATABASE</code></h4>
|
||||
<p>The variable is Zabbix database name. By default, value is <code>zabbix</code>.</p>
|
||||
<h3 id="-zbx_historystorageurl-"><code>ZBX_HISTORYSTORAGEURL</code></h3>
|
||||
<h4><code>ZBX_HISTORYSTORAGEURL</code></h4>
|
||||
<p>History storage HTTP[S] URL. This parameter is used for Elasticsearch setup. Available since 3.4.5.</p>
|
||||
<h3 id="-zbx_historystoragetypes-"><code>ZBX_HISTORYSTORAGETYPES</code></h3>
|
||||
<p>Array of value types to be sent to the history storage. An example: ['uint', 'dbl']. This parameter is used for Elasticsearch setup. Available since 3.4.5.</p>
|
||||
<h3 id="-php_tz-"><code>PHP_TZ</code></h3>
|
||||
<p>The variable is timezone in PHP format. Full list of supported timezones are available on <a href="http://php.net/manual/en/timezones.php"><code>php.net</code></a>. By default, value is 'Europe/Riga' and system timezone since Zabbix 5.2.0.</p>
|
||||
<h3 id="-zbx_server_name-"><code>ZBX_SERVER_NAME</code></h3>
|
||||
<h4><code>ZBX_HISTORYSTORAGETYPES</code></h4>
|
||||
<p>Array of value types to be sent to the history storage. An example: ['uint', 'dbl']. This parameter is used for Elasticsearch setup. Available since 3.4.5.</p>
|
||||
<h4><code>PHP_TZ</code></h4>
|
||||
<p>The variable is timezone in PHP format. Full list of supported timezones are available on <a href="http://php.net/manual/en/timezones.php"><code>php.net</code></a>. By default, value is 'Europe/Riga' and system timezone since Zabbix 5.2.0.</p>
|
||||
<h4><code>ZBX_SERVER_NAME</code></h4>
|
||||
<p>The variable is visible Zabbix installation name in right or left top corner of the web interface.</p>
|
||||
<h3 id="-db_double_ieee754-"><code>DB_DOUBLE_IEEE754</code></h3>
|
||||
<h4><code>DB_DOUBLE_IEEE754</code></h4>
|
||||
<p>Use IEEE754 compatible value range for 64-bit Numeric (float) history values. Available since 5.0.0. Enabled by default.</p>
|
||||
<h3 id="-enable_web_access_log-"><code>ENABLE_WEB_ACCESS_LOG</code></h3>
|
||||
<h4><code>ENABLE_WEB_ACCESS_LOG</code></h4>
|
||||
<p>The variable sets the Access Log directive for Web server. By default, value corresponds to standard output.</p>
|
||||
<h3 id="-http_index_file-"><code>HTTP_INDEX_FILE</code></h3>
|
||||
<h4><code>HTTP_INDEX_FILE</code></h4>
|
||||
<p>The variable controls default index page. By default, <code>index.php</code>.</p>
|
||||
<h3 id="-expose_web_server_info-"><code>EXPOSE_WEB_SERVER_INFO</code></h3>
|
||||
<h4><code>EXPOSE_WEB_SERVER_INFO</code></h4>
|
||||
<p>The variable allows to hide Web server and PHP versions. By default, <code>on</code>.</p>
|
||||
<h3 id="-zbx_maxexecutiontime-"><code>ZBX_MAXEXECUTIONTIME</code></h3>
|
||||
<p>The varable is PHP <code>max_execution_time</code> option. By default, value is <code>300</code>.</p>
|
||||
<h3 id="-zbx_memorylimit-"><code>ZBX_MEMORYLIMIT</code></h3>
|
||||
<p>The varable is PHP <code>memory_limit</code> option. By default, value is <code>128M</code>.</p>
|
||||
<h3 id="-zbx_postmaxsize-"><code>ZBX_POSTMAXSIZE</code></h3>
|
||||
<p>The varable is PHP <code>post_max_size</code> option. By default, value is <code>16M</code>.</p>
|
||||
<h3 id="-zbx_uploadmaxfilesize-"><code>ZBX_UPLOADMAXFILESIZE</code></h3>
|
||||
<p>The varable is PHP <code>upload_max_filesize</code> option. By default, value is <code>2M</code>.</p>
|
||||
<h3 id="-zbx_maxinputtime-"><code>ZBX_MAXINPUTTIME</code></h3>
|
||||
<p>The varable is PHP <code>max_input_time</code> option. By default, value is <code>300</code>.</p>
|
||||
<h3 id="-zbx_session_name-"><code>ZBX_SESSION_NAME</code></h3>
|
||||
<h4><code>ZBX_MAXEXECUTIONTIME</code></h4>
|
||||
<p>The variable is PHP <code>max_execution_time</code> option. By default, value is <code>300</code>.</p>
|
||||
<h4><code>ZBX_MEMORYLIMIT</code></h4>
|
||||
<p>The variable is PHP <code>memory_limit</code> option. By default, value is <code>128M</code>.</p>
|
||||
<h4><code>ZBX_POSTMAXSIZE</code></h4>
|
||||
<p>The variable is PHP <code>post_max_size</code> option. By default, value is <code>16M</code>.</p>
|
||||
<h4><code>ZBX_UPLOADMAXFILESIZE</code></h4>
|
||||
<p>The variable is PHP <code>upload_max_filesize</code> option. By default, value is <code>2M</code>.</p>
|
||||
<h4><code>ZBX_MAXINPUTTIME</code></h4>
|
||||
<p>The variable is PHP <code>max_input_time</code> option. By default, value is <code>300</code>.</p>
|
||||
<h4><code>ZBX_SESSION_NAME</code></h4>
|
||||
<p>The variable is Zabbix frontend <a href="https://www.zabbix.com/documentation/current/manual/web_interface/definitions">definition</a>. String used as the name of the Zabbix frontend session cookie. By default, value is <code>zbx_sessionid</code>.</p>
|
||||
<h3 id="-zbx_deny_gui_access-"><code>ZBX_DENY_GUI_ACCESS</code></h3>
|
||||
<h4><code>ZBX_DENY_GUI_ACCESS</code></h4>
|
||||
<p>Enable (<code>true</code>) maintenance mode for Zabbix web-interface.</p>
|
||||
<h3 id="-zbx_gui_access_ip_range-"><code>ZBX_GUI_ACCESS_IP_RANGE</code></h3>
|
||||
<h4><code>ZBX_GUI_ACCESS_IP_RANGE</code></h4>
|
||||
<p>Array of IP addresses which are allowed for accessing to Zabbix web-interface during maintenance period.</p>
|
||||
<h3 id="-zbx_gui_warning_msg-"><code>ZBX_GUI_WARNING_MSG</code></h3>
|
||||
<h4><code>ZBX_GUI_WARNING_MSG</code></h4>
|
||||
<p>Information message about maintenance period for Zabbix web-interface.</p>
|
||||
<h3 id="-zbx_db_encryption-"><code>ZBX_DB_ENCRYPTION</code></h3>
|
||||
<h4><code>ZBX_DB_ENCRYPTION</code></h4>
|
||||
<p>The variable allows to activate encryption for connections to Zabbix database. Even if no other environment variables are specified, connections will be TLS-encrypted if <code>ZBX_DB_ENCRYPTION=true</code> specified. Available since 5.0.0. Disabled by default.</p>
|
||||
<h3 id="-zbx_db_key_file-"><code>ZBX_DB_KEY_FILE</code></h3>
|
||||
<h4><code>ZBX_DB_KEY_FILE</code></h4>
|
||||
<p>The variable allows to specify the full path to a valid TLS key file. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_db_cert_file-"><code>ZBX_DB_CERT_FILE</code></h3>
|
||||
<h4><code>ZBX_DB_CERT_FILE</code></h4>
|
||||
<p>The variable allows to specify the full path to a valid TLS certificate file. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_db_ca_file-"><code>ZBX_DB_CA_FILE</code></h3>
|
||||
<h4><code>ZBX_DB_CA_FILE</code></h4>
|
||||
<p>The variable allows to specify the full path to a valid TLS certificate authority file. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_db_verify_host-"><code>ZBX_DB_VERIFY_HOST</code></h3>
|
||||
<h4><code>ZBX_DB_VERIFY_HOST</code></h4>
|
||||
<p>The variable allows to activate host verification. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_db_cipher_list-"><code>ZBX_DB_CIPHER_LIST</code></h3>
|
||||
<h4><code>ZBX_DB_CIPHER_LIST</code></h4>
|
||||
<p>The variable allows to specify a custom list of valid ciphers. The format of the cipher list must conform to the OpenSSL standard. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_sso_sp_key-"><code>ZBX_SSO_SP_KEY</code></h3>
|
||||
<h4><code>ZBX_SSO_SP_KEY</code></h4>
|
||||
<p>The variable allows to specify a custom file path to the Service Provider (SP) private key file.</p>
|
||||
<h3 id="-zbx_sso_sp_cert-"><code>ZBX_SSO_SP_CERT</code></h3>
|
||||
<p>The variable allows to specify a custom file path to the Serivce Provider (SP) cert file.</p>
|
||||
<h3 id="-zbx_sso_idp_cert-"><code>ZBX_SSO_IDP_CERT</code></h3>
|
||||
<h4><code>ZBX_SSO_SP_CERT</code></h4>
|
||||
<p>The variable allows to specify a custom file path to the Service Provider (SP) cert file.</p>
|
||||
<h4><code>ZBX_SSO_IDP_CERT</code></h4>
|
||||
<p>The variable allows to specify a custom file path to the SAML Certificate provided by the Identity Provider (ID) file.</p>
|
||||
<h2 id="-zbx_sso_settings-"><code>ZBX_SSO_SETTINGS</code></h2>
|
||||
<h3><code>ZBX_SSO_SETTINGS</code></h3>
|
||||
<p>The variable allows to specify custom SSO settings in JSON format. Available since 5.0.0.</p>
|
||||
<p>Example of YAML Mapping to Sequences</p>
|
||||
<pre><code><span class="hljs-code">....
|
||||
<pre><code>....
|
||||
environment:
|
||||
ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}"
|
||||
ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}"
|
||||
....
|
||||
....
|
||||
....</span>
|
||||
</code></pre>
|
||||
<h3 id="-zbx_allow_http_auth-"><code>ZBX_ALLOW_HTTP_AUTH</code></h3>
|
||||
<h3><code>ZBX_ALLOW_HTTP_AUTH</code></h3>
|
||||
<p>The variable allows to disable user HTTP authentication.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_VAULT=HashiCorp</span> <span class="hljs-comment"># Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since 6.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTDBPATH=</span> <span class="hljs-comment"># Available since 5.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTURL=https://127.0.0.1:8200</span> <span class="hljs-comment"># Available since 5.2.0</span>
|
||||
<span class="hljs-attr">VAULT_TOKEN=</span> <span class="hljs-comment"># Available since 5.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTPREFIX=</span> <span class="hljs-comment"># Available since 7.0.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTCERTFILE=</span> <span class="hljs-comment"># Available since 6.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTKEYFILE=</span> <span class="hljs-comment"># Available since 6.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTCACHE=false</span> <span class="hljs-comment"># Available since 6.2.0</span>
|
||||
<pre><code>ZBX_VAULT=HashiCorp # Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since 6.2.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_VAULTPREFIX= # Available since 7.0.0
|
||||
ZBX_VAULTCERTFILE= # Available since 6.2.0
|
||||
ZBX_VAULTKEYFILE= # Available since 6.2.0
|
||||
ZBX_VAULTCACHE=false # Available since 6.2.0
|
||||
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_ACTIVE=false</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CAFILE=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CA=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_KEYFILE=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_KEY=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CERTFILE=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CERT=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CERT_ISSUER=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CERT_SUBJECT=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
ZBX_SERVER_TLS_ACTIVE=false # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CAFILE= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CA= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_KEYFILE= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_KEY= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CERTFILE= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CERT= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CERT_ISSUER= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CERT_SUBJECT= # Available since 7.4.0
|
||||
|
||||
Allowed PHP-FPM configuration options:
|
||||
<span class="hljs-attr">PHP_FPM_PM=dynamic</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_MAX_CHILDREN=50</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_START_SERVERS=5</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_MIN_SPARE_SERVERS=5</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_MAX_SPARE_SERVERS=35</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_MAX_REQUESTS=0</span>
|
||||
PHP_FPM_PM=dynamic
|
||||
PHP_FPM_PM_MAX_CHILDREN=50
|
||||
PHP_FPM_PM_START_SERVERS=5
|
||||
PHP_FPM_PM_MIN_SPARE_SERVERS=5
|
||||
PHP_FPM_PM_MAX_SPARE_SERVERS=35
|
||||
PHP_FPM_PM_MAX_REQUESTS=0
|
||||
|
||||
Allowed Nginx configuration options:
|
||||
<span class="hljs-attr">WEB_REAL_IP_FROM=</span>
|
||||
<span class="hljs-attr">WEB_REAL_IP_HEADER=</span>
|
||||
</code></pre><h2 id="allowed-volumes-for-the-zabbix-web-interface-container">Allowed volumes for the Zabbix web interface container</h2>
|
||||
<h3 id="-etc-ssl-nginx-"><code>/etc/ssl/nginx</code></h3>
|
||||
<p>The volume allows to enable HTTPS for the Zabbix web interface. The volume must contains three files <code>ssl.crt</code>, <code>ssl.key</code> and <code>dhparam.pem</code> prepared for Nginx SSL connections.</p>
|
||||
WEB_REAL_IP_FROM=
|
||||
WEB_REAL_IP_HEADER=
|
||||
</code></pre>
|
||||
<h3>Allowed volumes for the Zabbix web interface container</h3>
|
||||
<h4><code>/etc/ssl/nginx</code></h4>
|
||||
<p>The volume allows to enable HTTPS for the Zabbix web interface. The volume must contain three files <code>ssl.crt</code>, <code>ssl.key</code> and <code>dhparam.pem</code> prepared for Nginx SSL connections.</p>
|
||||
<p>Please follow official Nginx <a href="http://nginx.org/en/docs/http/configuring_https_servers.html">documentation</a> to get more details about how to create certificate files.</p>
|
||||
<h3 id="-etc-zabbix-web-certs-"><code>/etc/zabbix/web/certs</code></h3>
|
||||
<p>The volume allows to use custom certificates for SAML authentification. The volume must contains three files <code>sp.key</code>, <code>sp.crt</code> and <code>idp.crt</code>. Available since 5.0.0.</p>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h4><code>/etc/zabbix/web/certs</code></h4>
|
||||
<p>The volume allows to use custom certificates for SAML authentication. The volume must contain three files <code>sp.key</code>, <code>sp.crt</code> and <code>idp.crt</code>. Available since 5.0.0.</p>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_SERVER_TLS_CAFILE</code>, <code>ZBX_SERVER_TLS_KEYFILE</code> and <code>ZBX_SERVER_TLS_CERTFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_SERVER_TLS_CA</code>, <code>ZBX_SERVER_TLS_KEY</code> and <code>ZBX_SERVER_TLS_CERT</code> with plaintext values. Available since 7.4.0.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/web-nginx-mysql"><code>web-nginx-mysql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/web-nginx-mysql"><code>web-nginx-mysql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h4>Known issues</h4>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,12 +1,11 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-web-interface-">What is Zabbix web interface?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix web interface?</h2>
|
||||
<p>Zabbix web interface is a part of Zabbix software. It is used to manage resources under monitoring and view monitoring statistics.</p>
|
||||
<h1 id="zabbix-web-interface-images">Zabbix web interface images</h1>
|
||||
<p>These are the only official Zabbix web interface Podman images. Images are updated when new releases are published.</p>
|
||||
<h2>Zabbix web interface images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<p>Zabbix web interface available in four editions:</p>
|
||||
<ul>
|
||||
<li>Zabbix web-interface based on Apache2 web server with MySQL database support</li>
|
||||
|
|
@ -15,153 +14,196 @@
|
|||
<li>Zabbix web-interface based on Nginx web server with PostgreSQL database support</li>
|
||||
</ul>
|
||||
<p>The image based on Nginx web server with PostgreSQL database support.</p>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-web-nginx-pgsql-">Start <code>zabbix-web-nginx-pgsql</code></h2>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-web-nginx-pgsql</code></h3>
|
||||
<p>Start a Zabbix web-interface container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-web-nginx-pgsql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-postgres-server"</span> <span class="hljs-_">-e</span> POSTGRES_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> POSTGRES_PASSWORD=<span class="hljs-string">"some-password"</span> <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-pgsql:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-web-nginx-pgsql</code> is the name you want to assign to your container, <code>some-postgres-server</code> is IP or DNS name of PostgreSQL server, <code>some-user</code> is user to connect to Zabbix database on PostgreSQL server, <code>some-password</code> is the password to connect to PostgreSQL server, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server or proxy, <code>some-timezone</code> is PHP like timezone name and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h2 id="linking-the-container-to-zabbix-server">Linking the container to Zabbix server</h2>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-web-nginx-pgsql --link some-zabbix-server:zabbix-server <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-postgres-server"</span> <span class="hljs-_">-e</span> POSTGRES_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> POSTGRES_PASSWORD=<span class="hljs-string">"some-password"</span> <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-pgsql:tag</span>
|
||||
</code></pre><h2 id="linking-the-container-to-postgresql-database">Linking the container to PostgreSQL database</h2>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-web-nginx-pgsql --link some-postgres-server:postgres <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-postgres-server"</span> <span class="hljs-_">-e</span> POSTGRES_USER=<span class="hljs-string">"some-user"</span> <span class="hljs-_">-e</span> POSTGRES_PASSWORD=<span class="hljs-string">"some-password"</span> <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-pgsql:tag</span>
|
||||
</code></pre><h2 id="container-shell-access-and-viewing-zabbix-web-interface-logs">Container shell access and viewing Zabbix web interface logs</h2>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-nginx-pgsql \
|
||||
-e DB_SERVER_HOST="some-postgres-server" \
|
||||
-e POSTGRES_USER="some-user" \
|
||||
-e POSTGRES_PASSWORD="some-password" \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
-e PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-pgsql-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-web-nginx-pgsql</code> is the name you want to assign to your container, <code>some-postgres-server</code> is IP or DNS name of PostgreSQL server, <code>some-user</code> is user to connect to Zabbix database on PostgreSQL server, <code>some-password</code> is the password to connect to PostgreSQL server, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server or proxy, <code>some-timezone</code> is PHP like timezone name and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h3>Linking the container to Zabbix server</h3>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-nginx-pgsql \
|
||||
--link some-zabbix-server:zabbix-server \
|
||||
-e DB_SERVER_HOST="some-postgres-server" \
|
||||
-e POSTGRES_USER="some-user" \
|
||||
-e POSTGRES_PASSWORD="some-password" \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
-e PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-pgsql-74:tag
|
||||
</code></pre>
|
||||
<h3>Linking the container to PostgreSQL database</h3>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-nginx-pgsql \
|
||||
--link some-postgres-server:postgres \
|
||||
-e DB_SERVER_HOST="some-postgres-server" \
|
||||
-e POSTGRES_USER="some-user" \
|
||||
-e POSTGRES_PASSWORD="some-password" \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
-e PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-pgsql-74:tag
|
||||
</code></pre>
|
||||
<h3>Container shell access and viewing Zabbix web interface logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-web-nginx-pgsql</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-web-nginx-pgsql /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-web-nginx-pgsql /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix web interface log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-web-nginx-pgsql
|
||||
<p>The Zabbix web interface log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-web-nginx-pgsql
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-web-nginx-pgsql</code> image, you can adjust the configuration of the Zabbix web interface by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_server_host-"><code>ZBX_SERVER_HOST</code></h3>
|
||||
<h4><code>ZBX_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of Zabbix server. By default, value is <code>zabbix-server</code>.</p>
|
||||
<h3 id="-zbx_server_port-"><code>ZBX_SERVER_PORT</code></h3>
|
||||
<h4><code>ZBX_SERVER_PORT</code></h4>
|
||||
<p>This variable is port Zabbix server listening on. By default, value is <code>10051</code>.</p>
|
||||
<h3 id="-db_server_host-"><code>DB_SERVER_HOST</code></h3>
|
||||
<p>This variable is IP or DNS name of PostgreSQL server. By default, value is 'postgres-server'</p>
|
||||
<h3 id="-db_server_port-"><code>DB_SERVER_PORT</code></h3>
|
||||
<p>This variable is port of PostgreSQL server. By default, value is '5432'.</p>
|
||||
<h3 id="-postgres_user-postgres_password-postgres_user_file-postgres_password_file-"><code>POSTGRES_USER</code>, <code>POSTGRES_PASSWORD</code>, <code>POSTGRES_USER_FILE</code>, <code>POSTGRES_PASSWORD_FILE</code></h3>
|
||||
<h4><code>DB_SERVER_HOST</code></h4>
|
||||
<p>This variable is IP or DNS name of PostgreSQL server. By default, value is 'postgres-server'</p>
|
||||
<h4><code>DB_SERVER_PORT</code></h4>
|
||||
<p>This variable is port of PostgreSQL server. By default, value is '5432'.</p>
|
||||
<h4><code>POSTGRES_USER</code>, <code>POSTGRES_PASSWORD</code>, <code>POSTGRES_USER_FILE</code>, <code>POSTGRES_PASSWORD_FILE</code></h4>
|
||||
<p>These variables are used by Zabbix web interface to connect to Zabbix database. With the <code>_FILE</code> 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 <code>POSTGRES_USER</code> or <code>POSTGRES_USER_FILE</code>!</p>
|
||||
<pre><code class="lang-console">podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-web-nginx-pgsql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-postgres-server"</span> -v ./.POSTGRES_USER:/run/secrets/POSTGRES_USER <span class="hljs-_">-e</span> POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER -v ./.POSTGRES_PASSWORD:/run/secrets/POSTGRES_PASSWORD <span class="hljs-_">-e</span> POSTGRES_PASSWORD_FILE=/var/run/secrets/POSTGRES_PASSWORD <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-pgsql:tag</span>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-nginx-pgsql \
|
||||
-e DB_SERVER_HOST="some-postgres-server" \
|
||||
-v ./.POSTGRES_USER:/run/secrets/POSTGRES_USER \
|
||||
-e POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER \
|
||||
-v ./.POSTGRES_PASSWORD:/run/secrets/POSTGRES_PASSWORD \
|
||||
-e POSTGRES_PASSWORD_FILE=/var/run/secrets/POSTGRES_PASSWORD \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
-e PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-pgsql-74:tag
|
||||
</code></pre>
|
||||
<p>With Docker Swarm or Kubernetes this works with secrets. That way it is replicated in your cluster!</p>
|
||||
<pre><code class="lang-console"><span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create POSTGRES_USER -
|
||||
<span class="hljs-built_in">printf</span> <span class="hljs-string">"zabbix"</span> | podman secret create POSTGRES_PASSWORD -
|
||||
podman run --name some-zabbix-web-nginx-pgsql <span class="hljs-_">-e</span> DB_SERVER_HOST=<span class="hljs-string">"some-postgres-server"</span> <span class="hljs-_">-e</span> POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER <span class="hljs-_">-e</span> POSTGRES_PASSWORD_FILE=/run/secrets/POSTGRES_PASSWORD <span class="hljs-_">-e</span> ZBX_SERVER_HOST=<span class="hljs-string">"some-zabbix-server"</span> <span class="hljs-_">-e</span> PHP_TZ=<span class="hljs-string">"some-timezone"</span> <span class="hljs-_">-d</span> zabbix/zabbix-web-nginx-pgsql:tag
|
||||
<pre><code>printf "zabbix" | podman secret create POSTGRES_USER -
|
||||
printf "zabbix" | podman secret create POSTGRES_PASSWORD -
|
||||
podman run \
|
||||
--name some-zabbix-web-nginx-pgsql \
|
||||
-e DB_SERVER_HOST="some-postgres-server" \
|
||||
-e POSTGRES_USER_FILE=/run/secrets/POSTGRES_USER \
|
||||
-e POSTGRES_PASSWORD_FILE=/run/secrets/POSTGRES_PASSWORD \
|
||||
-e ZBX_SERVER_HOST="some-zabbix-server" \
|
||||
-e PHP_TZ="some-timezone" \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-pgsql-74:tag
|
||||
</code></pre>
|
||||
<p>By default, values for <code>POSTGRES_USER</code> and <code>POSTGRES_PASSWORD</code> are <code>zabbix</code>, <code>zabbix</code>.</p>
|
||||
<h3 id="-postgres_db-"><code>POSTGRES_DB</code></h3>
|
||||
<h4><code>POSTGRES_DB</code></h4>
|
||||
<p>The variable is Zabbix database name. By default, value is <code>zabbix</code>.</p>
|
||||
<h3 id="-postgres_use_implicit_search_path-"><code>POSTGRES_USE_IMPLICIT_SEARCH_PATH</code></h3>
|
||||
<p>In some setups, for example including <a href="https://www.pgbouncer.org">PgBouncer</a>, setting the <code>search_path</code> via connection parameters fails. If this variable is set to <code>"true"</code>, the image skips setting the <code>search_path</code> and trusts that the <code>search_path</code> of the Zabbix user is setup correctly in PostgreSQL database.</p>
|
||||
<h3 id="-zbx_historystorageurl-"><code>ZBX_HISTORYSTORAGEURL</code></h3>
|
||||
<h4><code>POSTGRES_USE_IMPLICIT_SEARCH_PATH</code></h4>
|
||||
<p>In some setups, for example including <a href="https://www.pgbouncer.org">PgBouncer</a>, setting the <code>search_path</code> via connection parameters fails. If this variable is set to <code>"true"</code>, the image skips setting the <code>search_path</code> and trusts that the <code>search_path</code> of the Zabbix user is setup correctly in PostgreSQL database.</p>
|
||||
<h4><code>ZBX_HISTORYSTORAGEURL</code></h4>
|
||||
<p>History storage HTTP[S] URL. This parameter is used for Elasticsearch setup. Available since 3.4.5.</p>
|
||||
<h3 id="-zbx_historystoragetypes-"><code>ZBX_HISTORYSTORAGETYPES</code></h3>
|
||||
<p>Array of value types to be sent to the history storage. An example: ['uint', 'dbl']. This parameter is used for Elasticsearch setup. Available since 3.4.5.</p>
|
||||
<h3 id="-php_tz-"><code>PHP_TZ</code></h3>
|
||||
<p>The variable is timezone in PHP format. Full list of supported timezones are available on <a href="http://php.net/manual/en/timezones.php"><code>php.net</code></a>. By default, value is 'Europe/Riga' and system timezone since Zabbix 5.2.0.</p>
|
||||
<h3 id="-zbx_server_name-"><code>ZBX_SERVER_NAME</code></h3>
|
||||
<h4><code>ZBX_HISTORYSTORAGETYPES</code></h4>
|
||||
<p>Array of value types to be sent to the history storage. An example: ['uint', 'dbl']. This parameter is used for Elasticsearch setup. Available since 3.4.5.</p>
|
||||
<h4><code>PHP_TZ</code></h4>
|
||||
<p>The variable is timezone in PHP format. Full list of supported timezones are available on <a href="http://php.net/manual/en/timezones.php"><code>php.net</code></a>. By default, value is 'Europe/Riga' and system timezone since Zabbix 5.2.0.</p>
|
||||
<h4><code>ZBX_SERVER_NAME</code></h4>
|
||||
<p>The variable is visible Zabbix installation name in right or left top corner of the web interface.</p>
|
||||
<h3 id="-db_double_ieee754-"><code>DB_DOUBLE_IEEE754</code></h3>
|
||||
<h4><code>DB_DOUBLE_IEEE754</code></h4>
|
||||
<p>Use IEEE754 compatible value range for 64-bit Numeric (float) history values. Available since 5.0.0. Enabled by default.</p>
|
||||
<h3 id="-enable_web_access_log-"><code>ENABLE_WEB_ACCESS_LOG</code></h3>
|
||||
<h4><code>ENABLE_WEB_ACCESS_LOG</code></h4>
|
||||
<p>The variable sets the Access Log directive for Web server. By default, value corresponds to standard output.</p>
|
||||
<h3 id="-http_index_file-"><code>HTTP_INDEX_FILE</code></h3>
|
||||
<h4><code>HTTP_INDEX_FILE</code></h4>
|
||||
<p>The variable controls default index page. By default, <code>index.php</code>.</p>
|
||||
<h3 id="-expose_web_server_info-"><code>EXPOSE_WEB_SERVER_INFO</code></h3>
|
||||
<h4><code>EXPOSE_WEB_SERVER_INFO</code></h4>
|
||||
<p>The variable allows to hide Web server and PHP versions. By default, <code>on</code>.</p>
|
||||
<h3 id="-zbx_maxexecutiontime-"><code>ZBX_MAXEXECUTIONTIME</code></h3>
|
||||
<p>The varable is PHP <code>max_execution_time</code> option. By default, value is <code>300</code>.</p>
|
||||
<h3 id="-zbx_memorylimit-"><code>ZBX_MEMORYLIMIT</code></h3>
|
||||
<p>The varable is PHP <code>memory_limit</code> option. By default, value is <code>128M</code>.</p>
|
||||
<h3 id="-zbx_postmaxsize-"><code>ZBX_POSTMAXSIZE</code></h3>
|
||||
<p>The varable is PHP <code>post_max_size</code> option. By default, value is <code>16M</code>.</p>
|
||||
<h3 id="-zbx_uploadmaxfilesize-"><code>ZBX_UPLOADMAXFILESIZE</code></h3>
|
||||
<p>The varable is PHP <code>upload_max_filesize</code> option. By default, value is <code>2M</code>.</p>
|
||||
<h3 id="-zbx_maxinputtime-"><code>ZBX_MAXINPUTTIME</code></h3>
|
||||
<p>The varable is PHP <code>max_input_time</code> option. By default, value is <code>300</code>.</p>
|
||||
<h3 id="-zbx_session_name-"><code>ZBX_SESSION_NAME</code></h3>
|
||||
<h4><code>ZBX_MAXEXECUTIONTIME</code></h4>
|
||||
<p>The variable is PHP <code>max_execution_time</code> option. By default, value is <code>300</code>.</p>
|
||||
<h4><code>ZBX_MEMORYLIMIT</code></h4>
|
||||
<p>The variable is PHP <code>memory_limit</code> option. By default, value is <code>128M</code>.</p>
|
||||
<h4><code>ZBX_POSTMAXSIZE</code></h4>
|
||||
<p>The variable is PHP <code>post_max_size</code> option. By default, value is <code>16M</code>.</p>
|
||||
<h4><code>ZBX_UPLOADMAXFILESIZE</code></h4>
|
||||
<p>The variable is PHP <code>upload_max_filesize</code> option. By default, value is <code>2M</code>.</p>
|
||||
<h4><code>ZBX_MAXINPUTTIME</code></h4>
|
||||
<p>The variable is PHP <code>max_input_time</code> option. By default, value is <code>300</code>.</p>
|
||||
<h4><code>ZBX_SESSION_NAME</code></h4>
|
||||
<p>The variable is Zabbix frontend <a href="https://www.zabbix.com/documentation/current/manual/web_interface/definitions">definition</a>. String used as the name of the Zabbix frontend session cookie. By default, value is <code>zbx_sessionid</code>.</p>
|
||||
<h3 id="-zbx_deny_gui_access-"><code>ZBX_DENY_GUI_ACCESS</code></h3>
|
||||
<h4><code>ZBX_DENY_GUI_ACCESS</code></h4>
|
||||
<p>Enable (<code>true</code>) maintenance mode for Zabbix web-interface.</p>
|
||||
<h3 id="-zbx_gui_access_ip_range-"><code>ZBX_GUI_ACCESS_IP_RANGE</code></h3>
|
||||
<h4><code>ZBX_GUI_ACCESS_IP_RANGE</code></h4>
|
||||
<p>Array of IP addresses which are allowed for accessing to Zabbix web-interface during maintenance period.</p>
|
||||
<h3 id="-zbx_gui_warning_msg-"><code>ZBX_GUI_WARNING_MSG</code></h3>
|
||||
<h4><code>ZBX_GUI_WARNING_MSG</code></h4>
|
||||
<p>Information message about maintenance period for Zabbix web-interface.</p>
|
||||
<h3 id="-zbx_db_encryption-"><code>ZBX_DB_ENCRYPTION</code></h3>
|
||||
<h4><code>ZBX_DB_ENCRYPTION</code></h4>
|
||||
<p>The variable allows to activate encryption for connections to Zabbix database. Even if no other environment variables are specified, connections will be TLS-encrypted if <code>ZBX_DB_ENCRYPTION=true</code> specified. Available since 5.0.0. Disabled by default.</p>
|
||||
<h3 id="-zbx_db_key_file-"><code>ZBX_DB_KEY_FILE</code></h3>
|
||||
<h4><code>ZBX_DB_KEY_FILE</code></h4>
|
||||
<p>The variable allows to specify the full path to a valid TLS key file. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_db_cert_file-"><code>ZBX_DB_CERT_FILE</code></h3>
|
||||
<h4><code>ZBX_DB_CERT_FILE</code></h4>
|
||||
<p>The variable allows to specify the full path to a valid TLS certificate file. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_db_ca_file-"><code>ZBX_DB_CA_FILE</code></h3>
|
||||
<h4><code>ZBX_DB_CA_FILE</code></h4>
|
||||
<p>The variable allows to specify the full path to a valid TLS certificate authority file. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_db_verify_host-"><code>ZBX_DB_VERIFY_HOST</code></h3>
|
||||
<h4><code>ZBX_DB_VERIFY_HOST</code></h4>
|
||||
<p>The variable allows to activate host verification. Available since 5.0.0.</p>
|
||||
<h3 id="-zbx_sso_sp_key-"><code>ZBX_SSO_SP_KEY</code></h3>
|
||||
<h4><code>ZBX_SSO_SP_KEY</code></h4>
|
||||
<p>The variable allows to specify a custom file path to the Service Provider (SP) private key file.</p>
|
||||
<h3 id="-zbx_sso_sp_cert-"><code>ZBX_SSO_SP_CERT</code></h3>
|
||||
<p>The variable allows to specify a custom file path to the Serivce Provider (SP) cert file.</p>
|
||||
<h3 id="-zbx_sso_idp_cert-"><code>ZBX_SSO_IDP_CERT</code></h3>
|
||||
<h4><code>ZBX_SSO_SP_CERT</code></h4>
|
||||
<p>The variable allows to specify a custom file path to the Service Provider (SP) cert file.</p>
|
||||
<h4><code>ZBX_SSO_IDP_CERT</code></h4>
|
||||
<p>The variable allows to specify a custom file path to the SAML Certificate provided by the Identity Provider (ID) file.</p>
|
||||
<h2 id="-zbx_sso_settings-"><code>ZBX_SSO_SETTINGS</code></h2>
|
||||
<h3><code>ZBX_SSO_SETTINGS</code></h3>
|
||||
<p>The variable allows to specify custom SSO settings in JSON format. Available since 5.0.0.</p>
|
||||
<p>Example of YAML Mapping to Sequences</p>
|
||||
<pre><code><span class="hljs-code">....
|
||||
<pre><code>....
|
||||
environment:
|
||||
ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}"
|
||||
ZBX_SSO_SETTINGS: "{'baseurl': 'https://zabbix-docker.mydomain.com', 'use_proxy_headers': true, 'strict': false}"
|
||||
....
|
||||
....
|
||||
....</span>
|
||||
</code></pre>
|
||||
<h3 id="-zbx_allow_http_auth-"><code>ZBX_ALLOW_HTTP_AUTH</code></h3>
|
||||
<h3><code>ZBX_ALLOW_HTTP_AUTH</code></h3>
|
||||
<p>The variable allows to disable user HTTP authentication.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_VAULT=HashiCorp</span> <span class="hljs-comment"># Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since 6.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTDBPATH=</span> <span class="hljs-comment"># Available since 5.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTURL=https://127.0.0.1:8200</span> <span class="hljs-comment"># Available since 5.2.0</span>
|
||||
<span class="hljs-attr">VAULT_TOKEN=</span> <span class="hljs-comment"># Available since 5.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTPREFIX=</span> <span class="hljs-comment"># Available since 7.0.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTCERTFILE=</span> <span class="hljs-comment"># Available since 6.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTKEYFILE=</span> <span class="hljs-comment"># Available since 6.2.0</span>
|
||||
<span class="hljs-attr">ZBX_VAULTCACHE=false</span> <span class="hljs-comment"># Available since 6.2.0</span>
|
||||
<pre><code>ZBX_VAULT=HashiCorp # Allowed values: HashiCorp, CyberArk. Required when Vault is used. Available since 6.2.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_VAULTPREFIX= # Available since 7.0.0
|
||||
ZBX_VAULTCERTFILE= # Available since 6.2.0
|
||||
ZBX_VAULTKEYFILE= # Available since 6.2.0
|
||||
ZBX_VAULTCACHE=false # Available since 6.2.0
|
||||
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_ACTIVE=false</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CAFILE=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CA=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_KEYFILE=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_KEY=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CERTFILE=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CERT=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CERT_ISSUER=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
<span class="hljs-attr">ZBX_SERVER_TLS_CERT_SUBJECT=</span> <span class="hljs-comment"># Available since 7.4.0</span>
|
||||
ZBX_SERVER_TLS_ACTIVE=false # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CAFILE= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CA= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_KEYFILE= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_KEY= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CERTFILE= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CERT= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CERT_ISSUER= # Available since 7.4.0
|
||||
ZBX_SERVER_TLS_CERT_SUBJECT= # Available since 7.4.0
|
||||
|
||||
Allowed PHP-FPM configuration options:
|
||||
<span class="hljs-attr">PHP_FPM_PM=dynamic</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_MAX_CHILDREN=50</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_START_SERVERS=5</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_MIN_SPARE_SERVERS=5</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_MAX_SPARE_SERVERS=35</span>
|
||||
<span class="hljs-attr">PHP_FPM_PM_MAX_REQUESTS=0</span>
|
||||
PHP_FPM_PM=dynamic
|
||||
PHP_FPM_PM_MAX_CHILDREN=50
|
||||
PHP_FPM_PM_START_SERVERS=5
|
||||
PHP_FPM_PM_MIN_SPARE_SERVERS=5
|
||||
PHP_FPM_PM_MAX_SPARE_SERVERS=35
|
||||
PHP_FPM_PM_MAX_REQUESTS=0
|
||||
|
||||
Allowed Nginx configuration options:
|
||||
<span class="hljs-attr">WEB_REAL_IP_FROM=</span>
|
||||
<span class="hljs-attr">WEB_REAL_IP_HEADER=</span>
|
||||
</code></pre><h2 id="allowed-volumes-for-the-zabbix-web-interface-container">Allowed volumes for the Zabbix web interface container</h2>
|
||||
<h3 id="-etc-ssl-nginx-"><code>/etc/ssl/nginx</code></h3>
|
||||
<p>The volume allows to enable HTTPS for the Zabbix web interface. The volume must contains three files <code>ssl.crt</code>, <code>ssl.key</code> and <code>dhparam.pem</code> prepared for Nginx SSL connections.</p>
|
||||
WEB_REAL_IP_FROM=
|
||||
WEB_REAL_IP_HEADER=
|
||||
</code></pre>
|
||||
<h3>Allowed volumes for the Zabbix web interface container</h3>
|
||||
<h4><code>/etc/ssl/nginx</code></h4>
|
||||
<p>The volume allows to enable HTTPS for the Zabbix web interface. The volume must contain three files <code>ssl.crt</code>, <code>ssl.key</code> and <code>dhparam.pem</code> prepared for Nginx SSL connections.</p>
|
||||
<p>Please follow official Nginx <a href="http://nginx.org/en/docs/http/configuring_https_servers.html">documentation</a> to get more details about how to create certificate files.</p>
|
||||
<h3 id="-etc-zabbix-web-certs-"><code>/etc/zabbix/web/certs</code></h3>
|
||||
<p>The volume allows to use custom certificates for SAML authentification. The volume must contains three files <code>sp.key</code>, <code>sp.crt</code> and <code>idp.crt</code>. Available since 5.0.0.</p>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h4><code>/etc/zabbix/web/certs</code></h4>
|
||||
<p>The volume allows to use custom certificates for SAML authentication. The volume must contain three files <code>sp.key</code>, <code>sp.crt</code> and <code>idp.crt</code>. Available since 5.0.0.</p>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_SERVER_TLS_CAFILE</code>, <code>ZBX_SERVER_TLS_KEYFILE</code> and <code>ZBX_SERVER_TLS_CERTFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_SERVER_TLS_CA</code>, <code>ZBX_SERVER_TLS_KEY</code> and <code>ZBX_SERVER_TLS_CERT</code> with plaintext values. Available since 7.4.0.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/web-nginx-pgsql"><code>web-nginx-pgsql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/web-nginx-pgsql"><code>web-nginx-pgsql/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<h4>Known issues</h4>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
|
|
@ -1,35 +1,44 @@
|
|||
<p><img src="https://assets.zabbix.com/img/logo/zabbix_logo_500x131.png" alt="logo"></p>
|
||||
<h1 id="what-is-zabbix-">What is Zabbix?</h1>
|
||||
<h2>What is Zabbix?</h2>
|
||||
<p>Zabbix is an enterprise-class open source distributed monitoring solution.</p>
|
||||
<p>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.</p>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">https://hub.docker.com/u/zabbix/</a> and <a href="https://zabbix.com">https://zabbix.com</a></p>
|
||||
<h1 id="what-is-zabbix-web-service-">What is Zabbix web service?</h1>
|
||||
<p>For more information and related downloads for Zabbix components, please visit <a href="https://hub.docker.com/u/zabbix/">Docker Hub</a> and <a href="https://zabbix.com">zabbix.com</a></p>
|
||||
<h2>What is Zabbix web service?</h2>
|
||||
<p>Zabbix web service for performing various tasks using headless web browser (for example, reporting).</p>
|
||||
<h1 id="zabbix-web-service-images">Zabbix web service images</h1>
|
||||
<p>These are the only official Zabbix web service Podman images. Images are updated when new releases are published.</p>
|
||||
<h1 id="how-to-use-this-image">How to use this image</h1>
|
||||
<h2 id="start-zabbix-web-service-">Start <code>zabbix-web-service</code></h2>
|
||||
<h2>Zabbix web service images</h2>
|
||||
<p>Images are updated when new releases are published.</p>
|
||||
<h2>How to use this image</h2>
|
||||
<h3>Start <code>zabbix-web-service</code></h3>
|
||||
<p>Start a Zabbix web service container as follows:</p>
|
||||
<pre><code>podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-web-service <span class="hljs-_">-e</span> ZBX_ALLOWEDIP=<span class="hljs-string">"some-zabbix-server"</span> --cap-add=SYS_ADMIN <span class="hljs-_">-d</span> zabbix/zabbix-web-service:tag</span>
|
||||
</code></pre><p>Where <code>some-zabbix-web-service</code> is the name you want to assign to your container, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h2 id="connects-from-zabbix-server-in-other-containers">Connects from Zabbix server in other containers</h2>
|
||||
<pre><code>podman run \
|
||||
--name some-zabbix-web-service \
|
||||
-e ZBX_ALLOWEDIP="some-zabbix-server" \
|
||||
--cap-add=SYS_ADMIN \
|
||||
-d registry.connect.redhat.com/zabbix/zabbix-web-service-74:tag
|
||||
</code></pre>
|
||||
<p>Where <code>some-zabbix-web-service</code> is the name you want to assign to your container, <code>some-zabbix-server</code> is IP or DNS name of Zabbix server and <code>tag</code> is the tag specifying the version you want.</p>
|
||||
<h3>Connects from Zabbix server in other containers</h3>
|
||||
<p>This image exposes the standard Zabbix web service port (<code>10053</code>) to perform communication, so container linking makes Zabbix web service instance available to Zabbix server containers. Start your application container like this in order to link it to the Zabbix web service container:</p>
|
||||
<pre><code class="lang-console">$ podman <span class="hljs-keyword">run</span><span class="bash"> --name some-zabbix-server --link some-zabbix-web-service:zabbix-web-service <span class="hljs-_">-e</span> ZBX_STARTREPORTWRITERS=<span class="hljs-string">"2"</span> <span class="hljs-_">-e</span> ZBX_WEBSERVICEURL=<span class="hljs-string">"http://some-zabbix-web-service:10053/report"</span> <span class="hljs-_">-d</span> zabbix/zabbix-server:latest</span>
|
||||
<pre><code>$ podman run \
|
||||
--name some-zabbix-server \
|
||||
--link some-zabbix-web-service:zabbix-web-service \
|
||||
-e ZBX_STARTREPORTWRITERS="2" \
|
||||
-e ZBX_WEBSERVICEURL="http://some-zabbix-web-service:10053/report" \
|
||||
-d zabbix/zabbix-server:latest
|
||||
</code></pre>
|
||||
<h2 id="container-shell-access-and-viewing-zabbix-web-service-logs">Container shell access and viewing Zabbix web service logs</h2>
|
||||
<h3>Container shell access and viewing Zabbix web service logs</h3>
|
||||
<p>The <code>podman exec</code> command allows you to run commands inside a Podman container. The following command line will give you a bash shell inside your <code>zabbix-web-service</code> container:</p>
|
||||
<pre><code class="lang-console">$ podman exec -ti <span class="hljs-keyword">some</span>-zabbix-web-service /bin/bash
|
||||
<pre><code>$ podman exec -ti some-zabbix-web-service /bin/bash
|
||||
</code></pre>
|
||||
<p>The Zabbix web service log is available through Podman's container log:</p>
|
||||
<pre><code class="lang-console">$ podman logs <span class="hljs-keyword">some</span>-zabbix-web-service
|
||||
<p>The Zabbix web service log is available through Podman's container log:</p>
|
||||
<pre><code>$ podman logs some-zabbix-web-service
|
||||
</code></pre>
|
||||
<h2 id="environment-variables">Environment Variables</h2>
|
||||
<h3>Environment Variables</h3>
|
||||
<p>When you start the <code>zabbix-web-service</code> image, you can adjust the configuration of the Zabbix web service by passing one or more environment variables on the <code>podman run</code> command line.</p>
|
||||
<h3 id="-zbx_allowedip-"><code>ZBX_ALLOWEDIP</code></h3>
|
||||
<h4><code>ZBX_ALLOWEDIP</code></h4>
|
||||
<p>This variable is IP or DNS name or list of IP / DNS names of Zabbix server. By default, value is <code>zabbix-server</code>.</p>
|
||||
<h3 id="-zbx_listenport-"><code>ZBX_LISTENPORT</code></h3>
|
||||
<h4><code>ZBX_LISTENPORT</code></h4>
|
||||
<p>Listen port for incoming request. By default, value is <code>10053</code>.</p>
|
||||
<h3 id="-zbx_debuglevel-"><code>ZBX_DEBUGLEVEL</code></h3>
|
||||
<h4><code>ZBX_DEBUGLEVEL</code></h4>
|
||||
<p>The variable is used to specify debug level. By default, value is <code>3</code>. It is <code>DebugLevel</code> parameter in <code>zabbix_web_service.conf</code>. Allowed values are listed below:</p>
|
||||
<ul>
|
||||
<li><code>0</code> - basic information about starting and stopping of Zabbix processes;</li>
|
||||
|
|
@ -39,32 +48,34 @@
|
|||
<li><code>4</code> - for debugging (produces lots of information)</li>
|
||||
<li><code>5</code> - extended debugging (produces even more information)</li>
|
||||
</ul>
|
||||
<h3 id="-zbx_timeout-"><code>ZBX_TIMEOUT</code></h3>
|
||||
<h4><code>ZBX_TIMEOUT</code></h4>
|
||||
<p>The variable is used to specify timeout for processing requests. By default, value is <code>3</code>.</p>
|
||||
<h3 id="other-variables">Other variables</h3>
|
||||
<h4>Other variables</h4>
|
||||
<p>Additionally the image allows to specify many other environment variables listed below:</p>
|
||||
<pre><code><span class="hljs-attr">ZBX_TLSACCEPT</span>=unencrypted
|
||||
<span class="hljs-attr">ZBX_TLSCAFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCA</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERTFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSCERT</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEYFILE</span>=
|
||||
<span class="hljs-attr">ZBX_TLSKEY</span>=
|
||||
<span class="hljs-attr">ZBX_IGNOREURLCERTERRORS</span>=<span class="hljs-number">0</span>
|
||||
</code></pre><p>Default values of these variables are specified after equal sign.</p>
|
||||
<pre><code>ZBX_TLSACCEPT=unencrypted
|
||||
ZBX_TLSCAFILE=
|
||||
ZBX_TLSCA=
|
||||
ZBX_TLSCERTFILE=
|
||||
ZBX_TLSCERT=
|
||||
ZBX_TLSKEYFILE=
|
||||
ZBX_TLSKEY=
|
||||
ZBX_IGNOREURLCERTERRORS=0
|
||||
</code></pre>
|
||||
<p>Default values of these variables are specified after equal sign.</p>
|
||||
<p>Please use official documentation for <a href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_web_service"><code>zabbix_web_service.conf</code></a> to get more information about the variables.</p>
|
||||
<h2 id="allowed-volumes-for-the-zabbix-web-service-container">Allowed volumes for the Zabbix web service container</h2>
|
||||
<h3 id="-var-lib-zabbix-enc-"><code>/var/lib/zabbix/enc</code></h3>
|
||||
<h3>Allowed volumes for the Zabbix web service container</h3>
|
||||
<h4><code>/var/lib/zabbix/enc</code></h4>
|
||||
<p>The volume is used to store TLS related files. These file names are specified using <code>ZBX_TLSCAFILE</code>, <code>ZBX_TLSCERTFILE</code> and <code>ZBX_TLSKEYFILE</code> variables. Additionally it is possible to use environment variables <code>ZBX_TLSCA</code>, <code>ZBX_TLSCERT</code> and <code>ZBX_TLSKEY</code> with plaintext values.</p>
|
||||
<h1 id="user-feedback">User Feedback</h1>
|
||||
<h2 id="documentation">Documentation</h2>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/web-service"><code>web-service/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h2 id="issues">Issues</h2>
|
||||
<h2>User Feedback</h2>
|
||||
<h3>Documentation</h3>
|
||||
<p>Documentation for this image is stored in the <a href="https://github.com/zabbix/zabbix-docker/tree/7.4/Dockerfiles/web-service"><code>web-service/</code> directory</a> of the <a href="https://github.com/zabbix/zabbix-docker/"><code>zabbix/zabbix-docker</code> GitHub repo</a>. Be sure to familiarize yourself with the <a href="https://github.com/zabbix/zabbix-docker/blob/7.4/README.md">repository's <code>README.md</code> file</a> before attempting a pull request.</p>
|
||||
<h3>Issues</h3>
|
||||
<p>If you have any problems with or questions about this image, please contact us through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>.</p>
|
||||
<h3 id="known-issues">Known issues</h3>
|
||||
<h4>Known issues</h4>
|
||||
<p>Zabbix web services uses Google Chromium with headless mode. Because of restrictions you may see the following error during report generation:</p>
|
||||
<pre><code>Failed <span class="hljs-keyword">to</span> move <span class="hljs-keyword">to</span> <span class="hljs-keyword">new</span> <span class="hljs-keyword">namespace</span>: PID namespaces supported, Network <span class="hljs-keyword">namespace</span> supported, but failed: errno = Operation <span class="hljs-keyword">not</span> permitted
|
||||
</code></pre><p>To avoid the issue it is required to add <code>SYS_ADMIN</code> capability for Zabbix web service. The capability is redundant and allow too much.</p>
|
||||
<h2 id="contributing">Contributing</h2>
|
||||
<pre><code>Failed to move to new namespace: PID namespaces supported, Network namespace supported, but failed: errno = Operation not permitted
|
||||
</code></pre>
|
||||
<p>To avoid the issue it is required to add <code>SYS_ADMIN</code> capability for Zabbix web service. The capability is redundant and allow too much.</p>
|
||||
<h3>Contributing</h3>
|
||||
<p>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.</p>
|
||||
<p>Before you start to code, we recommend discussing your plans through a <a href="https://github.com/zabbix/zabbix-docker/issues">GitHub issue</a>, 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.</p>
|
||||
|
|
|
|||
Loading…
Reference in a new issue