Skip to main content
Version: v1.0.0-rc.1 (pre-release)

Authorization in OpenChoreo

OpenChoreo provides a Kubernetes-native, Hierarchical Role-Based Access Control (RBAC) system that controls who can perform what actions on which resources. The authorization system is built on four Custom Resource Definitions (CRDs) that define roles, permissions, and bindings β€” all managed declaratively alongside your workloads.

note

Authorization can be disabled for testing purposes. When disabled, a passthrough implementation allows all requests without any policy evaluation.

Core Concepts​

Subject​

A subject represents the identity making a request. Subjects are identified by entitlements β€” claim-value pairs extracted from the caller's JWT/OIDC token. For example:

  • groups:platformEngineer β€” user belongs to the "platformEngineer" group
  • sub:user-abc-123 β€” user's unique identifier
  • email:alice@acme.com β€” user's email address

A single user can have multiple entitlements (e.g., belonging to several groups), and each entitlement is evaluated independently during authorization.

Action​

An action represents an operation that can be performed on a resource. Actions follow the format resource:verb. For example:

  • component:create β€” create a new component
  • project:view β€” view a project
  • componenttype:create β€” create a new component type

Actions also support wildcards:

  • component:* β€” all operations on components
  • * β€” all operations on all resources

Resource Hierarchy​

Resources in OpenChoreo form a four-level ownership hierarchy:

Cluster (everything)
└── Namespace
└── Project
└── Component

Every resource belongs to a specific point in this hierarchy. For example, a component belongs to a project, which belongs to a namespace. Cluster-scoped resources (like ClusterAuthzRole or ClusterDataPlane) sit at the top level and are not owned by any namespace.

Scope​

Scope is the boundary that controls where in the resource hierarchy a role's permissions apply. When a role binding includes a scope, only resources at or below that point in the hierarchy are affected. Resources outside the scope are invisible to that binding, as if it doesn't exist.

Scope is set via the scope field on each role mapping in a binding:

Scope levelHow to setWhat it means
Cluster-wideOmit scope on a ClusterAuthzRoleBindingPermissions apply to all resources at every level of the hierarchy
Namespacescope.namespace: acmePermissions apply to the acme namespace and all resources within it β€” its projects, their components, and any other namespace-scoped resources
Projectscope.namespace: acme, scope.project: crmPermissions apply to the crm project and all resources within it
Componentscope.namespace: acme, scope.project: crm, scope.component: backendPermissions apply only to the backend component and its resources

Effective Permissions​

A role defines what actions are permitted (e.g., component:view, project:create). Scope defines where those actions take effect. The effective permissions of a binding are the intersection of both β€” a user can only perform an action if the role grants that action and the target resource falls within the scope.

For example, a developer role that includes component:create and project:view:

  • Scoped to namespace: acme, project: crm β€” the user can create components and view the project, but only within the crm project. Other projects in acme are unaffected.
  • Scoped to namespace: acme β€” the user can create components and view projects across all projects in acme.
  • No scope (cluster-wide) β€” the user can create components and view projects across the entire cluster.

Two key properties:

  • Permissions cascade downward. Granting component:view at the namespace scope allows viewing components in every project within that namespace.
  • Permissions do not cascade upward. Even if a role includes actions for higher-level resources (e.g., environment:view), a binding scoped to a project will not grant access to namespace-level or cluster-level resources. If a user needs visibility into those, add supplementary role mappings at the appropriate scope β€” see Scoping Roles Below Cluster Level.

Authorization CRDs​

OpenChoreo uses four CRDs to manage authorization. Roles define what actions are permitted, and role bindings connect subjects to those roles with a specific scope and effect.

CRDScopePurpose
ClusterAuthzRoleClusterDefine a set of allowed actions, available across all namespaces
AuthzRoleNamespaceDefine actions scoped to a single namespace
ClusterAuthzRoleBindingClusterBind an entitlement to one or more cluster roles, optionally scoped to a namespace, project, or component
AuthzRoleBindingNamespaceBind an entitlement to one or more roles within a specific namespace

For detailed field descriptions and YAML examples, see Authorization CRDs.

Available Actions​

The following actions are defined in the system:

ResourceActions
Namespacenamespace:view, namespace:create, namespace:update, namespace:delete
Projectproject:view, project:create, project:update, project:delete
Componentcomponent:view, component:create, component:update, component:delete
Component Releasecomponentrelease:view, componentrelease:create
Release Bindingreleasebinding:view, releasebinding:create, releasebinding:update, releasebinding:delete
Component Typecomponenttype:view, componenttype:create, componenttype:update, componenttype:delete
Cluster Component Typeclustercomponenttype:view, clustercomponenttype:create, clustercomponenttype:update, clustercomponenttype:delete
Workflowworkflow:view, workflow:create, workflow:update, workflow:delete
Workflow Runworkflowrun:view, workflowrun:create, workflowrun:update
Cluster Workflowclusterworkflow:view, clusterworkflow:create, clusterworkflow:update, clusterworkflow:delete
Traittrait:view, trait:create, trait:update, trait:delete
Cluster Traitclustertrait:view, clustertrait:create, clustertrait:update, clustertrait:delete
Environmentenvironment:view, environment:create, environment:update, environment:delete
Data Planedataplane:view, dataplane:create, dataplane:update, dataplane:delete
Cluster Data Planeclusterdataplane:view, clusterdataplane:create, clusterdataplane:update, clusterdataplane:delete
Workflow Planeworkflowplane:view, workflowplane:create, workflowplane:update, workflowplane:delete
Cluster Workflow Planeclusterworkflowplane:view, clusterworkflowplane:create, clusterworkflowplane:update, clusterworkflowplane:delete
Observability Planeobservabilityplane:view, observabilityplane:create, observabilityplane:update, observabilityplane:delete
Cluster Observability Planeclusterobservabilityplane:view, clusterobservabilityplane:create, clusterobservabilityplane:update, clusterobservabilityplane:delete
Deployment Pipelinedeploymentpipeline:view, deploymentpipeline:create, deploymentpipeline:update, deploymentpipeline:delete
Observability Alert Notification Channelobservabilityalertsnotificationchannel:view, observabilityalertsnotificationchannel:create, observabilityalertsnotificationchannel:update, observabilityalertsnotificationchannel:delete
Secretssecretreference:view, secretreference:create, secretreference:update, secretreference:delete
Workloadworkload:view, workload:create, workload:update, workload:delete
ClusterAuthzRoleclusterauthzrole:view, clusterauthzrole:create, clusterauthzrole:update, clusterauthzrole:delete
AuthzRoleauthzrole:view, authzrole:create, authzrole:update, authzrole:delete
ClusterAuthzRoleBindingclusterauthzrolebinding:view, clusterauthzrolebinding:create, clusterauthzrolebinding:update, clusterauthzrolebinding:delete
AuthzRoleBindingauthzrolebinding:view, authzrolebinding:create, authzrolebinding:update, authzrolebinding:delete
Observabilitylogs:view, metrics:view, traces:view, alerts:view
Incidentsincidents:view, incidents:update
RCA Reportrcareport:view, rcareport:update