Skip to content

chore(docs): zarf package annotations #1429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrewg-xyz merged 5 commits into from
Apr 15, 2025
Merged

chore(docs): zarf package annotations #1429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5f291e2
chore(docs): zarf package annotations
andrewg-xyz Apr 5, 2025
87d2a81
update
andrewg-xyz Apr 15, 2025
575a414
lint
andrewg-xyz Apr 15, 2025
b0ece40
Merge branch 'main' into isgoodideaquestionmark
chance-coleman Apr 15, 2025
9cbd276
Apply suggestions from code review
andrewg-xyz Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/backup-restore/zarf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ metadata:
version: "0.40.0"
# x-release-please-end
x-uds-dependencies: ["base"]
annotations:
dev.uds.title: UDS Core (Backup and Restore)
dev.uds.tagline: Enable volumes and Kubernetes objects to be backed up and restored
dev.uds.category: UDS-Core, Backup, Restore
dev.uds.keywords: uds,backup,restore,velero

components:
# Velero
Expand Down
5 changes: 5 additions & 0 deletions packages/base/zarf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ metadata:
version: "0.40.0"
# x-release-please-end
x-uds-dependencies: []
annotations:
dev.uds.title: UDS Core (Base)
dev.uds.tagline: Provides the base for all other UDS Core Functional Layers
dev.uds.category: UDS-Core
dev.uds.keywords: uds,pepr,istio,operator,policies

components:
- name: uds-operator-config
Expand Down
5 changes: 5 additions & 0 deletions packages/identity-authorization/zarf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ metadata:
version: "0.40.0"
# x-release-please-end
x-uds-dependencies: ["base"]
annotations:
dev.uds.title: UDS Core (Identity & Authorization)
dev.uds.tagline: Enables authentication and authorization functionality
dev.uds.category: UDS-Core, Identity, Authorization
dev.uds.keywords: uds,keycloak,authservice

components:
# Keycloak
Expand Down
5 changes: 5 additions & 0 deletions packages/logging/zarf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ metadata:
version: "0.40.0"
# x-release-please-end
x-uds-dependencies: ["base"]
annotations:
dev.uds.title: UDS Core (Logging)
dev.uds.tagline: Enables backend log storage and log shipping capabilities
dev.uds.category: UDS-Core,Logging
dev.uds.keywords: uds,logging,loki,vector

components:
# Loki
Expand Down
5 changes: 5 additions & 0 deletions packages/metrics-server/zarf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ metadata:
version: "0.40.0"
# x-release-please-end
x-uds-dependencies: ["base"]
annotations:
dev.uds.title: UDS Core (Metrics Server)
dev.uds.tagline: Enables metrics collection capabilities
dev.uds.category: UDS-Core,Metrics
dev.uds.keywords: uds,metrics,metrics-server

components:
# Metrics Server
Expand Down
5 changes: 5 additions & 0 deletions packages/monitoring/zarf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ metadata:
version: "0.40.0"
# x-release-please-end
x-uds-dependencies: ["base", "identity-authorization"]
annotations:
dev.uds.title: UDS Core (Monitoring)
dev.uds.tagline: Enables frontend log data, metrics monitoring, and alerting
dev.uds.category: UDS-Core,Monitoring
dev.uds.keywords: uds,prometheus,grafana

components:
# Prometheus
Expand Down
5 changes: 5 additions & 0 deletions packages/runtime-security/zarf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ metadata:
version: "0.40.0"
# x-release-please-end
x-uds-dependencies: ["base", "identity-authorization"]
annotations:
dev.uds.title: UDS Core (Runtime Security)
dev.uds.tagline: Enable more advanced security with Runtime inspection
dev.uds.category: UDS-Core,Runtime Security
dev.uds.keywords: uds,neuvector

components:
# Neuvector
Expand Down
7 changes: 6 additions & 1 deletion packages/standard/zarf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@
kind: ZarfPackageConfig
metadata:
name: core
description: "UDS Core"
description: "UDS Core is a collection of several individual applications combined into a single Zarf Package, that establishes a secure baseline for secure cloud-native systems."
authors: "Defense Unicorns - Product"
# x-release-please-start-version
version: "0.40.0"
# x-release-please-end
annotations:
dev.uds.title: UDS Core
dev.uds.tagline: Collection of packages that enable a secure baseline for cloud-native systems
dev.uds.category: UDS-Core
dev.uds.keywords: uds,core

components:
- name: uds-operator-config
Expand Down