summaryrefslogtreecommitdiff
path: root/docs/configuration/container/index.rst
diff options
context:
space:
mode:
authorNicolas Vollmar <nvo@scaling.ch>2024-05-17 10:31:47 +0200
committerMergify <37929162+mergify[bot]@users.noreply.github.com>2024-05-17 13:36:47 +0000
commit9d72615c6675aee7c74809d5b8a59db402bf06ed (patch)
tree2880c281005acf7a12c5ef9903b668e18874ae09 /docs/configuration/container/index.rst
parente71ea0c1b15ad8700dcaa03cb2d25e3f87cc07cf (diff)
downloadvyos-documentation-9d72615c6675aee7c74809d5b8a59db402bf06ed.tar.gz
vyos-documentation-9d72615c6675aee7c74809d5b8a59db402bf06ed.zip
T6358: add documentation for container host pid
(cherry picked from commit f96fa5dd08ab5d3bd3438ebf2c7704abd5df28ae)
Diffstat (limited to 'docs/configuration/container/index.rst')
-rw-r--r--docs/configuration/container/index.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/configuration/container/index.rst b/docs/configuration/container/index.rst
index 2f668324..4dacc6f4 100644
--- a/docs/configuration/container/index.rst
+++ b/docs/configuration/container/index.rst
@@ -44,13 +44,20 @@ Configuration
Set the host name for a container.
+.. cfgcmd:: set container name <name> allow-host-pid
+
+ The container and the host share the same process namespace.
+ This means that processes running on the host are visible inside the
+ container, and processes inside the container are visible on the host.
+
+ The command translates to "--pid host" when the container is created.
+
.. cfgcmd:: set container name <name> allow-host-networks
Allow host networking in a container. The network stack of the container is
not isolated from the host and will use the host IP.
- The following commands translate to "--net host" when the container
- is created
+ The command translates to "--net host" when the container is created.
.. note:: **allow-host-networks** cannot be used with **network**