diff options
Diffstat (limited to 'docs/docker.rst')
| -rw-r--r-- | docs/docker.rst | 92 |
1 files changed, 82 insertions, 10 deletions
diff --git a/docs/docker.rst b/docs/docker.rst index cfa25834..927c606a 100644 --- a/docs/docker.rst +++ b/docs/docker.rst @@ -9,13 +9,30 @@ Get the Glances container: .. code-block:: console - docker pull nicolargo/glances + docker pull nicolargo/glances:<version> + +Available tags (all images are based on both Alpine and Ubuntu Operating System): + +- *latest-full* for a full Alpine Glances image (latest release) with all dependencies +- *latest* for a basic Alpine Glances (latest release) version with minimal dependencies (Bottle and Docker) +- *dev* for a basic Alpine Glances image (based on development branch) with all dependencies (Warning: may be instable) +- *ubuntu-latest-full* for a full Ubuntu Glances image (latest release) with all dependencies +- *ubuntu-latest* for a basic Ubuntu Glances (latest release) version with minimal dependencies (Bottle and Docker) +- *ubuntu-dev* for a basic Ubuntu Glances image (based on development branch) with all dependencies (Warning: may be instable) + +You can also specify a version (example: 3.4.0). All available versions can be found on `DockerHub`_. + +An Example to pull the `latest` tag: + +.. code-block:: console + + docker pull nicolargo/glances:latest Run the container in *console mode*: .. code-block:: console - docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host --network host -it docker.io/nicolargo/glances + docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro -v /run/user/1000/podman/podman.sock:/run/user/1000/podman/podman.sock:ro --pid host --network host -it docker.io/nicolargo/glances Additionally, if you want to use your own glances.conf file, you can create your own Dockerfile: @@ -29,7 +46,7 @@ Alternatively, you can specify something along the same lines with docker run op .. code-block:: console - docker run -v `pwd`/glances.conf:/glances/conf/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host -it docker.io/nicolargo/glances + docker run -v `pwd`/glances.conf:/glances/conf/glances.conf -v /var/run/docker.sock:/var/run/docker.sock:ro -v /run/user/1000/podman/podman.sock:/run/user/1000/podman/podman.sock:ro --pid host -it docker.io/nicolargo/glances Where \`pwd\`/glances.conf is a local directory containing your glances.conf file. @@ -37,7 +54,7 @@ Run the container in *Web server mode* (notice the `GLANCES_OPT` environment var .. code-block:: console - docker run -d --restart="always" -p 61208-61209:61208-61209 -e GLANCES_OPT="-w" -v /var/run/docker.sock:/var/run/docker.sock:ro --pid host docker.io/nicolargo/glances + docker run -d --restart="always" -p 61208-61209:61208-61209 -e GLANCES_OPT="-w" -v /var/run/docker.sock:/var/run/docker.sock:ro -v /run/user/1000/podman/podman.sock:/run/user/1000/podman/podman.sock:ro --pid host docker.io/nicolargo/glances Note: if you want to see the network interface stats within the container, add --net=host --privileged @@ -75,7 +92,7 @@ You can also include Glances container in you own `docker-compose.yml`. Here's a - "traefik.frontend.rule=Host:glances.docker.localhost" How to protect your Dockerized server (or Web server) with a login/password ? ------------------------------------------------------------------- +----------------------------------------------------------------------------- Below are two methods for setting up a login/password to protect Glances running inside a Docker container. @@ -93,29 +110,33 @@ and generate the password file (the default login is ``glances``, add the ``--us .. code-block:: console glances -s --password - + which will prompt you to answer the following questions: .. code-block:: console - Define the Glances server password (glances username): - Password (confirm): + + Define the Glances server password (glances username): + Password (confirm): Do you want to save the password? [Yes/No]: Yes after which you will need to kill the process by entering ``CTRL+C`` (potentially twice), before leaving the container: .. code-block:: console + exit You will then need to copy the password file to your host machine: .. code-block:: console + docker cp glances_docker:/root/.config/glances/glances.pwd ./secrets/glances_password and make it visible to your container by adding it to ``docker-compose.yml`` as a ``secret``: .. code-block:: yaml + version: '3' - + services: glances: image: nicolargo/glances:latest @@ -128,7 +149,7 @@ and make it visible to your container by adding it to ``docker-compose.yml`` as secrets: - source: glances_password target: /root/.config/glances/glances.pwd - + secrets: glances_password: file: ./secrets/glances_password @@ -148,3 +169,54 @@ You can add a ``[passwords]`` block to the Glances configuration file as mention # Additionally (and optionally) a default password could be defined localhost=mylocalhostpassword default=mydefaultpassword + +Using GPU Plugin with Docker (Only Nvidia GPUs) +----------------------------------------------- + +Complete the steps mentioned in the `docker docs <https://docs.docker.com/config/containers/resource_constraints/#gpu>`_ +to make the GPU accessible by the docker engine. + +With `docker run` +^^^^^^^^^^^^^^^^^ +Include the `--gpus` flag with the `docker run` command. + +**Note:** Make sure the `--gpus` is present before the image name in the command, otherwise it won't work. + +.. code-block:: ini + + docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro --gpus --pid host --network host -it docker.io/nicolargo/glances:latest-full + +.. + + +With `docker-compose` +^^^^^^^^^^^^^^^^^^^^^ +Include the `deploy` section in compose file as specified below in the example service definition. + +.. code-block:: ini + + version: '3' + + services: + monitoring: + image: nicolargo/glances:latest-full + pid: host + network_mode: host + volumes: + - /var/run/docker.sock:/var/run/docker.sock + environment: + - "GLANCES_OPT=-w" + # For nvidia GPUs + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: 1 + capabilities: [gpu] + +.. + +Reference: https://docs.docker.com/compose/gpu-support/ + +.. _DockerHub: https://hub.docker.com/r/nicolargo/glances/tags |