robos:GitOpsDeployment

Validation shape for robos:GitOpsDeployment nodes in the devops package group.

Details

Class	robos:GitOpsDeployment
Also matches	robos:ArgoCDApplication
Shape id	urn:robos:shape:GitOpsDeploymentShape
Package	DevOps & Cloud (robos.devops) (devops)
Classification	Infrastructure & delivery
Schema.org type	schema:SoftwareApplication
Domain standard	opengitops.dev

Properties

Count is the minimum and maximum number of values (* means no maximum). The validator enforces both. The type column is documentation only; the validator does not check types.

Property	Count	Type	Rule or description
dcterms:title	1..*	xsd:string	GitOps Deployment must have a title.
robos:gitopsEngine	1..*	-	GitOps Deployment must declare engine (argocd, flux).
robos:sourceRepo	1..*	-	GitOps Deployment must specify source Git repository.
robos:targetCluster	1..*	-	GitOps Deployment must link to target Kubernetes Cluster.
robos:targetNamespace	1..*	-	GitOps Deployment must specify target namespace.

Example node

This node comes from .robos/kgraphs/devops/package.jsonld in the RobOS repository. That graph holds sample data for a fictional company, so treat the values as illustrations.

{
  "@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/"
}

Validate the example

Save the example as node.json in the repository root, then run:

node -e "const { SHACLValidator } = require('./packages/robos-graph/lib/shacl-validator'); console.log(new SHACLValidator().validate([require('./node.json')]).conforms)"

The command prints true when the node meets every rule for its types.