reorg
This commit is contained in:
59
README.md
59
README.md
@@ -1,4 +1,6 @@
|
||||
# README.md
|
||||
# CLAUDE.md
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -11,23 +13,25 @@ This is a **Kubernetes cluster bootstrapping and GitOps configuration repository
|
||||
├── bootstrap.sh # Main bootstrap script to initialize ArgoCD and cluster
|
||||
├── argocd/ # ArgoCD configuration (primary entrypoint)
|
||||
│ ├── _app-of-apps.yaml # App-of-apps pattern: parent Application that manages all child apps
|
||||
│ ├── apps/ # Individual ArgoCD Application resources
|
||||
│ │ ├── traefik-application.yaml # Ingress controller (Traefik)
|
||||
│ │ ├── cert-manager-application.yaml # TLS certificate management
|
||||
│ │ ├── kyverno.yaml # Policy engine for security
|
||||
│ │ ├── prometheus.yaml # Metrics & monitoring
|
||||
│ │ ├── grafana.yaml # Monitoring visualization
|
||||
│ │ ├── loki.yaml # Log aggregation
|
||||
│ │ ├── fluent-bit.yaml # Log shipping
|
||||
│ │ ├── trivy.yaml # Container scanning
|
||||
│ │ ├── sealedsecrets.yaml # Secret encryption
|
||||
│ │ └── cluster-resources-application.yaml # Cluster-wide resources
|
||||
│ ├── infra/ # Individual ArgoCD Application resources for infrastructure
|
||||
│ │ ├── traefik-application.yaml # Ingress controller (Traefik)
|
||||
│ │ ├── cert-manager-application.yaml # TLS certificate management
|
||||
│ │ ├── kyverno.yaml # Policy engine for security
|
||||
│ │ ├── prometheus.yaml # Metrics & monitoring
|
||||
│ │ ├── grafana.yaml # Monitoring visualization
|
||||
│ │ ├── loki.yaml # Log aggregation
|
||||
│ │ ├── fluent-bit.yaml # Log shipping
|
||||
│ │ ├── trivy.yaml # Container scanning
|
||||
│ │ ├── sealedsecrets.yaml # Secret encryption
|
||||
│ │ └── cluster-resources-application.yaml # Cluster-wide resources
|
||||
│ ├── apps/ # Application resources (currently unused/empty)
|
||||
│ └── values/ # Helm value overrides for ArgoCD and services
|
||||
│ ├── argocd-values.yaml # ArgoCD server configuration
|
||||
│ ├── argocd-values.yaml # ArgoCD server configuration
|
||||
│ ├── prometheus-values.yaml
|
||||
│ ├── grafana-values.yaml
|
||||
│ └── loki-values.yaml
|
||||
└── cluster-resources/ # Cluster-level configurations
|
||||
│ ├── loki-values.yaml
|
||||
│ └── fluent-bit-values.yaml
|
||||
└── cluster-resources/ # Cluster-level configurations managed by cluster-resources-application.yaml
|
||||
├── cert-manager-namespace.yaml
|
||||
├── letsencrypt-issuer.yaml # TLS certificate issuer
|
||||
└── kyverno-config.yaml # Security policies and secret syncing
|
||||
@@ -37,7 +41,7 @@ This is a **Kubernetes cluster bootstrapping and GitOps configuration repository
|
||||
|
||||
### GitOps Model
|
||||
- **App-of-Apps Pattern**: `argocd/_app-of-apps.yaml` is the root Application that manages all child applications
|
||||
- **Source of Truth**: GitHub repository (`https://github.com/snothub/scaling-parakeet.git`) is the single source of truth
|
||||
- **Source of Truth**: GitHub repository (`https://github.com/fortedigital/sturdy-adventure.git`) is the single source of truth
|
||||
- **Auto-sync**: All Applications have automated sync enabled with auto-pruning and self-healing
|
||||
- **Namespace Creation**: `CreateNamespace=true` allows ArgoCD to create namespaces as needed
|
||||
|
||||
@@ -102,25 +106,38 @@ kubectl get secrets -n <namespace>
|
||||
```
|
||||
|
||||
### Deploy Changes
|
||||
- Changes to YAML files in `argocd/` or `cluster-resources/` are automatically synced by ArgoCD
|
||||
- Changes to YAML files in `argocd/infra/`, `argocd/values/`, or `cluster-resources/` are automatically synced by ArgoCD
|
||||
- Push changes to the GitHub repository for them to be reflected
|
||||
- ArgoCD reconciliation happens every 60s (`timeout.reconciliation: 60s`)
|
||||
- Each application has a 5-minute sync timeout to prevent stalled deployments
|
||||
|
||||
### Review Helm Values
|
||||
Application-specific Helm value overrides are in `argocd/values/` and referenced within each Application's `values` field.
|
||||
Application-specific Helm value overrides are in `argocd/values/` and referenced within each Application's Helm configuration. Each application manifest uses both external value files and inline overrides where needed.
|
||||
|
||||
### Application Organization & Sync Ordering
|
||||
- Infrastructure applications use `argocd.argoproj.io/sync-wave` annotations for ordered deployment
|
||||
- Kyverno (sync-wave: 0) deploys before cluster-resources (sync-wave: 1) to ensure policies are ready
|
||||
- All applications have resource requests and limits configured to prevent resource starvation
|
||||
- Applications are labeled with `app.kubernetes.io/part-of` to indicate their component type (platform, monitoring-stack, application)
|
||||
|
||||
## Important Notes
|
||||
|
||||
- **No admin auth in development**: ArgoCD has `admin.enabled: "false"` - suitable for local/dev only
|
||||
- **Insecure server mode**: `--insecure` and `--disable-auth` flags are set - not for production
|
||||
- **Folder organization**:
|
||||
- `argocd/infra/` contains infrastructure/platform components (Traefik, Cert-Manager, Prometheus, Grafana, Loki, etc.)
|
||||
- `argocd/apps/` is reserved for business applications (currently empty)
|
||||
- **Replica counts**: Traefik runs 2 replicas; other services run 1 replica
|
||||
- **Retry policy**: All applications retry up to 5 times with exponential backoff (max 3m)
|
||||
- **Retry policy**: All applications retry up to 5 times with exponential backoff (max 3m timeout per application)
|
||||
- **Ignore replica scaling**: Deployments ignore replica count differences to allow HPA/manual scaling
|
||||
- **Sync validation**: All applications validate manifests before applying (`Validate=true`)
|
||||
- **Server-side apply**: All applications use `ServerSideApply=true` for safer field ownership tracking
|
||||
|
||||
## Development Tips
|
||||
|
||||
- **Check ArgoCD logs**: `kubectl logs -n argocd deployment/argocd-application-controller`
|
||||
- **Validate YAML**: Files are validated server-side (`Validate=true`) before applying
|
||||
- **Resource tracking**: Uses annotation-based method (`application.resourceTrackingMethod: annotation`)
|
||||
- **Modify applications**: Edit the corresponding YAML in `argocd/apps/` and push to trigger sync
|
||||
- **Add new services**: Create a new Application YAML following the pattern of existing ones, then reference it from `_app-of-apps.yaml`
|
||||
- **Modify applications**: Edit the corresponding YAML in `argocd/infra/` and push to trigger sync
|
||||
- **Add new services**: Create a new Application YAML in `argocd/infra/` following the pattern of existing ones, then it will be auto-discovered by the app-of-apps
|
||||
- **Application folder naming**: Infrastructure components are in `argocd/infra/`; `argocd/apps/` is reserved for business applications (currently empty)
|
||||
|
||||
Reference in New Issue
Block a user