From: Olivier Dugeon <olivier.dugeon@orange.com>
Date: Tue, 5 May 2020 14:40:35 +0000 (+0200)
Subject: isisd: Update documentation for Segment Routing
X-Git-Tag: frr-7.4~8^2^2
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=d4d008fea1172e6981ad18518a311d13c96269ed;p=matthieu%2Ffrr.git

isisd: Update documentation for Segment Routing

Signed-off-by: Olivier Dugeon <olivier.dugeon@orange.com>
---

diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst
index f0c64b9bb0..dc598ea5bf 100644
--- a/doc/user/isisd.rst
+++ b/doc/user/isisd.rst
@@ -473,15 +473,16 @@ Traffic Engineering
 Segment Routing
 ===============
 
-This is an EXPERIMENTAL support of Segment Routing as per draft
-`draft-ietf-isis-segment-routing-extensions-25.txt` for MPLS dataplane.
-It supports IPv4, IPv6 and ECMP and has been tested against Cisco & Juniper
-routers.
+This is an EXPERIMENTAL support of Segment Routing as per RFC8667
+for MPLS dataplane. It supports IPv4, IPv6 and ECMP and has been
+tested against Cisco & Juniper routers.
 
 Known limitations:
  - No support for level redistribution (L1 to L2 or L2 to L1)
  - No support for binding SID
  - No support for SRMS
+ - No support for SRLB
+ - Only one SRGB and default SPF Algorithm is supported
 
 .. index:: [no] segment-routing on
 .. clicmd:: [no] segment-routing on
@@ -491,14 +492,15 @@ Known limitations:
 .. index:: [no] segment-routing global-block (0-1048575) (0-1048575)
 .. clicmd:: [no] segment-routing global-block (0-1048575) (0-1048575)
 
-   Seet the Segment Routing Global Block i.e. the label range used by MPLS
+   Set the Segment Routing Global Block i.e. the label range used by MPLS
    to store label in the MPLS FIB.
 
 .. index:: [no] segment-routing node-msd (1-16)
 .. clicmd:: [no] segment-routing node-msd (1-16)
 
    Set the Maximum Stack Depth supported by the router. The value depend of the
-   MPLS dataplane. E.g. for Linux kernel, since version 4.13 it is 32.
+   MPLS dataplane. E.g. for Linux kernel, since version 4.13 the maximum value
+   is 32.
 
 .. index:: [no] segment-routing prefix <A.B.C.D/M|X:X::X:X/M> <absolute (16-1048575)|index (0-65535)> [no-php-flag|explicit-null]
 .. clicmd:: [no] segment-routing prefix <A.B.C.D/M|X:X::X:X/M> <absolute (16-1048575)|index (0-65535) [no-php-flag|explicit-null]
@@ -514,6 +516,11 @@ Known limitations:
 
    Show detailed information about all learned Segment Routing Prefix-SIDs.
 
+.. index:: show isis segment-routing nodes
+.. clicmd:: show isis segment-routing nodes
+
+   Show detailed information about all learned Segment Routing Nodes.
+
 Debugging ISIS
 ==============
 
@@ -707,3 +714,32 @@ Then the :file:`isisd.conf` itself:
      mpls-te router-address 10.1.1.1
    !
    line vty
+
+A Segment Routing configuration, with IPv4, IPv6, SRGB and MSD configuration.
+
+.. code-block:: frr
+
+   hostname HOSTNAME
+   password PASSWORD
+   log file /var/log/isisd.log
+   !
+   !
+   interface eth0
+    ip router isis SR
+    isis network point-to-point
+   !
+   interface eth1
+    ip router isis SR
+   !
+   !
+   router isis SR
+    net 49.0000.0000.0000.0001.00
+    is-type level-1
+    topology ipv6-unicast
+    lsp-gen-interval 2
+    segment-routing on
+    segment-routing node-msd 8
+    segment-routing prefix 10.1.1.1/32 index 100 explicit-null
+    segment-routing prefix 2001:db8:1000::1/128 index 101 explicit-null
+   !
+