@takodotid/circuit 0.7.0 → 0.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@takodotid/circuit",
-    "version": "0.7.0",
+    "version": "0.8.0",
     "description": "Declarative, vendor-neutral network configuration: describe each device in TypeScript, and Circuit makes the device match. Alpha.",
     "keywords": [
         "network",

package/src/adapters/devices/routeros/render.ts

@@ -874,12 +874,13 @@ export const RPKI_GROUP = "rpki";
 /** The chain a session without a policy uses, so that it learns or announces nothing. */
 export const REJECT_ALL = "REJECT-ALL";
 
+// RouterOS takes our own role. The config states the neighbor's, so each becomes its opposite: a neighbor that is our provider makes us its customer.
 const ROLES = {
-    provider: "ebgp-provider",
-    customer: "ebgp-customer",
+    provider: "ebgp-customer",
+    customer: "ebgp-provider",
     peer: "ebgp-peer",
-    rs: "ebgp-rs",
-    "rs-client": "ebgp-rs-client",
+    rs: "ebgp-rs-client",
+    "rs-client": "ebgp-rs",
 } as const;
 
 type AnyRule = PolicyRule<string, string>;
@@ -1097,7 +1098,7 @@ function bgpConnections(out: Output, ctx: Context): void {
         const addressFamily = familyOf(neighbor.address);
         const internal = settings.remote_as === bgp.asn;
         const originates = bgp.networks?.some((prefix) => familyOf(host(prefix)) === family);
-        const role = settings.local_role ? ROLES[settings.local_role] : internal ? "ibgp" : "ebgp";
+        const role = settings.role ? ROLES[settings.role] : internal ? "ibgp" : "ebgp";
 
         out.add(
             "/routing bgp connection",

package/src/adapters/registries/peeringdb.ts

@@ -56,8 +56,8 @@ function peersWithRouteServer(device: Device, iface: AnyInterface): boolean {
 
     return Object.values(bgp?.neighbors ?? {}).some((neighbor) => {
         const group = neighbor.group ? bgp?.groups?.[neighbor.group] : undefined;
-        const role = neighbor.local_role ?? group?.local_role;
-        return role === "rs-client" && subnets.some((subnet) => contains(subnet, neighbor.address));
+        const role = neighbor.role ?? group?.role;
+        return role === "rs" && subnets.some((subnet) => contains(subnet, neighbor.address));
     });
 }
 

package/src/schema/routing.ts

@@ -18,7 +18,9 @@ export type StaticRoute<I extends string, F extends string> = {
     description?: string;
 };
 
-/** Our side of the relationship, as RFC 9234 defines it. */
+/**
+ * What a BGP neighbor is to us, with the roles RFC 9234 defines: `provider`, a transit we buy from; `customer`, one we sell transit to; `peer`, one we exchange our own routes with; `rs`, an exchange's route server; `rs-client`, a network using our route server.
+ */
 export type BgpRole = "provider" | "customer" | "peer" | "rs" | "rs-client";
 
 /** Settings a BGP neighbor can state itself or take from its group. */
@@ -33,8 +35,8 @@ export type NeighborSettings<P extends string> = {
     import?: P;
     /** Policy for routes announced. Nothing is announced when absent. */
     export?: P;
-    /** Our role toward this neighbor, which lets both sides reject a leak. */
-    local_role?: BgpRole;
+    /** What the neighbor is to us, such as `provider` for a transit. Both sides then reject a route leak, after RFC 9234. */
+    role?: BgpRole;
     /** The neighbor is more than one hop away. */
     multihop?: boolean;
     /** TCP MD5 password shared with the neighbor. */

package/templates/colocation/edge-01.ts

@@ -67,7 +67,7 @@ export default defineDevice({
                 "example-transit": {
                     address: "203.0.113.1",
                     remote_as: 64501,
-                    local_role: "customer",
+                    role: "provider",
                     import: "TRANSIT-IN",
                     export: "OUT",
                     max_prefixes: 1_200_000,
@@ -75,7 +75,7 @@ export default defineDevice({
                 "example-ix-rs-v4": {
                     address: "192.0.2.1",
                     remote_as: 64502,
-                    local_role: "rs-client",
+                    role: "rs",
                     import: "IX-IN",
                     export: "OUT",
                     max_prefixes: 100_000,
@@ -83,7 +83,7 @@ export default defineDevice({
                 "example-ix-rs-v6": {
                     address: "2001:db8:ffff::1",
                     remote_as: 64502,
-                    local_role: "rs-client",
+                    role: "rs",
                     import: "IX-IN",
                     export: "OUT",
                     max_prefixes: 50_000,

package/templates/edge-router/edge-01.ts

@@ -51,7 +51,7 @@ export default defineDevice({
                 "example-transit": {
                     address: "203.0.113.1",
                     remote_as: 64501,
-                    local_role: "customer",
+                    role: "provider",
                     import: "TRANSIT-IN",
                     export: "OUT",
                     max_prefixes: 1_200_000,
@@ -59,7 +59,7 @@ export default defineDevice({
                 "example-ix-rs-v4": {
                     address: "192.0.2.1",
                     remote_as: 64502,
-                    local_role: "rs-client",
+                    role: "rs",
                     import: "IX-IN",
                     export: "OUT",
                     max_prefixes: 100_000,
@@ -67,7 +67,7 @@ export default defineDevice({
                 "example-ix-rs-v6": {
                     address: "2001:db8:ffff::1",
                     remote_as: 64502,
-                    local_role: "rs-client",
+                    role: "rs",
                     import: "IX-IN",
                     export: "OUT",
                     max_prefixes: 50_000,