docs: add critical Flux CD deployment notes

Updated CLAUDE.md and README.md to clearly document:
- Repository is deployed via Flux CD
- Manifests use Flux variable substitution
- Variables must NOT be replaced with hardcoded values

This prevents future mistakes with variable substitution.

Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
This commit is contained in:
2026-02-08 10:03:47 -05:00
parent c8ee58c67f
commit 43d6bab89e
2 changed files with 24 additions and 1 deletions
+6
View File
@@ -2,6 +2,12 @@
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## ⚠️ CRITICAL: Flux CD Deployment
**This repository is deployed via Flux CD.** All manifests use Flux variable substitution syntax (e.g., `${VARIABLE_NAME}`).
**DO NOT replace Flux variables with hardcoded values.** Flux substitutes these variables at deployment time from ConfigMaps or Secrets.
## Project Overview
This repository contains Kubernetes manifests for deploying IRC-related applications (The Lounge web client and ZNC bouncer) using Kustomize. The infrastructure is deployed to a Kubernetes cluster with Flux CD and uses Gitea Actions for CI/CD validation and security scanning.
+18 -1
View File
@@ -1,3 +1,20 @@
# irc
Some useful apps for IRC
Kubernetes manifests for IRC applications, deployed via Flux CD.
## Applications
- **The Lounge** - Modern web IRC client
- **ZNC** - IRC bouncer
## Deployment
This repository is deployed to Kubernetes using **Flux CD** with variable substitution. Configuration variables (e.g., hostnames) are provided via ConfigMaps at deployment time.
## CI/CD
Automated validation and security scanning via Gitea Actions:
- YAML linting and Kustomize validation
- Kubernetes schema validation (kubeconform)
- Security scanning (Trivy, Checkov)
- Best practices analysis (kube-score, Polaris)