From a98e5b43c4d5d69eeed98accc28b50f6a901e9ad Mon Sep 17 00:00:00 2001 From: ximenchuifeng Date: Wed, 15 Jul 2026 00:29:30 +0800 Subject: [PATCH] docs(gitops): plan disabling audit default deployment --- ...-07-15-disable-audit-default-deployment.md | 96 +++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 docs/superpowers/plans/2026-07-15-disable-audit-default-deployment.md diff --git a/docs/superpowers/plans/2026-07-15-disable-audit-default-deployment.md b/docs/superpowers/plans/2026-07-15-disable-audit-default-deployment.md new file mode 100644 index 0000000..d371f5b --- /dev/null +++ b/docs/superpowers/plans/2026-07-15-disable-audit-default-deployment.md @@ -0,0 +1,96 @@ +# Disable Audit Default Deployment Implementation Plan + +> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking. + +**Goal:** Exclude Audit from the default demo Argo CD app-of-apps deployment while preserving its manifest for manual re-enablement. + +**Architecture:** Follow the repository's existing disabled-manifest convention by moving the Audit Argo CD Application from the active `applications/demo` directory into `applications/demo/disabled`. Keep environment values and image metadata unchanged so the service can be restored by moving the manifest back. + +**Tech Stack:** Argo CD Application manifests, Kubernetes YAML, Git + +## Global Constraints + +- Do not modify the Audit Helm chart. +- Keep `environments/demo/audit-values.yaml` unchanged. +- Keep the Audit entry in `environments/demo/image-version.yaml` unchanged. +- Do not delete or alter an existing `mixingx-audit` Application or workload in the current cluster. + +--- + +### Task 1: Move Audit Application to the disabled manifest directory + +**Files:** +- Move: `applications/demo/audit.yaml` → `applications/demo/disabled/audit.yaml` +- Verify unchanged: `environments/demo/audit-values.yaml` +- Verify unchanged: `environments/demo/image-version.yaml` + +**Interfaces:** +- Consumes: `bootstrap/mixingx-demo-root.yaml`, whose source path is `applications/demo` +- Produces: A preserved Audit Argo CD Application manifest outside the root application's active top-level manifest set + +- [ ] **Step 1: Capture checksums of configuration files that must remain unchanged** + +Run: + +```bash +shasum -a 256 environments/demo/audit-values.yaml environments/demo/image-version.yaml +``` + +Expected: two checksum lines. Save the output for comparison in Step 5. + +- [ ] **Step 2: Move the Audit Application manifest** + +Apply a file move with no content changes: + +```bash +mkdir -p applications/demo/disabled +mv applications/demo/audit.yaml applications/demo/disabled/audit.yaml +``` + +Expected: `applications/demo/audit.yaml` no longer exists and `applications/demo/disabled/audit.yaml` contains the original manifest. + +- [ ] **Step 3: Validate the moved YAML document** + +Run: + +```bash +ruby -e "require 'yaml'; doc = YAML.load_file('applications/demo/disabled/audit.yaml'); abort 'wrong kind' unless doc['kind'] == 'Application'; abort 'wrong name' unless doc.dig('metadata', 'name') == 'mixingx-audit'" +``` + +Expected: exit code 0 with no output. + +- [ ] **Step 4: Verify Audit is excluded from active top-level manifests** + +Run: + +```bash +test ! -e applications/demo/audit.yaml +test -e applications/demo/disabled/audit.yaml +find applications/demo -maxdepth 1 -type f -name '*.yaml' -exec grep -l 'name: mixingx-audit' {} + +``` + +Expected: both `test` commands exit 0 and `find` prints no path. + +- [ ] **Step 5: Verify retained configuration and inspect the complete diff** + +Run: + +```bash +shasum -a 256 environments/demo/audit-values.yaml environments/demo/image-version.yaml +git diff --check +git diff --summary +git status --short +``` + +Expected: checksums match Step 1, `git diff --check` exits 0, the summary reports only the Audit manifest rename, and status contains no unrelated changes. + +- [ ] **Step 6: Commit the deployment change** + +Run: + +```bash +git add applications/demo/audit.yaml applications/demo/disabled/audit.yaml +git commit -m "chore(gitops): disable audit default deployment" +``` + +Expected: one commit recording the Audit manifest rename with no changes to values or image metadata.