summaryrefslogtreecommitdiff
path: root/docs/configexamples
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-04-10 21:48:08 +0300
committerGitHub <noreply@github.com>2026-04-10 19:48:08 +0100
commit3fab910622ef60a8fd68d5552ad104f46608df35 (patch)
tree4d6fd35541502b8869543b15a41be6b00b877fad /docs/configexamples
parentac00e1c4a6b456628e412123383450653f668bdb (diff)
downloadvyos-documentation-3fab910622ef60a8fd68d5552ad104f46608df35.tar.gz
vyos-documentation-3fab910622ef60a8fd68d5552ad104f46608df35.zip
docs: fix typos and prose in terraform, ansible, and config docs (#1829)
* docs: fix typos and improve prose in terraform, ansible, and config docs Fix typos (VyoS→VyOS, respresent→represents), rewrap long prose lines for readability, restore correct YAML indentation in Ansible examples, and standardize heading hierarchy in affected files. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: replace public DNS IP with RFC 5737 address in NMP example Use 198.51.100.1 (TEST-NET-2) instead of 8.8.8.8 to satisfy the documentation linter requirement for reserved addresses. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: restore linter markers around NMP code block with 8.8.8.8 Restore stop/start_vyoslinter markers that were incorrectly removed. The DNS server address is intentional and should not be changed. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'docs/configexamples')
-rw-r--r--docs/configexamples/ansible.rst62
1 files changed, 31 insertions, 31 deletions
diff --git a/docs/configexamples/ansible.rst b/docs/configexamples/ansible.rst
index 4241c706..4d6561d0 100644
--- a/docs/configexamples/ansible.rst
+++ b/docs/configexamples/ansible.rst
@@ -51,6 +51,8 @@ Install Paramiko:
Check the version:
==================
+.. stop_vyoslinter
+
.. code-block:: none
# ansible --version
@@ -61,6 +63,8 @@ Check the version:
executable location = /usr/bin/ansible
python version = 3.9.2 (default, Feb 28 2021, 17:03:44) [GCC 10.2.1 20210110]
+.. start_vyoslinter
+
Basic configuration of ansible.cfg:
=======================================
@@ -99,8 +103,6 @@ Add general variables:
Add a simple playbook with the tasks for each router:
=====================================================
-.. stop_vyoslinter
-
.. code-block:: none
# nano /root/main.yml
@@ -112,24 +114,24 @@ Add a simple playbook with the tasks for each router:
- name: Configure general settings for the vyos hosts group
vyos_config:
lines:
- - set system name-server 8.8.8.8
- - set interfaces ethernet eth0 description '#WAN#'
- - set interfaces ethernet eth1 description '#LAN#'
- - set interfaces ethernet eth2 disable
- - set interfaces ethernet eth3 disable
- - set system host-name {{ inventory_hostname }}
+ - set system name-server 192.0.2.1
+ - set interfaces ethernet eth0 description '#WAN#'
+ - set interfaces ethernet eth1 description '#LAN#'
+ - set interfaces ethernet eth2 disable
+ - set interfaces ethernet eth3 disable
+ - set system host-name {{ inventory_hostname }}
save: true
-
-.. start_vyoslinter
-
+
Start the playbook:
===================
+.. stop_vyoslinter
+
.. code-block:: none
ansible-playbook -i hosts main.yml
PLAY [vyos_hosts] **************************************************************
-
+
TASK [Configure general settings for the vyos hosts group] *********************
ok: [vyos9]
ok: [vyos10]
@@ -142,11 +144,11 @@ Start the playbook:
vyos8 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
vyos9 : ok=2 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
+.. start_vyoslinter
+
Check the result on the vyos10 router:
======================================
-.. stop_vyoslinter
-
.. code-block:: none
vyos@vyos10:~$ show interfaces
@@ -159,17 +161,13 @@ Check the result on the vyos10 router:
eth3 - A/D
lo 127.0.0.1/8 u/u
::1/128
-
- vyos@vyos10:~$ sh configuration commands | grep 8.8.8.8
- set system name-server '8.8.8.8'
-
-.. start_vyoslinter
+
+ vyos@vyos10:~$ sh configuration commands | grep 192.0.2.1
+ set system name-server '192.0.2.1'
The simple way without configuration of the hostname (one task for all routers):
================================================================================
-.. stop_vyoslinter
-
.. code-block:: none
# nano /root/hosts_v2
@@ -194,21 +192,22 @@ The simple way without configuration of the hostname (one task for all routers):
- name: Configure remote vyos_hosts_group
vyos_config:
lines:
- - set system name-server 8.8.8.8
- - set interfaces ethernet eth0 description WAN
- - set interfaces ethernet eth1 description LAN
- - set interfaces ethernet eth2 disable
- - set interfaces ethernet eth3 disable
+ - set system name-server 192.0.2.1
+ - set interfaces ethernet eth0 description WAN
+ - set interfaces ethernet eth1 description LAN
+ - set interfaces ethernet eth2 disable
+ - set interfaces ethernet eth3 disable
save: true
-.. start_vyoslinter
+
+.. stop_vyoslinter
.. code-block:: none
-
+
# ansible-playbook -i hosts_v2 main_v2.yml
-
+
PLAY [vyos_hosts_group] ********************************************************
-
+
TASK [Configure remote vyos_hosts_group] ***************************************
ok: [vyos8]
ok: [vyos7]
@@ -220,7 +219,8 @@ The simple way without configuration of the hostname (one task for all routers):
vyos7 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
vyos8 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
vyos9 : ok=1 changed=0 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0
-
+
+.. start_vyoslinter
In the next chapter of the example, we'll use Ansible with jinja2
templates and variables.