From 5f291e27d6804c7713ba2a17b343881a14b76fac Mon Sep 17 00:00:00 2001 From: Andrew Greene Date: Sat, 5 Apr 2025 15:58:06 -0600 Subject: [PATCH 1/4] chore(docs): zarf package annotations --- packages/backup-restore/zarf.yaml | 5 +++++ packages/base/zarf.yaml | 5 +++++ packages/identity-authorization/zarf.yaml | 5 +++++ packages/logging/zarf.yaml | 5 +++++ packages/metrics-server/zarf.yaml | 5 +++++ packages/monitoring/zarf.yaml | 5 +++++ packages/runtime-security/zarf.yaml | 5 +++++ packages/standard/zarf.yaml | 5 +++++ 8 files changed, 40 insertions(+) diff --git a/packages/backup-restore/zarf.yaml b/packages/backup-restore/zarf.yaml index 86d2cb3ac9..1c285790ce 100644 --- a/packages/backup-restore/zarf.yaml +++ b/packages/backup-restore/zarf.yaml @@ -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: Components for backup and restore + dev.uds.category: Backup and Restore + dev.uds.keywords: uds,backup,restore,velero components: # Velero diff --git a/packages/base/zarf.yaml b/packages/base/zarf.yaml index 2bc007a988..bda5764a40 100644 --- a/packages/base/zarf.yaml +++ b/packages/base/zarf.yaml @@ -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: UDS Core mTLS, zero trust, and Pepr + dev.uds.category: Base + dev.uds.keywords: uds,pepr,istio components: - name: uds-operator-config diff --git a/packages/identity-authorization/zarf.yaml b/packages/identity-authorization/zarf.yaml index e82c299509..ef42c0b9f8 100644 --- a/packages/identity-authorization/zarf.yaml +++ b/packages/identity-authorization/zarf.yaml @@ -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: Components for identity and authorization + dev.uds.category: Identity, Authorization + dev.uds.keywords: uds,keycloak,authservice components: # Keycloak diff --git a/packages/logging/zarf.yaml b/packages/logging/zarf.yaml index c3e621b846..0dbfc9f4ce 100644 --- a/packages/logging/zarf.yaml +++ b/packages/logging/zarf.yaml @@ -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: Components for logging + dev.uds.category: Logging + dev.uds.keywords: uds,logging,loki,vector components: # Loki diff --git a/packages/metrics-server/zarf.yaml b/packages/metrics-server/zarf.yaml index bc6aeb0cfb..35eed4c781 100644 --- a/packages/metrics-server/zarf.yaml +++ b/packages/metrics-server/zarf.yaml @@ -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: Components for metrics + dev.uds.category: Metrics + dev.uds.keywords: uds,metrics,metrics-server components: # Metrics Server diff --git a/packages/monitoring/zarf.yaml b/packages/monitoring/zarf.yaml index d9713b9ea8..88cde247a6 100644 --- a/packages/monitoring/zarf.yaml +++ b/packages/monitoring/zarf.yaml @@ -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: Components for monitoring + dev.uds.category: Monitoring + dev.uds.keywords: uds,prometheus,grafana components: # Prometheus diff --git a/packages/runtime-security/zarf.yaml b/packages/runtime-security/zarf.yaml index a9a7cd7084..85349b63e2 100644 --- a/packages/runtime-security/zarf.yaml +++ b/packages/runtime-security/zarf.yaml @@ -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: Components for runtime security + dev.uds.category: Runtime Security + dev.uds.keywords: uds,neuvector components: # Neuvector diff --git a/packages/standard/zarf.yaml b/packages/standard/zarf.yaml index 54d4c60fd8..e48ef7dd42 100644 --- a/packages/standard/zarf.yaml +++ b/packages/standard/zarf.yaml @@ -9,6 +9,11 @@ metadata: # x-release-please-start-version version: "0.40.0" # x-release-please-end + annotations: + dev.uds.title: UDS Core + dev.uds.tagline: Standard components for UDS Core + dev.uds.category: Core + dev.uds.keywords: uds,core components: - name: uds-operator-config From 87d2a8125936e83d108a34b7d3fd64ec58274016 Mon Sep 17 00:00:00 2001 From: Andrew Greene Date: Tue, 15 Apr 2025 12:06:56 -0600 Subject: [PATCH 2/4] update --- packages/backup-restore/zarf.yaml | 4 ++-- packages/base/zarf.yaml | 4 ++-- packages/identity-authorization/zarf.yaml | 4 ++-- packages/logging/zarf.yaml | 4 ++-- packages/metrics-server/zarf.yaml | 4 ++-- packages/monitoring/zarf.yaml | 4 ++-- packages/runtime-security/zarf.yaml | 4 ++-- packages/standard/zarf.yaml | 6 +++--- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/packages/backup-restore/zarf.yaml b/packages/backup-restore/zarf.yaml index 1c285790ce..10cf1b9e3f 100644 --- a/packages/backup-restore/zarf.yaml +++ b/packages/backup-restore/zarf.yaml @@ -12,8 +12,8 @@ metadata: x-uds-dependencies: ["base"] annotations: dev.uds.title: UDS Core (Backup and Restore) - dev.uds.tagline: Components for backup and restore - dev.uds.category: 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: diff --git a/packages/base/zarf.yaml b/packages/base/zarf.yaml index bda5764a40..abb1d8dfde 100644 --- a/packages/base/zarf.yaml +++ b/packages/base/zarf.yaml @@ -12,8 +12,8 @@ metadata: x-uds-dependencies: [] annotations: dev.uds.title: UDS Core (Base) - dev.uds.tagline: UDS Core mTLS, zero trust, and Pepr - dev.uds.category: 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 components: diff --git a/packages/identity-authorization/zarf.yaml b/packages/identity-authorization/zarf.yaml index ef42c0b9f8..38a1733b77 100644 --- a/packages/identity-authorization/zarf.yaml +++ b/packages/identity-authorization/zarf.yaml @@ -12,8 +12,8 @@ metadata: x-uds-dependencies: ["base"] annotations: dev.uds.title: UDS Core (Identity & Authorization) - dev.uds.tagline: Components for identity and authorization - dev.uds.category: Identity, Authorization + dev.uds.tagline: Enables authentication and authorization functionality + dev.uds.category: UDS-Core, Identity, Authorization dev.uds.keywords: uds,keycloak,authservice components: diff --git a/packages/logging/zarf.yaml b/packages/logging/zarf.yaml index 0dbfc9f4ce..ef2871482d 100644 --- a/packages/logging/zarf.yaml +++ b/packages/logging/zarf.yaml @@ -12,8 +12,8 @@ metadata: x-uds-dependencies: ["base"] annotations: dev.uds.title: UDS Core (Logging) - dev.uds.tagline: Components for logging - dev.uds.category: 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: diff --git a/packages/metrics-server/zarf.yaml b/packages/metrics-server/zarf.yaml index 35eed4c781..1fecd78eb8 100644 --- a/packages/metrics-server/zarf.yaml +++ b/packages/metrics-server/zarf.yaml @@ -12,8 +12,8 @@ metadata: x-uds-dependencies: ["base"] annotations: dev.uds.title: UDS Core (Metrics Server) - dev.uds.tagline: Components for metrics - dev.uds.category: Metrics + dev.uds.tagline: Enables metrics collection capabilities + dev.uds.category: UDS-Core,Metrics dev.uds.keywords: uds,metrics,metrics-server components: diff --git a/packages/monitoring/zarf.yaml b/packages/monitoring/zarf.yaml index 88cde247a6..ca77e4b023 100644 --- a/packages/monitoring/zarf.yaml +++ b/packages/monitoring/zarf.yaml @@ -12,8 +12,8 @@ metadata: x-uds-dependencies: ["base", "identity-authorization"] annotations: dev.uds.title: UDS Core (Monitoring) - dev.uds.tagline: Components for monitoring - dev.uds.category: 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: diff --git a/packages/runtime-security/zarf.yaml b/packages/runtime-security/zarf.yaml index 85349b63e2..ab130b1c1b 100644 --- a/packages/runtime-security/zarf.yaml +++ b/packages/runtime-security/zarf.yaml @@ -12,8 +12,8 @@ metadata: x-uds-dependencies: ["base", "identity-authorization"] annotations: dev.uds.title: UDS Core (Runtime Security) - dev.uds.tagline: Components for runtime security - dev.uds.category: Runtime Security + dev.uds.tagline: Enable more advanced secureity with Runtime inspection + dev.uds.category: UDS-Core,Runtime Security dev.uds.keywords: uds,neuvector components: diff --git a/packages/standard/zarf.yaml b/packages/standard/zarf.yaml index e48ef7dd42..9a254ea9ee 100644 --- a/packages/standard/zarf.yaml +++ b/packages/standard/zarf.yaml @@ -4,15 +4,15 @@ 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: Standard components for UDS Core - dev.uds.category: 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: From 575a414d6f2a75f97251f193036be808b00a733a Mon Sep 17 00:00:00 2001 From: Andrew Greene Date: Tue, 15 Apr 2025 12:09:45 -0600 Subject: [PATCH 3/4] lint --- packages/metrics-server/zarf.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/metrics-server/zarf.yaml b/packages/metrics-server/zarf.yaml index 1fecd78eb8..5bd442d8eb 100644 --- a/packages/metrics-server/zarf.yaml +++ b/packages/metrics-server/zarf.yaml @@ -12,7 +12,7 @@ metadata: x-uds-dependencies: ["base"] annotations: dev.uds.title: UDS Core (Metrics Server) - dev.uds.tagline: Enables metrics collection capabilities + dev.uds.tagline: Enables metrics collection capabilities dev.uds.category: UDS-Core,Metrics dev.uds.keywords: uds,metrics,metrics-server From 9cbd276c2ee56f16c3c489ad38b2de2153ebf2e6 Mon Sep 17 00:00:00 2001 From: Andrew <46836330+andrewg-xyz@users.noreply.github.com> Date: Tue, 15 Apr 2025 14:23:06 -0600 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Micah Nagel --- packages/base/zarf.yaml | 2 +- packages/runtime-security/zarf.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/base/zarf.yaml b/packages/base/zarf.yaml index abb1d8dfde..5b57d81c75 100644 --- a/packages/base/zarf.yaml +++ b/packages/base/zarf.yaml @@ -14,7 +14,7 @@ metadata: 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 + dev.uds.keywords: uds,pepr,istio,operator,policies components: - name: uds-operator-config diff --git a/packages/runtime-security/zarf.yaml b/packages/runtime-security/zarf.yaml index ab130b1c1b..c1ceb17ea8 100644 --- a/packages/runtime-security/zarf.yaml +++ b/packages/runtime-security/zarf.yaml @@ -12,7 +12,7 @@ metadata: x-uds-dependencies: ["base", "identity-authorization"] annotations: dev.uds.title: UDS Core (Runtime Security) - dev.uds.tagline: Enable more advanced secureity with Runtime inspection + dev.uds.tagline: Enable more advanced security with Runtime inspection dev.uds.category: UDS-Core,Runtime Security dev.uds.keywords: uds,neuvector