@crvouga/atlas 0.4.0 → 0.6.0

package/packages/schema/schemas/server-config.schema.json

@@ -0,0 +1,208 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/server-config.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "host": {
+      "description": "Where to listen. 127.0.0.1 keeps it on this machine; 0.0.0.0 is every interface and needs tokens (or `auth.insecure`)",
+      "default": "127.0.0.1",
+      "type": "string"
+    },
+    "port": {
+      "default": 8080,
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 65535
+    },
+    "data": {
+      "description": "The folder that is the default backend and the default write target: layers, specs and runs live here",
+      "default": "./atlas-data",
+      "type": "string"
+    },
+    "backends": {
+      "description": "Further backends, read together with the data folder: S3, another server, a device lab",
+      "default": [],
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "description": "Lowercase letters, digits and hyphens. Names where a result came from",
+            "type": "string",
+            "pattern": "^[a-z0-9-]+$"
+          },
+          "label": {
+            "type": "string"
+          },
+          "url": {
+            "description": "A folder, s3://bucket/prefix, r2://, gs://, or another Atlas server (https://…)",
+            "type": "string",
+            "minLength": 1
+          },
+          "write": {
+            "description": "Uploads go here instead of the data folder. At most one backend is the write target",
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "id",
+          "url"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "write": {
+      "description": "The id of the backend uploads go to. Default: the data folder",
+      "type": "string"
+    },
+    "auth": {
+      "default": {
+        "tokens": [],
+        "anonymousRead": false,
+        "insecure": false
+      },
+      "type": "object",
+      "properties": {
+        "tokens": {
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "description": "Shown in logs, never the token itself",
+                "type": "string",
+                "minLength": 1
+              },
+              "role": {
+                "description": "`read` may look. `publish` may also upload. `admin` may also remove scratch objects",
+                "type": "string",
+                "enum": [
+                  "read",
+                  "publish",
+                  "admin"
+                ]
+              },
+              "token": {
+                "description": "The token. Prefer `tokenEnv`, so the file holds no secret",
+                "type": "string",
+                "minLength": 12
+              },
+              "tokenEnv": {
+                "description": "The name of the environment variable that holds the token",
+                "type": "string"
+              }
+            },
+            "required": [
+              "name",
+              "role"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "anonymousRead": {
+          "description": "Let anyone look without a token. Uploading still needs one",
+          "default": false,
+          "type": "boolean"
+        },
+        "insecure": {
+          "description": "Allow listening on every interface with no tokens at all",
+          "default": false,
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "site": {
+      "description": "The built viewer. Default: the one shipped with Atlas, built on first start",
+      "type": "string"
+    },
+    "outlineBranch": {
+      "description": "Which branch's specs the report is laid over. Default main, then master, then the newest",
+      "type": "string"
+    },
+    "include": {
+      "default": {},
+      "type": "object",
+      "properties": {
+        "branches": {
+          "description": "Only layers recorded on these branches take part",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "ignoreModified": {
+          "description": "Leave out layers from modified checkouts and unknown origins",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "refreshSeconds": {
+      "description": "How often the backends are looked at for layers written by something other than this server",
+      "default": 10,
+      "type": "number",
+      "minimum": 1
+    },
+    "limits": {
+      "default": {
+        "maxObjectMiB": 256,
+        "maxJsonMiB": 32,
+        "maxStreams": 500
+      },
+      "type": "object",
+      "properties": {
+        "maxObjectMiB": {
+          "description": "The largest object an upload may be",
+          "default": 256,
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "maxJsonMiB": {
+          "description": "The largest JSON body (a manifest, a checks request)",
+          "default": 32,
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "maxStreams": {
+          "description": "Viewers that may be connected for live updates at once",
+          "default": 500,
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "additionalProperties": false
+    },
+    "runTimeoutSeconds": {
+      "description": "Interrupt a live run after this many seconds without a producer heartbeat",
+      "default": 30,
+      "type": "number",
+      "minimum": 10,
+      "maximum": 3600
+    },
+    "runStallSeconds": {
+      "description": "Interrupt after this many seconds without test progress; 0 disables progress expiry",
+      "default": 900,
+      "type": "number",
+      "minimum": 0,
+      "maximum": 86400
+    },
+    "heartbeatSeconds": {
+      "description": "How often a live connection is touched, so proxies keep it open",
+      "default": 15,
+      "type": "number",
+      "minimum": 1
+    },
+    "log": {
+      "description": "One JSON line per request",
+      "default": true,
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}

package/packages/schema/schemas/server-editable-settings.schema.json

@@ -0,0 +1,132 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/server-editable-settings.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "data": {
+      "description": "The folder that is the default backend and the default write target: layers, specs and runs live here",
+      "default": "./atlas-data",
+      "type": "string"
+    },
+    "backends": {
+      "description": "Further backends, read together with the data folder: S3, another server, a device lab",
+      "default": [],
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "description": "Lowercase letters, digits and hyphens. Names where a result came from",
+            "type": "string",
+            "pattern": "^[a-z0-9-]+$"
+          },
+          "label": {
+            "type": "string"
+          },
+          "url": {
+            "description": "A folder, s3://bucket/prefix, r2://, gs://, or another Atlas server (https://…)",
+            "type": "string",
+            "minLength": 1
+          },
+          "write": {
+            "description": "Uploads go here instead of the data folder. At most one backend is the write target",
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "id",
+          "url"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "write": {
+      "description": "The id of the backend uploads go to. Default: the data folder",
+      "type": "string"
+    },
+    "outlineBranch": {
+      "description": "Which branch's specs the report is laid over. Default main, then master, then the newest",
+      "type": "string"
+    },
+    "include": {
+      "default": {},
+      "type": "object",
+      "properties": {
+        "branches": {
+          "description": "Only layers recorded on these branches take part",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "ignoreModified": {
+          "description": "Leave out layers from modified checkouts and unknown origins",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "refreshSeconds": {
+      "description": "How often the backends are looked at for layers written by something other than this server",
+      "default": 10,
+      "type": "number",
+      "minimum": 1
+    },
+    "limits": {
+      "default": {
+        "maxObjectMiB": 256,
+        "maxJsonMiB": 32,
+        "maxStreams": 500
+      },
+      "type": "object",
+      "properties": {
+        "maxObjectMiB": {
+          "description": "The largest object an upload may be",
+          "default": 256,
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "maxJsonMiB": {
+          "description": "The largest JSON body (a manifest, a checks request)",
+          "default": 32,
+          "type": "number",
+          "exclusiveMinimum": 0
+        },
+        "maxStreams": {
+          "description": "Viewers that may be connected for live updates at once",
+          "default": 500,
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        }
+      },
+      "additionalProperties": false
+    },
+    "heartbeatSeconds": {
+      "description": "How often a live connection is touched, so proxies keep it open",
+      "default": 15,
+      "type": "number",
+      "minimum": 1
+    },
+    "runTimeoutSeconds": {
+      "description": "Interrupt a live run after this many seconds without a producer heartbeat",
+      "default": 30,
+      "type": "number",
+      "minimum": 10,
+      "maximum": 3600
+    },
+    "runStallSeconds": {
+      "description": "Interrupt after this many seconds without test progress; 0 disables progress expiry",
+      "default": 900,
+      "type": "number",
+      "minimum": 0,
+      "maximum": 86400
+    },
+    "log": {
+      "description": "One JSON line per request",
+      "default": true,
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}

package/packages/schema/schemas/server-info.schema.json

@@ -0,0 +1,114 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/server-info.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "const": "atlas"
+    },
+    "version": {
+      "description": "The @crvouga/atlas version the server runs, or null when it does not know",
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "role": {
+      "description": "What the token of this request may do. A server with no tokens treats everyone as admin",
+      "type": "string",
+      "enum": [
+        "read",
+        "publish",
+        "admin"
+      ]
+    },
+    "open": {
+      "description": "True when the server has no tokens at all",
+      "type": "boolean"
+    },
+    "write": {
+      "description": "The id of the backend uploads go to",
+      "type": "string"
+    },
+    "ready": {
+      "type": "boolean"
+    },
+    "viewers": {
+      "description": "Viewers connected to /api/events right now",
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "time": {
+      "description": "The server clock, epoch milliseconds",
+      "type": "number"
+    },
+    "backends": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "label": {
+            "type": "string"
+          },
+          "available": {
+            "type": "boolean"
+          },
+          "write": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "id",
+          "label",
+          "available",
+          "write"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "layers": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "slots": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "capabilities": {
+      "description": "Features this server has, by name: `events`, `ingest`, `store`, `checks`, `status`, `effective`. A client checks a name before using what it names",
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "boolean"
+      }
+    }
+  },
+  "required": [
+    "name",
+    "version",
+    "role",
+    "open",
+    "write",
+    "ready",
+    "viewers",
+    "time",
+    "backends",
+    "layers",
+    "slots",
+    "capabilities"
+  ],
+  "additionalProperties": {}
+}