blueprint: add autotest section

1 files changed, 112 insertions, 0 deletions

diff --git a/docs/configexamples/autotest/Wireguard/Wireguard.rst b/docs/configexamples/autotest/Wireguard/Wireguard.rst
new file mode 100644
index 00000000..efd0ac42
--- /dev/null
+++ b/docs/configexamples/autotest/Wireguard/Wireguard.rst
@@ -0,0 +1,112 @@
+#########
+Wireguard
+#########
+
+
+| Testdate: 2021-11-30
+| Version: 1.3.0-rc6
+
+
+This simple structure show how to connect two offices. One remote branch and the
+central office.
+
+********
+Topology
+********
+
+The topology have a central and a branch VyOS router and one client, to
+test, in each site.
+
+.. image:: _include/topology.png
+  :alt: Ansible Example topology image
+
+*************
+Configuration
+*************
+
+Set the local subnet on eth2 and the public ip address eth1 on each site.
+
+Central
+
+.. literalinclude:: _include/central.conf
+   :language: none
+   :lines: 1-2
+
+Branch
+
+.. literalinclude:: _include/branch.conf
+   :language: none
+   :lines: 1-2
+
+
+Next thing to do, is to create a wireguard keypair on each side.
+After this, the public key can be displayed, to save for later.
+
+.. code-block:: none
+
+   vyos@central:~$ generate wireguard default-keypair
+   vyos@central:~$ show wireguard keypairs pubkey default
+   EP6GX0Idw+mMlGUtvZheRR4FmYfxjb3a5GPiNVVf9yY=
+
+
+After you have each public key. The wireguard interfaces can be setup.
+
+
+Central
+
+.. literalinclude:: _include/central.conf
+   :language: none
+   :lines: 4-11
+
+Branch
+
+.. literalinclude:: _include/branch.conf
+   :language: none
+   :lines: 4-11
+
+
+To reach the network, a route must be set on each VyOS host.
+In this structure, a static interface route will fit the requirements.
+
+Central
+
+.. literalinclude:: _include/central.conf
+   :language: none
+   :lines: 13
+
+Branch
+
+.. literalinclude:: _include/branch.conf
+   :language: none
+   :lines: 13
+
+*********************
+Testing and debugging
+*********************
+
+After all is done and commit, let's take a look if the Wireguard interface is
+up and running.
+
+.. code-block:: none
+
+   vyos@central:~$ show interfaces wireguard
+   Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
+   Interface        IP Address                        S/L  Description
+   ---------        ----------                        ---  -----------
+   wg01             192.168.0.1/24                    u/u  VPN-to-Branch
+
+
+And ping the Branch PC from your central router to check the response.
+
+.. code-block:: none
+
+   vyos@central:~$ ping 10.0.2.100 count 4
+   PING 10.0.2.100 (10.0.2.100) 56(84) bytes of data.
+   64 bytes from 10.0.2.100: icmp_seq=1 ttl=63 time=0.727 ms
+   64 bytes from 10.0.2.100: icmp_seq=2 ttl=63 time=0.712 ms
+   64 bytes from 10.0.2.100: icmp_seq=3 ttl=63 time=0.913 ms
+   64 bytes from 10.0.2.100: icmp_seq=4 ttl=63 time=0.792 ms
+   
+   --- 10.0.2.100 ping statistics ---
+   4 packets transmitted, 4 received, 0% packet loss, time 48ms
+   rtt min/avg/max/mdev = 0.712/0.786/0.913/0.079 ms