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

package/dist/hover-usage/30-channel-usage.yaml

@@ -0,0 +1,41 @@
+entries:
+  - keyword: export
+    usage: export filter only_bgp;
+  - keyword: export block
+    usage: export block 16384;
+  - keyword: export limit
+    usage: export limit 100000 action warn;
+  - keyword: import
+    usage: import all;
+  - keyword: import keep filtered
+    usage: import keep filtered on;
+  - keyword: import limit
+    usage: import limit 100000 action block;
+  - keyword: ipv4
+    usage: |
+      ipv4 {
+        import all;
+        export none;
+      };
+  - keyword: ipv6
+    usage: |
+      ipv6 {
+        import all;
+        export filter only_v6;
+      };
+  - keyword: preference
+    usage: preference 100;
+  - keyword: receive limit
+    usage: receive limit 200000 action disable;
+  - keyword: rpki reload
+    usage: rpki reload on;
+  - keyword: table
+    path:
+      - protocol.bgp.channel
+      - protocol.ospf.channel
+      - protocol.rip.channel
+      - protocol.babel.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+    usage: table master4;

package/dist/hover-usage/40-protocol-usage.yaml

@@ -0,0 +1,258 @@
+entries:
+  # ── Common protocol options ──────────────────────────────────────
+  - keyword: description
+    usage: description "core upstream session";
+  - keyword: disabled
+    usage: disabled on;
+  - keyword: restart time limit
+    usage: restart time limit 60;
+  - keyword: vrf
+    usage: vrf "blue";
+  # ── Protocol declarations ───────────────────────────────────────
+  - keyword: babel
+    usage: protocol babel edge_babel {}
+  - keyword: bfd
+    usage: protocol bfd {}
+  - keyword: rip
+    usage: protocol rip edge_rip {}
+  - keyword: device
+    usage: protocol device {}
+  - keyword: direct
+    usage: protocol direct { interface "eth*"; };
+  - keyword: kernel
+    usage: protocol kernel { ipv4 { export all; }; };
+  - keyword: static
+    usage: protocol static { route 203.0.113.0/24 via 192.0.2.1; };
+  - keyword: pipe
+    usage: protocol pipe { table master4; peer table backup4; };
+  - keyword: mpls domain
+    usage: mpls domain core_mpls;
+  - keyword: label policy
+    usage: label policy aggregate;
+  - keyword: label range
+    usage: label range dynamic;
+  - keyword: aggregator
+    usage: protocol aggregator sum4 {}
+  - keyword: bmp
+    usage: protocol bmp monitor { station address 192.0.2.200 port 1790; };
+  - keyword: l3vpn
+    usage: protocol l3vpn vpn1 { vrf "blue"; };
+  - keyword: mrt
+    usage: protocol mrt dump1 { table master4; filename "/var/log/bird.mrt"; };
+  - keyword: perf
+    usage: protocol perf bench {}
+  - keyword: radv
+    usage: protocol radv ra1 { interface "eth*" { max ra interval 30; }; };
+  - keyword: rpki
+    usage: protocol rpki rpki1 { remote "192.0.2.50" port 3323; };
+  # ── Static route types ──────────────────────────────────────────
+  - keyword: route
+    usage: route 203.0.113.0/24 via 192.0.2.1;
+  - keyword: next hop
+    usage: route 203.0.113.0/24 via 192.0.2.1;
+  - keyword: blackhole
+    usage: route 203.0.113.0/24 blackhole;
+  - keyword: unreachable
+    usage: route 203.0.113.0/24 unreachable;
+  - keyword: prohibit
+    usage: route 203.0.113.0/24 prohibit;
+    path: protocol.static
+  - keyword: password
+    usage: password "secret";
+  # ── Kernel sub-options ──────────────────────────────────────────
+  - keyword: persist
+    usage: persist;
+    path: protocol.kernel
+  - keyword: learn
+    usage: learn;
+    path: protocol.kernel
+  - keyword: kernel table
+    usage: kernel table 200;
+    path: protocol.kernel
+  - keyword: merge paths
+    usage: merge paths on;
+    path: protocol.kernel
+  - keyword: scan time
+    usage: scan time 10;
+    path: protocol.device
+  - keyword: check link
+    usage: check link yes;
+    path: protocol.direct
+  - keyword: peer table
+    usage: peer table backup4;
+    path: protocol.pipe
+  # ── Static sub-options ──────────────────────────────────────────
+  - keyword: igp table
+    usage: igp table master4;
+    path: protocol.static
+  - keyword: recursive
+    usage: route 203.0.113.0/24 recursive 192.0.2.1;
+    path: protocol.static
+  # ── BFD sub-options ─────────────────────────────────────────────
+  - keyword: interval
+    usage: interval 100 ms;
+    path: protocol.bfd.interface
+  - keyword: min rx interval
+    usage: min rx interval 50 ms;
+    path: protocol.bfd.interface
+  - keyword: min tx interval
+    usage: min tx interval 50 ms;
+    path: protocol.bfd.interface
+  - keyword: idle tx interval
+    usage: idle tx interval 500 ms;
+    path: protocol.bfd.interface
+  - keyword: multiplier
+    usage: multiplier 5;
+    path: protocol.bfd.interface
+  # ── Babel sub-options ───────────────────────────────────────────
+  - keyword: randomize router id
+    usage: randomize router id yes;
+    path: protocol.babel
+  - keyword: rxcost
+    usage: rxcost 256;
+    path: protocol.babel.interface
+  - keyword: hello interval
+    usage: hello interval 4;
+    path: protocol.babel.interface
+  - keyword: update interval
+    usage: update interval 16;
+    path: protocol.babel.interface
+  - keyword: rtt cost
+    usage: rtt cost 100;
+    path: protocol.babel.interface
+  - keyword: rtt min
+    usage: rtt min 10 ms;
+    path: protocol.babel.interface
+  - keyword: rtt max
+    usage: rtt max 120 ms;
+    path: protocol.babel.interface
+  # ── RIP sub-options ─────────────────────────────────────────────
+  - keyword: infinity
+    usage: infinity 16;
+    path: protocol.rip
+  - keyword: update time
+    usage: update time 30;
+    path: protocol.rip.interface
+  - keyword: timeout time
+    usage: timeout time 180;
+    path: protocol.rip.interface
+  - keyword: garbage time
+    usage: garbage time 120;
+    path: protocol.rip.interface
+  - keyword: split horizon
+    usage: split horizon yes;
+    path: protocol.rip.interface
+  - keyword: poison reverse
+    usage: poison reverse yes;
+    path: protocol.rip.interface
+  - keyword: version
+    usage: version 2;
+    path: protocol.rip.interface
+  # ── RAdv sub-options ────────────────────────────────────────────
+  - keyword: trigger
+    usage: trigger "eth0";
+    path: protocol.radv
+  - keyword: propagate routes
+    usage: propagate routes yes;
+    path: protocol.radv
+  - keyword: max ra interval
+    usage: max ra interval 600;
+    path: protocol.radv.interface
+  - keyword: min ra interval
+    usage: min ra interval 200;
+    path: protocol.radv.interface
+  - keyword: managed
+    usage: managed yes;
+    path: protocol.radv.interface
+  - keyword: other config
+    usage: other config yes;
+    path: protocol.radv.interface
+  - keyword: link mtu
+    usage: link mtu 1500;
+    path: protocol.radv.interface
+  - keyword: default lifetime
+    usage: default lifetime 1800;
+    path: protocol.radv.interface
+  - keyword: default preference
+    usage: default preference high;
+    path: protocol.radv.interface
+  - keyword: rdnss
+    usage: rdnss 2001:db8::1;
+    path: protocol.radv
+  - keyword: dnssl
+    usage: dnssl "example.com";
+    path: protocol.radv
+  # ── RPKI sub-options ────────────────────────────────────────────
+  - keyword: remote
+    usage: remote "192.0.2.50" port 3323;
+    path: protocol.rpki
+  - keyword: port
+    usage: port 3323;
+    path: protocol.rpki
+  - keyword: refresh
+    usage: refresh 3600;
+    path: protocol.rpki
+  - keyword: retry
+    usage: retry 600;
+    path: protocol.rpki
+  - keyword: expire
+    usage: expire 7200;
+    path: protocol.rpki
+  - keyword: ignore max length
+    usage: ignore max length;
+    path: protocol.rpki
+  - keyword: transport tcp
+    usage: transport tcp;
+    path: protocol.rpki
+  - keyword: transport ssh
+    usage: 'transport ssh { bird private key "/etc/bird/ssh_key"; };'
+    path: protocol.rpki
+  - keyword: bird private key
+    usage: bird private key "/etc/bird/ssh_key";
+    path: protocol.rpki
+  - keyword: remote public key
+    usage: remote public key "/etc/bird/rpki_pub.pem";
+    path: protocol.rpki
+  # ── Extended protocol sub-options ───────────────────────────────
+  - keyword: aggregate on
+    usage: aggregate on net;
+    path: protocol.aggregator
+  - keyword: merge by
+    usage: merge by bgp_path;
+    path: protocol.aggregator
+  - keyword: station address
+    usage: station address 192.0.2.200;
+    path: protocol.bmp
+  - keyword: station port
+    usage: station port 1790;
+    path: protocol.bmp
+  - keyword: monitoring rib
+    usage: monitoring rib in pre_policy;
+    path: protocol.bmp
+  - keyword: route distinguisher
+    usage: route distinguisher 65000:100;
+    path: protocol.l3vpn
+  - keyword: route target
+    usage: route target 65000:100;
+    path: protocol.l3vpn
+  - keyword: import target
+    usage: import target 65000:100;
+    path: protocol.l3vpn
+  - keyword: export target
+    usage: export target 65000:100;
+    path: protocol.l3vpn
+  - keyword: filename
+    usage: filename "/var/log/bird.mrt";
+    path: protocol.mrt
+  - keyword: period
+    usage: period 3600;
+    path: protocol.mrt
+  - keyword: always add path
+    usage: always add path yes;
+    path: protocol.mrt
+  - keyword: mode
+    usage: mode import;
+    path: protocol.perf
+  - keyword: repeat
+    usage: repeat 1000;
+    path: protocol.perf

package/dist/hover-usage/50-bgp-usage.yaml

@@ -0,0 +1,254 @@
+entries:
+  # ── Protocol-level ────────────────────────────────────────────────
+  - keyword: bgp
+    usage: |
+      protocol bgp upstream {
+        local as 65001;
+        neighbor 192.0.2.1 as 64496;
+        hold time 90;
+        keepalive time 30;
+        graceful restart on;
+        ipv4 {
+          import all;
+          export filter only_bgp;
+          next hop self;
+        };
+      }
+  - keyword: local as
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        local as <asn>;
+      }
+  - keyword: neighbor
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        neighbor 192.0.2.1 as 64496;
+      }
+  - keyword: multihop
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        multihop <hops>;
+      }
+  - keyword: hold time
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        hold time <seconds>;
+      }
+  - keyword: keepalive time
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        keepalive time <seconds>;
+      }
+  - keyword: source address
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        source address <ip>;
+      }
+  - keyword: ttl security
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        ttl security <switch>;
+      }
+  - keyword: password
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        password "bgp-secret";
+      }
+  - keyword: passive
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        passive <switch>;
+      }
+  - keyword: rr client
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        rr client;
+      }
+  - keyword: rr cluster id
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        rr cluster id <id>;
+      }
+  - keyword: rs client
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        rs client;
+      }
+  - keyword: graceful restart
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        graceful restart on;
+        graceful restart time 120;
+      }
+  - keyword: graceful restart time
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        graceful restart time 120;
+      }
+  - keyword: allow local as
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        allow local as <number>;
+      }
+  - keyword: bfd
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        bfd on;
+      }
+  - keyword: local role
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        local role peer;
+      }
+  - keyword: authentication
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        authentication md5;
+        password "secret";
+      }
+  - keyword: confederation
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        confederation <number>;
+        confederation member;
+      }
+  - keyword: confederation member
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        confederation member;
+      }
+  - keyword: direct
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        direct;
+      }
+  - keyword: path metric
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        path metric on;
+      }
+  - keyword: med metric
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        med metric on;
+      }
+  - keyword: deterministic med
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        deterministic med on;
+      }
+  - keyword: igp metric
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        igp metric on;
+      }
+  - keyword: interpret communities
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        interpret communities on;
+      }
+  - keyword: default bgp_local_pref
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        default bgp_local_pref 100;
+      }
+  - keyword: enable extended messages
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        enable extended messages on;
+      }
+  - keyword: connect retry time
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        connect retry time 120;
+      }
+  - keyword: error wait time
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        error wait time 60, 300;
+      }
+  - keyword: disable after error
+    path: protocol.bgp
+    usage: |
+      protocol bgp <name> {
+        disable after error on;
+      }
+  # ── Channel-level ─────────────────────────────────────────────────
+  - keyword: next hop self
+    path: protocol.bgp.channel
+    usage: |
+      protocol bgp <name> {
+        ipv4 {
+          next hop self;
+        };
+      }
+  - keyword: next hop keep
+    path: protocol.bgp.channel
+    usage: |
+      protocol bgp <name> {
+        ipv4 {
+          next hop keep on;
+        };
+      }
+  - keyword: add paths
+    path: protocol.bgp.channel
+    usage: |
+      protocol bgp <name> {
+        ipv4 {
+          add paths tx;
+        };
+      }
+  - keyword: gateway
+    path: protocol.bgp.channel
+    usage: |
+      protocol bgp <name> {
+        ipv4 {
+          gateway recursive;
+        };
+      }
+  - keyword: extended next hop
+    path: protocol.bgp.channel
+    usage: |
+      protocol bgp <name> {
+        ipv4 {
+          extended next hop on;
+        };
+      }
+  - keyword: aigp
+    path: protocol.bgp.channel
+    usage: |
+      protocol bgp <name> {
+        ipv4 {
+          aigp on;
+        };
+      }