summaryrefslogtreecommitdiffstats
path: root/docs/aoa
diff options
context:
space:
mode:
authorBharath Vignesh J K <52282402+RazCrimson@users.noreply.github.com>2023-05-10 00:56:16 +0530
committerBharath Vignesh J K <52282402+RazCrimson@users.noreply.github.com>2023-05-10 01:13:38 +0530
commita08d3dc546ebffc42384b3bd7da678a396804e86 (patch)
treec5323d007827fe3989d06e342d9f8ac64aa412c9 /docs/aoa
parentdb4bd0d136707ffe58620825aa147eff1d3640bf (diff)
parent156d8b61348f776e67f5b8975d122aea8f3b6bd7 (diff)
Merge from develop
Diffstat (limited to 'docs/aoa')
-rw-r--r--docs/aoa/containers.rst (renamed from docs/aoa/docker.rst)27
-rw-r--r--docs/aoa/index.rst3
-rw-r--r--docs/aoa/monitor.rst8
-rw-r--r--docs/aoa/ps.rst9
4 files changed, 22 insertions, 25 deletions
diff --git a/docs/aoa/docker.rst b/docs/aoa/containers.rst
index 568978d1..c969b1e8 100644
--- a/docs/aoa/docker.rst
+++ b/docs/aoa/containers.rst
@@ -1,25 +1,25 @@
-.. _docker:
+.. _containers:
-Docker
-======
+Containers
+==========
-If you use ``Docker``, Glances can help you to monitor your containers.
-Glances uses the Docker API through the `docker-py`_ library.
+If you use ``containers``, Glances can help you to monitor your Docker or Podman containers.
+Glances uses the containers API through the `docker-py`_ and `podman-py`_ libraries.
You can install this dependency using:
.. code-block:: console
- pip install glances[docker]
+ pip install glances[containers]
-.. image:: ../_static/docker.png
+.. image:: ../_static/containers.png
It is possible to define limits and actions from the configuration file
-under the ``[docker]`` section:
+under the ``[containers]`` section:
.. code-block:: ini
- [docker]
+ [containers]
disable=False
# Only show specific containers (comma separated list of container name or regular expression)
show=thiscontainer,andthisone,andthoseones.*
@@ -27,7 +27,7 @@ under the ``[docker]`` section:
hide=donotshowthisone,andthose.*
# Show only specific containers (comma separated list of container name or regular expression)
#show=showthisone,andthose.*
- # Define the maximum docker size name (default is 20 chars)
+ # Define the maximum containers size name (default is 20 chars)
max_name_size=20
# Global containers' thresholds for CPU and MEM (in %)
cpu_careful=50
@@ -44,12 +44,15 @@ under the ``[docker]`` section:
# By default, Glances only display running containers
# Set the following key to True to display all containers
all=False
+ # Define Podman sock
+ #podman_sock=unix:///run/user/1000/podman/podman.sock
-You can use all the variables ({{foo}}) available in the Docker plugin.
+You can use all the variables ({{foo}}) available in the containers plugin.
Filtering (for hide or show) is based on regular expression. Please be sure that your regular
expression works as expected. You can use an online tool like `regex101`_ in
order to test your regular expression.
.. _regex101: https://regex101.com/
-.. _docker-py: https://github.com/docker/docker-py
+.. _docker-py: https://github.com/containers/containers-py
+.. _podman-py: https://github.com/containers/podman-py \ No newline at end of file
diff --git a/docs/aoa/index.rst b/docs/aoa/index.rst
index edc41e36..72ce2ba7 100644
--- a/docs/aoa/index.rst
+++ b/docs/aoa/index.rst
@@ -40,8 +40,7 @@ Legend:
sensors
hddtemp
ps
- monitor
+ containers
amps
events
- docker
actions
diff --git a/docs/aoa/monitor.rst b/docs/aoa/monitor.rst
deleted file mode 100644
index 97b0a6dd..00000000
--- a/docs/aoa/monitor.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-.. _monitor:
-
-Monitored Processes List
-========================
-
-.. warning::
- The monitored processes list feature has been removed. Use the new
- Application Monitoring Process (AMP) instead.
diff --git a/docs/aoa/ps.rst b/docs/aoa/ps.rst
index ec4c4f95..310c8cd5 100644
--- a/docs/aoa/ps.rst
+++ b/docs/aoa/ps.rst
@@ -108,12 +108,15 @@ Columns display
``VIRT`` Virtual Memory Size
The total amount of virtual memory used by the
- process.
-
- It includes all code, data and shared
+ process. It includes all code, data and shared
libraries plus pages that have been swapped out
and pages that have been mapped but not used.
+ Virtual memory is usually much larger than physical
+ memory, making it possible to run programs for which
+ the total code plus data size is greater than the amount
+ of RAM available.
+
Most of the time, this is not a useful number.
``RES`` Resident Memory Size