# Kaniop

> Kaniop is a Kubernetes operator for declaratively managing Kanidm clusters and identity resources through Kubernetes Custom Resources.

Use this file as the machine-oriented documentation index. Follow only the links needed for the task. For exact fields and validation, prefer the CRDs installed in the target cluster or the generated CRD schema. For repository development tasks, read the repository agent instructions before editing.

Source precedence for operational answers is: installed CRDs via `kubectl explain` > generated CRD schema > generated examples > Helm values/schema > public documentation > internal ADRs and plans > narrative agent guidance.

## Documentation

- [Introduction](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/index.md)
- [Architecture](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/architecture.md)
- [Getting Started](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/getting-started.md)
  - [Concepts](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/concepts.md)
  - [Quickstart](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/quickstart.md)
- [Installation](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/installation.md)
- [Usage](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/usage.md)
  - [Managing Kanidm Clusters](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/usage/kanidm.md)
  - [Backup and Restore (Experimental)](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/usage/backup-restore.md)
  - [OAuth2 Integration](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/usage/oauth2.md)
  - [Managing Groups](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/usage/group.md)
  - [Managing Persons](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/usage/person.md)
  - [Managing Service Accounts](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/usage/service.md)
- [Webhook Validation](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/webhook.md)
- [Upgrade Guides](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/upgrade/index.md)
  - [v0.11 CRD Plural Migration](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/upgrade/v0.11-migration.md)
- [Troubleshooting](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/troubleshooting.md)
- [Project Analysis](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/project-analysis/index.md)
  - [Methodology](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/project-analysis/methodology.md)
  - [Current Report](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/project-analysis/current.md)
  - [Historical Snapshots](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/project-analysis/history/index.md)
    - [2026-08-29 Baseline](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/project-analysis/history/2026-08-29.md)
- [LLM Operations Guide](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/llm-guide.md)
- [Contributing](https://raw.githubusercontent.com/pando85/kaniop/master/Documentation/src/contributing.md)

## Machine-readable sources

- [Generated CRD schema](https://raw.githubusercontent.com/pando85/kaniop/master/charts/kaniop/crds/crds.yaml): Authoritative repository schema for fields, required values, validation, status, and descriptions.
- [Generated examples](https://github.com/pando85/kaniop/tree/master/examples): Generated safe manifest shapes for common operations.
- [Helm values](https://raw.githubusercontent.com/pando85/kaniop/master/charts/kaniop/values.yaml): Install-time defaults and comments.
- [Helm values schema](https://raw.githubusercontent.com/pando85/kaniop/master/charts/kaniop/values.schema.json): Valid Helm value structure and types.

## Agent guidance

- [Detailed LLM operations guide](llms-full.txt): Source precedence, operational order, common commands, status interpretation, troubleshooting, and LLM-specific pitfalls.
- [Repository agent instructions](https://raw.githubusercontent.com/pando85/kaniop/master/AGENTS.md): Canonical instructions for coding agents working in the repository.