Package Metadata

Packages published to UDS Registry and consumed by other UDS products support a set of standard metadata annotations that improve discoverability and user experience across UDS products.

These annotations are defined under metadata.annotations in your zarf.yaml package config:

kind: ZarfPackageConfig
metadata:
  annotations:
    dev.uds.title: "Example Package"
    dev.uds.categories: "Development, Testing"

Production annotations

The following annotations are recommended for production packages and are used across UDS products:

Annotation	Description	Example	Products
`dev.uds.title`	Human-readable package title	`"GitLab Runner"`	UDS Registry, UDS Fleet, UDS Portal
`dev.uds.categories`	Dynamic category list	`"Software Dev, Kubernetes (K8s)"`	UDS Registry, UDS Fleet
`dev.uds.keywords`	Search keywords	`"CI/CD Pipelines, Automation, GitLab"`	UDS Registry
`dev.uds.tagline`	Short package tagline	`"Open Source CI/CD Job Execution Tool"`	UDS Registry
`dev.uds.icon`	Base64 icon as data URI	`"data:image/png;base64,iVBORw0KGgo..."`	UDS Registry, UDS Fleet, UDS Portal

Implementation guidelines

dev.uds.title

MUST be a human-readable title-case string that clearly identifies the package.
SHOULD match the official product name when packaging existing software.

dev.uds.categories

MUST be a comma-with-space-separated string ("Category One, Category Two").
SHOULD include 1-3 categories from these standard options:

Standard categories

AI
Cloud Native
Collaboration
Command And Control
Cybersecurity
Data Engineering
Databases
Digital Engineering
IT Management
Infrastructure
Kubernetes (K8s)
Load Balancing
Networking
Observability
Operator
Pipelines
Productivity
Security
Software Dev
Web

MAY include new categories when existing categories do not adequately describe the package.

dev.uds.keywords

MUST be a comma-with-space-separated string of 3-7 relevant search terms.
SHOULD include alternative terms and abbreviations users might search for.

dev.uds.tagline

MUST be one concise sentence (recommended 5-10 words) describing package function.

dev.uds.icon

MUST be encoded as a base64 data URI.
SHOULD use .png or .svg (.svg recommended), square aspect ratio, transparent background.
RECOMMENDED size: 200x200px.

Provisional annotations

These annotations are experimental and may evolve over time:

Annotation	Description	Example	Products
`dev.uds.system`	Whether a package is system-level (OS/firmware) vs application-level	`"true"`	UDS Fleet

UDS Package Requirements - pre-publish checklist for required capabilities and standards.
Create a UDS Package - end-to-end guide for building a package that meets UDS requirements.