# OpenChoreo Documentation (v1.1.x) > A complete, open-source developer platform for Kubernetes, ready to use from day one, built to integrate with your stack. ## Ecosystem - [Modules](https://openchoreo.dev/ecosystem/modules.md) - [Integrations](https://openchoreo.dev/ecosystem/integrations.md) - [Component Types](https://openchoreo.dev/ecosystem/component-types.md) - [Workflows](https://openchoreo.dev/ecosystem/workflows.md) - [Skills](https://openchoreo.dev/ecosystem/skills.md) - [Agents](https://openchoreo.dev/ecosystem/agents.md) ## Overview - [What is OpenChoreo](https://openchoreo.dev/docs.md) - [Architecture](https://openchoreo.dev/docs/overview/architecture.md) ## Get Started - [Quick Start Guide](https://openchoreo.dev/docs/getting-started/quick-start-guide.md) - [Run Locally on K3d](https://openchoreo.dev/docs/getting-started/try-it-out/on-k3d-locally.md) - [Run in Your Environment](https://openchoreo.dev/docs/getting-started/try-it-out/on-your-environment.md) - [CLI Installation](https://openchoreo.dev/docs/getting-started/cli-installation.md) - [Deploy and Explore](https://openchoreo.dev/docs/getting-started/deploy-and-explore.md) - [Examples Catalog](https://openchoreo.dev/docs/getting-started/examples-catalog.md) ## Concepts - [Developer Abstractions](https://openchoreo.dev/docs/concepts/developer-abstractions.md) - [Platform Abstractions](https://openchoreo.dev/docs/concepts/platform-abstractions.md) - [Runtime Model](https://openchoreo.dev/docs/concepts/runtime-model.md) - [Resource Relationships](https://openchoreo.dev/docs/concepts/resource-relationships.md) ## Platform Engineer Guide - [Resource Types](https://openchoreo.dev/docs/platform-engineer-guide/resource-types.md) ### Platform Setup - [Deployment Topology](https://openchoreo.dev/docs/platform-engineer-guide/deployment-topology.md) - [Multi-Cluster Connectivity](https://openchoreo.dev/docs/platform-engineer-guide/multi-cluster-connectivity.md) - [mTLS Setup for Cluster Gateway and Agent with External CA](https://openchoreo.dev/docs/platform-engineer-guide/external-ca-tls-setup.md) - [Controlplane Namespace Management](https://openchoreo.dev/docs/platform-engineer-guide/namespace-management.md) - [Container Registry Configuration](https://openchoreo.dev/docs/platform-engineer-guide/container-registry-configuration.md) - [Identity Provider Configuration](https://openchoreo.dev/docs/platform-engineer-guide/identity-configuration.md) - [Backstage Configuration](https://openchoreo.dev/docs/platform-engineer-guide/backstage-configuration.md) - [Backstage Entity Ownership](https://openchoreo.dev/docs/platform-engineer-guide/backstage-ownership.md) - [Custom Backstage Scaffolder Templates](https://openchoreo.dev/docs/platform-engineer-guide/backstage-scaffolder-templates.md) - [Secret Management](https://openchoreo.dev/docs/platform-engineer-guide/secret-management.md) ### Backstage Plugins - [Backstage Plugins](https://openchoreo.dev/docs/platform-engineer-guide/backstage-plugins/overview.md) - [Installing into an existing Backstage app](https://openchoreo.dev/docs/platform-engineer-guide/backstage-plugins/installing-into-existing-backstage.md) - [Catalog sync](https://openchoreo.dev/docs/platform-engineer-guide/backstage-plugins/catalog-sync.md) - [Entity views](https://openchoreo.dev/docs/platform-engineer-guide/backstage-plugins/entity-views.md) - [Permission policy](https://openchoreo.dev/docs/platform-engineer-guide/backstage-plugins/permission-policy.md) - [Troubleshooting](https://openchoreo.dev/docs/platform-engineer-guide/backstage-plugins/troubleshooting.md) - [Compatibility matrix](https://openchoreo.dev/docs/platform-engineer-guide/backstage-plugins/compatibility-matrix.md) ### Component Types & Traits - [Overview](https://openchoreo.dev/docs/platform-engineer-guide/component-types/overview.md) - [Templating Syntax](https://openchoreo.dev/docs/platform-engineer-guide/component-types/templating-syntax.md) - [openAPIV3Schema](https://openchoreo.dev/docs/platform-engineer-guide/component-types/schema-syntax.md) - [Patching Syntax](https://openchoreo.dev/docs/platform-engineer-guide/component-types/patching-syntax.md) - [Validation Rules](https://openchoreo.dev/docs/platform-engineer-guide/component-types/validation-rules.md) ### Workflows & CI - [Overview](https://openchoreo.dev/docs/platform-engineer-guide/workflows/overview.md) - [Creating Workflows](https://openchoreo.dev/docs/platform-engineer-guide/workflows/creating-workflows.md) - [Schema Syntax](https://openchoreo.dev/docs/platform-engineer-guide/workflows/schema-syntax.md) - [Running Workflows](https://openchoreo.dev/docs/platform-engineer-guide/workflows/running-workflows.md) #### CI - [CI Governance](https://openchoreo.dev/docs/platform-engineer-guide/workflows/ci-governance.md) - [Workload Generation](https://openchoreo.dev/docs/platform-engineer-guide/workflows/workload-generation.md) - [Workload Publishing Credentials](https://openchoreo.dev/docs/platform-engineer-guide/workflows/workflow-workload-configuration.md) - [Auto Build](https://openchoreo.dev/docs/platform-engineer-guide/workflows/auto-build.md) - [External CI Integration](https://openchoreo.dev/docs/platform-engineer-guide/workflows/external-ci.md) ### API Gateway - [Modular Architecture](https://openchoreo.dev/docs/platform-engineer-guide/api-gateway/modules.md) - [Gateway Topology](https://openchoreo.dev/docs/platform-engineer-guide/api-gateway/topology.md) ### Observability - [Observability & Alerting](https://openchoreo.dev/docs/platform-engineer-guide/observability-alerting.md) ### Authorization & Access Control - [Overview](https://openchoreo.dev/docs/platform-engineer-guide/authorization/overview.md) - [Authorization Configuration](https://openchoreo.dev/docs/platform-engineer-guide/authorization.md) - [Custom Roles and Bindings](https://openchoreo.dev/docs/platform-engineer-guide/authorization/custom-roles.md) - [Conditions](https://openchoreo.dev/docs/platform-engineer-guide/authorization/conditions.md) ### GitOps - [Overview](https://openchoreo.dev/docs/platform-engineer-guide/gitops/overview.md) - [Using Flux CD](https://openchoreo.dev/docs/platform-engineer-guide/gitops/using-flux-cd.md) #### Automations - [Build and Release Workflows](https://openchoreo.dev/docs/platform-engineer-guide/gitops/automations/build-and-release-workflows.md) - [Bulk Promote Workflow](https://openchoreo.dev/docs/platform-engineer-guide/gitops/automations/bulk-promote.md) ### Modules - [Modules Overview](https://openchoreo.dev/docs/platform-engineer-guide/modules/overview.md) #### Building a Module - [Building a Module](https://openchoreo.dev/docs/platform-engineer-guide/modules/building-a-module.md) - [Logs Adapter API Reference](https://openchoreo.dev/docs/platform-engineer-guide/modules/observability-logging-adapter-api.md) - [Metrics Adapter API Reference](https://openchoreo.dev/docs/platform-engineer-guide/modules/observability-metrics-adapter-api.md) - [Tracing Adapter API Reference](https://openchoreo.dev/docs/platform-engineer-guide/modules/observability-tracing-adapter-api.md) ### Operations & Maintenance - [CLI Configuration](https://openchoreo.dev/docs/platform-engineer-guide/cli-configuration.md) - [Upgrades](https://openchoreo.dev/docs/platform-engineer-guide/upgrades.md) - [Cluster Agent RBAC Configuration](https://openchoreo.dev/docs/platform-engineer-guide/cluster-agent-rbac.md) ## Developer Guide ### Projects and Components - [Overview](https://openchoreo.dev/docs/developer-guide/projects-and-components/overview.md) - [Creating a Project](https://openchoreo.dev/docs/developer-guide/projects-and-components/creating-a-project.md) - [Creating a Component](https://openchoreo.dev/docs/developer-guide/projects-and-components/creating-a-component.md) ### Define Your Workload - [Overview](https://openchoreo.dev/docs/developer-guide/workload/overview.md) - [Endpoint Dependencies](https://openchoreo.dev/docs/developer-guide/dependencies/endpoints.md) - [Resource Dependencies](https://openchoreo.dev/docs/developer-guide/dependencies/resources.md) ### Build Your Code - [CI Overview](https://openchoreo.dev/docs/developer-guide/workflows/ci/overview.md) - [Workload Descriptor](https://openchoreo.dev/docs/developer-guide/workflows/ci/workload-descriptor.md) - [Auto-Build](https://openchoreo.dev/docs/developer-guide/workflows/ci/auto-build.md) - [Private Git Repository](https://openchoreo.dev/docs/developer-guide/workflows/ci/private-repository.md) ### Deploying Applications - [Overview](https://openchoreo.dev/docs/developer-guide/deploying-applications/overview.md) - [Deploy and Promote](https://openchoreo.dev/docs/developer-guide/deploying-applications/deploy-and-promote.md) - [Environment Overrides](https://openchoreo.dev/docs/developer-guide/deploying-applications/environment-overrides.md) - [Logs and Troubleshooting](https://openchoreo.dev/docs/developer-guide/deploying-applications/logs-and-troubleshooting.md) ## Tutorials - [Deploy a Prebuilt Container Image](https://openchoreo.dev/docs/tutorials/deploy-prebuilt-image.md) - [Build from a Private Repository and Deploy via a Private Registry](https://openchoreo.dev/docs/tutorials/build-and-deploy-private.md) - [Deploy an Application with Configurations and Secrets](https://openchoreo.dev/docs/tutorials/deploy-with-configurations.md) - [Configure Component Alerts and Manage Incidents](https://openchoreo.dev/docs/tutorials/component-alerts-and-incidents.md) - [Analyze component cost using FinOps agent](https://openchoreo.dev/docs/tutorials/configure-budget-alert-and-cost-analysis.md) ## Ecosystem - [Ecosystem](https://openchoreo.dev/docs/ecosystem/overview.md) ## Working with AI - [Overview](https://openchoreo.dev/docs/ai/overview.md) ### MCP Servers - [Configuring MCP Servers with AI Assistants](https://openchoreo.dev/docs/ai/mcp-servers.md) - [MCP Prompt Scenarios](https://openchoreo.dev/docs/ai/mcp-prompt-scenarios.md) ### Built-in Agents - [FinOps Agent](https://openchoreo.dev/docs/ai/finops-agent.md) - [SRE Agent](https://openchoreo.dev/docs/ai/sre-agent.md) - [Portal Assistant](https://openchoreo.dev/docs/ai/portal-assistant.md) ## References - [MCP Servers](https://openchoreo.dev/docs/reference/mcp-servers.md) - [CLI Reference](https://openchoreo.dev/docs/reference/cli-reference.md) ### Helm Charts - [Control Plane](https://openchoreo.dev/docs/reference/helm/control-plane.md) - [Data Plane](https://openchoreo.dev/docs/reference/helm/data-plane.md) - [Workflow Plane](https://openchoreo.dev/docs/reference/helm/workflow-plane.md) - [Observability Plane](https://openchoreo.dev/docs/reference/helm/observability-plane.md) ### API Reference #### Application Resources - [Project](https://openchoreo.dev/docs/reference/api/application/project.md) - [Component](https://openchoreo.dev/docs/reference/api/application/component.md) - [WorkflowRun](https://openchoreo.dev/docs/reference/api/application/workflowrun.md) - [Workload](https://openchoreo.dev/docs/reference/api/application/workload.md) - [Resource](https://openchoreo.dev/docs/reference/api/application/resource.md) #### Platform Resources ##### Infrastructure - [DataPlane](https://openchoreo.dev/docs/reference/api/platform/dataplane.md) - [ClusterDataPlane](https://openchoreo.dev/docs/reference/api/platform/clusterdataplane.md) - [WorkflowPlane](https://openchoreo.dev/docs/reference/api/platform/workflowplane.md) - [ClusterWorkflowPlane](https://openchoreo.dev/docs/reference/api/platform/clusterworkflowplane.md) - [ObservabilityPlane](https://openchoreo.dev/docs/reference/api/platform/observabilityplane.md) - [ClusterObservabilityPlane](https://openchoreo.dev/docs/reference/api/platform/clusterobservabilityplane.md) ##### Governance - [ComponentType](https://openchoreo.dev/docs/reference/api/platform/componenttype.md) - [ClusterComponentType](https://openchoreo.dev/docs/reference/api/platform/clustercomponenttype.md) - [Trait](https://openchoreo.dev/docs/reference/api/platform/trait.md) - [ClusterTrait](https://openchoreo.dev/docs/reference/api/platform/clustertrait.md) - [ResourceType](https://openchoreo.dev/docs/reference/api/platform/resourcetype.md) - [ClusterResourceType](https://openchoreo.dev/docs/reference/api/platform/clusterresourcetype.md) - [Workflow](https://openchoreo.dev/docs/reference/api/platform/workflow.md) - [ClusterWorkflow](https://openchoreo.dev/docs/reference/api/platform/clusterworkflow.md) - [SecretReference](https://openchoreo.dev/docs/reference/api/platform/secretreference.md) ##### Deployment - [DeploymentPipeline](https://openchoreo.dev/docs/reference/api/platform/deployment-pipeline.md) - [Environment](https://openchoreo.dev/docs/reference/api/platform/environment.md) - [ReleaseBinding](https://openchoreo.dev/docs/reference/api/platform/releasebinding.md) - [ResourceReleaseBinding](https://openchoreo.dev/docs/reference/api/platform/resourcereleasebinding.md) ##### Observability - [ObservabilityAlertRule](https://openchoreo.dev/docs/reference/api/platform/observabilityalertrule.md) - [ObservabilityAlertsNotificationChannel](https://openchoreo.dev/docs/reference/api/platform/observabilityalertsnotificationchannel.md) ##### Authorization - [AuthzRole](https://openchoreo.dev/docs/reference/api/platform/authzrole.md) - [ClusterAuthzRole](https://openchoreo.dev/docs/reference/api/platform/clusterauthzrole.md) - [AuthzRoleBinding](https://openchoreo.dev/docs/reference/api/platform/authzrolebinding.md) - [ClusterAuthzRoleBinding](https://openchoreo.dev/docs/reference/api/platform/clusterauthzrolebinding.md) #### Runtime Resources - [ComponentRelease](https://openchoreo.dev/docs/reference/api/runtime/componentrelease.md) - [ResourceRelease](https://openchoreo.dev/docs/reference/api/runtime/resourcerelease.md) - [RenderedRelease](https://openchoreo.dev/docs/reference/api/runtime/renderedrelease.md) ### CEL Reference - [Context Variables](https://openchoreo.dev/docs/reference/cel/context-variables.md) - [Built-in Functions](https://openchoreo.dev/docs/reference/cel/built-in-functions.md) - [Helper Functions](https://openchoreo.dev/docs/reference/cel/helper-functions.md) ## Releases - [Releases](https://openchoreo.dev/docs/releases/release-and-support-process.md) ## Changelog - [Changelog](https://openchoreo.dev/docs/changelog.md) ## FAQ - [FAQ](https://openchoreo.dev/docs/reference/faq.md) ## Other versions - [Latest stable (v1.1.x)](https://openchoreo.dev/llms.txt) - [Bleeding edge (next)](https://openchoreo.dev/llms-next.txt) - [v1.2.0-m.1 (pre-release)](https://openchoreo.dev/llms-v1.2.0-m.1.txt) - [v1.1.x](https://openchoreo.dev/llms-v1.1.x.txt) - [v1.0.x](https://openchoreo.dev/llms-v1.0.x.txt) - [v0.17.x](https://openchoreo.dev/llms-v0.17.x.txt) - [v0.16.x](https://openchoreo.dev/llms-v0.16.x.txt)