diff options
Diffstat (limited to 'docs/configuration/container/index.rst')
| -rw-r--r-- | docs/configuration/container/index.rst | 56 |
1 files changed, 45 insertions, 11 deletions
diff --git a/docs/configuration/container/index.rst b/docs/configuration/container/index.rst index 988b425b..4dacc6f4 100644 --- a/docs/configuration/container/index.rst +++ b/docs/configuration/container/index.rst @@ -21,19 +21,43 @@ 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> host-name <hostname> + + 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** @@ -47,7 +71,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 +128,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 +149,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**: Administation 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. @@ -145,8 +178,8 @@ Container Networks .. cfgcmd:: set container network <name> prefix <ipv4|ipv6> - Define IPv4 or IPv6 prefix for a given network name. Only one IPv4 and - one IPv6 prefix can be used per network name. + Define IPv4 and/or IPv6 prefix for a given network name. + Both IPv4 and IPv6 can be used in parallel. .. cfgcmd:: set container network <name> vrf <nme> @@ -216,7 +249,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 |