summaryrefslogtreecommitdiff
path: root/doc/rtd/topics
diff options
context:
space:
mode:
authorAntti Myyrä <antti.myyra@gmail.com>2021-01-07 17:33:43 +0200
committerGitHub <noreply@github.com>2021-01-07 10:33:43 -0500
commitaa1014cae2e326109581d4624f3a195a89369fd7 (patch)
tree36499cedf02cb11e16ba508cb55e628482373ed1 /doc/rtd/topics
parent30da21bd299a7eb5a4c6f7b6a29ca09359327e41 (diff)
downloadvyos-cloud-init-aa1014cae2e326109581d4624f3a195a89369fd7.tar.gz
vyos-cloud-init-aa1014cae2e326109581d4624f3a195a89369fd7.zip
doc: document missing IPv6 subnet types (#744)
Added some missing IPv6 subnet configuration types (ipv6_dhcpv6-stateful, ipv6_dhcpv6-stateless, ipv6_slaac) to Networking config v1 documentation.
Diffstat (limited to 'doc/rtd/topics')
-rw-r--r--doc/rtd/topics/network-config-format-v1.rst16
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/rtd/topics/network-config-format-v1.rst b/doc/rtd/topics/network-config-format-v1.rst
index 92e81897..17732c2a 100644
--- a/doc/rtd/topics/network-config-format-v1.rst
+++ b/doc/rtd/topics/network-config-format-v1.rst
@@ -414,9 +414,19 @@ Subnet types are one of the following:
- ``dhcp6``: Configure this interface with IPv6 dhcp.
- ``static``: Configure this interface with a static IPv4.
- ``static6``: Configure this interface with a static IPv6 .
+- ``ipv6_dhcpv6-stateful``: Configure this interface with ``dhcp6``
+- ``ipv6_dhcpv6-stateless``: Configure this interface with SLAAC and DHCP
+- ``ipv6_slaac``: Configure address with SLAAC
-When making use of ``dhcp`` types, no additional configuration is needed in
-the subnet dictionary.
+When making use of ``dhcp`` or either of the ``ipv6_dhcpv6`` types,
+no additional configuration is needed in the subnet dictionary.
+
+Using ``ipv6_dhcpv6-stateless`` or ``ipv6_slaac`` allows the IPv6 address to be
+automatically configured with StateLess Address AutoConfiguration (`SLAAC`_).
+SLAAC requires support from the network, so verify that your cloud or network
+offering has support before trying it out. With ``ipv6_dhcpv6-stateless``,
+DHCPv6 is still used to fetch other subnet details such as gateway or DNS
+servers. If you only want to discover the address, use ``ipv6_slaac``.
**Subnet DHCP Example**::
@@ -603,4 +613,6 @@ Some more examples to explore the various options available.
- dellstack
type: nameserver
+.. _SLAAC: https://tools.ietf.org/html/rfc4862
+
.. vi: textwidth=78