Skip to content

docs: add a What is COS doc#262

Open
sinapah wants to merge 6 commits intomainfrom
docs/feat/what-is-cos-doc
Open

docs: add a What is COS doc#262
sinapah wants to merge 6 commits intomainfrom
docs/feat/what-is-cos-doc

Conversation

@sinapah
Copy link
Copy Markdown
Contributor

@sinapah sinapah commented Apr 16, 2026

Issue

  1. Removes the stack variants doc since most of its info was repeated in the COS Components doc anyway. Move the necessary information to the What is COS doc.
  2. Add a doc explaining COS and its "flavours".

Solution

Checklist

  • I have added or updated relevant documentation.
  • PR title makes an appropriate release note and follows conventional commits syntax.
  • Merge target is the correct branch, and relevant tandem backport PRs opened.

Context

Testing Instructions

Upgrade Notes

@sinapah sinapah changed the title docs: What is COS doc docs: add a What is COS doc Apr 16, 2026
@sinapah sinapah marked this pull request as ready for review April 16, 2026 16:29
@sinapah sinapah requested a review from a team as a code owner April 16, 2026 16:29
Comment thread docs/explanation/overview/what-is-cos.md Outdated
Comment thread docs/explanation/overview/what-is-cos.md Outdated
Comment thread docs/explanation/overview/what-is-cos.md Outdated

# What is COS?

The **Canonical Observability Stack** (COS) is a highly-integrated, low-operations observability suite powered by [Juju](https://documentation.ubuntu.com/juju/3.6/) and Kubernetes.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The **Canonical Observability Stack** (COS) is a highly-integrated, low-operations observability suite powered by [Juju](https://documentation.ubuntu.com/juju/3.6/) and Kubernetes.
The Canonical Observability Stack (COS) is a highly-integrated, low-operations observability suite powered by [Juju](https://documentation.ubuntu.com/juju/3.6/) and Kubernetes. There are two editions available: COS and COS Lite.

This should be clarified somewhere in the intro section. I like here/upfront better, but it could also be as a new line at the bottom.

The reason I'm suggesting this is because "COS" can be used to be either COS or "COS and COS Lite" (i.e., the entire product/offering), so it's good to set that clarification early - basically implying that "COS" can refer to both editions

(I made a similar call-out in a What is Landscape? doc)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this okay:

Suggested change
The **Canonical Observability Stack** (COS) is a highly-integrated, low-operations observability suite powered by [Juju](https://documentation.ubuntu.com/juju/3.6/) and Kubernetes.
The Canonical Observability Stack (COS) is a highly-integrated, low-operations observability suite powered by [Juju](https://documentation.ubuntu.com/juju/3.6/) and Kubernetes. There are two editions available: COS HA (more commonly referred to as COS) and COS Lite.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

COS (sometimes referred to as COS HA)

Comment thread docs/explanation/overview/what-is-cos.md Outdated
Comment thread docs/explanation/overview/what-is-cos.md Outdated
- Alert rules are evaluated by Prometheus and Loki, and notifications are routed through **Alertmanager**.
- All telemetry is visualised through **Grafana**, which is pre-configured to query each backend as a datasource.

Juju topology labels are automatically applied to all telemetry, making it possible to filter and correlate data by model, application, unit, or charm.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the Juju telemetry labels page in the COS docs

Comment thread docs/explanation/overview/what-is-cos.md Outdated
Comment thread docs/explanation/overview/what-is-cos.md Outdated
@sinapah sinapah requested a review from YanisaHS April 16, 2026 19:00
Copy link
Copy Markdown
Collaborator

@YanisaHS YanisaHS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but pointing out Leon's suggestion to call them "variants" rather than "editions"

@sinapah sinapah requested a review from a team as a code owner April 17, 2026 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants