[WIP] pyroscope-coordinator-k8s docs - index

Pyroscope Coordinator Charm (part of Charmed Pyroscope HA)

pyroscope-coordinator-k8s is a charm that, in conjunction with the pyroscope-worker-k8s charm, deploys and operates Grafana Pyroscope, a continuous profiling backend by Grafana Labs.

This charm, together with one or multiple worker charms, handles deployment, scaling, configuration, and Day 2 operations specific to Grafana Pyroscope.

This operator is the main entry point to the distributed Pyroscope deployment. It is responsible for configuring the worker nodes and runs an Nginx instance to provide an unified access point to all incoming traffic.

Important! This charm only works in conjunction with its counterpart, and, when deployed in isolation, is not functional. This documentation only contains charm-specific, and as such relatively low-level documentation. For the solution-level documentation, look at the solution-level Charmed Pyroscope HA docs.

This charm is:

This charm, as well as its counterpart, will not be released to the stable channel until we implement profiling support via the otel-collector charm.

In this documentation

Tutorial
Get started - a hands-on introduction for new users deploying the charmed operator.
How-to guides
Step-by-step guides covering key operations and common tasks
Explanation
Concepts - discussion and clarification of key topics
Reference
Technical information - specifications, APIs, architecture

Project and community

Charmed Pyroscope is part of the Canonical Observability Stack. It is an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

Thinking about using the Canonical Observability Stack for your next project? Get in touch!

Navigation

Level Path Navlink
1 Tutorials Tutorials
1 How To How To
1 Reference Reference
1 Explanation Explanation
2 worker-coordinator architecture The worker-coordinator architecture