Links
DevsPortal is built on the Control Plane Operator engine. These docs cover the product and the Fedshi instance; the deep engine reference lives in the upstream Control Plane Operator documentation. This page is the map of which to read for what.
note
Keep the split in mind: anything specific to this branded instance (hostnames, versions, install, admin, onboarding) is here; anything about the engine's generic API, configuration language, or Helm internals is upstream.
What these docs cover
| Area | Where |
|---|---|
| What DevsPortal is, why, and how it works | Overview |
| Deploying and operating the Fedshi instance | Operators |
| Day-2 admin (upgrades, branding, backup, troubleshooting) | Operators › Day 2 |
| Developer onboarding and self-service | Developers |
| Team setup and roles | Teams |
| This instance's environment map, versions, endpoints, and API surface | Reference |
What to read upstream
Read the upstream Control Plane Operator docs for deep, engine-generic reference that does not change per customer:
| Upstream section | Read it for | Link |
|---|---|---|
| API / CRD reference | Field-level spec of every openchoreo.dev/v1alpha1 kind | https://openchoreo.dev/docs/reference/api/ |
| CEL reference | The Common Expression Language used in component/trait rendering | https://openchoreo.dev/docs/reference/cel/ |
| Helm reference | Chart values for the control/data/workflow/observability planes | https://openchoreo.dev/docs/reference/helm/ |
| Concepts & modules | How the engine, planes, and abstractions work in general | https://openchoreo.dev/docs/concepts/ |
| Docs home | Everything else in the engine documentation | https://openchoreo.dev/docs |
Source repositories
| Repository | What it is | Link |
|---|---|---|
| Engine | The Control Plane Operator engine (controllers, CRDs, charts, CLI) | https://github.com/openchoreo/openchoreo |
| UI / Backstage plugins | The portal plugins DevsPortal brands and builds on | https://github.com/openchoreo/backstage-plugins |
Related pages
- Resource Model — the hierarchy charts and a reference page per kind.
- API and CRDs — how the API maps to those resources, and how to authenticate.
- Versions — the pinned chart and image versions for this instance.