Schema: robos:GitOpsDeployment

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:GitOpsDeployment in the devops package store.

Table of contents

  1. Specification Metadata
  2. Upstream Schema Basis (Refers From) & Global Standards Provenance
  3. Entity Relationship & Schema Context
  4. Property Constraints & SHACL Rules
  5. Canonical OSLC JSON-LD Example
  6. Programmatic SHACL Validation

Specification Metadata

Upstream Schema Basis (Refers From) & Global Standards Provenance

This RobOS schema is modeled after and directly aligns with two levels of global standards:

  • Universal Schema.org Class: https://schema.org/SoftwareApplication (100% interoperability with search engines, web indexers, and general AI reasoning)
  • Specialized Domain Standard: https://opengitops.dev/ (de facto standard for domain-specific ALM, BDD, or infrastructure operations)
  • Canonical Reference: https://schema.org/SoftwareApplication
  • Agent Guidelines: When autonomous agents generate, expand, or validate instances of robos:GitOpsDeployment, they MUST adhere to and base their output on this referred schema object and universal Schema.org parent class, extending it with RobOS SDLC properties.

Entity Relationship & Schema Context

GitOps Deployment robos:GitOpsDeployment

Governed by W3C SHACL shape urn:robos:shape:GitOpsDeploymentShape within the DevOps & Cloud (robos.devops) (robos.devops) package store.

dcterms:title robos:gitopsEngine robos:sourceRepo robos:targetCluster robos:targetNamespace

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string GitOps Deployment must have a title.
robos:gitopsEngine gitopsEngine 1..* xsd:string GitOps Deployment must declare engine (argocd, flux).
robos:sourceRepo sourceRepo 1..* xsd:string GitOps Deployment must specify source Git repository.
robos:targetCluster targetCluster 1..* xsd:string GitOps Deployment must link to target Kubernetes Cluster.
robos:targetNamespace targetNamespace 1..* xsd:string GitOps Deployment must specify target namespace.

Canonical OSLC JSON-LD Example 

{
  "@id": "urn:robos:gitops:checkout-service-argocd",
  "@type": [
    "oslc_config:ConfigurationItem",
    "robos:GitOpsDeployment",
    "robos:ArgoCDApplication",
    "schema:SoftwareApplication"
  ],
  "dcterms:title": "Billing & Checkout ArgoCD GitOps Application",
  "dcterms:description": "Declarative GitOps deployment application managing Kubernetes manifests via ArgoCD.",
  "robos:gitopsEngine": "argocd",
  "robos:sourceRepo": "https://github.com/acme/gitops-manifests",
  "robos:sourcePath": "charts/billing-api",
  "robos:targetCluster": "urn:robos:cluster:prod-us-east-eks",
  "robos:targetNamespace": "production",
  "robos:syncPolicy": "automated",
  "robos:package": "devops",
  "robos:namespace": "robos.devops",
  "robos:schemaOrgType": "https://schema.org/SoftwareApplication",
  "robos:domainStandard": "https://opengitops.dev/"
}

Programmatic SHACL Validation 

const { SHACLValidator } = require('/usr/local/share/robos/robos-graph/lib/shacl-validator');
const { OSLCGraphParser, OSLC_CONTEXT } = require('/usr/local/share/robos/robos-graph/lib/oslc-parser');

const validator = new SHACLValidator();
const result = validator.validateGraph(new OSLCGraphParser({
  "@context": OSLC_CONTEXT,
  "robos:nodes": [
    {
        "@id": "urn:robos:gitops:checkout-service-argocd",
        "@type": [
            "oslc_config:ConfigurationItem",
            "robos:GitOpsDeployment",
            "robos:ArgoCDApplication",
            "schema:SoftwareApplication"
        ],
        "dcterms:title": "Billing & Checkout ArgoCD GitOps Application",
        "dcterms:description": "Declarative GitOps deployment application managing Kubernetes manifests via ArgoCD.",
        "robos:gitopsEngine": "argocd",
        "robos:sourceRepo": "https://github.com/acme/gitops-manifests",
        "robos:sourcePath": "charts/billing-api",
        "robos:targetCluster": "urn:robos:cluster:prod-us-east-eks",
        "robos:targetNamespace": "production",
        "robos:syncPolicy": "automated",
        "robos:package": "devops",
        "robos:namespace": "robos.devops",
        "robos:schemaOrgType": "https://schema.org/SoftwareApplication",
        "robos:domainStandard": "https://opengitops.dev/"
    }
  ],
}));

console.log("Conforms:", result.conforms); // Expected: true