@takodotid/circuit 0.25.0 → 0.26.1

package/src/adapters/devices/vrp/TRAPS.md

@@ -14,10 +14,10 @@ Behaviour that looks like something else. Each one has been hit on a CE6855 runn
 - LLDP is off by default. A port setting for LLDP is refused until it is on globally.
 - A trunk forwards its native VLAN's untagged frames only when that VLAN is also allowed; the adapter adds it.
 - The name `admin` is refused for a local user.
-- A port joins an Eth-Trunk only while it holds no other setting, including a description.
+- A port joins an Eth-Trunk only while it has no other setting, including a description.
 - An empty block such as `bfd` enters its view; the next line sent goes into it unless the view is left.
 - SNMPv3 passwords are asked for interactively, twice. `authentication-mode` must come before `privacy-mode`.
 - `abort` is not a command here. `clear configuration candidate` discards uncommitted changes.
-- sFlow samples per port, `sflow sampling rate N`, N from 4096; the default is 8192 and an explicit 8192 is kept as written. A port names a collector only once the collector exists globally; until then it is refused with "collector does not exist".
-- `vlan batch` holds every VLAN on one line, and undoing a list that names a VLAN with an L3 interface is refused. A change sends only the VLANs added and `undo vlan batch` for the ones removed.
-- A VLAN name is unique across VLANs: a new VLAN cannot take a name another still holds. VLANs no longer used, and their VLAN interfaces, are removed first, in the same candidate.
+- sFlow samples per port, `sflow sampling rate N`, N from 4096; the default is 8192 and an explicit 8192 is kept as written. A port can point to a collector only once the collector exists globally; until then it is refused with "collector does not exist".
+- `vlan batch` has every VLAN on one line, and undoing a list that includes a VLAN with an L3 interface is refused. A change sends only the VLANs added and `undo vlan batch` for the ones removed.
+- A VLAN name is unique across VLANs: a new VLAN cannot take a name another still has. VLANs no longer used, and their VLAN interfaces, are removed first, in the same candidate.

package/src/schema/common.ts

@@ -9,7 +9,7 @@ export type Secret =
           readonly secret: string;
       }
     | {
-          /** Path of a file holding the value, relative to the config file. */
+          /** Path of the file with the value, relative to the config file. */
           readonly secret_file: string;
       };
 

package/src/schema/device.ts

@@ -43,7 +43,7 @@ export type Device<
 > = {
     /** Hostname. */
     name: string;
-    /** Operating system, which decides the adapter that renders and applies the device. */
+    /** Operating system. It decides which adapter renders and applies the device. */
     platform: Pl;
     /** Hardware model. Decides which port names exist. */
     model: M;

package/src/schema/firewall.ts

@@ -15,7 +15,7 @@ export type Ports = number | PortRange | readonly (number | PortRange)[];
 /** A TCP header flag. */
 export type TcpFlag = "fin" | "syn" | "rst" | "psh" | "ack" | "urg";
 
-/** Conditions on a packet. All must hold. A rule with addresses of one family applies to that family only. */
+/** Conditions on a packet. All must be true. A rule with addresses of one family applies to that family only. */
 export type FilterMatch<I extends string, AS extends string> = {
     /** Only packets of this family. */
     family?: Family;
@@ -51,7 +51,7 @@ export type FilterRule<I extends string, AS extends string> = {
     match?: FilterMatch<I, AS>;
     /** What happens to a matching packet. `reject` answers the sender, `drop` does not. */
     action: "accept" | "drop" | "reject";
-    /** Hand the rest of an accepted flow to the fast path, past the remaining rules. */
+    /** Send the rest of an accepted flow through the fast path, skipping the remaining rules. */
     offload?: true;
 };
 
@@ -126,7 +126,7 @@ export type AclRule<V extends string> = {
         src_port?: Ports;
         /** Destination port, or any of several. */
         dst_port?: Ports;
-        /** Carried in this VLAN. */
+        /** In this VLAN. */
         vlan?: V;
     };
     /** What happens to a matching packet. */

package/src/schema/interfaces.ts

@@ -1,8 +1,8 @@
 import type { Address, IP, Prefix, Secret } from "./common";
 
-/** A VLAN. The key it is declared under is its name. */
+/** A VLAN. Its key in `vlans` is its name. */
 export type Vlan = {
-    /** The number carried on the wire, 1 to 4094. */
+    /** The VLAN's number on the wire, 1 to 4094. */
     id: number;
     /** What the VLAN is for. */
     description?: string;
@@ -25,7 +25,7 @@ export type Vrrp = {
     interval?: number;
 };
 
-/** Layer 3 settings shared by every interface that can hold an address. */
+/** Layer 3 settings shared by every interface that can have an address. */
 export type Routed<F extends string> = {
     /** Addresses with their length. Use `{ address, peer }` for a point-to-point address whose far end is outside its own prefix. */
     addresses?: readonly (Address | { address: Address; peer: IP })[];
@@ -33,7 +33,7 @@ export type Routed<F extends string> = {
     ipv6_ra?: boolean;
     /** Overrides the device's `hardware_offload` for traffic routed through this interface. Software forwarding is what makes the firewall apply. */
     hardware_offload?: boolean;
-    /** Virtual router addresses held on this interface. */
+    /** Virtual router addresses on this interface. */
     vrrp?: readonly Vrrp[];
     /** The VRF this interface routes in. The default table when absent. */
     vrf?: F;
@@ -63,11 +63,11 @@ export type PortStp = {
 
 /** Layer 2 membership. A port or LAG with none of these is routed. */
 export type Switched<V extends string> = {
-    /** Untagged member of one VLAN. */
+    /** The one VLAN this port or LAG is in, untagged. */
     access_vlan?: V;
-    /** Tagged member of these VLANs. */
+    /** The VLANs this port or LAG carries, tagged. */
     trunk_vlans?: readonly V[];
-    /** Untagged frames on a trunk belong to this VLAN. Only with `trunk_vlans`. */
+    /** Untagged frames on a trunk are in this VLAN. Only with `trunk_vlans`. */
     native_vlan?: V;
     /** Overrides the device's `stp` for this port. `false` stops it sending or acting on BPDUs. */
     stp?: boolean | PortStp;
@@ -100,7 +100,7 @@ export type Port<V extends string, A extends string, L extends string, F extends
         lldp?: boolean;
         /** Hardware ACL applied to traffic arriving on this port. */
         acl?: A;
-        /** Member of this LAG. The LAG holds every other setting. */
+        /** The LAG this port is in. Every other setting goes on the LAG. */
         lag?: L;
         /** Another of our devices at the other end of the cable. */
         link?: Link;
@@ -117,20 +117,20 @@ type Base<F extends string> = Routed<F> & {
 /** A layer 3 interface on a VLAN. */
 export type VlanInterface<V extends string, F extends string> = Base<F> & {
     type: "vlan";
-    /** The VLAN it sits on. */
+    /** The VLAN it is on. */
     vlan: V;
 };
 
-/** An interface that is always up and belongs to no link, for addresses that must not depend on one. */
+/** An interface that is always up and is on no link, for addresses that must not depend on one. */
 export type Loopback<F extends string> = Base<F> & { type: "loopback" };
 
-/** A link aggregation. Member ports name it with `lag`. */
+/** A link aggregation. Each member port points to it with `lag`. */
 export type Lag<V extends string, F extends string> = Base<F> &
     Switched<V> & {
         type: "lag";
-        /** LACP negotiates membership with the far end; static bundles without asking. LACP when absent. */
+        /** LACP negotiates membership with the far end; `static` joins the ports without asking. LACP when absent. */
         mode?: "lacp" | "static";
-        /** Number on platforms that name a LAG by number. Its position among the device's LAGs when absent. */
+        /** Number, on platforms where a LAG has a number instead of a name. Its position among the device's LAGs when absent. */
         id?: number;
     };
 

package/src/schema/policy.ts

@@ -20,7 +20,7 @@ export type PrefixSet =
           };
       };
 
-/** Conditions on a route. All must hold. An empty match holds for every route. */
+/** Conditions on a route. All must be true. An empty match is true for every route. */
 export type Match<S extends string> = {
     /** Only routes of this family. */
     family?: Family;
@@ -34,9 +34,9 @@ export type Match<S extends string> = {
     as_path_length?: { min?: number; max?: number };
     /** The route's origin validation state. */
     rpki?: "valid" | "invalid" | "not-found";
-    /** Carries this standard community, `asn:value`. */
+    /** Has this standard community, `asn:value`. */
     community?: string;
-    /** Carries this large community, `asn:function:parameter`. */
+    /** Has this large community, `asn:function:parameter`. */
     large_community?: string;
 };
 

package/src/schema/routing.ts

@@ -1,6 +1,6 @@
 import type { Family, IP, Prefix, Secret } from "./common";
 
-/** A route the device carries without learning it. */
+/** A route the device has without learning it. */
 export type StaticRoute<I extends string, F extends string> = {
     /** Destination. */
     prefix: Prefix;
@@ -12,7 +12,7 @@ export type StaticRoute<I extends string, F extends string> = {
     blackhole?: true;
     /** Preference against other routes to the same prefix. Lower wins. 1 when absent. */
     distance?: number;
-    /** The VRF the route belongs to. The default table when absent. */
+    /** The VRF the route is in. The default table when absent. */
     vrf?: F;
     /** Why the route exists. */
     description?: string;
@@ -23,7 +23,7 @@ export type StaticRoute<I extends string, F extends string> = {
  */
 export type BgpRole = "provider" | "customer" | "peer" | "rs" | "rs-client";
 
-/** Settings a BGP neighbor can state itself or take from its group. */
+/** Settings a BGP neighbor can set itself or take from its group. */
 export type NeighborSettings<P extends string> = {
     /** The neighbor's AS. Our own AS makes the session internal. */
     remote_as?: number;
@@ -35,7 +35,7 @@ export type NeighborSettings<P extends string> = {
     import?: P;
     /** Policy for routes announced. Nothing is announced when absent. */
     export?: P;
-    /** What the neighbor is to us, such as `provider` for a transit. Both sides then reject a route leak, after RFC 9234. */
+    /** What the neighbor is to us, such as `provider` for a transit. Both sides then reject a route leak, as RFC 9234 describes. */
     role?: BgpRole;
     /** The neighbor is more than one hop away. */
     multihop?: boolean;
@@ -55,11 +55,11 @@ export type NeighborSettings<P extends string> = {
     bfd?: boolean;
 };
 
-/** One BGP session. Settings it does not state come from its group. */
+/** One BGP session. Settings it does not set come from its group. */
 export type Neighbor<P extends string, G extends string> = NeighborSettings<P> & {
     /** The neighbor's address. */
     address: IP;
-    /** Group whose settings this neighbor takes where it states none. */
+    /** The group this neighbor takes a setting from when it does not set that setting itself. */
     group?: NoInfer<G>;
 };
 
@@ -111,7 +111,7 @@ export type Ospf<I extends string> = {
 export type Routing<P extends string, G extends string, I extends string, F extends string> = {
     /** Identifies this router to its neighbors. */
     router_id?: IP;
-    /** Routes the device carries without learning them. */
+    /** Routes the device has without learning them. */
     static?: readonly StaticRoute<I, F>[];
     /** BGP sessions and what they exchange. */
     bgp?: Bgp<P, G>;

package/src/schema/system.ts

@@ -13,7 +13,7 @@ export type System = {
         /** Answer queries from others. Off when absent. */
         serve?: boolean;
     };
-    /** Time the device keeps. */
+    /** How the device keeps time. */
     ntp?: {
         /** Time sources, by address or name. */
         servers: readonly string[];
@@ -87,7 +87,7 @@ export type SnmpUser = {
 
 /** How the device is reached and managed. */
 export type Management<I extends string, C extends string> = {
-    /** Sources allowed to every service that does not state its own. */
+    /** Sources allowed to every service that does not set its own. */
     allow?: readonly Prefix[];
     /** Secure shell. */
     ssh?: Service & {
@@ -141,11 +141,11 @@ export type DhcpServer<I extends string> = {
     interface: I;
     /** The network it serves. */
     network: Prefix;
-    /** Default gateway handed out. */
+    /** Default gateway given to clients. */
     gateway: IP;
-    /** Resolvers handed out. */
+    /** Resolvers given to clients. */
     dns?: readonly IP[];
-    /** First and last address handed out. */
+    /** First and last address given to clients. */
     pool: readonly [IP, IP];
     /** Seconds a lease lasts. */
     lease_time?: number;
@@ -168,9 +168,9 @@ export type DhcpRelay<I extends string> = {
 
 /** A certificate the device presents or trusts. */
 export type Certificate = {
-    /** The certificate, PEM. Public, so it lives in the repository. */
+    /** The certificate, PEM. Public, so it is kept in the repository. */
     certificate: string;
-    /** Its private key: a PEM file through `secretFile`, or PEM base64-encoded as one line through `secret`. A certificate only trusted, such as a CA, has none. */
+    /** Its private key: a PEM file through `secretFile`, or PEM base64-encoded as one line through `secret`. A certificate the device only trusts, such as a CA, has none. */
     private_key?: Secret;
 };