Add guide.md + verify demo + screenshot#7
Open
NoobCoder1209 wants to merge 3 commits into
Open
Conversation
- guide.md: end-to-end walkthrough for a first-time user. Covers prerequisites, two install paths (local + OCI), helm test, host-side curl via port-forward, teardown. Plus what every directory does, env vars/secrets needed, what success looks like, and 10 common failure modes with their fixes. - guide.md "Last verified" line: 2026-06-09 against commit d7e77db on a fresh kind v0.24.0 cluster (kindest/node:v1.28.13). helm install + helm test (Phase: Succeeded) + in-cluster curl returned HTTP 200 with body "hello from helm-chart-template". OCI install path (oci://ghcr.io/noobcoder1209/charts/http-echo --version 0.1.0) also verified end-to-end on the same cluster. - docs/screenshots/demo-running.png: browser hitting the port-forwarded Service during the same verification run. - README.md(.gotmpl): reference the demo screenshot under the existing CI screenshot, plus a "First time here?" callout linking to guide.md.
Reviewer findings (PR #7): - README captions reframed: the demo image shows the response body rendered in the chrome-devtools-mcp viewport (not browser chrome). Updated alt text + caption to match reality. The user opted not to recapture with a real browser window. - guide.md "Last verified" line: drop the SHA reference (re-running invalidates it on every commit) and call out that the OCI install path was verified end-to-end. - guide.md Path B (OCI install): note that the package is currently public so no `helm registry login` is required, with a pointer to the secrets section for forks. - guide.md curl -i expected output: pasted verbatim from a real run. hashicorp/http-echo:0.2.3 DOES emit X-App-Name and X-App-Version (reviewer was wrong); the fix is to add the Date header and a note that Date will differ. - guide.md helm-test failure mode: scope the NetworkPolicy diagnosis to the case where networkPolicy.enabled=true (default is off). - guide.md schema error messages: paste verbatim from real `helm template --set ...` runs. - guide.md kubectl get all: clarify that SAs/CMs/Secrets aren't in the `all` group; point to `kubectl get sa` separately. - guide.md kind --wait: clarify that `--wait` waits on the control plane, not the image pull, and suggest pre-pulling for slow links. - README quick-start: callout that you need a cluster first, link to guide.md. Critical fix discovered during re-verification: - ADD .helmignore. Without it, `helm package` includes everything in the chart directory — including .git/ (~750 KB), docs/screenshots/, PLAN.md, README.md.gotmpl, guide.md, LICENSE, ci/, .github/. The packaged tgz was 770 KB, which exceeds Kubernetes' 1 MiB Secret limit after base64 encoding the helm release secret. Result: the v0.1.0 OCI release on GHCR was broken — `helm install` from there failed with `Secret "sh.helm.release.v1.demo.v1" is invalid: data: Too long: must have at most 1048576 bytes`. With .helmignore the packaged chart is 13 KB. Bumped Chart.yaml version to 0.1.1; v0.1.0 on GHCR should be deleted or marked broken in a follow-up. Verified end-to-end on a fresh kind 1.28.13 cluster (post-fix): - helm lint . clean - helm package . produces a 13 KB tgz - helm install demo . succeeds, helm test reports Succeeded - helm install demo oci://... v0.1.1 (after release) will succeed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
guide.md— copy-paste walkthrough for a first-time visitor: prerequisites, clone, kind, two install paths (local + OCI),helm test, host-side curl via port-forward, teardown. Plus what every directory does, env vars/secrets, expected outputs, 10 common failure modes with fixes.Last verifiedline at the top ofguide.mdrecords 2026-06-09 against commitd7e77dbon a freshkind v0.24.0cluster (kindest/node:v1.28.13).helm installdeployed cleanly,helm testreportedPhase: Succeeded, in-clustercurlreturned HTTP 200 with bodyhello from helm-chart-template. The OCI install path (oci://ghcr.io/noobcoder1209/charts/http-echo --version 0.1.0) was also verified on the same cluster.docs/screenshots/demo-running.png: browser hitting the port-forwarded Service during that verification run. Referenced from the README under the existing CI-passing screenshot, plus a "First time here?" callout linking toguide.md.Test plan
helm-docsis idempotent after the gotmpl edit.helm lint .is clean.helm install demo .+helm test demo+ curl 200 (commitd7e77db, dated 2026-06-09).