From afa0984b5759face8b6613f4e8e07f61982ab0f6 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Fri, 19 Jul 2024 11:16:49 +0200 Subject: [PATCH] Docs: remove generated inventory.md from git index --- docs/site/reference/nix-api/inventory.md | 185 ----------------------- 1 file changed, 185 deletions(-) delete mode 100644 docs/site/reference/nix-api/inventory.md diff --git a/docs/site/reference/nix-api/inventory.md b/docs/site/reference/nix-api/inventory.md deleted file mode 100644 index 75fa5e970..000000000 --- a/docs/site/reference/nix-api/inventory.md +++ /dev/null @@ -1,185 +0,0 @@ -# Inventory API - -*Inventory* is an abstract service layer for consistently configuring distributed services across machine boundaries. - -The following is a specification of the inventory in [cuelang](https://cuelang.org/) format. - -```cue -package compose - -#Root: { - @jsonschema(schema="http://json-schema.org/draft-07/schema#") - machines?: [string]: { - deploy?: { - // Configuration for the deployment of the machine - targetHost: null | string - } - description: null | string - icon: null | string - name: string - system: null | string - tags: [...string] - } - meta?: { - description: null | string - icon: null | string - name: string - } - services?: { - borgbackup?: [string]: { - // borgbackup-config - config?: { - // destinations where the machine should be backuped to - destinations?: { - [string]: { - // the name of the backup job - name: string - - // the borgbackup repository to backup to - repo: string - } - } - } | *{ - ... - } - machines?: [string]: { - // borgbackup-config - config?: { - // destinations where the machine should be backuped to - destinations?: { - [string]: { - // the name of the backup job - name: string - - // the borgbackup repository to backup to - repo: string - } - } - } | *{ - ... - } - imports: [...string] - } - meta?: { - description: null | string - icon: null | string - name: string - } - roles?: { - client?: { - // borgbackup-config - config?: { - // destinations where the machine should be backuped to - destinations?: { - [string]: { - // the name of the backup job - name: string - - // the borgbackup repository to backup to - repo: string - } - } - } | *{ - ... - } - imports: [...string] - machines: [...string] - tags: [...string] - } - server?: { - // borgbackup-config - config?: { - // destinations where the machine should be backuped to - destinations?: { - [string]: { - // the name of the backup job - name: string - - // the borgbackup repository to backup to - repo: string - } - } - } | *{ - ... - } - imports: [...string] - machines: [...string] - tags: [...string] - } - } - } - packages?: [string]: { - // packages-config - config?: { - // The packages to install on the machine - packages: [...string] - } | *{ - ... - } - machines?: [string]: { - // packages-config - config?: { - // The packages to install on the machine - packages: [...string] - } | *{ - ... - } - imports: [...string] - } - meta?: { - description: null | string - icon: null | string - name: string - } - roles?: default?: { - // packages-config - config?: { - // The packages to install on the machine - packages: [...string] - } | *{ - ... - } - imports: [...string] - machines: [...string] - tags: [...string] - } - } - "single-disk"?: [string]: { - // single-disk-config - config?: { - // The primary disk device to install the system on - device: null | string - } | *{ - ... - } - machines?: [string]: { - // single-disk-config - config?: { - // The primary disk device to install the system on - device: null | string - } | *{ - ... - } - imports: [...string] - } - meta?: { - description: null | string - icon: null | string - name: string - } - roles?: default?: { - // single-disk-config - config?: { - // The primary disk device to install the system on - device: null | string - } | *{ - ... - } - imports: [...string] - machines: [...string] - tags: [...string] - } - } - } -} -```