Kubernetes Deployment Documenter skill for Claude and Codex
Turns a Deployment manifest into a one-page reference an SRE or developer can read in two minutes: what runs, how it scales, what it needs, and what to watch…
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when a Kubernetes Deployment manifest needs a readable reference page for SREs or developers who should not have to parse the YAML. Do not use for validating a manifest for errors or rewriting it to best practices. Related topics: coding, kubernetes.
What it will ask you for
- Deployment manifest (longer free text)
- Intended audience (choose one: SRE, Developer, Architect)
- Detail level (choose one: High, Medium, Low)
- Include resource limits (choose one: Yes, No)
- Include environment variables (choose one: Yes, No)
- Output format (choose one: Markdown, HTML, AsciiDoc)
How it works
- Extract every fact from the manifest a reader needs: identity, selector, replicas, update strategy, containers, ports, probes, volumes, and service account, with nothing invented.
- Write the Overview in plain language pitched at the chosen audience, so it answers what the workload does and how it scales in under five sentences.
- Fill the Spec Summary and Containers tables from the extracted facts, one row per container with image, tag, ports, and probes.
- Add the Resources and Environment Variables sections only when toggled on, masking secret values and naming their source instead.
- List surprising settings in Notes, such as a latest tag or a missing probe, and deliver the document in the requested format with the sections in order.
What you get
A single document in the selected format with sections in this order: Overview, Spec Summary, Containers table, Resources (optional), Environment Variables (optional), Notes.
What it watches out for
- Copying secret values or base64 blobs from env entries into the document, which turns a reference page into a leak.
- Describing what the Deployment should do instead of what the manifest actually says, so the doc and the cluster drift apart.
- Burying the replica count and update strategy in prose where an SRE on call cannot find them.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.