summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2020-11-29 21:52:28 +0100
committerrebortg <github@ghlr.de>2020-11-29 21:52:28 +0100
commit4abded8025a47990e58cd0a5fe9b96e38f4a3715 (patch)
tree2a6ebaa9dcf96a10e95577ae446c3897b0938fd4
parente7f01e6efc8578603592ff86c031d46f1f1f9d82 (diff)
downloadvyos-documentation-4abded8025a47990e58cd0a5fe9b96e38f4a3715.tar.gz
vyos-documentation-4abded8025a47990e58cd0a5fe9b96e38f4a3715.zip
arrange: interfaces
-rw-r--r--Pipfile16
-rw-r--r--docs/configuration/interfaces/bonding.rst (renamed from docs/interfaces/bond.rst)0
-rw-r--r--docs/configuration/interfaces/bridge.rst (renamed from docs/interfaces/bridge.rst)0
-rw-r--r--docs/configuration/interfaces/dummy.rst (renamed from docs/interfaces/dummy.rst)0
-rw-r--r--docs/configuration/interfaces/ethernet.rst (renamed from docs/interfaces/ethernet.rst)0
-rw-r--r--docs/configuration/interfaces/geneve.rst (renamed from docs/interfaces/geneve.rst)0
-rw-r--r--docs/configuration/interfaces/index.rst28
-rw-r--r--docs/configuration/interfaces/l2tpv3.rst (renamed from docs/interfaces/l2tpv3.rst)0
-rw-r--r--docs/configuration/interfaces/loopback.rst (renamed from docs/interfaces/loopback.rst)0
-rw-r--r--docs/configuration/interfaces/macsec.rst (renamed from docs/interfaces/macsec.rst)0
-rw-r--r--docs/configuration/interfaces/openvpn.rst (renamed from docs/vpn/openvpn.rst)0
-rw-r--r--docs/configuration/interfaces/pppoe.rst (renamed from docs/interfaces/pppoe.rst)0
-rw-r--r--docs/configuration/interfaces/pseudo-ethernet.rst (renamed from docs/interfaces/pseudo-ethernet.rst)0
-rw-r--r--docs/configuration/interfaces/tunnel.rst (renamed from docs/interfaces/tunnel.rst)19
-rw-r--r--docs/configuration/interfaces/vti.rst22
-rw-r--r--docs/configuration/interfaces/vxlan.rst (renamed from docs/interfaces/vxlan.rst)0
-rw-r--r--docs/configuration/interfaces/wireguard.rst (renamed from docs/vpn/wireguard.rst)0
-rw-r--r--docs/configuration/interfaces/wireless.rst (renamed from docs/interfaces/wireless.rst)0
-rw-r--r--docs/configuration/interfaces/wirelessmodem.rst (renamed from docs/interfaces/wirelessmodem.rst)0
19 files changed, 66 insertions, 19 deletions
diff --git a/Pipfile b/Pipfile
new file mode 100644
index 00000000..423092c4
--- /dev/null
+++ b/Pipfile
@@ -0,0 +1,16 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+sphinx-rtd-theme = "*"
+docutils = "*"
+lxml = "*"
+sphinx-notfound-page = "*"
+Sphinx = ">=1.4.3"
+
+[dev-packages]
+
+[requires]
+python_version = "3.9"
diff --git a/docs/interfaces/bond.rst b/docs/configuration/interfaces/bonding.rst
index 7faddd6f..7faddd6f 100644
--- a/docs/interfaces/bond.rst
+++ b/docs/configuration/interfaces/bonding.rst
diff --git a/docs/interfaces/bridge.rst b/docs/configuration/interfaces/bridge.rst
index dc94a761..dc94a761 100644
--- a/docs/interfaces/bridge.rst
+++ b/docs/configuration/interfaces/bridge.rst
diff --git a/docs/interfaces/dummy.rst b/docs/configuration/interfaces/dummy.rst
index c36d0024..c36d0024 100644
--- a/docs/interfaces/dummy.rst
+++ b/docs/configuration/interfaces/dummy.rst
diff --git a/docs/interfaces/ethernet.rst b/docs/configuration/interfaces/ethernet.rst
index f2ab3f67..f2ab3f67 100644
--- a/docs/interfaces/ethernet.rst
+++ b/docs/configuration/interfaces/ethernet.rst
diff --git a/docs/interfaces/geneve.rst b/docs/configuration/interfaces/geneve.rst
index 47068687..47068687 100644
--- a/docs/interfaces/geneve.rst
+++ b/docs/configuration/interfaces/geneve.rst
diff --git a/docs/configuration/interfaces/index.rst b/docs/configuration/interfaces/index.rst
new file mode 100644
index 00000000..85d2c177
--- /dev/null
+++ b/docs/configuration/interfaces/index.rst
@@ -0,0 +1,28 @@
+##########
+Interfaces
+##########
+
+
+.. toctree::
+ :maxdepth: 1
+ :includehidden:
+
+ bonding
+ bridge
+ dummy
+ ethernet
+ geneve
+ l2tpv3
+ loopback
+ macsec
+ openvpn
+ pppoe
+ pseudo-ethernet
+ tunnel
+ vti
+ vxlan
+ wireguard
+ wireless
+ wirelessmodem
+
+
diff --git a/docs/interfaces/l2tpv3.rst b/docs/configuration/interfaces/l2tpv3.rst
index 4c9cbf9b..4c9cbf9b 100644
--- a/docs/interfaces/l2tpv3.rst
+++ b/docs/configuration/interfaces/l2tpv3.rst
diff --git a/docs/interfaces/loopback.rst b/docs/configuration/interfaces/loopback.rst
index a6d659b5..a6d659b5 100644
--- a/docs/interfaces/loopback.rst
+++ b/docs/configuration/interfaces/loopback.rst
diff --git a/docs/interfaces/macsec.rst b/docs/configuration/interfaces/macsec.rst
index ebc8f151..ebc8f151 100644
--- a/docs/interfaces/macsec.rst
+++ b/docs/configuration/interfaces/macsec.rst
diff --git a/docs/vpn/openvpn.rst b/docs/configuration/interfaces/openvpn.rst
index c6934335..c6934335 100644
--- a/docs/vpn/openvpn.rst
+++ b/docs/configuration/interfaces/openvpn.rst
diff --git a/docs/interfaces/pppoe.rst b/docs/configuration/interfaces/pppoe.rst
index 313edd84..313edd84 100644
--- a/docs/interfaces/pppoe.rst
+++ b/docs/configuration/interfaces/pppoe.rst
diff --git a/docs/interfaces/pseudo-ethernet.rst b/docs/configuration/interfaces/pseudo-ethernet.rst
index c2baca39..c2baca39 100644
--- a/docs/interfaces/pseudo-ethernet.rst
+++ b/docs/configuration/interfaces/pseudo-ethernet.rst
diff --git a/docs/interfaces/tunnel.rst b/docs/configuration/interfaces/tunnel.rst
index c14314d1..4b9da26b 100644
--- a/docs/interfaces/tunnel.rst
+++ b/docs/configuration/interfaces/tunnel.rst
@@ -210,26 +210,7 @@ that are discarding IP protocol 47 or blocking your source/desintation traffic.
4 packets transmitted, 4 received, 0% packet loss, time 3008ms
rtt min/avg/max/mdev = 1.055/1.729/1.989/0.395 ms
-Virtual Tunnel Interface (VTI)
-------------------------------
-
-Set Virtual Tunnel Interface
-
-.. code-block:: none
-
- set interfaces vti vti0 address 192.168.2.249/30
- set interfaces vti vti0 address 2001:db8:2::249/64
-
-Results in:
-
-.. code-block:: none
- vyos@vyos# show interfaces vti
- vti vti0 {
- address 192.168.2.249/30
- address 2001:db8:2::249/64
- description "Description"
- }
.. _`other proposals`: https://www.isc.org/othersoftware/
.. _`Hurricane Electric`: https://tunnelbroker.net/
diff --git a/docs/configuration/interfaces/vti.rst b/docs/configuration/interfaces/vti.rst
new file mode 100644
index 00000000..62cd13f3
--- /dev/null
+++ b/docs/configuration/interfaces/vti.rst
@@ -0,0 +1,22 @@
+##############################
+Virtual Tunnel Interface (VTI)
+##############################
+
+
+Set Virtual Tunnel Interface
+
+.. code-block:: none
+
+ set interfaces vti vti0 address 192.168.2.249/30
+ set interfaces vti vti0 address 2001:db8:2::249/64
+
+Results in:
+
+.. code-block:: none
+
+ vyos@vyos# show interfaces vti
+ vti vti0 {
+ address 192.168.2.249/30
+ address 2001:db8:2::249/64
+ description "Description"
+ } \ No newline at end of file
diff --git a/docs/interfaces/vxlan.rst b/docs/configuration/interfaces/vxlan.rst
index 40dc5400..40dc5400 100644
--- a/docs/interfaces/vxlan.rst
+++ b/docs/configuration/interfaces/vxlan.rst
diff --git a/docs/vpn/wireguard.rst b/docs/configuration/interfaces/wireguard.rst
index 3580fac3..3580fac3 100644
--- a/docs/vpn/wireguard.rst
+++ b/docs/configuration/interfaces/wireguard.rst
diff --git a/docs/interfaces/wireless.rst b/docs/configuration/interfaces/wireless.rst
index 2de3b126..2de3b126 100644
--- a/docs/interfaces/wireless.rst
+++ b/docs/configuration/interfaces/wireless.rst
diff --git a/docs/interfaces/wirelessmodem.rst b/docs/configuration/interfaces/wirelessmodem.rst
index f9dfa228..f9dfa228 100644
--- a/docs/interfaces/wirelessmodem.rst
+++ b/docs/configuration/interfaces/wirelessmodem.rst