@takodotid/circuit 0.43.1 → 1.0.0-rc.2

package/templates/single-site/router.ts

@@ -1,86 +0,0 @@
-// The router: the internet connection, a gateway and DHCP for each VLAN, and the firewall.
-
-import { defineDevice, secret } from "@takodotid/circuit";
-import { MANAGEMENT, ROUTER, TIMEZONE, vlans } from "./site";
-
-export default defineDevice({
-    name: "router",
-    platform: "routeros",
-    model: "CCR2216-1G-12XS-2XQ",
-    connection: { host: ROUTER, user: "operator" },
-    users: { operator: { role: "admin", password: secret("ROUTER_PASSWORD") } },
-
-    system: {
-        timezone: TIMEZONE,
-        dns: { servers: ["1.1.1.1", "1.0.0.1"], serve: true },
-        ntp: { servers: ["pool.ntp.org"], serve: true },
-    },
-    management: { allow: [MANAGEMENT], ssh: {} },
-
-    vlans,
-
-    ports: {
-        "1g-1": { description: "Internet provider", addresses: ["203.0.113.2/30"] },
-        "25g-1": {
-            description: "Switch",
-            speed: "10g",
-            trunk_vlans: ["mgmt", "home", "guests"],
-            link: { device: "switch", port: "10g-1" },
-        },
-    },
-
-    // The gateway of each VLAN.
-    interfaces: {
-        mgmt: { type: "vlan", vlan: "mgmt", addresses: [`${ROUTER}/24`] },
-        home: { type: "vlan", vlan: "home", addresses: ["192.168.20.1/24"] },
-        guests: { type: "vlan", vlan: "guests", addresses: ["192.168.30.1/24"] },
-    },
-
-    routing: { static: [{ prefix: "0.0.0.0/0", via: "203.0.113.1", description: "Internet provider" }] },
-
-    dhcp: {
-        home: {
-            interface: "home",
-            network: "192.168.20.0/24",
-            gateway: "192.168.20.1",
-            dns: ["192.168.20.1"],
-            pool: ["192.168.20.100", "192.168.20.200"],
-        },
-        guests: {
-            interface: "guests",
-            network: "192.168.30.0/24",
-            gateway: "192.168.30.1",
-            dns: ["192.168.30.1"],
-            pool: ["192.168.30.100", "192.168.30.200"],
-            lease_time: 3600,
-        },
-    },
-
-    firewall: {
-        filter: {
-            // Traffic to the router itself.
-            input: {
-                default: "drop",
-                rules: [
-                    { description: "Replies", match: { state: ["established", "related"] }, action: "accept" },
-                    { description: "Ping", match: { protocol: "icmp" }, action: "accept" },
-                    { description: "Management", match: { src: MANAGEMENT }, action: "accept" },
-                    { description: "DNS from home", match: { in_interface: "home", protocol: "udp", dst_port: 53 }, action: "accept" },
-                    { description: "DNS from guests", match: { in_interface: "guests", protocol: "udp", dst_port: 53 }, action: "accept" },
-                ],
-            },
-            // Traffic passing through the router: home and guests reach the internet, and nothing else gets through.
-            forward: {
-                default: "drop",
-                rules: [
-                    { description: "Replies", match: { state: ["established", "related"] }, action: "accept", offload: true },
-                    { description: "Home to the internet", match: { in_interface: "home", out_interface: "1g-1" }, action: "accept" },
-                    { description: "Guests to the internet", match: { in_interface: "guests", out_interface: "1g-1" }, action: "accept" },
-                ],
-            },
-        },
-        nat: {
-            source: [{ description: "Share the public address", match: { out_interface: "1g-1" }, action: "masquerade" }],
-        },
-    },
-});

package/templates/single-site/site.ts

@@ -1,18 +0,0 @@
-// Values both devices share. Change them to your own.
-
-import type { Prefix, Vlan } from "@takodotid/circuit";
-
-/** The management network. Only addresses in it can log in to the devices. */
-export const MANAGEMENT = "192.168.10.0/24" satisfies Prefix;
-
-/** The router's address on the management network, the switch's gateway. */
-export const ROUTER = "192.168.10.1";
-
-export const TIMEZONE = "Asia/Jakarta";
-
-/** Every VLAN on the site. Each device lists the ones it carries. */
-export const vlans = {
-    mgmt: { id: 10, description: "Management" },
-    home: { id: 20, description: "Home" },
-    guests: { id: 30, description: "Guests" },
-} as const satisfies Record<string, Vlan>;

package/templates/single-site/switch.ts

@@ -1,34 +0,0 @@
-// The switch: a port for each device on the site, on the VLAN it belongs to.
-
-import { defineDevice, secret } from "@takodotid/circuit";
-import { MANAGEMENT, ROUTER, TIMEZONE, vlans } from "./site";
-
-export default defineDevice({
-    name: "switch",
-    platform: "vrp",
-    model: "CE6855-48S6Q-HI",
-    connection: { host: "192.168.10.2", user: "operator" },
-    users: { operator: { role: "admin", password: secret("SWITCH_PASSWORD") } },
-
-    system: { timezone: TIMEZONE, ntp: { servers: [ROUTER] } },
-    management: { allow: [MANAGEMENT], ssh: {} },
-
-    lldp: true,
-    stp: {},
-
-    vlans,
-
-    ports: {
-        "10g-1": {
-            description: "Router",
-            trunk_vlans: ["mgmt", "home", "guests"],
-            link: { device: "router", port: "25g-1" },
-        },
-        "10g-2": { description: "Desk", access_vlan: "home", stp: { edge: true } },
-        "10g-3": { description: "Living room", access_vlan: "home", stp: { edge: true } },
-        "10g-4": { description: "Guest access point", access_vlan: "guests", stp: { edge: true } },
-    },
-
-    interfaces: { mgmt: { type: "vlan", vlan: "mgmt", addresses: ["192.168.10.2/24"] } },
-    routing: { static: [{ prefix: "0.0.0.0/0", via: ROUTER }] },
-});