From 699163ce9f23afb739ebf560df47684dd81859f1 Mon Sep 17 00:00:00 2001 From: Ken Dreyer Date: Thu, 12 Mar 2026 17:02:28 -0400 Subject: [PATCH] remove stale sections from manifests README The detailed directory tree only listed 3 of the 5 overlays and omitted "minikube/" and "observability/", so it kept drifting from reality. Replace it with a short prose list of top-level directories that won't need updating every time a file is added. The "Migration Notes" section referenced directories that were deleted long ago ("e2e/manifests/", "components/scripts/local-dev/manifests/"). Remove it entirely. Co-Authored-By: Claude Opus 4.6 --- components/manifests/README.md | 55 ++++------------------------------ 1 file changed, 6 insertions(+), 49 deletions(-) diff --git a/components/manifests/README.md b/components/manifests/README.md index 7f101f5d1..30b30af2c 100644 --- a/components/manifests/README.md +++ b/components/manifests/README.md @@ -2,47 +2,13 @@ This directory contains Kubernetes/OpenShift manifests organized using **Kustomize overlays** to eliminate duplication across environments. -## Directory Structure +## Layout -``` -manifests/ -├── base/ # Common resources shared across all environments -│ ├── backend-deployment.yaml -│ ├── frontend-deployment.yaml -│ ├── operator-deployment.yaml -│ ├── workspace-pvc.yaml -│ ├── namespace.yaml -│ ├── crds/ # Custom Resource Definitions -│ └── rbac/ # Role-Based Access Control -│ -├── overlays/ # Environment-specific configurations -│ ├── production/ # OpenShift production environment -│ │ ├── kustomization.yaml -│ │ ├── route.yaml -│ │ ├── backend-route.yaml -│ │ ├── frontend-oauth-*.yaml # OAuth proxy patches -│ │ ├── github-app-secret.yaml -│ │ └── namespace-patch.yaml -│ │ -│ ├── e2e/ # Kind/K8s testing environment -│ │ ├── kustomization.yaml -│ │ ├── *-ingress.yaml # K8s Ingress resources -│ │ ├── test-user.yaml # Test user with cluster-admin -│ │ ├── secrets.yaml -│ │ └── *-patch.yaml # Environment-specific patches -│ │ -│ └── local-dev/ # CRC local development environment -│ ├── kustomization.yaml -│ ├── build-configs.yaml # OpenShift BuildConfigs -│ ├── dev-users.yaml # Local development users -│ ├── frontend-auth.yaml -│ ├── *-route.yaml -│ └── *-patch.yaml # Local dev patches -│ -├── deploy.sh # Production deployment script -├── env.example # Example environment variables -└── README.md # This file -``` +This directory is organized into the following top-level directories: + +- **`base/`** — Common resources (deployments, services, CRDs, RBAC) shared across all environments +- **`overlays/`** — Environment-specific Kustomize overlays (e.g. `production`, `e2e`, `kind`, `kind-local`, `local-dev`) +- **`observability/`** — Monitoring and observability resources ## Environment Differences @@ -197,15 +163,6 @@ NAMESPACE=my-namespace IMAGE_TAG=v1.0 ./deploy.sh ✅ **Clear Differences**: Overlays show exactly what's unique per environment ✅ **Type-Safe**: Kustomize validates patches against base resources -## Migration Notes - -This structure replaces the previous duplicated manifests: -- ~~`components/manifests/*.yaml`~~ → `base/` + `overlays/production/` -- ~~`e2e/manifests/*.yaml`~~ → `overlays/e2e/` -- ~~`components/scripts/local-dev/manifests/*.yaml`~~ → `overlays/local-dev/` - -Old manifest directories have been preserved for reference but are no longer used by deployment scripts. - ## Troubleshooting ### Kustomize build fails