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 |
|
Decomposes into child resources; tracks overall status |
API Operator |
|
API Gateway / Service Mesh routes, CORS, rate limits |
Identity Operator |
|
Keycloak roles, listeners, party role APIs |
Secrets Operator |
|
Vault sidecar injection, pod selectors |
Dependency Operator |
|
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 |
|---|---|---|---|
|
|
β |
Top-level component specification |
|
|
β |
API exposed through the gateway |
|
|
|
API dependency on another component |
|
|
β |
Identity and role configuration |
|
|
|
Secrets vault sidecar configuration |
|
|
β |
Outbound event notification channel |
|
|
β |
Inbound event subscription |
|
|
β |
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 |
|---|---|---|
|
Component |
~line 1858 |
|
ExposedAPI |
~line 337 |
|
DependentAPI |
~line 176 |
|
IdentityConfig |
~line 66 |
|
SecretsManagement |
~line 150 |
|
PublishedNotification |
~line 231 |
|
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 |
|---|---|
|
Base component with core, management, and security functions |
|
Component declaring dependent APIs on a product catalog and a product inventory |
|
Static |
|
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 |