Environment
An Environment is a first-class stage in the delivery lifecycle — development, staging,
production, or whatever your org uses. It is not just a label: an Environment maps to a data
plane, the cluster where workloads for that stage actually run. That mapping is its main job;
it also marks whether the stage is production, which downstream governance keys off.
| Kind | Environment (short: env) |
| API group | openchoreo.dev/v1alpha1 |
| Scope | Namespaced |
| Audience | Platform engineer |
| Maps to | DataPlane (spec.dataPlaneRef) |
| Wired by | DeploymentPipeline (promotion paths), ReleaseBinding (deploy target) |
Key spec fields
| Field | Description |
|---|---|
spec.dataPlaneRef.kind | DataPlane or ClusterDataPlane |
spec.dataPlaneRef.name | The data plane this stage runs on |
spec.isProduction | Marks the stage as production for governance/conditions |
metadata.annotations[openchoreo.dev/display-name] | Human-readable name |
Because the mapping is explicit, you can shape topology freely — share one data plane between
development and staging, give production a dedicated HA plane, or point eu-production and
us-production at regional planes.
Create in the portal
- Open Create… → Platform Resources → Environment.
- Name the stage (e.g.
development), choose the data plane it maps to, and mark whether it's production. - Click Create. Wire it into a Deployment pipeline to make it a promotion target.
Prefer YAML/GitOps? See the Example below, or Environments and pipelines.
Example
apiVersion: openchoreo.dev/v1alpha1
kind: Environment
metadata:
name: development
namespace: fedshi
annotations:
openchoreo.dev/display-name: "Development"
spec:
dataPlaneRef:
kind: ClusterDataPlane
name: default
isProduction: false
See also
- Environments and pipelines (authoring guide).
- Environment map — the concrete environments on the Fedshi instance.
- Deployment pipeline · Planes
- Upstream field-level API reference.