docs: Clarify the use of ~/.kube/config during deployment.
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- kubernetes
- Domain
- devops, documentation
Research direction
Open the reported COS on Canonical K8s installation page and review its deployment instructions around kubeconfig usage. Clarify whether deployment uses the local ~/.kube/config regardless of the cluster type, or document how Juju should provide the kubeconfig; done means a reader can determine which cluster the deployment targets.
Written by the indexing model from the issue text.
Description
Please describe the question or issue you're facing with "Getting started with COS on Canonical K8s - Observability documentation".
The documentation should make it clear that the local ~/.kube/config is assumed to be used when deploying. I had a non-charmed/snap/microk8s (k3s) cluster it happily deployed on. It should ideally use juju to fetch the relevant kubeconfig from the juju k8s model it would have access to.
Alternatively, the docs should make it clear that ~/.kube/config is used regardless of whether or not the k8s cluster it points to is one deployed via juju.
Reported from: https://documentation.ubuntu.com/observability/track-2/tutorial/installation/cos-canonical-k8s-sandbox/
- Dominant language
- HCL
- Stars
- 9
- Forks
- 12
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 11
Contributor guide
No contributing guide indexed for this repository
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 canonical/observability-stack
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
canonical/observability-stack#476 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
canonical/observability-stack#428 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
canonical/observability-stack#422 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
canonical/observability-stack#344 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
canonical/observability-stack#306 ·
All issues in canonical/observability-stack
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
repo:raw-data
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
hotosm/raw-data-api#316 · 1 comment ·
-
agentic-workflows cascade-suspected
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
willow
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
openedx/openedx-authz#460 ·