Skip to content

Commit 02000ea

Browse files
wowselclaude
andcommitted
skill: ship idlefy-deploy wizard
A new SKILL.md that turns any AI agent (Claude Code, Cursor, Cline, etc.) into a guided wizard for producing a validated values.yaml for the idlefy-universal chart. Five phases, 23 questions across 8 blocks (Identity, Exposure, Resources, Storage, Security, Observability, Repo & multi-env, Secrets). Auto-discovers from docker-compose / Dockerfile / k8s manifests / helm / Procfile / CI files; drafts with provenance-annotated YAML; validates with helm template (JSON-Pointer error parser, 5-fix loop bound); hands off without running helm install. Distribution: a single canonical URL the user pastes into their agent — https://raw.githubusercontent.com/idlefy/idlefy-universal/main/skills/idlefy-deploy/SKILL.md Audience reminder: the chart is for autonomous agents; this wizard is for the HUMAN who happens to be using an agent as the interface. Wires the wizard into the site (How-To nav, homepage promo replaces the verbose paste-this-prompt block, README install pointer). mkdocs build --strict is clean. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 1f0b531 commit 02000ea

5 files changed

Lines changed: 509 additions & 45 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ helm install demo oci://ghcr.io/idlefy/idlefy-universal \
2929
-f values.yaml
3030
```
3131

32+
Prefer a guided experience? Hand the [deploy wizard](https://idlefy.github.io/idlefy-universal/how-to/wizard/)
33+
to an AI agent and it'll author a validated `values.yaml` for you.
34+
3235
A minimal `values.yaml`:
3336

3437
```yaml

docs/how-to/wizard.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Use the deploy wizard
2+
3+
`idlefy-deploy` is a SKILL.md that walks a human (you) through producing
4+
a validated `values.yaml` for the `idlefy-universal` Helm chart, with
5+
the AI agent of your choice handling the conversation. It scans your
6+
project, drafts a values.yaml from what it finds, asks only the
7+
gap-filling questions that can't be inferred, validates with
8+
`helm template`, and hands off — stopping short of `helm install` so
9+
you review the diff yourself.
10+
11+
## Invoke it
12+
13+
Paste a sentence like this into Claude Code, Cursor, Cline, or any other
14+
agent that can fetch a URL and run shell commands:
15+
16+
> Using <https://raw.githubusercontent.com/idlefy/idlefy-universal/main/skills/idlefy-deploy/SKILL.md>, help me deploy this project to Kubernetes via idlefy-universal.
17+
18+
The agent fetches the file and follows it. No install step, no `curl`,
19+
no `~/.claude/skills/` directory required.
20+
21+
## What you'll be asked
22+
23+
23 questions total, grouped into 8 blocks. Each one explains WHY and
24+
gives a sensible default — most you can accept and move on:
25+
26+
- **Identity** — workload kind, namespace, image tag, imagePullSecrets, replicas.
27+
- **Exposure** — Service, Ingress, cert-manager TLS (with a precondition gate).
28+
- **Resources** — CPU / memory presets (starter / web / heavy).
29+
- **Storage** — PVC size and class (only for stateful workloads).
30+
- **Security** — RBAC, ServiceAccount, NetworkPolicy.
31+
- **Observability** — ServiceMonitor, PodDisruptionBudget, HPA.
32+
- **Repo & multi-env** — save path, single- vs multi-env layout.
33+
- **Secrets**`secretRefs` for sensitive env vars (never written into values.yaml).
34+
35+
The agent skips any question already answered by the scan.
36+
37+
## Failure modes
38+
39+
- **HTTP 429 from `raw.githubusercontent.com`.** Unauthenticated reads
40+
are rate-limited per IP (~60/hr). A single human user never hits this;
41+
multi-tenant CI does. Mirror the file to your own bucket, or fall
42+
back to the `git clone` path below.
43+
- **Air-gapped / offline.** `git clone https://github.com/idlefy/idlefy-universal`
44+
and point the agent at the local file path.
45+
- **Agent without `WebFetch` / equivalent.** Paste the SKILL.md contents
46+
directly into the conversation as a one-time message. Functionally
47+
identical, just verbose.
48+
49+
## Related
50+
51+
- [Verify the chart's supply chain](verify-supply-chain.md) — recommended before any `helm install`.
52+
- [Your first app](../tutorials/your-first-app.md) — manual walk-through if you'd rather not use an agent.
53+
- [Reference → Values](../reference/values.md) — the full schema surface the wizard navigates.

docs/index.md

Lines changed: 13 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -16,58 +16,26 @@ hide:
1616

1717
## Deploy with an AI agent
1818

19-
`idlefy-universal` is built for AI-driven deployment. The chart bundles
20-
[`agent-index.json`](reference/agent-metadata.md#agent-indexjson) — a flat,
21-
machine-readable description of every value with `whenToUse`,
19+
`idlefy-universal` ships [`agent-index.json`](reference/agent-metadata.md#agent-indexjson)
20+
— a flat, machine-readable description of every value with `whenToUse`,
2221
`relatedFields`, `commonMistakes`, and `exampleUseCase`. Every release is
2322
signed (cosign keyless), SBOM-attached, and carries SLSA L3 provenance,
2423
so an agent can self-verify the artifact before installing it.
2524

26-
Paste the prompt below into any agent that can run shell commands
27-
(Claude Code, Cursor, Cline, an MCP-equipped harness, a custom runner — all
28-
work; the chart ships data, not an integration). Replace `<DESCRIBE YOUR
29-
WORKLOAD>` with what you actually want deployed.
30-
31-
````text
32-
You are deploying idlefy-universal for the following workload:
33-
<DESCRIBE YOUR WORKLOAD>
34-
35-
Use VERSION=1.0.0 throughout this prompt. Every command below that
36-
references a chart version MUST use that same value.
37-
38-
1. Verify the chart's supply chain before pulling it. Run the three
39-
commands documented at
40-
https://idlefy.github.io/idlefy-universal/how-to/verify-supply-chain/#three-command-verification
41-
with CHART_REF="oci://ghcr.io/idlefy/idlefy-universal:${VERSION}".
42-
Refuse to proceed if any command exits non-zero.
43-
44-
2. After verification passes, pull the chart locally so you can read
45-
its agent metadata:
46-
helm pull oci://ghcr.io/idlefy/idlefy-universal --version "${VERSION}" --untar
47-
Read idlefy-universal/agent-index.json — that file is your
48-
authoritative list of fields, with whenToUse, relatedFields,
49-
commonMistakes, and exampleUseCase for each.
50-
51-
3. Build a minimal values.yaml for the workload above. Honor every
52-
commonMistakes warning. Enable autoCreate* flags only for resources
53-
the workload actually needs (Service, Ingress, Certificate, RBAC,
54-
ServiceMonitor, NetworkPolicy, PodDisruptionBudget, ServiceAccount).
55-
56-
4. Validate locally before touching the cluster:
57-
helm template demo ./idlefy-universal -f values.yaml
58-
The chart ships values.schema.json (JSON Schema 2020-12). Typos and
59-
cross-field violations fail with a JSON Pointer path. Fix and retry
60-
until the template renders cleanly.
61-
62-
5. Install:
63-
helm install demo oci://ghcr.io/idlefy/idlefy-universal \
64-
--version "${VERSION}" -f values.yaml
65-
````
25+
The fastest way to deploy: hand your favourite AI agent the
26+
[`idlefy-deploy` wizard](how-to/wizard.md). One sentence in your agent's
27+
chat:
28+
29+
> Using <https://raw.githubusercontent.com/idlefy/idlefy-universal/main/skills/idlefy-deploy/SKILL.md>, help me deploy this project to Kubernetes via idlefy-universal.
30+
31+
The wizard scans your repo, drafts a `values.yaml`, asks only the
32+
questions the scan couldn't answer, and validates with `helm template`.
33+
See [Use the deploy wizard](how-to/wizard.md) for details and failure-mode notes.
6634

6735
Further reading:
6836

69-
- [How-To → Verify the chart's supply chain](how-to/verify-supply-chain.md)the three-command gate, plus a single-script autonomous form
70-
- [Concepts → Agent-native](concepts/agent-native.md) — why the metadata lives inside the schema, not in a sidecar
37+
- [How-To → Verify the chart's supply chain](how-to/verify-supply-chain.md) — three-command gate
38+
- [Concepts → Agent-native](concepts/agent-native.md) — why the metadata lives inside the schema
7139
- [Reference → Agent metadata](reference/agent-metadata.md) — the `x-agent-*` keyword spec and `agent-index.json` shape
7240

7341
## Why idlefy-universal

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ nav:
8484
- Add metrics: tutorials/add-metrics.md
8585
- Gateway API: tutorials/gateway-api.md
8686
- How-To:
87+
- Use the deploy wizard: how-to/wizard.md
8788
- Monitoring: how-to/monitoring.md
8889
- RBAC: how-to/rbac.md
8990
- Network policy: how-to/network-policy.md

0 commit comments

Comments
 (0)