[STORY] Helm NOTES that fit the cluster, and uninstall docs that list what stays behind
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- helm, kubernetes, markdown
- Domain
- devops, documentation
Research direction
Read charts/llmkube/templates/NOTES.txt, charts/llmkube/values.yaml, charts/llmkube/README.md, and the quickstart docs page. Render the chart with default values using helm template charts/llmkube | head, then run helm unittest charts/llmkube. Done when default NOTES omit GPU-generation-specific requirements, uninstall docs list the remaining CRDs and per-namespace PVC and removal steps, and the quickstart explains the PVC created on first deploy and its size.
Written by the indexing model from the issue text.
Description
Goal
Make the chart's install output and uninstall instructions fit the cluster the user has, and say what stays behind.
Definition of done
- Observable:
helm installon a CPU-only cluster prints a short NOTES.txt (the hardware-specific platform floors are behind a value or a link); the chart README's uninstall section lists the CRDs and the per-namespacellmkube-model-cachePVC that remain and how to remove them; the quickstart mentions that the first deploy creates that PVC and its size. - Negative: NOTES.txt on a default install does not print GPU-generation-specific requirements.
Scope
charts/llmkube/templates/NOTES.txt,charts/llmkube/values.yaml(one value if needed),charts/llmkube/README.md, the quickstart docs page.
Out of scope
- Automatic cleanup of the cache PVC (#2169).
Consumers and surfaces touched
- Helm install output; one optional chart value.
Verification
helm template charts/llmkube | head
helm unittest charts/llmkube
Falsification
- Edit: render NOTES.txt with the default values.
- Expected failure: none of the GPU-generation platform floors appear.
Risks
- none
- Dominant language
- Go
- Stars
- 232
- Forks
- 37
- Avg merge
- 21h 42m
- Merged PRs (30d)
- 244
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from defilantech/LLMKube
-
component/metal-agent documentation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
defilantech/LLMKube#2581 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
defilantech/LLMKube#2578 ·
Maintainers usually reply within 1 day
-
component/metal-agent enhancement priority/low size/medium
Difficulty 4/5 3-5 days Newbie friendliness 48/100
defilantech/LLMKube#2597 ·
Maintainers usually reply within 1 day
-
[BUG] Docs and comments describe InsufficientMemory only as a start refusal, but a serving engine can now carry itPossibly taken @defilan-agent claimed this today. Openbug component/metal-agent documentation priority/low size/small
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
defilantech/LLMKube#2596 ·
Maintainers usually reply within 1 day
-
kind/cleanup size/large
Difficulty 5/5 Over a week Newbie friendliness 15/100
defilantech/LLMKube#2593 ·
Maintainers usually reply within 1 day
All issues in defilantech/LLMKube
Similar issues
-
☢️ Bug v3
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
area/import-export area/projects concern/ux
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
go-vikunja/vikunja#4455 · 1 comment ·
Maintainers usually reply within 2 days
-
Dependabot PRs no longer merge automaticallyPossibly taken @dwisiswant0 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
projectdiscovery/urlfinder#160 ·
Maintainers usually reply within 1 day
-
database
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
chnm/legal-modernism#450 ·
Maintainers usually reply within 1 day
-
tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day