From 8d0279a0f0552092a8e0f2107675658580c5064f Mon Sep 17 00:00:00 2001
From: Christian Breunig <christian@breunig.cc>
Date: Tue, 25 Jul 2023 23:13:35 +0200
Subject: ospf: T5377: add graceful restart FRR feature (RFC 3623)

---
 docs/configuration/protocols/ospf.rst | 89 +++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)

(limited to 'docs')

diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst
index c46497a1..e360d86a 100644
--- a/docs/configuration/protocols/ospf.rst
+++ b/docs/configuration/protocols/ospf.rst
@@ -202,6 +202,17 @@ Optional
   This command will change the hold down value globally for IGP-LDP
   synchronization during convergence/interface flap events.
 
+.. cfgcmd:: set protocols ospf capability opaque
+
+   ospfd supports Opaque LSA :rfc:`2370` as partial support for MPLS Traffic
+   Engineering LSAs. The opaque-lsa capability must be enabled in the
+   configuration.
+
+   An alternate command could be "mpls-te on" (Traffic Engineering)
+
+   .. note:: FRR offers only partial support for some of the routing
+      protocol extensions that are used with MPLS-TE; it does not
+      support a complete RSVP-TE solution.
 
 Area Configuration
 ------------------
@@ -483,6 +494,45 @@ Route will be originated on-behalf of all matched external LSAs.
    This command to ensure not advertise the summary lsa for the matched
    external LSAs.
 
+Graceful Restart
+----------------
+
+.. cfgcmd:: set protocols ospf graceful-restart [grace-period (1-1800)]
+
+   Configure Graceful Restart :rfc:`3623` restarting support. When enabled,
+   the default grace period is 120 seconds.
+
+   To perform a graceful shutdown, the FRR ``graceful-restart prepare ip
+   ospf`` EXEC-level command needs to be issued before restarting the
+   ospfd daemon.
+
+.. cfgcmd:: set protocols ospf graceful-restart helper enable [router-id A.B.C.D]
+
+   Configure Graceful Restart :rfc:`3623` helper support. By default, helper support
+   is disabled for all neighbours. This config enables/disables helper support
+   on this router for all neighbours.
+
+   To enable/disable helper support for a specific neighbour, the router-id
+   (A.B.C.D) has to be specified.
+
+.. cfgcmd:: set protocols ospf graceful-restart helper no-strict-lsa-checking
+
+   By default `strict-lsa-checking` is configured then the helper will abort
+   the Graceful Restart when a LSA change occurs which affects the restarting
+   router.
+
+   This command disables it.
+
+.. cfgcmd:: set protocols ospf graceful-restart helper supported-grace-time
+
+   Supports as HELPER for configured grace period.
+
+.. cfgcmd:: set protocols ospf graceful-restart helper planned-only
+
+   It helps to support as HELPER only for planned restarts.
+
+   By default, it supports both planned and unplanned outages.
+
 Manual Neighbor Configuration
 -----------------------------
 
@@ -1156,6 +1206,45 @@ Interface Configuration
 
 .. _ospf:v3_redistribution_config:
 
+Graceful Restart
+----------------
+
+.. cfgcmd:: set protocols ospfv3 graceful-restart [grace-period (1-1800)]
+
+   Configure Graceful Restart :rfc:`3623` restarting support. When enabled,
+   the default grace period is 120 seconds.
+
+   To perform a graceful shutdown, the FRR ``graceful-restart prepare ip
+   ospf`` EXEC-level command needs to be issued before restarting the
+   ospfd daemon.
+
+.. cfgcmd:: set protocols ospfv3 graceful-restart helper enable [router-id A.B.C.D]
+
+   Configure Graceful Restart :rfc:`3623` helper support. By default, helper support
+   is disabled for all neighbours. This config enables/disables helper support
+   on this router for all neighbours.
+
+   To enable/disable helper support for a specific neighbour, the router-id
+   (A.B.C.D) has to be specified.
+
+.. cfgcmd:: set protocols ospfv3 graceful-restart helper lsa-check-disable
+
+   By default `strict-lsa-checking` is configured then the helper will abort
+   the Graceful Restart when a LSA change occurs which affects the restarting
+   router.
+
+   This command disables it.
+
+.. cfgcmd:: set protocols ospfv3 graceful-restart helper supported-grace-time
+
+   Supports as HELPER for configured grace period.
+
+.. cfgcmd:: set protocols ospfv3 graceful-restart helper planned-only
+
+   It helps to support as HELPER only for planned restarts.
+
+   By default, it supports both planned and unplanned outages.
+
 Redistribution Configuration
 ----------------------------
 
-- 
cgit v1.2.3