vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1449 from nvollmar/complete-container-doc

Browse Source 
Add missing container commands
This commit is contained in:
Christian Breunig 2024-05-16 07:16:12 +02:00 committed by GitHub
commit 7973a39fe9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 39 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/configuration/container/index.rst
View File

@ -21,12 +21,34 @@ Configuration
If a registry is not specified, Docker.io will be used as the container
registry unless an alternative registry is specified using
**set container registry <name>** or the registry is included in the image name
**set container registry <name>** or the registry is included
in the image name
.. code-block:: none
set container name mysql-server image quay.io/mysql:8.0
.. cfgcmd:: set container name <name> entrypoint <entrypoint>
Override the default entrypoint from the image for a container.
.. cfgcmd:: set container name <name> command <command>
Override the default command from the image for a container.
.. cfgcmd:: set container name <name> arguments <arguments>
Set the command arguments for a container.
.. cfgcmd:: set container name <name> uid <userid>
.. cfgcmd:: set container name <name> gid <groupid>
Set user ID and/or group ID a container will run as.
.. cfgcmd:: set container name <name> host-name <hostname>
Set the host name for a container.
.. cfgcmd:: set container name <name> allow-host-networks
Allow host networking in a container. The network stack of the container is
@ -47,7 +69,8 @@ Configuration
Optionally set a specific static IPv4 or IPv6 address for the container.
This address must be within the named network prefix.
.. note:: The first IP in the container network is reserved by the engine and cannot be used
.. note:: The first IP in the container network is reserved by the
engine and cannot be used
.. cfgcmd:: set container name <name> description <text>
@ -103,8 +126,10 @@ Configuration
Set the restart behavior of the container.
- **no**: Do not restart containers on exit
- **on-failure**: Restart containers when they exit with a non-zero exit code, retrying indefinitely (default)
- **always**: Restart containers when they exit, regardless of status, retrying indefinitely
- **on-failure**: Restart containers when they exit with a non-zero
exit code, retrying indefinitely (default)
- **always**: Restart containers when they exit, regardless of status,
retrying indefinitely
.. cfgcmd:: set container name <name> memory <MB>
@ -122,12 +147,18 @@ Configuration
Set container capabilities or permissions.
- **net-admin**: Network operations (interface, firewall, routing tables)
- **net-bind-service**: Bind a socket to privileged ports (port numbers less than 1024)
- **net-bind-service**: Bind a socket to privileged ports
(port numbers less than 1024)
- **net-raw**: Permission to create raw network sockets
- **setpcap**: Capability sets (from bounded or inherited set)
- **sys-admin**: Administration operations (quotactl, mount, sethostname, setdomainame)
- **sys-admin**: Administration operations (quotactl, mount, sethostname,
setdomainame)
- **sys-time**: Permission to set system clock
.. cfgcmd:: set container name <name> label <label> value <value>
Add metadata label for this container.
.. cfgcmd:: set container name <name> disable
Disable a container.
@ -216,7 +247,8 @@ Example Configuration
*********************
For the sake of demonstration, `example #1 in the official documentation
<https://www.zabbix.com/documentation/current/manual/installation/containers>`_
<https://www.zabbix.com/documentation/current/manual/
installation/containers>`_
to the declarative VyOS CLI syntax.
.. code-block:: none