diff options
| m--------- | docs/_include/vyos-1x | 0 | ||||
| -rw-r--r-- | docs/automation/cloud-init.rst | 50 | ||||
| -rw-r--r-- | docs/changelog/1.3.rst | 33 | ||||
| -rw-r--r-- | docs/changelog/1.4.rst | 43 | ||||
| -rw-r--r-- | docs/configuration/protocols/ospf.rst | 41 | ||||
| -rw-r--r-- | docs/configuration/service/tftp-server.rst | 8 | ||||
| -rw-r--r-- | docs/configuration/vrf/index.rst | 2 |
7 files changed, 153 insertions, 24 deletions
diff --git a/docs/_include/vyos-1x b/docs/_include/vyos-1x -Subproject 22e3558834784a8ca37f6335c15c58a631a7fe1 +Subproject b675c8b6187c4b77759e3f96c9c92dd382dabea diff --git a/docs/automation/cloud-init.rst b/docs/automation/cloud-init.rst index 8f5dfcba..3ca8739b 100644 --- a/docs/automation/cloud-init.rst +++ b/docs/automation/cloud-init.rst @@ -19,7 +19,7 @@ VyOS support three types of config sources. * Metadata - Metadata is sourced by the cloud platform or hypervisor. In some clouds, there is implemented as an HTTP endpoint at - ```http://169.254.169.254```. + ``http://169.254.169.254``. * Network configuration - This config source informs the system about the network settings like IP addresses, routes, DNS. Available only in several cloud and virtualization platforms. @@ -44,13 +44,14 @@ described below. Cloud-config modules ******************** -In VyOS, by default, enabled only two modules: +In VyOS, by default, enables only two modules: * ``write_files`` - this module allows to insert any files into the filesystem before the first boot, for example, pre-generated encryption keys, certificates, or even a whole ``config.boot`` file. * ``vyos_userdata`` - the module accepts a list of CLI configuration commands in a ``vyos_config_commands`` section, which gives an easy way to configure the + system during deployment. ************************ @@ -169,6 +170,51 @@ obtained from the EC2 metadata service. commit exit +******* +NoCloud +******* + +Injecting configuration data is not limited to cloud platforms. Users can +employ the NoCloud data source to inject user-data and meta-data on +virtualization platforms such as VMware, Hyper-V and KVM. + +While other methods exist, the most straightforward method for using the +NoCloud data source is creating a seed ISO and attaching it to the virtual +machine as a CD drive. The volume must be formatted as a vfat or ISO 9660 +file system with the label "cidata" or "CIDATA". + +Create text files named user-data and meta-data. On linux-based systems, +the mkisofs utility can be used to create the seed ISO. The following +syntax will add these files to the ISO 9660 file system. + +.. code-block:: none + + mkisofs -joliet -rock -volid "cidata" -output seed.iso meta-data user-data + +The seed.iso file can be attached to the virtual machine. As an example, +the method with KVM to attach the ISO as a CD drive follows. + +.. code-block:: none + + $ virt-install -n vyos_r1 \ + --ram 4096 \ + --vcpus 2 \ + --cdrom seed.iso \ + --os-type linux \ + --os-variant debian10 \ + --network network=default \ + --graphics vnc \ + --hvm \ + --virt-type kvm \ + --disk path=/var/lib/libvirt/images/vyos_kvm.qcow2,bus=virtio \ + --import \ + --noautoconsole + + +For more information on the NoCloud data source, visit its +`page <https://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html>`_ +in the cloud-init documentation. + *************** Troubleshooting *************** diff --git a/docs/changelog/1.3.rst b/docs/changelog/1.3.rst index b7dd1861..68d15822 100644 --- a/docs/changelog/1.3.rst +++ b/docs/changelog/1.3.rst @@ -8,6 +8,37 @@ _ext/releasenotes.py +2021-11-28 +========== + +* :vytask:`T3999` (bug): show lldp neighbor Traceback error + + +2021-11-26 +========== + +* :vytask:`T4019` (bug): Smoketests for SSTP and openconnect fails + + +2021-11-25 +========== + +* :vytask:`T4005` (feature): Feature Request: IPsec IKEv1 + IKEv2 for one peer + + +2021-11-24 +========== + +* :vytask:`T4015` (feature): Update Accel-PPP to a newer revision +* :vytask:`T1083` (feature): Implement persistent/random address and port mapping options for NAT rules + + +2021-11-23 +========== + +* :vytask:`T3990` (bug): WATCHFRR: crashlog and per-thread log buffering unavailable (due to files left behind in /var/tmp/frr/ after reboot) + + 2021-11-20 ========== @@ -1141,7 +1172,7 @@ 2021-02-16 ========== -* :vytask:`T3318` (feature): Update Linux Kernel to v5.4.160 / 5.10.80 +* :vytask:`T3318` (feature): Update Linux Kernel to v5.4.162 / 5.10.82 2021-02-14 diff --git a/docs/changelog/1.4.rst b/docs/changelog/1.4.rst index 4f1a9df2..047f2a6b 100644 --- a/docs/changelog/1.4.rst +++ b/docs/changelog/1.4.rst @@ -8,6 +8,47 @@ _ext/releasenotes.py +2021-11-28 +========== + +* :vytask:`T3999` (bug): show lldp neighbor Traceback error +* :vytask:`T3928` (feature): Add OSPFv3 VRF support + + +2021-11-27 +========== + +* :vytask:`T3755` (feature): ospf: adjust to new FRR 8 syntax where "no passive-interface " moved to interface section +* :vytask:`T3753` (feature): frr: upgrade to stable/8.1 release train + + +2021-11-26 +========== + +* :vytask:`T3978` (bug): containers add network without declaring prefix raise ConfigError + + +2021-11-25 +========== + +* :vytask:`T4006` (default): Add additional Linux capabilities to container configuration +* :vytask:`T3986` (bug): Incorrect description for vpn ipsec site-to-site authentication and connection + + +2021-11-24 +========== + +* :vytask:`T4015` (feature): Update Accel-PPP to a newer revision +* :vytask:`T3865` (bug): loadkey command help text missing escape sequence +* :vytask:`T1083` (feature): Implement persistent/random address and port mapping options for NAT rules + + +2021-11-23 +========== + +* :vytask:`T3990` (bug): WATCHFRR: crashlog and per-thread log buffering unavailable (due to files left behind in /var/tmp/frr/ after reboot) + + 2021-11-20 ========== @@ -1290,7 +1331,7 @@ ========== * :vytask:`T3313` (bug): ospfv3 interface missing options -* :vytask:`T3318` (feature): Update Linux Kernel to v5.4.160 / 5.10.80 +* :vytask:`T3318` (feature): Update Linux Kernel to v5.4.162 / 5.10.82 2021-02-15 diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index ccddcd92..bb67653e 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -37,12 +37,12 @@ starts when the first ospf enabled interface is configured. This command is also used to enable the OSPF process. The area number can be specified in decimal notation in the range from 0 to 4294967295. Or it can be specified in dotted decimal notation similar to ip address. - + Prefix length in interface must be equal or bigger (i.e. smaller network) than prefix length in network statement. For example statement above doesn't enable ospf on interface with address 192.168.1.1/23, but it does on interface with address 192.168.1.129/25. - + In some cases it may be more convenient to enable OSPF on a per interface/subnet basis :cfgcmd:`set protocols ospf interface <interface> area <x.x.x.x | x>` @@ -145,12 +145,16 @@ Optional This command should NOT be set normally. -.. cfgcmd:: set protocols ospf passive-interface <interface> +.. cfgcmd:: set protocols ospf interface <interface> passive [disable] This command specifies interface as passive. Passive interface advertises its address, but does not run the OSPF protocol (adjacencies are not formed and hello packets are not generated). + The optional `disable` option allows to exclude interface from passive state. + This command is used if the command :cfgcmd:`passive-interface default` was + configured. + .. cfgcmd:: set protocols ospf passive-interface default This command specifies all interfaces as passive by default. Because this @@ -158,11 +162,6 @@ Optional interfaces where router adjacencies are expected need to be configured with the :cfgcmd:`passive-interface-exclude` command. -.. cfgcmd:: set protocols ospf passive-interface-exclude <interface> - - This command allows exclude interface from passive state. This command is - used if the command :cfgcmd:`passive-interface default` was configured. - .. cfgcmd:: set protocols ospf refresh timers <seconds> The router automatically updates link-state information with its neighbors. @@ -549,12 +548,12 @@ Operational Mode Commands This command displays the neighbors information in a detailed form for a neighbor whose IP address is specified. -.. opcmd:: show ip ospf neighbor <intname> +.. opcmd:: show ip ospf neighbor <interface> This command displays the neighbors status for a neighbor on the specified interface. -.. opcmd:: show ip ospf interface [<intname>] +.. opcmd:: show ip ospf interface [<interface>] This command displays state and configuration of OSPF the specified interface, or all interfaces if no interface is given. @@ -754,6 +753,8 @@ address and the node 1 sending the default route: set policy route-map CONNECT rule 10 match interface lo +.. _routing-ospfv3: + ************* OSPFv3 (IPv6) ************* @@ -826,20 +827,20 @@ Area Configuration Interface Configuration ----------------------- -.. cfgcmd:: set protocols ospfv3 interface <intname> ipv6 cost <number> +.. cfgcmd:: set protocols ospfv3 interface <interface> ipv6 cost <number> This command sets link cost for the specified interface. The cost value is set to router-LSA’s metric field and used for SPF calculation. The cost range is 1 to 65535. -.. cfgcmd:: set protocols ospfv3 interface <intname> dead-interval <number> +.. cfgcmd:: set protocols ospfv3 interface <interface> dead-interval <number> Set number of seconds for router Dead Interval timer value used for Wait Timer and Inactivity Timer. This value must be the same for all routers attached to a common network. The default value is 40 seconds. The interval range is 1 to 65535. -.. cfgcmd:: set protocols ospfv3 interface <intname> hello-interval +.. cfgcmd:: set protocols ospfv3 interface <interface> hello-interval <number> Set number of seconds for Hello Interval timer value. Setting this value, @@ -848,14 +849,14 @@ Interface Configuration common network. The default value is 10 seconds. The interval range is 1 to 65535. -.. cfgcmd:: set protocols ospfv3 interface <intname> mtu-ignore +.. cfgcmd:: set protocols ospfv3 interface <interface> mtu-ignore This command disables check of the MTU value in the OSPF DBD packets. Thus, use of this command allows the OSPF adjacency to reach the FULL state even though there is an interface MTU mismatch between two OSPF routers. -.. cfgcmd:: set protocols ospfv3 interface <intname> network <type> +.. cfgcmd:: set protocols ospfv3 interface <interface> network <type> This command allows to specify the distribution type for the network connected to this interface: @@ -863,20 +864,20 @@ Interface Configuration **broadcast** – broadcast IP addresses distribution. **point-to-point** – address distribution in point-to-point networks. -.. cfgcmd:: set protocols ospfv3 interface <intname> priority <number> +.. cfgcmd:: set protocols ospfv3 interface <interface> priority <number> This command sets Router Priority integer value. The router with the highest priority will be more eligible to become Designated Router. Setting the value to 0, makes the router ineligible to become Designated Router. The default value is 1. The interval range is 0 to 255. -.. cfgcmd:: set protocols ospfv3 interface <intname> passive +.. cfgcmd:: set protocols ospfv3 interface <interface> passive This command specifies interface as passive. Passive interface advertises its address, but does not run the OSPF protocol (adjacencies are not formed and hello packets are not generated). -.. cfgcmd:: set protocols ospfv3 interface <intname> retransmit-interval +.. cfgcmd:: set protocols ospfv3 interface <interface> retransmit-interval <number> This command sets number of seconds for RxmtInterval timer value. This @@ -884,7 +885,7 @@ Interface Configuration Request packets if acknowledge was not received. The default value is 5 seconds. The interval range is 3 to 65535. -.. cfgcmd:: set protocols ospfv3 interface <intname> transmit-delay +.. cfgcmd:: set protocols ospfv3 interface <interface> transmit-delay <number> This command sets number of seconds for InfTransDelay value. It allows to @@ -927,7 +928,7 @@ Operational Mode Commands This command displays the neighbor DR choice information. -.. opcmd:: show ipv6 ospfv3 interface [prefix]|[<intname> [prefix]] +.. opcmd:: show ipv6 ospfv3 interface [prefix]|[<interface> [prefix]] This command displays state and configuration of OSPF the specified interface, or all interfaces if no interface is given. Whith the argument diff --git a/docs/configuration/service/tftp-server.rst b/docs/configuration/service/tftp-server.rst index 11011144..0ca75efe 100644 --- a/docs/configuration/service/tftp-server.rst +++ b/docs/configuration/service/tftp-server.rst @@ -28,6 +28,14 @@ Configure the IPv4 or IPv6 listen address of the TFTP server. Multiple IPv4 and IPv6 addresses can be given. There will be one TFTP server instances listening on each IP address. +.. cfgcmd:: set service tftp-server listen-address <address> vrf <name> + +.. stop_vyoslinter + +Additional option to run TFTP server in the :abbr:`VRF (Virtual Routing and Forwarding)` context + +.. start_vyoslinter + .. note:: Configuring a listen-address is essential for the service to work. .. cfgcmd:: set service tftp-server allow-upload diff --git a/docs/configuration/vrf/index.rst b/docs/configuration/vrf/index.rst index 05904209..90d99c56 100644 --- a/docs/configuration/vrf/index.rst +++ b/docs/configuration/vrf/index.rst @@ -62,6 +62,7 @@ Currently dynamic routing is supported for the following protocols: - :ref:`routing-bgp` - :ref:`routing-isis` - :ref:`routing-ospf` +- :ref:`routing-ospfv3` - :ref:`routing-static` The CLI configuration is same as mentioned in above articles. The only @@ -77,6 +78,7 @@ routing protocol inside a given vrf: - :ref:`routing-bgp`: ``set vrf name <name> protocols bgp ...`` - :ref:`routing-isis`: ``set vrf name <name> protocols isis ...`` - :ref:`routing-ospf`: ``set vrf name <name> protocols ospf ...`` +- :ref:`routing-ospfv3`: ``set vrf name <name> protocols ospfv3 ...`` - :ref:`routing-static`: ``set vrf name <name> protocols static ...`` Operation |