@zinn-digital/sdk 0.1.1416 → 0.1.1419

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11221,7 +11221,7 @@ export interface paths {
11221
11221
  };
11222
11222
  /**
11223
11223
  * Capacity and health of every server - disk, inodes, RAM, CPU, load, sites, days-to-full (staff).
11224
- * @description Every hosting box and mail relay, worst first: the fullest real filesystem, inode use, RAM, CPU busy (15 min), load per core, sites placed against the box's capacity, the measured days until the fullest filesystem fills (least squares over 3 days, `null` when there is not enough history), seconds since the box last reported, and a status (`critical`, `warning`, `watch`, `ok`) computed from the SAME lines the `zinn-server-capacity` PrometheusRule pages on (75 / 85 / 95 % disk, 14 / 3 days to full). Requires staff + `platform.observability.read`.
11224
+ * @description Every server we run, in display groups (`groups`, in order): hosting, magento, mail, cluster (each Kubernetes node, with its `sub_roles` and pods / CPU / memory requests as `units`), ci, network (owned egress, private-network gateway), launch, customer_compute and v1. Rows are the UNION of what pushes metrics, the engine's `Worker` table and the supplier inventory (Hetzner Cloud + Robot), so a billed server that pushes nothing is still a row (`source: none`, status `critical` with `not_reporting`), never an absence. Customer compute, launch-project and V1 servers carry no V2 agent by design (`agent_expected: false`, status `unmonitored`, no problems): they are listed with their `size`; launch and V1 are monitored by their own projects, and V1 capacity is read on V1's own page (`v1_capacity_url`). The dev workstation is not production and is not listed. Within each group, worst first: the fullest real filesystem, inode use, RAM, CPU busy (15 min), load per core, sites placed against the box's capacity, the measured days until the fullest filesystem fills (least squares over 3 days, `null` when there is not enough history), seconds since the box last reported, and a status (`critical`, `warning`, `watch`, `ok`) computed from the SAME lines the `zinn-server-capacity` PrometheusRule pages on (75 / 85 / 95 % disk, 14 / 3 days to full). Requires staff + `platform.observability.read`.
11225
11225
  *
11226
11226
  * **`available: false` is not "nothing is filling up".** Every box pushes a root filesystem and a load average, so zero series is a monitoring failure. Hosting boxes the engine knows about that push nothing are listed in `silent_workers`, never dropped.
11227
11227
  */
@@ -96488,6 +96488,10 @@ export interface components {
96488
96488
  };
96489
96489
  ServerCapacity: {
96490
96490
  available: boolean;
96491
+ /** @description The display groups, in the order the console shows them. */
96492
+ groups: string[];
96493
+ /** @description False when the supplier inventory could not be read - then servers that push nothing may be missing. */
96494
+ inventory_available: boolean;
96491
96495
  servers: components["schemas"]["ServerUsage"][];
96492
96496
  silent_workers: string[];
96493
96497
  thresholds: {
@@ -96503,6 +96507,11 @@ export interface components {
96503
96507
  stale_seconds: number;
96504
96508
  };
96505
96509
  unavailable_reason: string;
96510
+ /**
96511
+ * Format: uri
96512
+ * @description V1's own capacity page, where V1 servers are monitored.
96513
+ */
96514
+ v1_capacity_url: string;
96506
96515
  };
96507
96516
  ServerFilesystem: {
96508
96517
  /** Format: int64 */
@@ -96516,8 +96525,19 @@ export interface components {
96516
96525
  size_bytes: number;
96517
96526
  used_fraction: number;
96518
96527
  };
96528
+ ServerUnitUsage: {
96529
+ /** @description True when `limit` is estimated from the server's measured RAM at the fleet's declared sites-per-RAM ratio (a worker with no declared capacity), never alerted on. */
96530
+ estimated: boolean;
96531
+ /** @enum {string} */
96532
+ kind: "sites" | "pods" | "cpu_requests_millicores" | "memory_requests_bytes";
96533
+ limit: number;
96534
+ used: number;
96535
+ used_fraction: number | null;
96536
+ };
96519
96537
  ServerUsage: {
96520
96538
  accepts_deploys: boolean | null;
96539
+ /** @description False for groups that carry no V2 agent by design (customer_compute, launch, v1). */
96540
+ agent_expected: boolean;
96521
96541
  /** @description The server's hostname. */
96522
96542
  box: string;
96523
96543
  cores: number;
@@ -96525,7 +96545,11 @@ export interface components {
96525
96545
  days_to_full: number | null;
96526
96546
  disk_used_fraction: number;
96527
96547
  filesystems: components["schemas"]["ServerFilesystem"][];
96548
+ /** @enum {string} */
96549
+ group: "hosting" | "magento" | "mail" | "cluster" | "ci" | "network" | "launch" | "customer_compute" | "v1" | "other";
96528
96550
  inode_used_fraction: number;
96551
+ /** @description The customer's own name for a Zinn® Compute server; empty otherwise. */
96552
+ label: string;
96529
96553
  load_per_core: number | null;
96530
96554
  load15: number | null;
96531
96555
  /**
@@ -96539,13 +96563,28 @@ export interface components {
96539
96563
  pool: string;
96540
96564
  problems: ("not_reporting" | "disk_critical" | "disk_warn" | "disk_watch" | "inodes_critical" | "inodes_warn" | "inodes_watch" | "full_within_critical" | "full_within_warn" | "memory_warn" | "cpu_warn" | "load_warn" | "sites_full")[];
96541
96565
  region: string;
96542
- /** @enum {string} */
96543
- role: "hosting-worker" | "mail-relay";
96566
+ /** @description The box's role label (`hosting-worker`, `mail-relay`, `cluster-node`, `owned-egress`, `privatenet-gateway`, `launch`, or the supplier's label for an unmonitored server). */
96567
+ role: string;
96544
96568
  seconds_since_report: number | null;
96545
96569
  site_capacity: number | null;
96546
96570
  sites: number | null;
96571
+ /** @description Plan or product from the supplier (`cpx32`, `AX102-3-LTD`); empty when unknown. */
96572
+ size: string;
96573
+ /**
96574
+ * @description Where the figures come from: node exporter, the CI box health reporter, or nothing.
96575
+ * @enum {string}
96576
+ */
96577
+ source: "metrics" | "ci_report" | "none";
96547
96578
  /** @enum {string} */
96548
- status: "critical" | "warning" | "watch" | "ok";
96579
+ status: "critical" | "warning" | "watch" | "ok" | "unmonitored";
96580
+ /** @description What a cluster node carries, from its node roles and taints plus what is scheduled on it (e.g. `control-plane`, `etcd`, `observability`, `database` for a CloudNativePG instance, `managed-db`). */
96581
+ sub_roles: string[];
96582
+ /**
96583
+ * @description Which supplier inventory lists it; empty when none does.
96584
+ * @enum {string}
96585
+ */
96586
+ supplier: "hetzner_cloud" | "hetzner_robot" | "";
96587
+ units: components["schemas"]["ServerUnitUsage"][];
96549
96588
  };
96550
96589
  /** @description The estate's service health, as the admin overview renders it. */
96551
96590
  ServiceHealthOverview: {
@@ -186250,7 +186289,7 @@ export interface operations {
186250
186289
  "application/json": components["schemas"]["Error"];
186251
186290
  };
186252
186291
  };
186253
- /** @description The `primary_domain` is not available, an `Idempotency-Key` was reused with a different body, or a request with that `Idempotency-Key` is still in flight (retry once it settles). */
186292
+ /** @description The `primary_domain` is not available (another site uses it, or another organisation holds that domain or a domain it sits under; the answer does not say which), an `Idempotency-Key` was reused with a different body, or a request with that `Idempotency-Key` is still in flight (retry once it settles). */
186254
186293
  409: {
186255
186294
  headers: {
186256
186295
  [name: string]: unknown;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zinn-digital/sdk",
3
- "version": "0.1.1416",
3
+ "version": "0.1.1419",
4
4
  "description": "Typed TypeScript client for the Zinn Digital Platform API, generated from its OpenAPI spec.",
5
5
  "license": "MIT",
6
6
  "author": "Neil Lock \u2014 CEO, Zinn Digital\u00ae Ltd <office@zinndigital.com>",