Skip to content

Commit

Permalink
Add Operator_Guide for Open/R under CFM rule
Browse files Browse the repository at this point in the history
Summary: As titled.

Reviewed By: ashutoshgrewal

Differential Revision: D53879375

fbshipit-source-id: 3b6985ce17cbd30cd6bdf00d9f5d954de4bb46a6
  • Loading branch information
Xiang Xu authored and facebook-github-bot committed Feb 19, 2024
1 parent 9cead21 commit fece09c
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 37 deletions.
45 changes: 29 additions & 16 deletions openr/docs/CFM_RULES
Original file line number Diff line number Diff line change
@@ -1,21 +1,34 @@
publish(
wiki_root_path = "Network_Routing_Control/Routing_Protocol/Open-R",
wiki_root_path = "Network_Routing_Control/Routing_Protocol/Open-R/Operator_Guide",
srcs = [
"Protocol_Guide/Architecture.md",
"Protocol_Guide/Config.md",
"Protocol_Guide/Decision.md",
"Protocol_Guide/Dispatcher.md",
"Protocol_Guide/Fib.md",
"Protocol_Guide/Initialization_Process.md",
"Protocol_Guide/KvStore.md",
"Protocol_Guide/LinkMonitor.md",
"Protocol_Guide/Messaging.md",
"Protocol_Guide/Miscellaneous.md",
"Protocol_Guide/Monitor.md",
"Protocol_Guide/Netlink.md",
"Protocol_Guide/Platform.md",
"Protocol_Guide/PrefixManager.md",
"Protocol_Guide/Spark.md",
"CLI.md",
"Configuration.md",
"Control_Plane_IO.md",
"Drain_OSS.md",
"Route_Representation.md",
"Version.md",
],
oncall = "routing_protocol",
)

publish(
wiki_root_path = "Network_Routing_Control/Routing_Protocol/Open-R/Protocol_Guide",
srcs = [
"Architecture.md",
"Config.md",
"Decision.md",
"Dispatcher.md",
"Fib.md",
"Initialization_Process.md",
"KvStore.md",
"LinkMonitor.md",
"Messaging.md",
"Miscellaneous.md",
"Monitor.md",
"Netlink.md",
"Platform.md",
"PrefixManager.md",
"Spark.md",
],
oncall = "routing_protocol",
)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Monitoring
# Counters and Log Events

Each module internally generates its own list of counters using the `ThreadData`
library (which has supports for stats like SUM/RATE/COUNT over various
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,39 @@ Open/R has thrift endpoints to ask the daemon to drain itself. Open/R supports
draining a link and whole device/node. Using the `breeze` CLI is an option to
hit these endpoints and see/control the drain state.

### See Drain Status
### Check Drain Status

- `breeze openr interfaces`
- alias of `breeze lm links`

### Drain
### Hard-Drain

- A link
- `breeze lm set-link-overload INTERFACE`
- A device/node
- `breeze lm set-node-overload`

### Undrain
### Undrain (Hard-Drain)

- A link
- `breeze lm unset-link-overload INTERFACE`
- A device/node
- `breeze lm unset-node-overload`

### Soft-Drain

- A link
- `breeze lm increase-link-metric INTERFACE METRIC`
- A device/node
- `breeze lm increase-node-metric METRIC`

### Undrain (Soft-Drain)

- A link
- `breeze lm clear-link-metric-increase INTERFACE`
- A device/node
- `breeze lm clear-node-metric-increase`

#### API

If you wish to write you own tool, just look at the `breeze` commands source
Expand Down
17 changes: 0 additions & 17 deletions openr/docs/Operator_Guide/index.rst

This file was deleted.

0 comments on commit fece09c

Please sign in to comment.