@takodotid/circuit 0.12.0 → 0.13.0

package/dist/presets/index.js

@@ -162,14 +162,14 @@ function communityScheme(scheme) {
   const information = [scheme.learned_from?.function, scheme.learned_at?.function, scheme.learned_from_as].filter((fn) => fn !== undefined);
   const tag = (neighborClass, neighborAs, options = {}) => {
     const { site } = options;
-    const mayAsk = scheme.requests_from?.includes(neighborClass) ?? false;
+    const isCustomer = scheme.customers?.includes(neighborClass) ?? false;
     if (scheme.learned_at && site === undefined)
       throw new Error(`communityScheme: tag for AS${neighborAs} needs a site, for learned_at`);
     return {
       description: `Learned from AS${neighborAs}`,
       set: {
         remove_communities: ours.standard,
-        remove_large_communities: mayAsk ? information.map((fn) => community(fn, "*")) : ours.large,
+        remove_large_communities: isCustomer ? information.map((fn) => community(fn, "*")) : ours.large,
         add_large_communities: [
           ...scheme.learned_from ? [community(scheme.learned_from.function, scheme.learned_from.classes[neighborClass])] : [],
           ...scheme.learned_at ? [community(scheme.learned_at.function, site)] : [],

package/dist/types/presets/index.d.ts

@@ -64,8 +64,8 @@ export type CommunityScheme<Class extends string = string> = {
         function: number;
         classes: Readonly<Record<Class, number>>;
     };
-    /** The kinds of neighbor allowed to ask you for something, usually your customers: the requests below that they set on their routes stay. From anyone else, they are removed on import. */
-    requests_from?: readonly NoInfer<Class>[];
+    /** Which of the classes above are your customers. Only a customer may ask you for something, such as not announcing its route somewhere; what anyone else asks is removed when the route comes in. */
+    customers?: readonly NoInfer<Class>[];
     /** Set on import: the site a route was learned at, `asn:function:site`. `sites` names the sites, for the catalogue. */
     learned_at?: {
         function: number;
@@ -87,7 +87,7 @@ export type CommunityScheme<Class extends string = string> = {
 /**
  * Policy rules and a catalogue from one community scheme, so the communities your routers set, the ones they act on, and the ones you publish never disagree.
  *
- * - `tag(neighborClass, neighborAs, { site })`: a rule for an import policy. It removes your communities a neighbor set, then adds where the route was learned. A neighbor of a class in `requests_from` keeps its requests. `site` is needed when the scheme has `learned_at`.
+ * - `tag(neighborClass, neighborAs, { site })`: a rule for an import policy. It removes your communities a neighbor set, then adds where the route was learned. A customer, a class in `customers`, keeps its requests. `site` is needed when the scheme has `learned_at`.
  * - `actions(neighborAs, { blackhole })`: rules for an export policy toward one neighbor. They act on a customer's action communities, then remove all of yours. Place them before the rules that accept. A blackholed route goes no further, unless `blackhole` names the neighbor's own blackhole community: then it is passed on with it, so the neighbor drops the traffic too.
  * - `blackhole(prefixSet)`: a rule for a customer's import policy, before anything that rejects long prefixes. It takes a route the customer asked to blackhole, but only inside `prefixSet`, its own space, and drops traffic to it here.
  * - `catalogue`: every community, for `communities` in `defineNetwork`.

package/package.json

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

package/src/presets/index.ts

@@ -226,8 +226,8 @@ export type CommunityScheme<Class extends string = string> = {
     asn: number;
     /** Set on import: the kind of neighbor a route came from, `asn:function:class`. */
     learned_from?: { function: number; classes: Readonly<Record<Class, number>> };
-    /** The kinds of neighbor allowed to ask you for something, usually your customers: the requests below that they set on their routes stay. From anyone else, they are removed on import. */
-    requests_from?: readonly NoInfer<Class>[];
+    /** Which of the classes above are your customers. Only a customer may ask you for something, such as not announcing its route somewhere; what anyone else asks is removed when the route comes in. */
+    customers?: readonly NoInfer<Class>[];
     /** Set on import: the site a route was learned at, `asn:function:site`. `sites` names the sites, for the catalogue. */
     learned_at?: { function: number; sites?: Readonly<Record<number, string>> };
     /** Set on import: the AS a route was learned from, `asn:function:asn`. */
@@ -251,7 +251,7 @@ const article = (word: string) => (/^[aeiou]/i.test(word) ? `an ${word}` : `a ${
 /**
  * Policy rules and a catalogue from one community scheme, so the communities your routers set, the ones they act on, and the ones you publish never disagree.
  *
- * - `tag(neighborClass, neighborAs, { site })`: a rule for an import policy. It removes your communities a neighbor set, then adds where the route was learned. A neighbor of a class in `requests_from` keeps its requests. `site` is needed when the scheme has `learned_at`.
+ * - `tag(neighborClass, neighborAs, { site })`: a rule for an import policy. It removes your communities a neighbor set, then adds where the route was learned. A customer, a class in `customers`, keeps its requests. `site` is needed when the scheme has `learned_at`.
  * - `actions(neighborAs, { blackhole })`: rules for an export policy toward one neighbor. They act on a customer's action communities, then remove all of yours. Place them before the rules that accept. A blackholed route goes no further, unless `blackhole` names the neighbor's own blackhole community: then it is passed on with it, so the neighbor drops the traffic too.
  * - `blackhole(prefixSet)`: a rule for a customer's import policy, before anything that rejects long prefixes. It takes a route the customer asked to blackhole, but only inside `prefixSet`, its own space, and drops traffic to it here.
  * - `catalogue`: every community, for `communities` in `defineNetwork`.
@@ -267,7 +267,7 @@ export function communityScheme<const Class extends string>(scheme: CommunitySch
 
     const tag = (neighborClass: Class, neighborAs: number, options: { site?: number } = {}): PolicyRule<never, never> => {
         const { site } = options;
-        const mayAsk = scheme.requests_from?.includes(neighborClass) ?? false;
+        const isCustomer = scheme.customers?.includes(neighborClass) ?? false;
         if (scheme.learned_at && site === undefined)
             throw new Error(`communityScheme: tag for AS${neighborAs} needs a site, for learned_at`);
 
@@ -275,7 +275,7 @@ export function communityScheme<const Class extends string>(scheme: CommunitySch
             description: `Learned from AS${neighborAs}`,
             set: {
                 remove_communities: ours.standard,
-                remove_large_communities: mayAsk ? information.map((fn) => community(fn, "*")) : ours.large,
+                remove_large_communities: isCustomer ? information.map((fn) => community(fn, "*")) : ours.large,
                 add_large_communities: [
                     ...(scheme.learned_from ? [community(scheme.learned_from.function, scheme.learned_from.classes[neighborClass])] : []),
                     ...(scheme.learned_at ? [community(scheme.learned_at.function, site!)] : []),

package/templates/colocation/edge-01.ts

@@ -1,4 +1,6 @@
 // The edge router: BGP with an IP transit and an internet exchange, the gateway of every tenant, and the filter between them.
+//
+// Hurricane Electric and SGIX stand for your own transit and exchange. Addresses are from the documentation ranges; use the ones your providers give you.
 
 import type { Prefix } from "@takodotid/circuit";
 import { defineDevice, merge, secret } from "@takodotid/circuit";
@@ -29,16 +31,16 @@ export default defineDevice({
     vlans: merge(
         {
             mgmt: { id: 99, description: "Management of the switches" },
-            transit: { id: 300, description: "IP transit from Example Transit, AS64501" },
-            ix: { id: 200, description: "Peering LAN of Example IX" },
+            transit: { id: 300, description: "IP transit from Hurricane Electric, AS6939" },
+            ix: { id: 200, description: "Peering LAN of SGIX" },
         },
         internetVlans(TENANTS)
     ),
 
     ports: {
         "1g-1": { description: "Management", addresses: ["10.0.0.1/24"] },
-        "25g-1": { description: "Example Transit", access_vlan: "transit", acl: "edge" },
-        "25g-2": { description: "Example IX", access_vlan: "ix", acl: "edge" },
+        "25g-1": { description: "Hurricane Electric", access_vlan: "transit", acl: "edge" },
+        "25g-2": { description: "SGIX", access_vlan: "ix", acl: "edge" },
         "100g-1": {
             description: "tor-01",
             speed: "40g",
@@ -64,25 +66,25 @@ export default defineDevice({
             asn: ASN,
             networks: [...OURS],
             neighbors: {
-                "example-transit": {
+                "hurricane-electric": {
                     address: "203.0.113.1",
-                    remote_as: 64501,
+                    remote_as: 6939,
                     role: "provider",
                     import: "TRANSIT-IN",
                     export: "OUT",
                     max_prefixes: 1_200_000,
                 },
-                "example-ix-rs-v4": {
+                "sgix-rs-v4": {
                     address: "192.0.2.1",
-                    remote_as: 64502,
+                    remote_as: 55518,
                     role: "rs",
                     import: "IX-IN",
                     export: "OUT",
                     max_prefixes: 100_000,
                 },
-                "example-ix-rs-v6": {
+                "sgix-rs-v6": {
                     address: "2001:db8:ffff::1",
-                    remote_as: 64502,
+                    remote_as: 55518,
                     role: "rs",
                     import: "IX-IN",
                     export: "OUT",
@@ -95,8 +97,8 @@ export default defineDevice({
     policies: {
         SANITY: bgpSanity(),
         // A route from the exchange is preferred over the same route from the transit: higher local preference wins.
-        "TRANSIT-IN": [{ call: "SANITY" }, communities.tag("transit", 64501), { set: { local_pref: 100 } }, { action: "accept" }],
-        "IX-IN": [{ call: "SANITY" }, communities.tag("exchange", 64502), { set: { local_pref: 200 } }, { action: "accept" }],
+        "TRANSIT-IN": [{ call: "SANITY" }, communities.tag("transit", 6939), { set: { local_pref: 100 } }, { action: "accept" }],
+        "IX-IN": [{ call: "SANITY" }, communities.tag("exchange", 55518), { set: { local_pref: 200 } }, { action: "accept" }],
         OUT: [
             ...OURS.map((prefix) => ({ description: `Announce ${prefix}`, match: { prefix }, action: "accept" as const })),
             { description: "Nothing else leaves", action: "reject" },

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

@@ -1,4 +1,6 @@
 // The edge router: BGP with an IP transit and an internet exchange, filtered on the way in and on the way out.
+//
+// Hurricane Electric and SGIX stand for your own transit and exchange. Addresses are from the documentation ranges; use the ones your providers give you.
 
 import type { Prefix } from "@takodotid/circuit";
 import { defineDevice, secret } from "@takodotid/circuit";
@@ -25,14 +27,14 @@ export default defineDevice({
     management: { allow: [MANAGEMENT], ssh: {} },
 
     vlans: {
-        transit: { id: 300, description: "IP transit from Example Transit, AS64501" },
-        ix: { id: 200, description: "Peering LAN of Example IX" },
+        transit: { id: 300, description: "IP transit from Hurricane Electric, AS6939" },
+        ix: { id: 200, description: "Peering LAN of SGIX" },
     },
 
     ports: {
         "1g-1": { description: "Management", addresses: ["10.0.0.1/24"] },
-        "25g-1": { description: "Example Transit", access_vlan: "transit", acl: "edge" },
-        "25g-2": { description: "Example IX", access_vlan: "ix", acl: "edge" },
+        "25g-1": { description: "Hurricane Electric", access_vlan: "transit", acl: "edge" },
+        "25g-2": { description: "SGIX", access_vlan: "ix", acl: "edge" },
     },
 
     interfaces: {
@@ -48,25 +50,25 @@ export default defineDevice({
             asn: ASN,
             networks: [...OURS],
             neighbors: {
-                "example-transit": {
+                "hurricane-electric": {
                     address: "203.0.113.1",
-                    remote_as: 64501,
+                    remote_as: 6939,
                     role: "provider",
                     import: "TRANSIT-IN",
                     export: "OUT",
                     max_prefixes: 1_200_000,
                 },
-                "example-ix-rs-v4": {
+                "sgix-rs-v4": {
                     address: "192.0.2.1",
-                    remote_as: 64502,
+                    remote_as: 55518,
                     role: "rs",
                     import: "IX-IN",
                     export: "OUT",
                     max_prefixes: 100_000,
                 },
-                "example-ix-rs-v6": {
+                "sgix-rs-v6": {
                     address: "2001:db8:ffff::1",
-                    remote_as: 64502,
+                    remote_as: 55518,
                     role: "rs",
                     import: "IX-IN",
                     export: "OUT",
@@ -79,8 +81,8 @@ export default defineDevice({
     policies: {
         SANITY: bgpSanity(),
         // A route from the exchange is preferred over the same route from the transit: higher local preference wins.
-        "TRANSIT-IN": [{ call: "SANITY" }, communities.tag("transit", 64501), { set: { local_pref: 100 } }, { action: "accept" }],
-        "IX-IN": [{ call: "SANITY" }, communities.tag("exchange", 64502), { set: { local_pref: 200 } }, { action: "accept" }],
+        "TRANSIT-IN": [{ call: "SANITY" }, communities.tag("transit", 6939), { set: { local_pref: 100 } }, { action: "accept" }],
+        "IX-IN": [{ call: "SANITY" }, communities.tag("exchange", 55518), { set: { local_pref: 200 } }, { action: "accept" }],
         OUT: [
             ...OURS.map((prefix) => ({ description: `Announce ${prefix}`, match: { prefix }, action: "accept" as const })),
             { description: "Nothing else leaves", action: "reject" },