---
myst:
  html_meta:
    "description": "Information-oriented technical reference for cdk8s-monitoring: configuration options, sync-wave order, alerts and routing, Grafana datasources, dropped metrics, and the construct API."
    "property=og:description": "Information-oriented technical reference for cdk8s-monitoring: configuration options, sync-wave order, alerts and routing, Grafana datasources, dropped metrics, and the construct API."
    "property=og:title": "Reference"
    "keywords": "cdk8s, Kubernetes, monitoring, reference, configuration, API, sync waves"
---

```{image} ../_static/kup6s-icon-reference.svg
:align: center
:class: section-icon-large
```

# Reference

**Information-oriented technical specifications for cdk8s-monitoring.**

Reference pages describe the machinery exactly.
They state facts: configuration fields, their defaults, the rollout order, the generated alerting and Grafana configuration, and the public API.
For task-driven instructions, see the {doc}`../how-to/index`.

## Configuration

```{toctree}
---
maxdepth: 1
titlesonly: true
---
configuration-options
sync-waves
```

## Generated resources

```{toctree}
---
maxdepth: 1
titlesonly: true
---
alerts-and-routing
grafana-datasources
dropped-metrics
```

## API

```{toctree}
---
maxdepth: 1
titlesonly: true
---
api/index
```

---

**Getting started?** Begin with the {doc}`../tutorials/index`.

**Solving a problem?** See the {doc}`../how-to/index`.

**Understanding concepts?** Read the {doc}`../explanation/index`.