GitOpsHQ Documentation
Complete product documentation for teams that build, deploy, and operate with GitOpsHQ.
GitOpsHQ is a unified GitOps control plane that manages Kubernetes deployments across organizations, projects, tenants, and environments. This documentation covers every feature of the platform.
Quick Navigation
What is GitOpsHQ?
Architecture, object model, and key concepts
15-Minute Quickstart
Get up and running fast
Platform Setup
Auth, orgs, clusters, and registry
Deployment
Projects, releases, promotions, rollbacks
Governance
Policies, OPA engine, API keys, audit
Operations
Dashboard, drift, observability, runbooks
Reference
Roadmap traceability, feature gates, runtime limits, API map
End-to-End Scenarios
8 cross-module real product workflows
Team Playbooks
Role-specific daily workflows
FAQ
Common questions answered quickly
Changelog
Release history and upcoming roadmap
Start by Role
Developer
Service config, values, releases, monitoring
DevOps Engineer
Release management, CI/CD, promotions
Platform Engineer
Org governance, RBAC, clusters, catalog
SRE
Reliability, incident response, rollback, drift
Documentation Structure
Core Concepts — Understand the architecture, object model, and terminology.
Quickstart — Set up your first project and deploy in 15 minutes.
How-To Guides — Step-by-step task guides with validation checklists.
Reference — Code-verified roadmap traceability, feature gate behavior, limits, and API map.
Platform Setup — Configure auth, organizations, clusters, and the artifact registry.
Deployment — Projects, tenants, workloads, releases, promotion, and rollback.
Governance — Approval policies, OPA engine, API keys, notifications, and audit.
Operations — Dashboard, drift detection, observability, and runbooks.
Complete Reference
| Section | What's Inside |
|---|---|
| Reference | Roadmap Traceability · Feature Gates and Limits · API Surface Map |
| Platform Setup | Auth · Organization · Clusters · Registry |
| Deployment | Projects · Tenants · Workloads · Variables · Git/Editor · Releases · Promotion · Rollback · Compare |
| Governance | Approvals · OPA Engine · API Keys · Notifications |
| Operations | Dashboard · Drift · Delivery · K8s Validation · Observability · Runbooks |