mas env and secrets

DiSSCo · Sep 9, 2024 · 34eecd7 · 34eecd7
1 parent 05b302e
commit 34eecd7
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 97 deletions.
diff --git a/...a/machine-annotation-service/0.3.0/schema/machine-annotation-service-request-wrapper.json b/...a/machine-annotation-service/0.3.0/schema/machine-annotation-service-request-wrapper.json
diff --git a/...er-schema/machine-annotation-service/0.3.0/schema/machine-annotation-service-request.json b/...er-schema/machine-annotation-service/0.3.0/schema/machine-annotation-service-request.json
@@ -153,6 +153,19 @@
       "type": "object",
       "description": "Object containing the tombstone metadata of the object",
       "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/tombstone-metadata.json"
+    },
+    "ods:hasEnvironment": {
+      "type": "array",
+      "description": "Environmental variables to supply to the MAS, non-sensitive",
+      "items": {
+        "$ref": "https://schemas.dissco.tech/schemas/developer-schema/machine-annotation-service/0.3.0/machine-annotation-service-environment.json"
+      }
+    },
+    "ods:hasSecret": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schemas.dissco.tech/schemas/developer-schema/machine-annotation-service/0.3.0/machine-annotation-service-secret.json"
+      }
     }
   },
   "required": [

diff --git a/...-type/machine-annotation-service/0.3.0/schema/machine-annotation-service-environment.json b/...-type/machine-annotation-service/0.3.0/schema/machine-annotation-service-environment.json
@@ -0,0 +1,36 @@
+{
+  "$id": "https://schemas.dissco.tech/schemas/developer-schema/machine-annotation-service/0.3.0/machine-annotation-service-environment.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment": "Machine Annotation Service Environment Version 0.3.0",
+  "title": "MachineAnnotationServiceEnvironment",
+  "type": "object",
+  "description": "Environmental variables to supply to the MAS, non-sensitive",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of a non-sensitive property or environmental variable",
+      "examples": [
+        "server.port",
+        "spring.profiles.active"
+      ]
+    },
+    "value": {
+      "type": [
+        "string",
+        "integer",
+        "boolean",
+        "null"
+      ],
+      "description": "Value to be stored in the \"name\" field. NOT for sensitive information.",
+      "examples": [
+        8080,
+        "web-profile"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "name",
+    "value"
+  ]
+}
diff --git a/...l/fdo-type/machine-annotation-service/0.3.0/schema/machine-annotation-service-secret.json b/...l/fdo-type/machine-annotation-service/0.3.0/schema/machine-annotation-service-secret.json
@@ -0,0 +1,49 @@
+{
+  "$id": "https://schemas.dissco.tech/schemas/developer-schema/machine-annotation-service/0.3.0/machine-annotation-service-secret.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment": "Machine Annotation Service Environment Version 0.3.0",
+  "title": "MachineAnnotationServiceSecret",
+  "type": "object",
+  "description": "Remote secrets to supply to the MAS",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of an environmental variable stored remotely",
+      "examples": [
+        "database.password",
+        "keycloak.secret"
+      ]
+    },
+    "secretKeyRef": {
+      "type": "object",
+      "description": "Key-value pair of a remote secret.",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of the secret store within DiSSCo",
+          "examples": [
+            "aws-secrets",
+            "db-secrets"
+          ]
+        },
+        "key": {
+          "type": "string",
+          "description": "The name of the key stored in the above secret store. NOT the key's value.",
+          "example": [
+            "db-password"
+          ]
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "key"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "name",
+    "secretKeyRef"
+  ]
+}
diff --git a/data-model/fdo-type/machine-annotation-service/0.3.0/schema/machine-annotation-service.json b/data-model/fdo-type/machine-annotation-service/0.3.0/schema/machine-annotation-service.json
@@ -216,6 +216,19 @@
       "type": "object",
       "description": "Object containing the tombstone metadata of the object",
       "$ref": "https://schemas.dissco.tech/schemas/fdo-type/shared-model/0.3.0/tombstone-metadata.json"
+    },
+    "ods:hasEnvironment": {
+      "type": "array",
+      "description": "Environmental variables to supply to the MAS, non-sensitive",
+      "items": {
+        "$ref": "https://schemas.dissco.tech/schemas/developer-schema/machine-annotation-service/0.3.0/machine-annotation-service-environment.json"
+      }
+    },
+    "ods:hasSecret": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schemas.dissco.tech/schemas/developer-schema/machine-annotation-service/0.3.0/machine-annotation-service-secret.json"
+      }
     }
   },
   "required": [