About ODA CanvasΒΆ

Table of ContentsΒΆ

What is the ODA Canvas?ΒΆ

The TM Forum Open Digital Architecture (ODA) Canvas is an execution environment for ODA Components running on Kubernetes. It follows the Kubernetes Operator Pattern β€” a set of controllers watch for ODA custom resources and reconcile them into the desired state by configuring infrastructure services like API Gateways, Identity Management, Service Meshes, and Observability stacks.

Think of the Canvas as the β€œoperating system” for telecom software components. A vendor packages their software as an ODA Component (a Kubernetes Custom Resource), and the Canvas reads that specification to automatically:

  • Expose APIs through the API Gateway

  • Register the component with Identity Management

  • Configure secrets access

  • Resolve dependencies on other components’ APIs

  • Set up event notification channels

  • Enforce availability policies

The Kubernetes Operator PatternΒΆ

Each concern is handled by an independent operator (a controller running in the canvas namespace):

Operator

Watches

Configures

Component Operator

Component

Decomposes into child resources; tracks overall status

API Operator

ExposedAPI

API Gateway / Service Mesh routes, CORS, rate limits

Identity Operator

IdentityConfig

Keycloak roles, listeners, party role APIs

Secrets Operator

SecretsManagement

Vault sidecar injection, pod selectors

Dependency Operator

DependentAPI

Discovers upstream ExposedAPIs, resolves URLs

ODA Custom Resource DefinitionsΒΆ

All ODA resources belong to the API group oda.tmforum.org. List them on a live cluster:

kubectl get crd | grep oda.tmforum.org

CRD

Kind

Short Names

Purpose

components.oda.tmforum.org

Component

β€”

Top-level component specification

exposedapis.oda.tmforum.org

ExposedAPI

β€”

API exposed through the gateway

dependentapis.oda.tmforum.org

DependentAPI

depapi, depapis

API dependency on another component

identityconfigs.oda.tmforum.org

IdentityConfig

β€”

Identity and role configuration

secretsmanagements.oda.tmforum.org

SecretsManagement

sman, smans

Secrets vault sidecar configuration

publishednotifications.oda.tmforum.org

PublishedNotification

β€”

Outbound event notification channel

subscribednotifications.oda.tmforum.org

SubscribedNotification

β€”

Inbound event subscription

availabilitypolicies.oda.tmforum.org

AvailabilityPolicy

β€”

Pod disruption budget policies

The Canvas currently serves versions v1 (current), v1beta4, and v1beta3, with webhook-based conversion between them. Check which versions are active:

kubectl get crd components.oda.tmforum.org -o jsonpath='{.spec.versions[?(@.served==true)].name}'

Component DecompositionΒΆ

When you create a Component custom resource, the Component Operator reads its spec and decomposes it into child resources. Each child resource is then handled by its specialist operator:

Component (top-level custom resource)
β”œβ”€β”€ spec.componentMetadata          β†’ identity & catalog metadata (TMFC ID, version, etc.)
β”œβ”€β”€ spec.coreFunction
β”‚   β”œβ”€β”€ exposedAPIs[]               β†’ creates ExposedAPI CRs (segment: coreFunction)
β”‚   └── dependentAPIs[]             β†’ creates DependentAPI CRs
β”œβ”€β”€ spec.eventNotification
β”‚   β”œβ”€β”€ publishedEvents[]           β†’ creates PublishedNotification CRs
β”‚   └── subscribedEvents[]          β†’ creates SubscribedNotification CRs
β”œβ”€β”€ spec.managementFunction
β”‚   β”œβ”€β”€ exposedAPIs[]               β†’ creates ExposedAPI CRs (segment: managementFunction)
β”‚   └── dependentAPIs[]             β†’ creates DependentAPI CRs
└── spec.securityFunction
    β”œβ”€β”€ canvasSystemRole            β†’ creates IdentityConfig CR
    β”œβ”€β”€ componentRole[]             β†’ included in IdentityConfig CR
    β”œβ”€β”€ secretsManagement           β†’ creates SecretsManagement CR
    β”œβ”€β”€ exposedAPIs[]               β†’ creates ExposedAPI CRs (segment: securityFunction)
    └── dependentAPIs[]             β†’ creates DependentAPI CRs

This decomposition is the core of the ODA Canvas architecture. You define everything in one Component YAML, and the Canvas breaks it apart so each operator can independently manage its domain.

Exploring the CRD SchemasΒΆ

Use kubectl explain to interactively explore any CRD schema on a live cluster:

# Top-level Component spec
kubectl explain component.spec

# Drill into specific sections
kubectl explain component.spec.componentMetadata
kubectl explain component.spec.coreFunction
kubectl explain component.spec.coreFunction.exposedAPIs
kubectl explain component.spec.securityFunction

# Other resource types
kubectl explain exposedapi.spec
kubectl explain dependentapi.spec
kubectl explain identityconfig.spec
kubectl explain secretsmanagement.spec
kubectl explain publishednotification.spec
kubectl explain subscribednotification.spec

Three Sources of CRD KnowledgeΒΆ

When explaining CRD structures, reference these three sources:

1. Live cluster β€” kubectl explainΒΆ

Best for interactive exploration. Shows the schema of the version currently stored in the cluster.

2. CRD Helm templates β€” charts/oda-crds/templates/ΒΆ

The authoritative schema definitions. Key files:

File

Resource

v1 schema starts at

oda-component-crd.yaml

Component

~line 1858

oda-exposedapi-crd.yaml

ExposedAPI

~line 337

oda-dependentapi-crd.yaml

DependentAPI

~line 176

oda-identityconfig-crd.yaml

IdentityConfig

~line 66

oda-secretsmanagement-crd.yaml

SecretsManagement

~line 150

oda-publishednotification-crd.yaml

PublishedNotification

~line 231

oda-subscribednotification-crd.yaml

SubscribedNotification

~line 237

Read the relevant section to show users the exact OpenAPI v3 schema properties, types, enums, and required fields.

3. Example components β€” feature-definition-and-test-kit/testData/ΒΆ

Real component YAML files used in BDD tests. Key examples:

Directory

What it demonstrates

productcatalog-v1/

Base component with core, management, and security functions

productordercaptureandvalidation-v1/

Component declaring dependent APIs on a product catalog and a product inventory

productcatalog-static-roles-v1/

Static componentRole definitions in securityFunction

productcatalog-dynamic-roles-v1/

Dynamic roles: permission specification sets created through the TMF672 API

The full list of test charts, and the features that use each one, is in feature-definition-and-test-kit/testData/README.md.

The rendered component template is in each directory’s templates/component-productcatalog.yaml. Show users these files as concrete examples of ODA Component specifications.

Contextual Next StepsΒΆ

Present these options to the user:

#

Next Step

1

Deploy a component β€” Install a reference example to explore hands-on

2

View deployed components β€” See what’s already running on the cluster

3

Return to main menu