Introduction¶
harbor-operator manages Harbor resources through Kubernetes custom resources.
This site is split into introduction material, API documentation, worked examples, and contributor guidance.
Start Here¶
-
Introduction
Start locally, understand the model, and find the main operator concepts.
-
API
Read resource guides and generated schema reference in one place.
-
Examples
Start from sample manifests for common tasks such as connections, projects, and robot accounts.
-
Contributing
Find the local workflow, testing expectations, and docs/publishing notes.
Documentation Model¶
The hand-written pages explain how the operator behaves:
- how a resource maps to Harbor
- ownership and deletion semantics
- examples and operational notes
The generated API reference documents the schema from the Go API types and Kubebuilder markers:
- fields and types
- defaults
- enums
- validation rules
Documentation Versioning¶
The published docs site tracks the current main branch only.
If you need docs for an older release or historical behavior, check out the relevant git tag or commit in the repository and read the Markdown files directly or run:
make docs-build