From 43d6bab89eb4e69113af2ffa96b7a8bc1eb61b70 Mon Sep 17 00:00:00 2001 From: Chris Farhood Date: Sun, 8 Feb 2026 10:03:47 -0500 Subject: [PATCH] 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 Co-Authored-By: Happy --- CLAUDE.md | 6 ++++++ README.md | 19 ++++++++++++++++++- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/CLAUDE.md b/CLAUDE.md index 23c5b6f..8b93889 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -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. diff --git a/README.md b/README.md index 2f02438..657a881 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # irc -Some useful apps for IRC \ No newline at end of file +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) \ No newline at end of file