← Back to issue list

docs: add tutorial for testing a k8s charm

View original Github issue

Metadata

Project
charmcraft
Number
#2477
Type
issue
State
open
Author
sed-i
Labels
Type: Documentation
Created
Updated
Closed
—

Current evaluation

Request for official tutorial on testing k8s charms with spread. Maintainer acknowledged as a 26.04 roadmap item (269 days ago). A test-kubernetes init profile exists (experimental) but no dedicated tutorial yet.

Suggested action: keep open

Reason: Maintainer @tonyandrewmeyer explicitly stated 'Charm Tech has this as a 26.04 roadmap item' (269 days ago), confirming it is triaged, valid, and planned. The test-kubernetes init profile (#2401) provides a partial framework but is marked experimental in the 4.0 release notes and does not constitute the requested tutorial. The issue remains relevant and scoped.

Impact: 45 Quick Win: 24.75 Staleness: 58 Complexity: 45 Confidence: 78 Support Request: 30

Issue body

*Please describe the question or issue you're facing with "test - Charmcraft 4.0.1 documentation".* For running tests with spread, it seems like we mainly have two options: - [zinc-k8s example](https://github.com/jnsgruk/zinc-k8s-operator/blob/main/spread.yaml): - custom ("adhoc") lxd backend with concierge installing k8s, juju + [cloud-config](https://github.com/jnsgruk/zinc-k8s-operator/blob/8569d92152f40e2a79ff88cad30061671a513843/tests/spread/cloud-config.yaml#L7) - custom ("adhoc") backend that lets spread "ssh into itself" ([mysql example](https://github.com/canonical/mysql-k8s-operator/blob/1c13d0850919d9565281a506afb05839a4ce31d5/spread.yaml#L67)). This approach is actually useful for running itest locally during dev. Official guidance on how to test (k8s) charm with spread would be extremely valuable. --- *Reported from: https://documentation.ubuntu.com/charmcraft/stable/reference/commands/test/*

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 45
Quick Win: 24.75
Staleness: 58
Complexity: 45
Confidence: 78
Support Request: 30
keep open Request for official tutorial on testing k8s charms with spread. Maintainer acknowledged as a 26.04 roadmap item (269 days ago). A test-kubernetes init profile exists (experimental) but no dedicated tutorial yet.
qwen/qwen3.6-35b-a3b
Staleness: 45
Complexity: 15
Confidence: 85
Support Request: 10
keep open Request for official documentation on testing Kubernetes charms with spread. Acknowledged by maintainers and placed on the 26.04 roadmap.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 20
Confidence: 80
Support Request: 10
needs triage Request for official documentation on testing Kubernetes charms with spread. Currently unlabelled, with a maintainer noting it is on the 26.04 roadmap.
qwen3.6-35b-a3b-mtp-q6
Staleness: 55
Complexity: 40
Confidence: 85
Support Request: 10
keep open Request for official documentation tutorial on testing Kubernetes charms using spread. Currently tracked on the Charm Tech 26.04 roadmap, awaiting implementation.
qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 20
Confidence: 90
Support Request: 10
keep open Request for official spread testing tutorial for Kubernetes charms. Current guidance relies on community workarounds. Charm Tech has added this to the 26.04 roadmap and is tracking it for implementation.

Update history

No update history recorded yet.

Related work

  • Related To: charmcraft#2401 (confidence 80%)

    Added test-kubernetes init profile with spread.yaml template using microk8s — partial solution but experimental, not a full tutorial

  • Related To: charmcraft#2743 (confidence 50%)

    Merged PR adding Canonical K8s instructions to web app charm how-tos; related K8s documentation effort but different scope

Related issues

Issue Project State Summary Similarity
#2743 docs: add Canonical K8s instructions to web app charm how-tos charmcraft merged Merged documentation update adding Canonical K8s instructions to web app charm how-to guides. Adds tabbed sections alongside MicroK8s steps in two .rst files for load balancer setup and troubleshooting. Approved by two reviewers with all CI checks passing.
70%