summaryrefslogtreecommitdiff
path: root/docs/configuration/container
diff options
context:
space:
mode:
authorGanawa Juanah <ganawa@juanah.com>2021-06-25 12:58:46 -0500
committerGanawa Juanah <ganawa@juanah.com>2021-06-25 12:58:46 -0500
commitd6820da432439ce5df65e543002555bd24b4a7af (patch)
tree972eac17f49b0a24a6697addb6bff59502b8aae3 /docs/configuration/container
parentd5dfc17dd9ad54f835c4ab6ee7b552c0fffa29eb (diff)
downloadvyos-documentation-d6820da432439ce5df65e543002555bd24b4a7af.tar.gz
vyos-documentation-d6820da432439ce5df65e543002555bd24b4a7af.zip
fixed wording for clarification
Diffstat (limited to 'docs/configuration/container')
-rw-r--r--docs/configuration/container/index.rst94
1 files changed, 49 insertions, 45 deletions
diff --git a/docs/configuration/container/index.rst b/docs/configuration/container/index.rst
index 2447cf90..520031d8 100644
--- a/docs/configuration/container/index.rst
+++ b/docs/configuration/container/index.rst
@@ -1,8 +1,10 @@
+.. include:: /_include/need_improvement.txt
+
.. _container:
-########
+#########
Container
-########
+#########
*************
Configuration
@@ -18,8 +20,9 @@ Configuration
.. cfgcmd:: set container registry <name>
- By default, for any image that does not include the registry in the image name, Vyos will use docker.io. Multiple registries
- can be added as unqualified-search-registries using this command
+ Adds registry to list of unqualified-search-registries. By default, for any
+ image that does not include the registry in the image name, Vyos will use
+ docker.io as the container registry.
.. cfgcmd:: set container <name> image
@@ -29,8 +32,9 @@ Configuration
set container name mysql-server image mysql:8.0
- If a registry is not specefied, Docker.io will be used as the registry by default unless an alternative registry is specefied
- using **set container registry <name>** or the registry is included in the image name
+ If a registry is not specefied, Docker.io will be used as the container
+ registry unless an alternative registry is specefied using
+ **set container registry <name>** or the registry is included in the image name
.. code-block:: none
@@ -38,8 +42,8 @@ Configuration
.. cfgcmd:: set container <name> allow-host-networks
- Allow host networking in container. The network stack of the container is not isolated from the host and will use the
- host IP.
+ Allow host networking in container. The network stack of the container is
+ not isolated from the host and will use the host IP.
The following commands translates to "--net host" when the container is created
@@ -78,8 +82,8 @@ Configuration
.. code-block:: none
- set container name zabbix-web-nginx-mysql port http source 80
- set container name zabbix-web-nginx-mysql port http destination 8080
+ set container name zabbix-web-nginx-mysql port http source 80
+ set container name zabbix-web-nginx-mysql port http destination 8080
.. cfgcmd:: set container <name> volume <volumename> [source | destination ] <path>
@@ -87,53 +91,53 @@ Configuration
.. code-block:: none
- set container name coredns volume 'corefile' source /config/coredns/Corefile
- set container name coredns volume 'corefile' destination /etc/Corefile
-
-
+ set container name coredns volume 'corefile' source /config/coredns/Corefile
+ set container name coredns volume 'corefile' destination /etc/Corefile
*********************
Example Configuration
*********************
+ For the sake of demonstration, `example #1 in the official documentation <https://www.zabbix.com/documentation/current/manual/installation/containers>`_ to the declarative VyOS CLI syntax.
+
.. code-block:: none
- set container network zabbix-net prefix 172.20.0.0/16
- set container network zabbix-net description 'Network for Zabbix component containers'
+ set container network zabbix-net prefix 172.20.0.0/16
+ set container network zabbix-net description 'Network for Zabbix component containers'
- set container name mysql-server image mysql:8.0
- set container name mysql-server network zabbix-net
+ set container name mysql-server image mysql:8.0
+ set container name mysql-server network zabbix-net
- set container name mysql-server environment 'MYSQL_DATABASE' value 'zabbix'
- set container name mysql-server environment 'MYSQL_USER' value 'zabbix'
- set container name mysql-server environment 'MYSQL_PASSWORD' value 'zabbix_pwd'
- set container name mysql-server environment 'MYSQL_ROOT_PASSWORD' value 'root_pwd'
+ set container name mysql-server environment 'MYSQL_DATABASE' value 'zabbix'
+ set container name mysql-server environment 'MYSQL_USER' value 'zabbix'
+ set container name mysql-server environment 'MYSQL_PASSWORD' value 'zabbix_pwd'
+ set container name mysql-server environment 'MYSQL_ROOT_PASSWORD' value 'root_pwd'
- set container name zabbix-java-gateway image zabbix/zabbix-java-gateway:alpine-5.2-latest
- set container name zabbix-java-gateway network zabbix-net
+ set container name zabbix-java-gateway image zabbix/zabbix-java-gateway:alpine-5.2-latest
+ set container name zabbix-java-gateway network zabbix-net
- set container name zabbix-server-mysql image zabbix/zabbix-server-mysql:alpine-5.2-latest
- set container name zabbix-server-mysql network zabbix-net
+ set container name zabbix-server-mysql image zabbix/zabbix-server-mysql:alpine-5.2-latest
+ set container name zabbix-server-mysql network zabbix-net
- set container name zabbix-server-mysql environment 'DB_SERVER_HOST' value 'mysql-server'
- set container name zabbix-server-mysql environment 'MYSQL_DATABASE' value 'zabbix'
- set container name zabbix-server-mysql environment 'MYSQL_USER' value 'zabbix'
- set container name zabbix-server-mysql environment 'MYSQL_PASSWORD' value 'zabbix_pwd'
- set container name zabbix-server-mysql environment 'MYSQL_ROOT_PASSWORD' value 'root_pwd'
- set container name zabbix-server-mysql environment 'ZBX_JAVAGATEWAY' value 'zabbix-java-gateway'
+ set container name zabbix-server-mysql environment 'DB_SERVER_HOST' value 'mysql-server'
+ set container name zabbix-server-mysql environment 'MYSQL_DATABASE' value 'zabbix'
+ set container name zabbix-server-mysql environment 'MYSQL_USER' value 'zabbix'
+ set container name zabbix-server-mysql environment 'MYSQL_PASSWORD' value 'zabbix_pwd'
+ set container name zabbix-server-mysql environment 'MYSQL_ROOT_PASSWORD' value 'root_pwd'
+ set container name zabbix-server-mysql environment 'ZBX_JAVAGATEWAY' value 'zabbix-java-gateway'
- set container name zabbix-server-mysql port zabbix source 10051
- set container name zabbix-server-mysql port zabbix destination 10051
+ set container name zabbix-server-mysql port zabbix source 10051
+ set container name zabbix-server-mysql port zabbix destination 10051
- set container name zabbix-web-nginx-mysql image zabbix/zabbix-web-nginx-mysql:alpine-5.2-latest
- set container name zabbix-web-nginx-mysql network zabbix-net
+ set container name zabbix-web-nginx-mysql image zabbix/zabbix-web-nginx-mysql:alpine-5.2-latest
+ set container name zabbix-web-nginx-mysql network zabbix-net
- set container name zabbix-web-nginx-mysql environment 'MYSQL_DATABASE' value 'zabbix'
- set container name zabbix-web-nginx-mysql environment 'ZBX_SERVER_HOST' value 'zabbix-server-mysql'
- set container name zabbix-web-nginx-mysql environment 'DB_SERVER_HOST' value 'mysql-server'
- set container name zabbix-web-nginx-mysql environment 'MYSQL_USER' value 'zabbix'
- set container name zabbix-web-nginx-mysql environment 'MYSQL_PASSWORD' value 'zabbix_pwd'
- set container name zabbix-web-nginx-mysql environment 'MYSQL_ROOT_PASSWORD' value 'root_pwd'
-
- set container name zabbix-web-nginx-mysql port http source 80
- set container name zabbix-web-nginx-mysql port http destination 8080 \ No newline at end of file
+ set container name zabbix-web-nginx-mysql environment 'MYSQL_DATABASE' value 'zabbix'
+ set container name zabbix-web-nginx-mysql environment 'ZBX_SERVER_HOST' value 'zabbix-server-mysql'
+ set container name zabbix-web-nginx-mysql environment 'DB_SERVER_HOST' value 'mysql-server'
+ set container name zabbix-web-nginx-mysql environment 'MYSQL_USER' value 'zabbix'
+ set container name zabbix-web-nginx-mysql environment 'MYSQL_PASSWORD' value 'zabbix_pwd'
+ set container name zabbix-web-nginx-mysql environment 'MYSQL_ROOT_PASSWORD' value 'root_pwd'
+
+ set container name zabbix-web-nginx-mysql port http source 80
+ set container name zabbix-web-nginx-mysql port http destination 8080 \ No newline at end of file