@fnndsc/stratus 0.1.0 → 0.2.0

package/dist/domain/spec.js

@@ -0,0 +1,191 @@
+/**
+ * @file A domain's spec: the cluster and the ChRIS on it, in neutral units
+ * (vCPU and GiB), as `harbor-oci`'s `spec.yaml` holds them (docs/stratus.adoc,
+ * "Three layers, three tools, one spec").
+ *
+ * The file keeps `harbor-oci`'s shape, so a spec moves between the two: a
+ * family, then `controlPlane`, `workers` and `chris` sections of `key: value`
+ * lines. It is read and written here without a YAML library, because only
+ * that shape is ever read; anything else refuses by line.
+ *
+ * @module
+ */
+/** The spec a new domain starts from: `harbor-oci`'s compact cluster. */
+export const SPEC_DEFAULT = {
+    family: 'E5',
+    controlPlane: { count: 3, vcpu: 8, ramGib: 24, bootGib: 200, bootTier: 'ultra' },
+    workers: { count: 0, vcpu: 8, ramGib: 32, bootGib: 120, bootTier: 'balanced' },
+    chris: { dataGib: 20, databaseGib: 5, queueGib: 1 },
+};
+/** The sections a spec holds, and the numbers each takes. */
+const SECTIONS = {
+    controlPlane: ['count', 'vcpu', 'ramGib', 'bootGib', 'bootTier'],
+    workers: ['count', 'vcpu', 'ramGib', 'bootGib', 'bootTier'],
+    chris: ['dataGib', 'databaseGib', 'queueGib'],
+};
+/**
+ * A copy of a spec, nothing shared.
+ *
+ * @param spec - The spec.
+ * @returns The copy.
+ */
+export function spec_copy(spec) {
+    return { family: spec.family, controlPlane: { ...spec.controlPlane }, workers: { ...spec.workers }, chris: { ...spec.chris } };
+}
+/**
+ * Sets one field of a section, by name: the names were checked against
+ * {@link SECTIONS} by the caller.
+ *
+ * @param spec - The spec.
+ * @param section - `controlPlane`, `workers` or `chris`.
+ * @param key - The field.
+ * @param value - Its value.
+ */
+function specField_set(spec, section, key, value) {
+    if (section === 'chris') {
+        const chris = spec.chris;
+        if (key === 'dataGib' || key === 'databaseGib' || key === 'queueGib')
+            chris[key] = Number(value);
+        return;
+    }
+    const pool = section === 'workers' ? spec.workers : spec.controlPlane;
+    if (key === 'bootTier')
+        pool.bootTier = String(value);
+    else if (key === 'count' || key === 'vcpu' || key === 'ramGib' || key === 'bootGib')
+        pool[key] = Number(value);
+}
+/**
+ * Writes a spec as `spec.yaml`.
+ *
+ * @param spec - The spec.
+ * @returns The file's text.
+ */
+export function specYaml_render(spec) {
+    const pool = (name, p, note) => [
+        `${name}:`,
+        `  count: ${p.count}${note}`,
+        `  vcpu: ${p.vcpu}`,
+        `  ramGib: ${p.ramGib}`,
+        `  bootGib: ${p.bootGib}`,
+        `  bootTier: ${p.bootTier}`,
+        '',
+    ];
+    return [
+        '# A Trusted Domain\'s spec: the cluster and the ChRIS on it, in vCPU and GiB.',
+        '# Written by `domain new`; harbor-oci reads the same shape.',
+        '',
+        `family: ${spec.family}`,
+        '',
+        ...pool('controlPlane', spec.controlPlane, spec.controlPlane.count === 3 ? '                # one per availability domain' : ''),
+        ...pool('workers', spec.workers, spec.workers.count === 0 ? '                # 0: compact cluster, schedulable control plane' : ''),
+        'chris:',
+        `  dataGib: ${spec.chris.dataGib}                # grows, never shrinks`,
+        `  databaseGib: ${spec.chris.databaseGib}             # fixed after the first deploy`,
+        `  queueGib: ${spec.chris.queueGib}                # fixed after the first deploy`,
+        '',
+    ].join('\n');
+}
+/**
+ * Reads `spec.yaml`.
+ *
+ * @param text - The file's text.
+ * @returns The spec, or the line it could not read.
+ */
+export function specYaml_parse(text) {
+    const spec = spec_copy(SPEC_DEFAULT);
+    let section = null;
+    const lines = text.split('\n');
+    for (let index = 0; index < lines.length; index++) {
+        const line = (lines[index] ?? '').replace(/\s+#.*$/, '').replace(/^#.*$/, '');
+        if (line.trim() === '')
+            continue;
+        const match = /^(\s*)([A-Za-z]+):\s*(\S*)\s*$/.exec(line);
+        if (match === null)
+            return { error: `line ${index + 1}: not a key: value line` };
+        const indent = match[1] ?? '';
+        const key = match[2] ?? '';
+        const value = match[3] ?? '';
+        if (indent === '') {
+            if (key === 'family' && value !== '') {
+                spec.family = value;
+                section = null;
+                continue;
+            }
+            if (SECTIONS[key] !== undefined && value === '') {
+                section = key;
+                continue;
+            }
+            return { error: `line ${index + 1}: ${key}: not a spec field` };
+        }
+        if (section === null || !(SECTIONS[section] ?? []).includes(key))
+            return { error: `line ${index + 1}: ${key}: not a field of ${section ?? 'the spec'}` };
+        const number = Number(value);
+        if (key !== 'bootTier' && (!Number.isInteger(number) || number < 0))
+            return { error: `line ${index + 1}: ${key}: wants a whole number, not '${value}'` };
+        specField_set(spec, section, key, key === 'bootTier' ? value : number);
+    }
+    return { spec };
+}
+/**
+ * Reads a pool written as `<count>x<vcpu>/<GiB>` (`3x8/24`).
+ *
+ * @param text - The words.
+ * @returns The count, vCPU and GiB, or null.
+ */
+export function poolArg_parse(text) {
+    const match = /^(\d+)x(\d+)\/(\d+)$/.exec(text.trim());
+    if (match === null)
+        return null;
+    return { count: Number(match[1]), vcpu: Number(match[2]), ramGib: Number(match[3]) };
+}
+/**
+ * Applies `domain new`'s sizing options to a spec.
+ *
+ * @param base - The spec to start from.
+ * @param options - `--family`, `--plane`, `--workers`, `--data`, `--database`, `--queue`, by name.
+ * @returns The spec, or what could not be read.
+ */
+export function specOptions_apply(base, options) {
+    const spec = spec_copy(base);
+    for (const [name, value] of options) {
+        if (name === '--family') {
+            spec.family = value;
+            continue;
+        }
+        if (name === '--plane' || name === '--workers') {
+            const pool = poolArg_parse(value);
+            if (pool === null)
+                return { error: `${name} takes <count>x<vCPU>/<GiB>, as 3x8/24, not '${value}'` };
+            if (name === '--plane' && pool.count !== 3)
+                return { error: '--plane: the control plane is three nodes, one per availability domain' };
+            Object.assign(name === '--plane' ? spec.controlPlane : spec.workers, pool);
+            continue;
+        }
+        const field = { '--data': 'dataGib', '--database': 'databaseGib', '--queue': 'queueGib' }[name];
+        if (field === undefined)
+            return { error: `${name}: unknown option` };
+        const number = Number(value);
+        if (!Number.isInteger(number) || number <= 0)
+            return { error: `${name} wants a whole number of GiB, not '${value}'` };
+        spec.chris[field] = number;
+    }
+    return { spec };
+}
+/**
+ * The nodes a spec asks for, placed one per zone in turn.
+ *
+ * @param domain - The domain's name, for the nodes' names.
+ * @param spec - The spec.
+ * @param zones - How many zones the region has.
+ * @returns The nodes.
+ */
+export function specNodes_of(domain, spec, zones) {
+    const nodes = [];
+    const count = Math.max(zones, 1);
+    for (let i = 0; i < spec.controlPlane.count; i++)
+        nodes.push({ name: `${domain}-cp-${i}`, role: 'plane', vcpu: spec.controlPlane.vcpu, ramGib: spec.controlPlane.ramGib, zoneIndex: i % count });
+    for (let i = 0; i < spec.workers.count; i++)
+        nodes.push({ name: `${domain}-w-${i}`, role: 'worker', vcpu: spec.workers.vcpu, ramGib: spec.workers.ramGib, zoneIndex: i % count });
+    return nodes;
+}
+//# sourceMappingURL=spec.js.map

package/dist/domain/spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec.js","sourceRoot":"","sources":["../../src/domain/spec.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AA0BH,yEAAyE;AACzE,MAAM,CAAC,MAAM,YAAY,GAAe;IACtC,MAAM,EAAE,IAAI;IACZ,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE;IAChF,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE;IAC9E,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE;CACpD,CAAC;AAEF,6DAA6D;AAC7D,MAAM,QAAQ,GAAoD;IAChE,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC;IAChE,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC;IAC3D,KAAK,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,UAAU,CAAC;CAC9C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,IAAgB;IACxC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;AACjI,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,aAAa,CAAC,IAAgB,EAAE,OAAe,EAAE,GAAW,EAAE,KAAsB;IAC3F,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;QACxB,MAAM,KAAK,GAAgB,IAAI,CAAC,KAAK,CAAC;QACtC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,aAAa,IAAI,GAAG,KAAK,UAAU;YAAE,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACjG,OAAO;IACT,CAAC;IACD,MAAM,IAAI,GAAa,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;IAChF,IAAI,GAAG,KAAK,UAAU;QAAE,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;SACjD,IAAI,GAAG,KAAK,OAAO,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,SAAS;QAAE,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AACjH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,IAAgB;IAC9C,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,CAAW,EAAE,IAAY,EAAY,EAAE,CAAC;QAClE,GAAG,IAAI,GAAG;QACV,YAAY,CAAC,CAAC,KAAK,GAAG,IAAI,EAAE;QAC5B,WAAW,CAAC,CAAC,IAAI,EAAE;QACnB,aAAa,CAAC,CAAC,MAAM,EAAE;QACvB,cAAc,CAAC,CAAC,OAAO,EAAE;QACzB,eAAe,CAAC,CAAC,QAAQ,EAAE;QAC3B,EAAE;KACH,CAAC;IACF,OAAO;QACL,+EAA+E;QAC/E,6DAA6D;QAC7D,EAAE;QACF,WAAW,IAAI,CAAC,MAAM,EAAE;QACxB,EAAE;QACF,GAAG,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,+CAA+C,CAAC,CAAC,CAAC,EAAE,CAAC;QAChI,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,iEAAiE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnI,QAAQ;QACR,cAAc,IAAI,CAAC,KAAK,CAAC,OAAO,wCAAwC;QACxE,kBAAkB,IAAI,CAAC,KAAK,CAAC,WAAW,6CAA6C;QACrF,eAAe,IAAI,CAAC,KAAK,CAAC,QAAQ,gDAAgD;QAClF,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,MAAM,IAAI,GAAe,SAAS,CAAC,YAAY,CAAC,CAAC;IACjD,IAAI,OAAO,GAAkB,IAAI,CAAC;IAClC,MAAM,KAAK,GAAa,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,KAAK,IAAI,KAAK,GAAW,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACtF,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,SAAS;QACjC,MAAM,KAAK,GAA4B,gCAAgC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnF,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,KAAK,GAAG,CAAC,yBAAyB,EAAE,CAAC;QACjF,MAAM,MAAM,GAAW,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACtC,MAAM,GAAG,GAAW,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACnC,MAAM,KAAK,GAAW,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;YAClB,IAAI,GAAG,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;gBAAC,OAAO,GAAG,IAAI,CAAC;gBAAC,SAAS;YAAC,CAAC;YACxF,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBAAC,OAAO,GAAG,GAAG,CAAC;gBAAC,SAAS;YAAC,CAAC;YAC7E,OAAO,EAAE,KAAK,EAAE,QAAQ,KAAK,GAAG,CAAC,KAAK,GAAG,oBAAoB,EAAE,CAAC;QAClE,CAAC;QACD,IAAI,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,KAAK,GAAG,CAAC,KAAK,GAAG,oBAAoB,OAAO,IAAI,UAAU,EAAE,EAAE,CAAC;QACzJ,MAAM,MAAM,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,GAAG,KAAK,UAAU,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,CAAC;YAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,KAAK,GAAG,CAAC,KAAK,GAAG,gCAAgC,KAAK,GAAG,EAAE,CAAC;QACzJ,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,MAAM,KAAK,GAA4B,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAChF,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACvF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAgB,EAAE,OAAoC;IACtF,MAAM,IAAI,GAAe,SAAS,CAAC,IAAI,CAAC,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;QACpC,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YAAC,SAAS;QAAC,CAAC;QAC3D,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;YAC/C,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,IAAI,KAAK,IAAI;gBAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,gDAAgD,KAAK,GAAG,EAAE,CAAC;YACrG,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;gBAAE,OAAO,EAAE,KAAK,EAAE,wEAAwE,EAAE,CAAC;YACvI,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC3E,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAmC,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,UAAU,EAAY,CAAC,IAA2C,CAAC,CAAC;QACjL,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACrE,MAAM,MAAM,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC;YAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,sCAAsC,KAAK,GAAG,EAAE,CAAC;QACtH,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;IAC7B,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,CAAC;AAClB,CAAC;AAYD;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,MAAc,EAAE,IAAgB,EAAE,KAAa;IAC1E,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,MAAM,KAAK,GAAW,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;IACzM,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;IAC1L,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/domain/spend.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @file What a domain costs: each live resource in its compartment priced at
+ * list price, an hour, and what that has come to since each was made
+ * (docs/stratus.adoc, D7). `harbor-oci`'s `burn`, read through the driver.
+ *
+ * Machines bill by vCPU and memory while running; volumes by size and
+ * performance whatever the machine does; load balancers by the hour and their
+ * minimum bandwidth. Buckets, networks and DNS zones are free at this scale.
+ * The figures are estimates at list price, not the bill: discounts, free
+ * tiers and traffic are not in them, and the lines say so.
+ *
+ * @module
+ */
+import type { CloudDriver, CloudInstance, CloudLoadBalancer, CloudPrice, CloudVolume, ServicePrices } from '../cloud/driver.js';
+/** The hours a month is billed as, as `harbor-oci` reckons. */
+export declare const HOURS_PER_MONTH: number;
+/** One priced resource. */
+export interface SpendItem {
+    readonly kind: 'compute' | 'volumes' | 'load balancers';
+    readonly name: string;
+    readonly detail: string;
+    /** Per hour, or null when it could not be priced. */
+    readonly hourly: number | null;
+    /** Since it was made, or null when unpriced or its making is not known. */
+    readonly soFar: number | null;
+}
+/** A compartment's spend. */
+export interface Spend {
+    readonly items: ReadonlyArray<SpendItem>;
+    readonly hourly: number;
+    readonly soFar: number;
+    readonly currency: string;
+    /** How many items could not be priced. */
+    readonly unpriced: number;
+}
+/**
+ * A machine's hour.
+ *
+ * @param instance - The machine.
+ * @param prices - The shapes' prices.
+ * @returns Its price an hour, or null.
+ */
+export declare function instance_hourly(instance: CloudInstance, prices: ReadonlyArray<CloudPrice>): number | null;
+/**
+ * A volume's hour.
+ *
+ * @param volume - The volume.
+ * @param prices - Storage prices.
+ * @returns Its price an hour.
+ */
+export declare function volume_hourly(volume: CloudVolume, prices: ServicePrices): number;
+/**
+ * A load balancer's hour.
+ *
+ * @param balancer - The load balancer.
+ * @param prices - Load-balancing prices.
+ * @returns Its price an hour.
+ */
+export declare function balancer_hourly(balancer: CloudLoadBalancer, prices: ServicePrices): number;
+/**
+ * Prices every live resource in a compartment.
+ *
+ * @param driver - The cloud.
+ * @param compartmentId - The compartment.
+ * @param region - The region.
+ * @param now - The clock.
+ * @returns The spend.
+ */
+export declare function spend_read(driver: CloudDriver, compartmentId: string, region: string, now: Date): Promise<Spend>;
+/**
+ * Money as the operator reads it.
+ *
+ * @param amount - The amount.
+ * @param currency - Its currency.
+ * @returns `$1.23`.
+ */
+export declare function money_words(amount: number, currency: string): string;
+/**
+ * A spend in a line.
+ *
+ * @param spend - The spend.
+ * @returns `$0.89 an hour · $412.30 so far, at list price`.
+ */
+export declare function spend_line(spend: Spend): string;

package/dist/domain/spend.js

@@ -0,0 +1,109 @@
+/** The hours a month is billed as, as `harbor-oci` reckons. */
+export const HOURS_PER_MONTH = 730;
+/** The states in which a machine bills. */
+const COMPUTE_STATES = ['running', 'starting', 'provisioning'];
+/** The states in which a resource is gone and bills nothing. */
+const GONE_STATES = ['terminated', 'deleted', 'terminating', 'deleting'];
+/**
+ * The hours since a time.
+ *
+ * @param created - ISO 8601, or empty.
+ * @param now - The clock.
+ * @returns Hours, or null when not known.
+ */
+function hours_since(created, now) {
+    const at = Date.parse(created);
+    return Number.isFinite(at) ? Math.max(0, (now.getTime() - at) / 3_600_000) : null;
+}
+/**
+ * A machine's hour.
+ *
+ * @param instance - The machine.
+ * @param prices - The shapes' prices.
+ * @returns Its price an hour, or null.
+ */
+export function instance_hourly(instance, prices) {
+    const price = prices.find((entry) => entry.shape === instance.shape);
+    if (price === undefined || instance.vcpus === undefined || instance.memoryGib === undefined)
+        return null;
+    return instance.vcpus * price.vcpuHour + instance.memoryGib * price.gibHour;
+}
+/**
+ * A volume's hour.
+ *
+ * @param volume - The volume.
+ * @param prices - Storage prices.
+ * @returns Its price an hour.
+ */
+export function volume_hourly(volume, prices) {
+    return (volume.sizeGib * (prices.volumeGibMonth + (volume.vpusPerGib ?? 10) * prices.vpuGibMonth)) / HOURS_PER_MONTH;
+}
+/**
+ * A load balancer's hour.
+ *
+ * @param balancer - The load balancer.
+ * @param prices - Load-balancing prices.
+ * @returns Its price an hour.
+ */
+export function balancer_hourly(balancer, prices) {
+    return prices.balancerHour + (balancer.minimumMbps ?? 10) * prices.balancerMbpsHour;
+}
+/**
+ * Prices every live resource in a compartment.
+ *
+ * @param driver - The cloud.
+ * @param compartmentId - The compartment.
+ * @param region - The region.
+ * @param now - The clock.
+ * @returns The spend.
+ */
+export async function spend_read(driver, compartmentId, region, now) {
+    const [instances, volumes, balancers, prices, service] = await Promise.all([
+        driver.instances_list(compartmentId, region),
+        driver.volumes_list(compartmentId, region),
+        driver.loadbalancers_list(compartmentId, region),
+        driver.prices_list(),
+        driver.servicePrices_get(),
+    ]);
+    const item = (kind, name, detail, hourly, created) => {
+        const hours = hours_since(created, now);
+        return { kind, name, detail, hourly, soFar: hourly === null || hours === null ? null : hourly * hours };
+    };
+    const items = [
+        ...instances.filter((instance) => COMPUTE_STATES.includes(instance.state))
+            .map((instance) => item('compute', instance.name, `${instance.shape}, ${instance.vcpus ?? '?'} vCPU, ${instance.memoryGib ?? '?'} GiB`, instance_hourly(instance, prices), instance.created)),
+        ...volumes.filter((volume) => !GONE_STATES.includes(volume.state))
+            .map((volume) => item('volumes', volume.name, `${volume.sizeGib} GiB, ${volume.vpusPerGib ?? 10} VPU/GiB`, service === null ? null : volume_hourly(volume, service), volume.created)),
+        ...balancers.filter((balancer) => !GONE_STATES.includes(balancer.state))
+            .map((balancer) => item('load balancers', balancer.name, `${balancer.shape}, ${balancer.minimumMbps ?? 10} Mbps minimum`, service === null ? null : balancer_hourly(balancer, service), balancer.created)),
+    ];
+    return {
+        items,
+        hourly: items.reduce((sum, entry) => sum + (entry.hourly ?? 0), 0),
+        soFar: items.reduce((sum, entry) => sum + (entry.soFar ?? 0), 0),
+        currency: service?.currency ?? prices[0]?.currency ?? 'USD',
+        unpriced: items.filter((entry) => entry.hourly === null).length,
+    };
+}
+/**
+ * Money as the operator reads it.
+ *
+ * @param amount - The amount.
+ * @param currency - Its currency.
+ * @returns `$1.23`.
+ */
+export function money_words(amount, currency) {
+    // A rate under a cent is shown to the hundredth of a cent, never as nothing.
+    const digits = amount !== 0 && Math.abs(amount) < 0.01 ? 4 : 2;
+    return `${currency === 'USD' ? '$' : `${currency} `}${amount.toFixed(digits)}`;
+}
+/**
+ * A spend in a line.
+ *
+ * @param spend - The spend.
+ * @returns `$0.89 an hour · $412.30 so far, at list price`.
+ */
+export function spend_line(spend) {
+    return `${money_words(spend.hourly, spend.currency)} an hour · ${money_words(spend.soFar, spend.currency)} so far, at list price${spend.unpriced > 0 ? ` (${spend.unpriced} not priced)` : ''}`;
+}
+//# sourceMappingURL=spend.js.map

package/dist/domain/spend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spend.js","sourceRoot":"","sources":["../../src/domain/spend.ts"],"names":[],"mappings":"AAeA,+DAA+D;AAC/D,MAAM,CAAC,MAAM,eAAe,GAAW,GAAG,CAAC;AAE3C,2CAA2C;AAC3C,MAAM,cAAc,GAA0B,CAAC,SAAS,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;AAEtF,gEAAgE;AAChE,MAAM,WAAW,GAA0B,CAAC,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;AAuBhG;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,OAAe,EAAE,GAAS;IAC7C,MAAM,EAAE,GAAW,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACvC,OAAO,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACpF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,QAAuB,EAAE,MAAiC;IACxF,MAAM,KAAK,GAA2B,MAAM,CAAC,IAAI,CAAC,CAAC,KAAiB,EAAW,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClH,IAAI,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACzG,OAAO,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC;AAC9E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,MAAmB,EAAE,MAAqB;IACtE,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,cAAc,GAAG,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,eAAe,CAAC;AACvH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,QAA2B,EAAE,MAAqB;IAChF,OAAO,MAAM,CAAC,YAAY,GAAG,CAAC,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC;AACtF,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,MAAmB,EAAE,aAAqB,EAAE,MAAc,EAAE,GAAS;IACpG,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACzE,MAAM,CAAC,cAAc,CAAC,aAAa,EAAE,MAAM,CAAC;QAC5C,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC;QAC1C,MAAM,CAAC,kBAAkB,CAAC,aAAa,EAAE,MAAM,CAAC;QAChD,MAAM,CAAC,WAAW,EAAE;QACpB,MAAM,CAAC,iBAAiB,EAAE;KAC3B,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,CAAC,IAAuB,EAAE,IAAY,EAAE,MAAc,EAAE,MAAqB,EAAE,OAAe,EAAa,EAAE;QACxH,MAAM,KAAK,GAAkB,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACvD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;IAC1G,CAAC,CAAC;IACF,MAAM,KAAK,GAAgB;QACzB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,QAAuB,EAAW,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAC/F,GAAG,CAAC,CAAC,QAAuB,EAAa,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,IAAI,GAAG,UAAU,QAAQ,CAAC,SAAS,IAAI,GAAG,MAAM,EAAE,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACzN,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAmB,EAAW,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aACrF,GAAG,CAAC,CAAC,MAAmB,EAAa,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,SAAS,MAAM,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/M,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,QAA2B,EAAW,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aACjG,GAAG,CAAC,CAAC,QAA2B,EAAa,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC,WAAW,IAAI,EAAE,eAAe,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;KAC3O,CAAC;IACF,OAAO;QACL,KAAK;QACL,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,KAAgB,EAAU,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7F,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,KAAgB,EAAU,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;QAC3F,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,IAAI,KAAK;QAC3D,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,KAAgB,EAAW,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,MAAM;KACpF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,QAAgB;IAC1D,6EAA6E;IAC7E,MAAM,MAAM,GAAW,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,OAAO,GAAG,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;AACjF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAAY;IACrC,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,cAAc,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,yBAAyB,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,QAAQ,cAAc,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAClM,CAAC"}

package/dist/domain/state.d.ts

@@ -0,0 +1,149 @@
+import { type DomainSpec } from './spec.js';
+/** Where a step stands in a domain this session builds. */
+export type BuiltStepState = 'not done' | 'running' | 'done' | 'failed';
+/** One step's history. */
+export interface StepRecord {
+    state: BuiltStepState;
+    started?: string;
+    ended?: string;
+    /** What it rests on, or why it failed, in a line. */
+    note?: string;
+}
+/**
+ * What `state.json` holds.
+ *
+ * @property name - The domain's name, its cluster's name and a DNS label.
+ * @property created - When `domain new` wrote it.
+ * @property region - The region it is built in.
+ * @property baseDomain - The DNS zone its cluster's names live under.
+ * @property steps - Each step's history, by name.
+ * @property ids - What the build recorded for later steps (the installer's ids, the stack's, the ISO object).
+ * @property billingAccepted - When the operator answered yes to the cost of the first billing step.
+ * @property compartmentId - The compartment its resources live in, when known.
+ * @property adopted - Where it was adopted from, and when: built elsewhere, never built on here.
+ * @property gone - When its teardown removed what it built.
+ */
+export interface DomainRecord {
+    name: string;
+    created: string;
+    region: string;
+    baseDomain: string;
+    steps: Record<string, StepRecord>;
+    ids: Record<string, string>;
+    billingAccepted?: string;
+    compartmentId?: string;
+    adopted?: {
+        from: string;
+        at: string;
+    };
+    gone?: string;
+}
+/**
+ * The folder a daemon keeps its domains in.
+ *
+ * @param env - The environment.
+ * @returns `$XDG_STATE_HOME/stratus/domains`, or `~/.local/state/stratus/domains`.
+ */
+export declare function domainsRoot_of(env?: NodeJS.ProcessEnv): string;
+/** A domain name is a DNS label: lower-case letters, digits and hyphens, at most 54. */
+export declare const DOMAIN_NAME: RegExp;
+/** The domains this daemon builds, on its host. */
+export declare class DomainStore {
+    readonly root: string;
+    /**
+     * @param root - The folder the domains live in.
+     */
+    constructor(root: string);
+    /**
+     * A domain's folder.
+     *
+     * @param name - The domain.
+     * @returns Its folder.
+     */
+    folder_of(name: string): string;
+    /** The names of the domains kept, sorted. */
+    names_list(): string[];
+    /**
+     * Makes a domain.
+     *
+     * @param record - Its first state.
+     * @param spec - Its spec.
+     * @throws Error - When one of that name is already kept.
+     */
+    create(record: DomainRecord, spec: DomainSpec): void;
+    /**
+     * A domain's state.
+     *
+     * @param name - The domain.
+     * @returns Its record, or null when none is kept.
+     */
+    record_read(name: string): DomainRecord | null;
+    /**
+     * Saves a domain's state.
+     *
+     * @param record - Its record.
+     */
+    record_write(record: DomainRecord): void;
+    /**
+     * Changes a domain's state and saves it.
+     *
+     * @param name - The domain.
+     * @param change - What to change.
+     * @returns The record as saved.
+     * @throws Error - When none is kept.
+     */
+    record_update(name: string, change: (record: DomainRecord) => void): DomainRecord;
+    /**
+     * A domain's spec, as written and as read.
+     *
+     * @param name - The domain.
+     * @returns The text and the spec (or why it does not read), or null when there is no file.
+     */
+    spec_read(name: string): {
+        text: string;
+        spec: DomainSpec | null;
+        error?: string;
+    } | null;
+    /**
+     * Writes one of the domain's own files (`plan.json`), whole.
+     *
+     * @param name - The domain.
+     * @param file - The file's name in the domain's folder.
+     * @param text - Its content.
+     */
+    file_write(name: string, file: string, text: string): void;
+    /**
+     * Reads one of the domain's own files.
+     *
+     * @param name - The domain.
+     * @param file - The file's name in the domain's folder.
+     * @returns Its content, or null when it is not there.
+     */
+    file_read(name: string, file: string): string | null;
+    /**
+     * Keeps a secret the build fetched.
+     *
+     * @param name - The domain.
+     * @param file - Its file name under `auth/`.
+     * @param text - Its content.
+     */
+    secret_write(name: string, file: string, text: string): void;
+    /**
+     * Reads a secret the build kept, for the build's own next step; never served.
+     *
+     * @param name - The domain.
+     * @param file - Its file name under `auth/`.
+     * @returns Its content, or null.
+     */
+    secret_read(name: string, file: string): string | null;
+    /**
+     * The secrets kept, by name and host path; their content is never read here.
+     *
+     * @param name - The domain.
+     * @returns The files.
+     */
+    secrets_list(name: string): Array<{
+        name: string;
+        hostPath: string;
+    }>;
+}