← 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

Documentation request for an official Spread tutorial covering Kubernetes charm testing, including CI and local-development patterns; acknowledged as a Charm Tech 26.04 roadmap item.

Suggested action: keep open

Reason: Maintainer @tonyandrewmeyer explicitly identified this as a Charm Tech 26.04 roadmap item, and the current tutorial and how-to indexes have no general Spread testing guide. The request already identifies two concrete approaches, but selecting and validating supported patterns requires documentation and technical design work.

Evaluated by: mr-cal-bot

Impact: 48 Quick Win: 19 Complexity: 49 Confidence: 91 Actionability: 77

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
stealth/space-bunny-alpha
Impact: 48
Quick Win: 19
Complexity: 49
Confidence: 91
Actionability: 77
keep open Documentation request for an official Spread tutorial covering Kubernetes charm testing, including CI and local-development patterns; acknowledged as a Charm Tech 26.04 roadmap item.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 17
Complexity: 20
Confidence: 70
Actionability: 70
keep open Documentation request for a tutorial on testing k8s charms with spread. Maintainer acknowledged it as a 26.04 roadmap item.
qwen/qwen3.8-27b
Impact: 45
Quick Win: 25
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.

Update history

No update history recorded yet.

Related work

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

    Merged Canonical Kubernetes setup and troubleshooting guidance for web-app charm how-tos, but it does not cover Spread integration testing.

  • Related To: charmcraft#2732 (confidence 86%)

    Commit 14284182 records “docs: Update 12-factor Spread tests,” indicating adjacent guidance work, but no evidence identifies it as resolving this general tutorial request.

Related issues

Issue Project State Summary Similarity
#2743 docs: add Canonical K8s instructions to web app charm how-tos charmcraft merged Merged charmcraft#2743, adding Canonical Kubernetes tabs and commands for load-balancer setup and pod/log troubleshooting alongside MicroK8s guidance.
73%