From 76833a2578c9830160486d011f7791ed8f763276 Mon Sep 17 00:00:00 2001 From: Sam Thursfield Date: Sat, 20 Feb 2016 13:38:54 +0000 Subject: Don't put schemas into versioned subdirectories This makes sense for build tools that want to support multiple versions of the definitions format, but it doesn't make sense here. You can look in the Git history for previous versions. --- schemas/007/baserock.owl | 295 --------------------------------------- schemas/007/chunk.json-schema | 116 --------------- schemas/007/cluster.json-schema | 64 --------- schemas/007/defaults.json-schema | 66 --------- schemas/007/stratum.json-schema | 99 ------------- schemas/007/system.json-schema | 59 -------- schemas/baserock.owl | 295 +++++++++++++++++++++++++++++++++++++++ schemas/chunk.json-schema | 116 +++++++++++++++ schemas/cluster.json-schema | 64 +++++++++ schemas/defaults.json-schema | 66 +++++++++ schemas/stratum.json-schema | 99 +++++++++++++ schemas/system.json-schema | 59 ++++++++ 12 files changed, 699 insertions(+), 699 deletions(-) delete mode 100644 schemas/007/baserock.owl delete mode 100644 schemas/007/chunk.json-schema delete mode 100644 schemas/007/cluster.json-schema delete mode 100644 schemas/007/defaults.json-schema delete mode 100644 schemas/007/stratum.json-schema delete mode 100644 schemas/007/system.json-schema create mode 100644 schemas/baserock.owl create mode 100644 schemas/chunk.json-schema create mode 100644 schemas/cluster.json-schema create mode 100644 schemas/defaults.json-schema create mode 100644 schemas/stratum.json-schema create mode 100644 schemas/system.json-schema diff --git a/schemas/007/baserock.owl b/schemas/007/baserock.owl deleted file mode 100644 index 33113d8..0000000 --- a/schemas/007/baserock.owl +++ /dev/null @@ -1,295 +0,0 @@ -# Copyright (C) 2015 Codethink Limited -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; version 2 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along -# with this program. If not, see . - - -# This schema describes the Baserock data model. It describes how the data -# can be represented in computer memory, it doesn't specify anything about -# how it should be stored on disk or transferred. -# -# Please see README.schemas, and http://wiki.baserock.org/definitions/current/ -# for more information. -# -# This is not a brilliant schema, in Linked Data terms, because it's using -# Baserock-specific terminology and a rigid layout, instead of being a generic -# vocabulary for describing how to assemble software. However, it maps closely -# to the format that the existing Baserock reference system definitions use. -# We hope to produce a simpler and more flexible 2.x version of this schema in -# future. - - -# Partial OWL and RDF Schema glossary: -# -# domain: the set of objects that a can have a property. -# range: the set of possible values for a property. -# -# ObjectProperty: -# a property whose value must be another resource. -# DatatypeProperty: -# a property whose value is one of the datatype defined by XML Schema ("xsd") -# FunctionalProperty: -# a property which can only have one value per resource -# InverseFunctionalProperty: -# a property which can only have one resource per value - - -# Metadata - -@prefix : . -@prefix owl: . -@prefix rdfs: . -@prefix rdf: . -@prefix xsd: . -@prefix dc: . - -: a owl:Ontology ; - dc:title "Schema for Baserock data model" ; - dc:creator "The Baserock Project" ; - # Versioned according to Semantic Versioning http://www.semver.org/ - owl:versionInfo "0.9.0" . - - -## Entities - -# Source definitions - -:Morphology a owl:Class ; - rdfs:comment "A definition file." . - -:Cluster a owl:Class ; - rdfs:subClassOf :Morphology ; - rdfs:comment "Instructions for deploying one or systems." ; - owl:disjointWith :System, :Stratum, :Chunk . - -:System a owl:Class ; - rdfs:subClassOf :Morphology ; - rdfs:comment "A collection of strata in a form that can be executed." ; - owl:disjointWith :Cluster, :Stratum, :Chunk . - -:Stratum a owl:Class ; - rdfs:subClassOf :Morphology ; - rdfs:comment "A set of related chunks." ; - owl:disjointWith :Cluster, :System, :Chunk . - -:Chunk a owl:Class ; - rdfs:subClassOf :Morphology ; - rdfs:comment "An individual component, that can be built from a Git repository." ; - owl:disjointWith :Cluster, :System, :Stratum . - -# Container contents - -:SystemDeployment a owl:Class ; - rdfs:comment "Information for deploying one system of a cluster." . - -:ChunkReference a owl:Class ; - rdfs:comment "An instance of a chunk within a stratum." . - -# Products (for artifact split rules). - -:Artifact a owl:Class ; - rdfs:comment "One part of the result of building a morphology. The output of a build is split according to patterns, so there are multiple artifacts produced for a given source." . - -:StratumArtifact a owl:Class ; - rdfs:subClassOf :Artifact ; - rdfs:comment "Part of the result of building a stratum." ; - owl:disjointWith :ChunkArtifact. - -:ChunkArtifact a owl:Class ; - rdfs:subClassOf :Artifact ; - rdfs:comment "Part of the result of building a chunk." ; - owl:disjointWith :StratumArtifact. - - -## Shared properties - -# 'name' becomes part of the URL when we import definition .morph files as RDF, -# so it doesn't need a property. - -# Use dc:description for 'description', see: -# http://dublincore.org/documents/2012/06/14/dcmi-terms/?v=terms#terms-description - - -## Cluster-specific properties - -:containsSystemDeployment a owl:ObjectProperty ; - rdfs:domain :Cluster ; - rdfs:range :SystemDeployment ; - owl:minCardinality 1 . - - -## SystemDeployment-specific properties - -:deploysSystem a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :SystemDeployment ; - rdfs:range :System . - -:hasLabel a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :SystemDeployment ; - rdfs:range xsd:string . - -:hasType a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :SystemDeployment ; - rdfs:range xsd:string ; - rdfs:comment "The .write extension used to perform the deployment." . - -:hasLocation a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :SystemDeployment ; - rdfs:range xsd:string ; - rdfs:comment "Deployment location. This is passed to the selected .write extension" . - -# FIXME: this is actually a key-value mapping, how do you do that in RDF properly? -:hasConfigurationSetting a owl:DatatypeProperty ; - rdfs:domain :SystemDeployment ; - rdfs:range xsd:string ; - rdfs:comment "Arbitrary key=value pair that is set in the environment of the .configure and .write extensions during deployment." . - - -## System-specific properties - -:containsStratumArtifact a owl:ObjectProperty ; - rdfs:domain :System ; - rdfs:range :StratumArtifact ; - owl:minCardinality 1 . - -# A build tool will only understand a certain set of architectures, but I think -# that should not be part of the data model. -:hasArchitecture a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :System ; - rdfs:range xsd:string . - -:hasConfigurationExtension a owl:DatatypeProperty ; - rdfs:domain :System ; - rdfs:range xsd:string ; - rdfs:comment "A .configure extension to be run when with system is deployed." . - - -## Stratum-specific properties - -:producesStratumArtifact a owl:ObjectProperty , rdf:Seq ; - rdfs:domain :Stratum ; - rdfs:range :StratumArtifact ; - rdfs:comment "iDescribes how this artifact is split once all chunks are built." . - -:hasStratumBuildDependency a owl:ObjectProperty ; - rdfs:domain :Stratum ; - rdfs:range :Stratum . - -:containsChunkReference a owl:ObjectProperty ; - rdfs:domain :Stratum ; - rdfs:range :ChunkReference ; - owl:minCardinality 1 . - - -## ChunkReference-specific properties - -:refersToChunk a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :ChunkReference ; - rdfs:range :Chunk . - -:repo a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :ChunkReference ; - rdfs:range xsd:string ; - rdfs:comment "Git repo that this chunk's build instructions should be run in. Can be a keyed URL according to the repo-alias mapping, which isn't currently defined in this data model." . - -:ref a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :ChunkReference ; - rdfs:range xsd:string ; - rdfs:comment "Ref of the Git repo that should be checked out before building. Usually a SHA1." . - -:unpetrifyRef a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :ChunkReference ; - rdfs:range xsd:string ; - rdfs:comment "Name of the ref that should be checked out (useful when 'ref' is a SHA1 to keep track of the actual branch/tag name)." . - -:hasChunkBuildDependency a owl:ObjectProperty ; - rdfs:domain :ChunkReference ; - rdfs:range :Chunk . - -:prefix a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :ChunkReference ; - rdfs:range xsd:string ; - rdfs:comment "Value of the PREFIX environment variable in the build environment (defaults to /usr)" . - -# FIXME: it's possible to specify in OWL that 'bootstrap' and 'normal' are the -# only valid values. -:buildMode a owl:DatatypeProperty , owl:FunctionalProperty ; - rdfs:domain :ChunkReference ; - rdfs:range xsd:string . - - -## Chunk-specific properties - -# build-system isn't included here, as it overlaps with the *-commands -# fields in an unfortunate way. - -# Note that representing lists of things in RDF is a bit of a pain. -# http://smiy.sourceforge.net/olo/spec/orderedlistontology.html might -# be worth investigating. - -:producesChunkArtifact a owl:ObjectProperty , rdf:Seq ; - rdfs:domain :Chunk ; - rdfs:range :ChunkArtifact ; - rdfs:comment "Describes how this artifact is split once built." . - -:maxJobs a owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range xsd:integer ; - rdfs:comment "Number of parallel jobs that can be run for this chunk. Only useful if set to 1, to mark components which have Makefiles that do not work with `make -j N`.". - -:CommandSequence a owl:Class ; - rdfs:subClassOf rdf:Seq ; - rdfs:comment "An ordered sequence of commands." . - -:preConfigureCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - -:configureCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - -:postConfigureCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - -:preBuildCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - -:buildCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - -:postBuildCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - -:preInstallCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - -:installCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - -:postInstallCommands a owl:ObjectProperty , owl:FunctionalProperty ; - rdfs:domain :Chunk ; - rdfs:range :CommandSequence . - - -# Artifact properties - -:includes a owl:DatatypeProperty , rdf:Seq ; - rdfs:domain :Artifact ; - rdfs:range xsd:string ; - rdfs:comment "A regular expression pattern. The results of a build are matched against this pattern and any that match will be included in that artifact." . diff --git a/schemas/007/chunk.json-schema b/schemas/007/chunk.json-schema deleted file mode 100644 index 8de2fb5..0000000 --- a/schemas/007/chunk.json-schema +++ /dev/null @@ -1,116 +0,0 @@ -$schema: http://json-schema.org/draft-04/schema# -id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/chunk.json-schema - -description: | - This is a JSON-Schema description of a 'chunk' .morph file, which is part of - the Baserock definitions YAML representation format. - - This JSON-Schema file is valid for VERSION 7 of the Baserock definitions - YAML serialisation format. - - The Baserock definitions format is the recommended way of representing - Baserock definitions on disk. The actual data model is described separately. - See https://wiki.baserock.org/definitions for more information. - - This schema is represented as YAML, so that it can be edited more easily. - You may need to convert to JSON if using a JSON-Schema tool that expects - its input to be an actual string containing data serialised as JSON. - -definitions: - # Corresponds to CommandSequence in Baserock data model. - command-sequence: - type: array - items: { type: string } - - # Corresponds to DeviceNode in Baserock data model. - device-node: - type: object - required: [type, filename, gid, uid, major, minor, permissions] - properties: - type: { type: string } - filename: { type: string } - gid: { type: integer } - uid: { type: integer } - major: { type: integer } - minor: { type: integer } - permissions: { type: string } - - # Defines one or more instances of ChunkArtifact from the Baserock data model. - split-rules: - type: array - items: - type: object - - required: [artifact, include] - additionalProperties: false - - properties: - artifact: {type: string} - include: - type: array - items: - type: string - format: regex - - system-integration-commands: - type: object - patternProperties: - # The property name here should correspond to the name of the chunk's - # artifacts, probably the '-bins' artifact if you are using the normal - # splitting rules. - ^.*$: - type: object - patternProperties: - ^.*$: - $ref: "#/definitions/command-sequence" - -# Corresponds to Chunk in Baserock data model. -type: object - -additionalProperties: false -required: [ 'name', 'kind'] - -properties: - name: { type: string } - kind: { enum: [ "chunk" ] } - - description: { type: string } - - build-system: { type: string } - max-jobs: { type: integer } - - products: - $ref: "#/definitions/split-rules" - - pre-configure-commands: - $ref: "#/definitions/command-sequence" - configure-commands: - $ref: "#/definitions/command-sequence" - post-configure-commands: - $ref: "#/definitions/command-sequence" - pre-build-commands: - $ref: "#/definitions/command-sequence" - build-commands: - $ref: "#/definitions/command-sequence" - post-build-commands: - $ref: "#/definitions/command-sequence" - pre-install-commands: - $ref: "#/definitions/command-sequence" - install-commands: - $ref: "#/definitions/command-sequence" - post-install-commands: - $ref: "#/definitions/command-sequence" - pre-strip-commands: - $ref: "#/definitions/command-sequence" - strip-commands: - $ref: "#/definitions/command-sequence" - post-strip-commands: - $ref: "#/definitions/command-sequence" - - system-integration: - $ref: "#/definitions/system-integration-commands" - - devices: - type: array - items: - $ref: "#/definitions/device-node" diff --git a/schemas/007/cluster.json-schema b/schemas/007/cluster.json-schema deleted file mode 100644 index 1a628c7..0000000 --- a/schemas/007/cluster.json-schema +++ /dev/null @@ -1,64 +0,0 @@ -$schema: http://json-schema.org/draft-04/schema# -id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/cluster.json-schema - -description: - This is a JSON-Schema description of a 'cluster' .morph file, which is part - of the Baserock definitions YAML representation format. - - This JSON-Schema file is valid for VERSION 7 of the Baserock definitions - YAML serialisation format. - - The Baserock definitions format is the recommended way of representing - Baserock definitions on disk. The actual data model is described separately. - See https://wiki.baserock.org/definitions for more information. - - This schema is represented as YAML, so that it can be edited more easily. - You may need to convert to JSON if using a JSON-Schema tool that expects - its input to be an actual string containing data serialised as JSON. - -definitions: - # A reference to a System, plus one or more SystemDeployment for that system. - system-deployment-set: - type: object - - required: [ 'morph', 'deploy' ] - additionalProperties: false - - properties: - morph: { type: string } - deploy-defaults: - type: object - additionalProperties: true - deploy: - patternProperties: - ^.*$: { $ref: "#/definitions/system-deployment" } - subsystems: - type: array - items: { $ref: "#/definitions/system-deployment-set" } - - # Corresponds to SystemDeployment in Baserock data model. - system-deployment: - type: object - - required: [ 'type', 'location' ] - additionalProperties: true - - properties: - type: { type: string } - location: { type: string } - - -# Corresponds to Cluster in Baserock data model. -type: object - -#required: [ 'name', 'kind', 'systems' ] -additionalProperties: false - -properties: - name: { type: string } - kind: { enum: [ "cluster" ] } - description: { type: string } - - systems: - type: array - items: { $ref: "#/definitions/system-deployment-set" } diff --git a/schemas/007/defaults.json-schema b/schemas/007/defaults.json-schema deleted file mode 100644 index 2f71342..0000000 --- a/schemas/007/defaults.json-schema +++ /dev/null @@ -1,66 +0,0 @@ -$schema: http://json-schema.org/draft-04/schema# -id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/defaults.json-schema - -description: | - This is a JSON-Schema description of the DEFAULTS file specified in the - Baserock definitions format. DEFAULTS is a YAML file that contains global - defaults for a set of Baserock definitions. - - This JSON-Schema file is valid for VERSION 7 of the Baserock definitions - YAML serialisation format. - - The Baserock definitions YAML serialisation format is the recommended way of - representing Baserock definitions on disk. The actual data model is described - separately. See for more information. - - This schema is represented as YAML, so that it can be edited more easily. - You may need to convert to JSON if using a JSON-Schema tool that expects - its input to be an actual string containing data serialised as JSON. - -definitions: - command-sequence: - type: array - items: {type: string} - - build-system: - type: object - additionalProperties: false - properties: - build-commands: {$ref: '#/definitions/command-sequence'} - configure-commands: {$ref: '#/definitions/command-sequence'} - install-commands: {$ref: '#/definitions/command-sequence'} - strip-commands: {$ref: '#/definitions/command-sequence'} - - split-rules: - type: array - items: - type: object - - required: [artifact, include] - additionalProperties: false - - properties: - artifact: {type: string} - include: - type: array - items: - type: string - format: regex - -type: object -additionalProperties: false - -properties: - # Predefined build systems. - build-systems: - type: object - patternProperties: - ^.*$: {$ref: '#/definitions/build-system'} - - # Predefined artifact splitting rules. - split-rules: - type: object - additionalProperties: false - properties: - chunk: {$ref: '#/definitions/split-rules'} - stratum: {$ref: '#/definitions/split-rules'} diff --git a/schemas/007/stratum.json-schema b/schemas/007/stratum.json-schema deleted file mode 100644 index 0330f37..0000000 --- a/schemas/007/stratum.json-schema +++ /dev/null @@ -1,99 +0,0 @@ -$schema: http://json-schema.org/draft-04/schema# -id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/chunk.json-schema - -description: | - This is a JSON-Schema description of a 'stratum' .morph file, which is part - of the Baserock definitions YAML representation format. - - This JSON-Schema file is valid for VERSION 7 of the Baserock definitions - YAML serialisation format. - - The Baserock definitions format is the recommended way of representing - Baserock definitions on disk. The actual data model is described separately. - See https://wiki.baserock.org/definitions for more information. - - This schema is represented as YAML, so that it can be edited more easily. - You may need to convert to JSON if using a JSON-Schema tool that expects - its input to be an actual string containing data serialised as JSON. - -definitions: - # Defines one or more instances of StratumArtifact from the Baserock data - # model. - split-rules: - type: array - items: - type: object - - required: [artifact, include] - additionalProperties: false - - properties: - artifact: {type: string} - include: - type: array - items: - type: string - format: regex - - # Corresponds to ChunkReference in Baserock data model. - chunk-reference: - type: object - - required: [ 'repo', 'ref' ] - additionalProperties: false - - properties: - name: { type: string } - morph: { type: string } - repo: { type: string } - ref: { type: string } - unpetrify-ref: { type: string } - build-mode: { type: string } - prefix: { type: string } - build-system: { type: string } - build-depends: - type: array - items: { type: string } - artifacts: - type: object - # This defines which chunk artifacts go in which stratum artifact. - # E.g. "glibc-nss: build-essential-runtime" specifies the glibc-nss - # chunk artifact should go in the build-essential-runtime stratum - # artifact. - patternProperties: - ^.*$: { type: string } - - # This doesn't need any special treatment in the Baserock data model because - # it's a link to another stratum definition, without any extra info. - stratum-reference: - type: object - - required: [ 'morph' ] - additionalProperties: false - - properties: - morph: { type: string } - - -# Corresponds to Stratum in Baserock data model. -type: object - -required: [ 'name', 'kind', 'chunks' ] -additionalProperties: false - -properties: - name: { type: string } - kind: { enum: [ "stratum" ] } - description: { type: string } - - build-depends: - type: array - items: - $ref: "#/definitions/stratum-reference" - - products: - $ref: "#/definitions/split-rules" - - chunks: - type: array - items: { $ref: "#/definitions/chunk-reference" } diff --git a/schemas/007/system.json-schema b/schemas/007/system.json-schema deleted file mode 100644 index a2fc0c5..0000000 --- a/schemas/007/system.json-schema +++ /dev/null @@ -1,59 +0,0 @@ -$schema: http://json-schema.org/draft-04/schema# -id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/system.json-schema - -description: | - This is a JSON-Schema description of a 'system' .morph file, which is part of - the Baserock definitions YAML representation format. - - This JSON-Schema file is valid for VERSION 7 of the Baserock definitions - YAML serialisation format. - - The Baserock definitions format is the recommended way of representing - Baserock definitions on disk. The actual data model is described separately. - See https://wiki.baserock.org/definitions for more information. - - This schema is represented as YAML, so that it can be edited more easily. - You may need to convert to JSON if using a JSON-Schema tool that expects - its input to be an actual string containing data serialised as JSON. - -definitions: - # In the Baserock data model, this becomes a list of links to StratumArtifact - # entities. - stratum-reference: - type: object - - required: [ 'morph' ] - additionalProperties: false - - properties: - name: { type: string } - morph: { type: string } - artifacts: - type: array - items: { type: string } - - -# Corresponds to System in Baserock data model. -system: -type: object - -required: [ 'name', 'kind', 'strata' ] -additionalProperties: false - -properties: - name: { type: string } - kind: { enum: [ "system" ] } - description: { type: string } - - # Morph and YBD will only accept certain values for 'arch' based on - # hardcoded conditions in those tools. - arch: { type: string } - - strata: - type: array - items: - $ref: "#/definitions/stratum-reference" - - configuration-extensions: - type: array - items: { type: string } diff --git a/schemas/baserock.owl b/schemas/baserock.owl new file mode 100644 index 0000000..33113d8 --- /dev/null +++ b/schemas/baserock.owl @@ -0,0 +1,295 @@ +# Copyright (C) 2015 Codethink Limited +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; version 2 of the License. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with this program. If not, see . + + +# This schema describes the Baserock data model. It describes how the data +# can be represented in computer memory, it doesn't specify anything about +# how it should be stored on disk or transferred. +# +# Please see README.schemas, and http://wiki.baserock.org/definitions/current/ +# for more information. +# +# This is not a brilliant schema, in Linked Data terms, because it's using +# Baserock-specific terminology and a rigid layout, instead of being a generic +# vocabulary for describing how to assemble software. However, it maps closely +# to the format that the existing Baserock reference system definitions use. +# We hope to produce a simpler and more flexible 2.x version of this schema in +# future. + + +# Partial OWL and RDF Schema glossary: +# +# domain: the set of objects that a can have a property. +# range: the set of possible values for a property. +# +# ObjectProperty: +# a property whose value must be another resource. +# DatatypeProperty: +# a property whose value is one of the datatype defined by XML Schema ("xsd") +# FunctionalProperty: +# a property which can only have one value per resource +# InverseFunctionalProperty: +# a property which can only have one resource per value + + +# Metadata + +@prefix : . +@prefix owl: . +@prefix rdfs: . +@prefix rdf: . +@prefix xsd: . +@prefix dc: . + +: a owl:Ontology ; + dc:title "Schema for Baserock data model" ; + dc:creator "The Baserock Project" ; + # Versioned according to Semantic Versioning http://www.semver.org/ + owl:versionInfo "0.9.0" . + + +## Entities + +# Source definitions + +:Morphology a owl:Class ; + rdfs:comment "A definition file." . + +:Cluster a owl:Class ; + rdfs:subClassOf :Morphology ; + rdfs:comment "Instructions for deploying one or systems." ; + owl:disjointWith :System, :Stratum, :Chunk . + +:System a owl:Class ; + rdfs:subClassOf :Morphology ; + rdfs:comment "A collection of strata in a form that can be executed." ; + owl:disjointWith :Cluster, :Stratum, :Chunk . + +:Stratum a owl:Class ; + rdfs:subClassOf :Morphology ; + rdfs:comment "A set of related chunks." ; + owl:disjointWith :Cluster, :System, :Chunk . + +:Chunk a owl:Class ; + rdfs:subClassOf :Morphology ; + rdfs:comment "An individual component, that can be built from a Git repository." ; + owl:disjointWith :Cluster, :System, :Stratum . + +# Container contents + +:SystemDeployment a owl:Class ; + rdfs:comment "Information for deploying one system of a cluster." . + +:ChunkReference a owl:Class ; + rdfs:comment "An instance of a chunk within a stratum." . + +# Products (for artifact split rules). + +:Artifact a owl:Class ; + rdfs:comment "One part of the result of building a morphology. The output of a build is split according to patterns, so there are multiple artifacts produced for a given source." . + +:StratumArtifact a owl:Class ; + rdfs:subClassOf :Artifact ; + rdfs:comment "Part of the result of building a stratum." ; + owl:disjointWith :ChunkArtifact. + +:ChunkArtifact a owl:Class ; + rdfs:subClassOf :Artifact ; + rdfs:comment "Part of the result of building a chunk." ; + owl:disjointWith :StratumArtifact. + + +## Shared properties + +# 'name' becomes part of the URL when we import definition .morph files as RDF, +# so it doesn't need a property. + +# Use dc:description for 'description', see: +# http://dublincore.org/documents/2012/06/14/dcmi-terms/?v=terms#terms-description + + +## Cluster-specific properties + +:containsSystemDeployment a owl:ObjectProperty ; + rdfs:domain :Cluster ; + rdfs:range :SystemDeployment ; + owl:minCardinality 1 . + + +## SystemDeployment-specific properties + +:deploysSystem a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :SystemDeployment ; + rdfs:range :System . + +:hasLabel a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :SystemDeployment ; + rdfs:range xsd:string . + +:hasType a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :SystemDeployment ; + rdfs:range xsd:string ; + rdfs:comment "The .write extension used to perform the deployment." . + +:hasLocation a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :SystemDeployment ; + rdfs:range xsd:string ; + rdfs:comment "Deployment location. This is passed to the selected .write extension" . + +# FIXME: this is actually a key-value mapping, how do you do that in RDF properly? +:hasConfigurationSetting a owl:DatatypeProperty ; + rdfs:domain :SystemDeployment ; + rdfs:range xsd:string ; + rdfs:comment "Arbitrary key=value pair that is set in the environment of the .configure and .write extensions during deployment." . + + +## System-specific properties + +:containsStratumArtifact a owl:ObjectProperty ; + rdfs:domain :System ; + rdfs:range :StratumArtifact ; + owl:minCardinality 1 . + +# A build tool will only understand a certain set of architectures, but I think +# that should not be part of the data model. +:hasArchitecture a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :System ; + rdfs:range xsd:string . + +:hasConfigurationExtension a owl:DatatypeProperty ; + rdfs:domain :System ; + rdfs:range xsd:string ; + rdfs:comment "A .configure extension to be run when with system is deployed." . + + +## Stratum-specific properties + +:producesStratumArtifact a owl:ObjectProperty , rdf:Seq ; + rdfs:domain :Stratum ; + rdfs:range :StratumArtifact ; + rdfs:comment "iDescribes how this artifact is split once all chunks are built." . + +:hasStratumBuildDependency a owl:ObjectProperty ; + rdfs:domain :Stratum ; + rdfs:range :Stratum . + +:containsChunkReference a owl:ObjectProperty ; + rdfs:domain :Stratum ; + rdfs:range :ChunkReference ; + owl:minCardinality 1 . + + +## ChunkReference-specific properties + +:refersToChunk a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :ChunkReference ; + rdfs:range :Chunk . + +:repo a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :ChunkReference ; + rdfs:range xsd:string ; + rdfs:comment "Git repo that this chunk's build instructions should be run in. Can be a keyed URL according to the repo-alias mapping, which isn't currently defined in this data model." . + +:ref a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :ChunkReference ; + rdfs:range xsd:string ; + rdfs:comment "Ref of the Git repo that should be checked out before building. Usually a SHA1." . + +:unpetrifyRef a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :ChunkReference ; + rdfs:range xsd:string ; + rdfs:comment "Name of the ref that should be checked out (useful when 'ref' is a SHA1 to keep track of the actual branch/tag name)." . + +:hasChunkBuildDependency a owl:ObjectProperty ; + rdfs:domain :ChunkReference ; + rdfs:range :Chunk . + +:prefix a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :ChunkReference ; + rdfs:range xsd:string ; + rdfs:comment "Value of the PREFIX environment variable in the build environment (defaults to /usr)" . + +# FIXME: it's possible to specify in OWL that 'bootstrap' and 'normal' are the +# only valid values. +:buildMode a owl:DatatypeProperty , owl:FunctionalProperty ; + rdfs:domain :ChunkReference ; + rdfs:range xsd:string . + + +## Chunk-specific properties + +# build-system isn't included here, as it overlaps with the *-commands +# fields in an unfortunate way. + +# Note that representing lists of things in RDF is a bit of a pain. +# http://smiy.sourceforge.net/olo/spec/orderedlistontology.html might +# be worth investigating. + +:producesChunkArtifact a owl:ObjectProperty , rdf:Seq ; + rdfs:domain :Chunk ; + rdfs:range :ChunkArtifact ; + rdfs:comment "Describes how this artifact is split once built." . + +:maxJobs a owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range xsd:integer ; + rdfs:comment "Number of parallel jobs that can be run for this chunk. Only useful if set to 1, to mark components which have Makefiles that do not work with `make -j N`.". + +:CommandSequence a owl:Class ; + rdfs:subClassOf rdf:Seq ; + rdfs:comment "An ordered sequence of commands." . + +:preConfigureCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + +:configureCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + +:postConfigureCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + +:preBuildCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + +:buildCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + +:postBuildCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + +:preInstallCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + +:installCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + +:postInstallCommands a owl:ObjectProperty , owl:FunctionalProperty ; + rdfs:domain :Chunk ; + rdfs:range :CommandSequence . + + +# Artifact properties + +:includes a owl:DatatypeProperty , rdf:Seq ; + rdfs:domain :Artifact ; + rdfs:range xsd:string ; + rdfs:comment "A regular expression pattern. The results of a build are matched against this pattern and any that match will be included in that artifact." . diff --git a/schemas/chunk.json-schema b/schemas/chunk.json-schema new file mode 100644 index 0000000..8de2fb5 --- /dev/null +++ b/schemas/chunk.json-schema @@ -0,0 +1,116 @@ +$schema: http://json-schema.org/draft-04/schema# +id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/chunk.json-schema + +description: | + This is a JSON-Schema description of a 'chunk' .morph file, which is part of + the Baserock definitions YAML representation format. + + This JSON-Schema file is valid for VERSION 7 of the Baserock definitions + YAML serialisation format. + + The Baserock definitions format is the recommended way of representing + Baserock definitions on disk. The actual data model is described separately. + See https://wiki.baserock.org/definitions for more information. + + This schema is represented as YAML, so that it can be edited more easily. + You may need to convert to JSON if using a JSON-Schema tool that expects + its input to be an actual string containing data serialised as JSON. + +definitions: + # Corresponds to CommandSequence in Baserock data model. + command-sequence: + type: array + items: { type: string } + + # Corresponds to DeviceNode in Baserock data model. + device-node: + type: object + required: [type, filename, gid, uid, major, minor, permissions] + properties: + type: { type: string } + filename: { type: string } + gid: { type: integer } + uid: { type: integer } + major: { type: integer } + minor: { type: integer } + permissions: { type: string } + + # Defines one or more instances of ChunkArtifact from the Baserock data model. + split-rules: + type: array + items: + type: object + + required: [artifact, include] + additionalProperties: false + + properties: + artifact: {type: string} + include: + type: array + items: + type: string + format: regex + + system-integration-commands: + type: object + patternProperties: + # The property name here should correspond to the name of the chunk's + # artifacts, probably the '-bins' artifact if you are using the normal + # splitting rules. + ^.*$: + type: object + patternProperties: + ^.*$: + $ref: "#/definitions/command-sequence" + +# Corresponds to Chunk in Baserock data model. +type: object + +additionalProperties: false +required: [ 'name', 'kind'] + +properties: + name: { type: string } + kind: { enum: [ "chunk" ] } + + description: { type: string } + + build-system: { type: string } + max-jobs: { type: integer } + + products: + $ref: "#/definitions/split-rules" + + pre-configure-commands: + $ref: "#/definitions/command-sequence" + configure-commands: + $ref: "#/definitions/command-sequence" + post-configure-commands: + $ref: "#/definitions/command-sequence" + pre-build-commands: + $ref: "#/definitions/command-sequence" + build-commands: + $ref: "#/definitions/command-sequence" + post-build-commands: + $ref: "#/definitions/command-sequence" + pre-install-commands: + $ref: "#/definitions/command-sequence" + install-commands: + $ref: "#/definitions/command-sequence" + post-install-commands: + $ref: "#/definitions/command-sequence" + pre-strip-commands: + $ref: "#/definitions/command-sequence" + strip-commands: + $ref: "#/definitions/command-sequence" + post-strip-commands: + $ref: "#/definitions/command-sequence" + + system-integration: + $ref: "#/definitions/system-integration-commands" + + devices: + type: array + items: + $ref: "#/definitions/device-node" diff --git a/schemas/cluster.json-schema b/schemas/cluster.json-schema new file mode 100644 index 0000000..1a628c7 --- /dev/null +++ b/schemas/cluster.json-schema @@ -0,0 +1,64 @@ +$schema: http://json-schema.org/draft-04/schema# +id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/cluster.json-schema + +description: + This is a JSON-Schema description of a 'cluster' .morph file, which is part + of the Baserock definitions YAML representation format. + + This JSON-Schema file is valid for VERSION 7 of the Baserock definitions + YAML serialisation format. + + The Baserock definitions format is the recommended way of representing + Baserock definitions on disk. The actual data model is described separately. + See https://wiki.baserock.org/definitions for more information. + + This schema is represented as YAML, so that it can be edited more easily. + You may need to convert to JSON if using a JSON-Schema tool that expects + its input to be an actual string containing data serialised as JSON. + +definitions: + # A reference to a System, plus one or more SystemDeployment for that system. + system-deployment-set: + type: object + + required: [ 'morph', 'deploy' ] + additionalProperties: false + + properties: + morph: { type: string } + deploy-defaults: + type: object + additionalProperties: true + deploy: + patternProperties: + ^.*$: { $ref: "#/definitions/system-deployment" } + subsystems: + type: array + items: { $ref: "#/definitions/system-deployment-set" } + + # Corresponds to SystemDeployment in Baserock data model. + system-deployment: + type: object + + required: [ 'type', 'location' ] + additionalProperties: true + + properties: + type: { type: string } + location: { type: string } + + +# Corresponds to Cluster in Baserock data model. +type: object + +#required: [ 'name', 'kind', 'systems' ] +additionalProperties: false + +properties: + name: { type: string } + kind: { enum: [ "cluster" ] } + description: { type: string } + + systems: + type: array + items: { $ref: "#/definitions/system-deployment-set" } diff --git a/schemas/defaults.json-schema b/schemas/defaults.json-schema new file mode 100644 index 0000000..2f71342 --- /dev/null +++ b/schemas/defaults.json-schema @@ -0,0 +1,66 @@ +$schema: http://json-schema.org/draft-04/schema# +id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/defaults.json-schema + +description: | + This is a JSON-Schema description of the DEFAULTS file specified in the + Baserock definitions format. DEFAULTS is a YAML file that contains global + defaults for a set of Baserock definitions. + + This JSON-Schema file is valid for VERSION 7 of the Baserock definitions + YAML serialisation format. + + The Baserock definitions YAML serialisation format is the recommended way of + representing Baserock definitions on disk. The actual data model is described + separately. See for more information. + + This schema is represented as YAML, so that it can be edited more easily. + You may need to convert to JSON if using a JSON-Schema tool that expects + its input to be an actual string containing data serialised as JSON. + +definitions: + command-sequence: + type: array + items: {type: string} + + build-system: + type: object + additionalProperties: false + properties: + build-commands: {$ref: '#/definitions/command-sequence'} + configure-commands: {$ref: '#/definitions/command-sequence'} + install-commands: {$ref: '#/definitions/command-sequence'} + strip-commands: {$ref: '#/definitions/command-sequence'} + + split-rules: + type: array + items: + type: object + + required: [artifact, include] + additionalProperties: false + + properties: + artifact: {type: string} + include: + type: array + items: + type: string + format: regex + +type: object +additionalProperties: false + +properties: + # Predefined build systems. + build-systems: + type: object + patternProperties: + ^.*$: {$ref: '#/definitions/build-system'} + + # Predefined artifact splitting rules. + split-rules: + type: object + additionalProperties: false + properties: + chunk: {$ref: '#/definitions/split-rules'} + stratum: {$ref: '#/definitions/split-rules'} diff --git a/schemas/stratum.json-schema b/schemas/stratum.json-schema new file mode 100644 index 0000000..0330f37 --- /dev/null +++ b/schemas/stratum.json-schema @@ -0,0 +1,99 @@ +$schema: http://json-schema.org/draft-04/schema# +id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/chunk.json-schema + +description: | + This is a JSON-Schema description of a 'stratum' .morph file, which is part + of the Baserock definitions YAML representation format. + + This JSON-Schema file is valid for VERSION 7 of the Baserock definitions + YAML serialisation format. + + The Baserock definitions format is the recommended way of representing + Baserock definitions on disk. The actual data model is described separately. + See https://wiki.baserock.org/definitions for more information. + + This schema is represented as YAML, so that it can be edited more easily. + You may need to convert to JSON if using a JSON-Schema tool that expects + its input to be an actual string containing data serialised as JSON. + +definitions: + # Defines one or more instances of StratumArtifact from the Baserock data + # model. + split-rules: + type: array + items: + type: object + + required: [artifact, include] + additionalProperties: false + + properties: + artifact: {type: string} + include: + type: array + items: + type: string + format: regex + + # Corresponds to ChunkReference in Baserock data model. + chunk-reference: + type: object + + required: [ 'repo', 'ref' ] + additionalProperties: false + + properties: + name: { type: string } + morph: { type: string } + repo: { type: string } + ref: { type: string } + unpetrify-ref: { type: string } + build-mode: { type: string } + prefix: { type: string } + build-system: { type: string } + build-depends: + type: array + items: { type: string } + artifacts: + type: object + # This defines which chunk artifacts go in which stratum artifact. + # E.g. "glibc-nss: build-essential-runtime" specifies the glibc-nss + # chunk artifact should go in the build-essential-runtime stratum + # artifact. + patternProperties: + ^.*$: { type: string } + + # This doesn't need any special treatment in the Baserock data model because + # it's a link to another stratum definition, without any extra info. + stratum-reference: + type: object + + required: [ 'morph' ] + additionalProperties: false + + properties: + morph: { type: string } + + +# Corresponds to Stratum in Baserock data model. +type: object + +required: [ 'name', 'kind', 'chunks' ] +additionalProperties: false + +properties: + name: { type: string } + kind: { enum: [ "stratum" ] } + description: { type: string } + + build-depends: + type: array + items: + $ref: "#/definitions/stratum-reference" + + products: + $ref: "#/definitions/split-rules" + + chunks: + type: array + items: { $ref: "#/definitions/chunk-reference" } diff --git a/schemas/system.json-schema b/schemas/system.json-schema new file mode 100644 index 0000000..a2fc0c5 --- /dev/null +++ b/schemas/system.json-schema @@ -0,0 +1,59 @@ +$schema: http://json-schema.org/draft-04/schema# +id: http://git.baserock.org/cgi-bin/cgit.cgi/baserock/baserock/definitions.git/tree/schemas/system.json-schema + +description: | + This is a JSON-Schema description of a 'system' .morph file, which is part of + the Baserock definitions YAML representation format. + + This JSON-Schema file is valid for VERSION 7 of the Baserock definitions + YAML serialisation format. + + The Baserock definitions format is the recommended way of representing + Baserock definitions on disk. The actual data model is described separately. + See https://wiki.baserock.org/definitions for more information. + + This schema is represented as YAML, so that it can be edited more easily. + You may need to convert to JSON if using a JSON-Schema tool that expects + its input to be an actual string containing data serialised as JSON. + +definitions: + # In the Baserock data model, this becomes a list of links to StratumArtifact + # entities. + stratum-reference: + type: object + + required: [ 'morph' ] + additionalProperties: false + + properties: + name: { type: string } + morph: { type: string } + artifacts: + type: array + items: { type: string } + + +# Corresponds to System in Baserock data model. +system: +type: object + +required: [ 'name', 'kind', 'strata' ] +additionalProperties: false + +properties: + name: { type: string } + kind: { enum: [ "system" ] } + description: { type: string } + + # Morph and YBD will only accept certain values for 'arch' based on + # hardcoded conditions in those tools. + arch: { type: string } + + strata: + type: array + items: + $ref: "#/definitions/stratum-reference" + + configuration-extensions: + type: array + items: { type: string } -- cgit v1.2.1