-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Standardize on external-secrets-system namespace
Problem
There are inconsistencies in namespace references for External Secrets Operator (ESO) across documentation and Helm charts.
Current State
Inconsistent references:
- Documentation: Mixed between
external-secretsandexternal-secrets-system - Helm charts: ESO resources deployed to namespace from
.Release.Namespace - Standard practice: Official ESO Helm chart uses
external-secrets-system
Examples of inconsistency:
- "external-secrets namespace"
- "external-secrets-system namespace"
- In deployment: "{{ .Release.Namespace }}"
Desired State
Standardize everywhere on external-secrets-system:
- ESO installation command
- All documentation references
- Helm chart comments and examples
- Troubleshooting commands
- Secret architecture diagrams
Files to Update
Documentation
platform-architecture.md- Update ESO namespace referencesCLAUDE.md(Helm charts) - Update ESO installation docs
Helm Charts
charts/judge/README.md- Update installation instructions- All template comments mentioning ESO
- Values.yaml example comments
Installation Instructions
Update to:
helm repo add external-secrets https://charts.external-secrets.io
helm install external-secrets external-secrets/external-secrets \
-n external-secrets-system \
--create-namespaceWhy This Change
- Standard Convention: Official ESO Helm chart defaults to
external-secrets-system - Consistency: Single source of truth for namespace name
- Documentation: Users won't be confused by multiple namespace references
- Best Practice: Dedicated namespace for external secrets improves security isolation
Impact
- Low Priority: Cosmetic/consistency fix
- No functional impact if namespace is used consistently
- Improves documentation clarity
- Aligns with community best practices
Verification
After fix, verify:
# ESO should be in external-secrets-system
kubectl get all -n external-secrets-system
# ESO SecretStore resources in judge namespace
kubectl get secretstore -n judge
# ESO ExternalSecret resources in judge namespace
kubectl get externalsecret -n judge
# ESO webhook validation in external-secrets-system
kubectl get validatingwebhookconfigurations | grep secretsTesting
# Install ESO in correct namespace
helm install external-secrets external-secrets/external-secrets \
-n external-secrets-system \
--create-namespace
# Deploy Judge platform
helm install judge ./charts/judge -n judge
# Verify SecretStores can connect to ESO webhook
kubectl describe secretstore vault-kratos -n judgeFiles to Update
-
/Users/nkennedy/proj/judge/.grc/platform-architecture.md- Line search for "external-secrets" and update references
- Update ESO installation instructions
-
/Users/nkennedy/proj/cust/conda/repos/cust-anaconda-helm-charts/CLAUDE.md- Update ESO installation command
- Update namespace references in prerequisites
-
charts/judge/README.md- Update installation steps
- Update troubleshooting commands
-
All template files with ESO references
- Update example commands
- Update comments
Labels
- documentation
- helm-charts
- consistency
- eso
Fix Location
Both Documentation and Helm Charts - Standardize namespace references throughout
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation