@birdcc/lsp 0.0.1-alpha.0 → 0.1.0-beta.0

package/dist/hover-docs/41-protocol-igp.yaml

@@ -0,0 +1,305 @@
+entries:
+  # ── Babel protocol ───────────────────────────────────────────────
+  - keyword: babel
+    description: Babel routing protocol
+    detail: A loop-avoiding distance-vector routing protocol that is robust and efficient for both wired and wireless networks.
+    diff: same
+    version: v2+
+    anchor: proto-babel
+    path: protocol
+    related:
+      - interface
+      - ipv4
+      - ipv6
+      - randomize router id
+  - keyword: randomize router id
+    description: Babel random router ID
+    detail: Randomize the upper 32 bits of the Babel router ID on each startup for privacy.
+    diff: same
+    version: v2+
+    anchor: proto-babel
+    path: protocol.babel
+    related:
+      - babel
+      - router id
+    parameters:
+      - name: switch
+        description: Enable router ID randomization (default no).
+  - keyword: rxcost
+    description: Babel interface receive cost
+    detail: Set the nominal RX cost for this Babel interface, used in metric computation.
+    diff: same
+    version: v2+
+    anchor: proto-babel
+    path: protocol.babel.interface
+    related:
+      - babel
+      - interface
+      - type
+    parameters:
+      - name: number
+        description: Interface RX cost value.
+  - keyword: hello interval
+    description: Babel hello interval
+    detail: Set the interval between Babel Hello messages on this interface.
+    diff: same
+    version: v2+
+    anchor: proto-babel
+    path: protocol.babel.interface
+    related:
+      - babel
+      - update interval
+    parameters:
+      - name: seconds
+        description: Hello interval in seconds.
+  - keyword: update interval
+    description: Babel update interval
+    detail: Set the interval between full routing table updates on this Babel interface.
+    diff: same
+    version: v2+
+    anchor: proto-babel
+    path: protocol.babel.interface
+    related:
+      - babel
+      - hello interval
+    parameters:
+      - name: seconds
+        description: Update interval in seconds.
+  - keyword: rtt cost
+    description: Babel RTT-based cost
+    detail: Add extra routing cost based on measured round-trip time to Babel neighbors.
+    diff: same
+    version: v2+
+    anchor: proto-babel
+    path: protocol.babel.interface
+    related:
+      - babel
+      - rtt min
+      - rtt max
+    parameters:
+      - name: number
+        description: Maximum additional cost applied at rtt_max.
+  - keyword: rtt min
+    description: Babel minimum RTT threshold
+    detail: RTT below this threshold adds no extra cost to routes via this Babel interface.
+    diff: same
+    version: v2+
+    anchor: proto-babel
+    path: protocol.babel.interface
+    related:
+      - rtt cost
+      - rtt max
+    parameters:
+      - name: milliseconds
+        description: Minimum RTT threshold.
+  - keyword: rtt max
+    description: Babel maximum RTT threshold
+    detail: RTT at or above this threshold applies the full rtt_cost penalty.
+    diff: same
+    version: v2+
+    anchor: proto-babel
+    path: protocol.babel.interface
+    related:
+      - rtt cost
+      - rtt min
+    parameters:
+      - name: milliseconds
+        description: Maximum RTT threshold.
+  # ── RIP protocol ─────────────────────────────────────────────────
+  - keyword: rip
+    description: RIP protocol
+    detail: Routing Information Protocol - a distance-vector interior gateway protocol.
+    diff: same
+    version: v2+
+    anchor: proto-rip
+    path: protocol
+    related:
+      - interface
+      - import
+      - export
+      - infinity
+      - ecmp
+  - keyword: infinity
+    description: RIP infinity metric
+    detail: Set the infinity (unreachable) metric value for RIP. Routes with this metric are considered dead.
+    diff: same
+    version: v2+
+    anchor: proto-rip
+    path: protocol.rip
+    related:
+      - rip
+    parameters:
+      - name: number
+        description: Infinity metric value (default 16).
+  - keyword: update time
+    description: RIP periodic update interval
+    detail: Set the interval between full routing table broadcasts to RIP neighbors.
+    diff: same
+    version: v2+
+    anchor: proto-rip
+    path: protocol.rip.interface
+    related:
+      - rip
+      - timeout time
+      - garbage time
+    parameters:
+      - name: seconds
+        description: Update interval in seconds (default 30).
+  - keyword: timeout time
+    description: RIP route timeout
+    detail: Set the time after which a route is considered expired if no updates are received.
+    diff: same
+    version: v2+
+    anchor: proto-rip
+    path: protocol.rip.interface
+    related:
+      - rip
+      - update time
+      - garbage time
+    parameters:
+      - name: seconds
+        description: Timeout interval in seconds (default 180).
+  - keyword: garbage time
+    description: RIP garbage collection timer
+    detail: Time to keep an expired route as unreachable before removing it completely.
+    diff: same
+    version: v2+
+    anchor: proto-rip
+    path: protocol.rip.interface
+    related:
+      - rip
+      - update time
+      - timeout time
+    parameters:
+      - name: seconds
+        description: Garbage collection interval in seconds (default 120).
+  - keyword: split horizon
+    description: RIP split horizon
+    detail: Enable split horizon to prevent routing loops by not advertising routes back to their source.
+    diff: same
+    version: v2+
+    anchor: proto-rip
+    path: protocol.rip.interface
+    related:
+      - rip
+      - poison reverse
+    parameters:
+      - name: switch
+        description: Enable split horizon (default yes).
+  - keyword: poison reverse
+    description: RIP poison reverse
+    detail: Advertise routes learned from a neighbor back with infinity metric to speed up convergence.
+    diff: same
+    version: v2+
+    anchor: proto-rip
+    path: protocol.rip.interface
+    related:
+      - rip
+      - split horizon
+    parameters:
+      - name: switch
+        description: Enable poison reverse (default yes).
+  - keyword: version
+    description: RIP protocol version
+    detail: Set the RIP protocol version used on this interface (RIPv1 or RIPv2).
+    diff: same
+    version: v2+
+    anchor: proto-rip
+    path: protocol.rip.interface
+    related:
+      - rip
+    parameters:
+      - name: number
+        description: "RIP version: 1 or 2."
+  # ── BFD protocol ─────────────────────────────────────────────────
+  - keyword: bfd
+    description: Bidirectional Forwarding Detection
+    detail: Fast failure detection protocol that can be used by other protocols like BGP and OSPF.
+    diff: same
+    version: v2+
+    anchor: proto-bfd
+    path: protocol
+    related:
+      - ospf
+      - bgp
+      - interval
+      - multiplier
+  - keyword: interval
+    description: BFD detection interval
+    detail: Set both the minimum transmit and receive intervals for BFD sessions simultaneously.
+    diff: same
+    version: v2+
+    anchor: proto-bfd
+    path:
+      - protocol.bfd.interface
+      - protocol.bfd.multihop
+    related:
+      - bfd
+      - min rx interval
+      - min tx interval
+      - multiplier
+    parameters:
+      - name: milliseconds
+        description: Combined min TX and RX interval.
+  - keyword: min rx interval
+    description: BFD minimum receive interval
+    detail: Set the minimum interval between received BFD control packets.
+    diff: same
+    version: v2+
+    anchor: proto-bfd
+    path:
+      - protocol.bfd.interface
+      - protocol.bfd.multihop
+    related:
+      - bfd
+      - min tx interval
+      - interval
+    parameters:
+      - name: milliseconds
+        description: Minimum receive interval.
+  - keyword: min tx interval
+    description: BFD minimum transmit interval
+    detail: Set the desired minimum interval between transmitted BFD control packets.
+    diff: same
+    version: v2+
+    anchor: proto-bfd
+    path:
+      - protocol.bfd.interface
+      - protocol.bfd.multihop
+    related:
+      - bfd
+      - min rx interval
+      - interval
+    parameters:
+      - name: milliseconds
+        description: Minimum transmit interval.
+  - keyword: idle tx interval
+    description: BFD idle transmit interval
+    detail: Transmit interval used when the BFD session is not yet established.
+    diff: same
+    version: v2+
+    anchor: proto-bfd
+    path:
+      - protocol.bfd.interface
+      - protocol.bfd.multihop
+    related:
+      - bfd
+      - min tx interval
+    parameters:
+      - name: milliseconds
+        description: Idle transmit interval.
+  - keyword: multiplier
+    description: BFD detection multiplier
+    detail: Number of missed BFD packets before declaring the session down.
+    diff: same
+    version: v2+
+    anchor: proto-bfd
+    path:
+      - protocol.bfd.interface
+      - protocol.bfd.multihop
+    related:
+      - bfd
+      - interval
+    parameters:
+      - name: number
+        description: Failure detection multiplier (default 5).

package/dist/hover-docs/42-protocol-kernel-static.yaml

@@ -0,0 +1,220 @@
+entries:
+  # ── Device protocol ───────────────────────────────────────────────
+  - keyword: device
+    description: Device scan protocol
+    detail:
+      Scan network interfaces for link state changes and generate routes for directly connected
+      networks.
+    diff: same
+    version: v2+
+    anchor: proto-device
+    path: protocol
+    related:
+      - direct
+      - scan time
+  - keyword: scan time
+    description: Device interface scan interval
+    detail: Set how often BIRD scans host interfaces for changes. Default is operating system event-driven.
+    diff: same
+    version: v2+
+    anchor: proto-device
+    path: protocol.device
+    related:
+      - device
+    parameters:
+      - name: seconds
+        description: Scan interval in seconds.
+  # ── Direct protocol ──────────────────────────────────────────────
+  - keyword: direct
+    description: Direct routes protocol
+    detail: Generate routes for directly connected networks based on interface addresses.
+    diff: same
+    version: v2+
+    anchor: proto-direct
+    path: protocol
+    related:
+      - device
+      - interface
+      - check link
+    parameters:
+      - name: interface-pattern
+        description: Interface name/pattern selection.
+  - keyword: check link
+    description: Hardware link state detection
+    detail: Use hardware link state to immediately detect interface up/down events.
+    diff: same
+    version: v2+
+    anchor: proto-direct
+    path:
+      - protocol.direct
+      - protocol.static
+    related:
+      - direct
+      - interface
+    parameters:
+      - name: switch
+        description: Enable or disable link state awareness.
+  # ── Kernel protocol ──────────────────────────────────────────────
+  - keyword: kernel
+    description: Kernel synchronization protocol
+    detail: Synchronize routes between BIRD and the operating system kernel routing table.
+    diff: same
+    version: v2+
+    anchor: proto-kernel
+    path: protocol
+    related:
+      - table
+      - export
+      - import
+      - persist
+      - learn
+      - scan time
+  - keyword: persist
+    description: Persist kernel routes on shutdown
+    detail: Keep routes installed by BIRD in the kernel routing table when BIRD exits.
+    diff: same
+    version: v2+
+    anchor: proto-kernel
+    path: protocol.kernel
+    related:
+      - kernel
+      - graceful restart
+    parameters:
+      - name: switch
+        description: Enable route persistence (default no).
+  - keyword: learn
+    description: Learn non-BIRD kernel routes
+    detail: Import routes added to the kernel routing table by other routing software or manual configuration.
+    diff: same
+    version: v2+
+    anchor: proto-kernel
+    path: protocol.kernel
+    related:
+      - kernel
+      - scan time
+    parameters:
+      - name: switch
+        description: Enable learning of alien routes (default no).
+  - keyword: kernel table
+    description: Select kernel routing table
+    detail: Choose which kernel routing table to synchronize with. Linux supports multiple tables (0-4 billion).
+    diff: same
+    version: v2+
+    anchor: proto-kernel
+    path: protocol.kernel
+    related:
+      - kernel
+    parameters:
+      - name: number
+        description: Kernel routing table number.
+  - keyword: metric
+    description: Kernel route metric/priority
+    detail: Set the routing metric (priority on Linux) for routes installed into the kernel.
+    diff: same
+    version: v2+
+    anchor: proto-kernel
+    path: protocol.kernel
+    related:
+      - kernel
+    parameters:
+      - name: number
+        description: Route metric value (default 32).
+  - keyword: merge paths
+    description: Merge equal-cost paths in kernel
+    detail: Merge multiple equal-cost routes into a single kernel multipath (ECMP) route.
+    diff: same
+    version: v2+
+    anchor: proto-kernel
+    path: protocol.kernel
+    related:
+      - kernel
+      - ecmp
+    parameters:
+      - name: switch
+        description: Enable ECMP merging (default no).
+  # ── Static protocol ──────────────────────────────────────────────
+  - keyword: static
+    description: Static routes protocol
+    detail: Define static routes that are not learned from any routing protocol.
+    diff: same
+    version: v2+
+    anchor: proto-static
+    path: protocol
+    related:
+      - route
+      - preference
+      - igp table
+  - keyword: igp table
+    description: IGP route lookup table
+    detail: Specify the routing table used for recursive next-hop resolution in static routes.
+    diff: same
+    version: v2+
+    anchor: proto-static
+    path:
+      - protocol.static
+      - protocol.bgp.channel
+    related:
+      - route
+      - recursive
+      - gateway
+    parameters:
+      - name: name
+        description: Routing table name for recursive lookups.
+  - keyword: recursive
+    description: Recursive static route
+    detail: Define a static route with a recursive next hop that is resolved through another routing table.
+    diff: same
+    version: v2+
+    anchor: proto-static-route
+    path: protocol.static.route
+    related:
+      - route
+      - igp table
+      - next hop
+    parameters:
+      - name: address
+        description: Recursive next-hop IP address.
+        required: true
+  - keyword: prohibit
+    description: Static route prohibit action
+    detail: Send ICMP administratively prohibited for traffic matching this static route.
+    diff: same
+    version: v2+
+    anchor: proto-static-route
+    path: protocol.static.route
+    related:
+      - route
+      - blackhole
+      - unreachable
+  # ── Pipe protocol ────────────────────────────────────────────────
+  - keyword: pipe
+    description: Protocol pipe
+    detail: Connect two routing tables, forwarding routes between them with optional filtering.
+    diff: same
+    version: v2+
+    anchor: proto-pipe
+    path: protocol
+    related:
+      - table
+      - peer table
+      - export
+      - import
+    parameters:
+      - name: table-name
+        description: Primary table to bridge.
+      - name: peer-table-name
+        description: Peer table to bridge with.
+  - keyword: peer table
+    description: Pipe peer routing table
+    detail: Specify the secondary routing table that the pipe protocol connects to.
+    diff: same
+    version: v2+
+    anchor: proto-pipe
+    path: protocol.pipe
+    related:
+      - pipe
+      - table
+    parameters:
+      - name: name
+        description: Peer routing table name.
+        required: true

package/dist/hover-docs/43-protocol-mpls.yaml

@@ -0,0 +1,40 @@
+entries:
+  - keyword: mpls domain
+    description: Define an MPLS domain
+    detail: Create a named MPLS domain for label distribution and MPLS forwarding.
+    diff: same
+    version: v2+
+    anchor: mpls-opts
+    path: protocol
+    related:
+      - label policy
+      - label range
+    parameters:
+      - name: domain-name
+        description: MPLS domain identifier.
+  - keyword: label policy
+    description: MPLS label policy
+    detail: Configure how MPLS labels are assigned and distributed.
+    diff: same
+    version: v2+
+    anchor: mpls-label-policy
+    path: protocol
+    related:
+      - mpls domain
+      - label range
+    parameters:
+      - name: mode
+        description: Label allocation behavior.
+  - keyword: label range
+    description: MPLS label range
+    detail: Define the range of MPLS labels to use.
+    diff: same
+    version: v2+
+    anchor: mpls-label-range
+    path: protocol
+    related:
+      - mpls domain
+      - label policy
+    parameters:
+      - name: range-name
+        description: Named MPLS label range.