canonical / canonical/canonical-openstack-docs

docs: Improved visibility into viewing Juju unit logs

Open
#159 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
10
Forks
36
Avg merge
4d 13h
Merged PRs (30d)
5

Description

Hi,

Juju units logs can be viewed with:

```
sudo k8s kubectl logs --namespace openstack --container
```

This is currently documented under _How-to Guides_ > _Troubleshooting_ > _Inspecting the cluster_ > _Services hosted on Canonical Kubernetes_, which seems too deeply buried in the docs for how essential and common an operation it is. It is also difficult to search. Those of us with long experiences with Charmed OpenStack will try (and have already tried) to `juju ssh` to units then check under `/var/log/juju/`, which is empty in Sunbeam.

It seems reasonable to also document this in a much more prominent and easily searchable location, such as adding a section like _How-to Guides_ > _Operations_ > _Checking unit logs_.

Contributor guide

Open the contributing guide

Research direction

Start in How-to Guides > Troubleshooting > Inspecting the cluster > Services hosted on Canonical Kubernetes and review how the existing kubectl logs command is documented. Add a prominent, searchable How-to Guides > Operations > Checking unit logs section with the shown command and its namespace, container, and pod placeholders; done when the guidance is easy to find in the docs.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.