← Back to issue list

docs: add Canonical K8s instructions to web app charm how-tos

View original Github issue

Metadata

Project
charmcraft
Number
#2743
Type
pull request
State
merged
Author
florentianayuwono
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

No scores available.

Issue body

Migrate the MicroK8s-only steps in the `manage-web-app-charms` how-to guides to also cover Canonical K8s, following the tabbed pattern already used in the "Use a database with your 12-factor app charm" guide. MicroK8s instructions are kept and Canonical K8s equivalents are added alongside them in `MicroK8s` / `Canonical K8s` tabs. Changes: - `integrate-web-app-charm.rst`: the Traefik load balancer setup now offers a Canonical K8s tab (`sudo k8s set load-balancer...` / `sudo k8s enable load-balancer`) next to the MicroK8s MetalLB steps. - `use-web-app-charm.rst`: the troubleshooting "Check Kubernetes pod services and logs" section now provides Canonical K8s `sudo k8s kubectl` equivalents, including per-framework log commands, plus a Canonical Kubernetes troubleshooting link. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [ ] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ ] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. - [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [ ] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b 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.
qwen/qwen3.6-35b-a3b Merged documentation update adding Canonical K8s instructions alongside MicroK8s steps in web app charm guides. Added tabbed sections for load balancer setup and troubleshooting. Approved by two reviewers and passed CI checks.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update adding Canonical K8s instructions alongside MicroK8s steps in web app charm guides. Updated two RST files with tabbed load balancer and troubleshooting configurations.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#2477 docs: add tutorial for testing a k8s charm charmcraft 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.
70%