Fix issue 150: Create data model

.githooks/pre-push

@@ -50,7 +50,7 @@ do
 
         # Check test examples
         set -e
-        doc-generation/check-examples.bash
+        data-model/tools/check-examples.bash
         set +e
 
 	fi

.github/workflows/pages.yml

@@ -60,7 +60,7 @@ jobs:
 
       - name: Run tests
         run: |
-          doc-generation/check-examples.bash
+          data-model/tools/check-examples.bash
 
   documents:
     needs:
@@ -90,17 +90,18 @@ jobs:
       - name: Install dependencies
         run: poetry install --no-interaction --all-extras
 
-      - name: Generate MarkDown documentation
+      - name: Generate all artifacts
         run: |
-          doc-generation/generate-documentation.bash
+          data-model/tools/generate-all.bash
 
-      - name: Share generated documentation with later jobs
+      - name: Share generated artifacts with later jobs
         uses: actions/upload-artifact@v4
         with:
-          name: generated-documentation
+          name: generated-artifacts
           path: |
             system-design/specification/applications/application-description.md
             system-design/specification/margo-management-interface/desired-state.md
+            system-design/specification/margo-management-interface/workload-management-api-1.0.0.yaml
 
   pages:
     needs:
@@ -135,12 +136,16 @@ jobs:
       - name: Install the project dependencies
         run: poetry install
 
-      - name: Get generated documentation from previous jobs
+      - name: Get generated artifacts from previous jobs
         uses: actions/download-artifact@v4
         with:
-          name: generated-documentation
+          name: generated-artifacts
           path: system-design/specification
 
+      - name: Generate merged documentation tree
+        run: |
+          data-model/tools/generate-docs.bash
+
       - name: Build Pages
         run: poetry run -- mkdocs build
 

.gitignore

@@ -10,3 +10,5 @@ system-design/specification/applications/application-description.md
 src/specification/applications/docs
 src/specification/margo-management-interface/docs
 *.code-workspace
+generated
+merged

data-model/application-deployment.linkml.yaml

@@ -0,0 +1,128 @@
+# yaml-language-server: $schema=https://linkml.io/linkml-model/linkml_model/jsonschema/meta.schema.json
+id: https://specification.margo.org/application_deployment_schema
+name: ApplicationDeployment
+description: >-
+  Each workload is represented as an `ApplicationDeployment` YAML file that specifies its components, configuration, and parameters.
+  This resource is delivered via the Desired State API and referenced by `id` in the Deployment Status API.
+
+  Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#applicationdeployment-yaml-definition
+version: 1.0.0 #Arne: update later
+prefixes:
+  linkml: https://w3id.org/linkml/
+  margo: https://specification.margo.org/
+imports:
+  - linkml:types
+  - margo-deployments.linkml
+
+default_prefix: margo
+default_range: string
+
+classes:
+  ApplicationDeployment:
+    description: >-
+      A class representing the desired state of an entity.
+
+      Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#applicationdeployment-yaml-definition
+    attributes:
+      apiVersion:
+        description: Identifier of the version of the API the object definition follows.
+        required: true
+        range: string
+      kind:
+        description: Must be `ApplicationDeployment`.
+        equals_string: "ApplicationDeployment"
+        required: true
+        range: string
+        designates_type: true
+      metadata:
+        description: >-
+          Metadata element specifying characteristics about the application deployment.
+          See the [Metadata Attributes](#metadata-attributes) section below.
+
+          Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#metadata-attributes
+        range: DeploymentMetadata
+        required: true
+      spec:
+        description: >-
+          Spec element that defines deployment profile and parameters associated with the application deployment.
+          See the [Spec Attributes](#spec-attributes) section below.
+
+          Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#spec-attributes
+        range: Spec
+        required: true
+
+  DeploymentMetadata:
+    description: >-
+      Metadata associated with the desired state.
+
+      Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#metadata-attributes
+    attributes:
+      annotations:
+        description: >-
+          Defines the application ID and unique identifier associated to the deployment specification.
+          Needs to be assigned by the Workload Orchestration Software.
+          See the [Annotation Attributes](#annotations-attributes) section below.
+
+          Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#annotations-attributes
+        range: DeploymentAnnotations
+        required: true
+      name:
+        description: >-
+          When deploying to Kubernetes, the manifests name.
+          The name is chosen by the workload orchestration vendor and is not displayed anywhere.
+        required: true
+        range: string
+      namespace:
+        description: When deploying to Kubernetes, the namespace the manifest is added under. The namespace is chosen by the workload orchestration solution vendor.
+        required: true
+        range: string
+
+  DeploymentAnnotations:
+    description: >-
+      A class representing annotations.
+
+      Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#annotations-attributes
+    attributes:
+      applicationId:
+        description: >-
+          An identifier for the application.
+          The id is used to help create unique identifiers where required, such as namespaces.
+          The id must be lower case letters and numbers and MAY contain dashes.
+          Uppercase letters, underscores and periods MUST NOT be used.
+          The id MUST NOT be more than 200 characters.
+          The applicationId MUST match the associated application package Metadata "id" attribute.
+        range: string
+        required: true
+        pattern: "^[-a-z0-9]{1,200}$"
+      id:
+        description: >-
+          The unique identifier UUID of the deployment specification.
+          Needs to be assigned by the Workload Orchestration Software.
+        range: string
+        required: true
+        pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+
+  Spec:
+    description: >-
+      Specification details of the desired state.
+
+      Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#spec-attributes
+    attributes:
+      deploymentProfile:
+        description: >-
+          Section that defines deployment details including type and components.
+
+          Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#deploymentprofile-attributes
+        range: DeploymentProfile
+        required: true
+      parameters:
+        description: >-
+          Describes the configured parameters applied via the end-user.
+
+          Pre-data-model reference https://github.com/margo/specification/blob/3519aa7be4b565b2e2395134b99778fdc0379ace/system-design/specification/margo-management-interface/desired-state.md#parameter-attributes
+        range: Parameter
+        required: true
+        multivalued: true
+        inlined: true
+        inlined_as_list: false
+