View Deployed ODA ComponentsΒΆ
Table of ContentsΒΆ
What is an ODA Component?ΒΆ
A Component is the top-level Custom Resource in the ODA Canvas. It is the single artifact that a software vendor creates to describe their entire application to the Canvas. When you deploy a Component, the Component Operator reads its spec and decomposes it into child resources:
ExposedAPIs β one per API listed in
coreFunction.exposedAPIs[],managementFunction.exposedAPIs[], andsecurityFunction.exposedAPIs[]DependentAPIs β one per dependency in
coreFunction.dependentAPIs[], etc.IdentityConfig β from
securityFunction.canvasSystemRoleandcomponentRole[]SecretsManagement β from
securityFunction.secretsManagement(if declared)PublishedNotifications β from
eventNotification.publishedEvents[]SubscribedNotifications β from
eventNotification.subscribedEvents[]
Each child resource is then processed by its specialist operator (API Operator, Identity Operator, etc.). The Component Operator tracks the aggregate status of all children and reports the overall deployment_status.
To see a real example of a Component YAML, look at the test data:
feature-definition-and-test-kit/testData/productcatalog-v1/templates/component-productcatalog.yaml
To explore the Component CRD schema on a live cluster:
kubectl explain component.spec
kubectl explain component.spec.coreFunction.exposedAPIs
The authoritative CRD definition is in charts/oda-crds/templates/oda-component-crd.yaml (v1 schema starts around line 1858).
Default NamespaceΒΆ
Use components as the default namespace unless the user specifies otherwise.
CommandsΒΆ
Offer both raw kubectl output and a structured summary.
Raw output (show to user):
# Summary table β shows NAME and DEPLOYMENT_STATUS columns
kubectl get components -n components
# Detailed view for a specific component
kubectl describe component <name> -n components
Note: -o wide does not show additional columns for Components β use -o yaml for full details instead.
Full YAML output (for drill-down):
kubectl get components -n components -o yaml
The agent interprets the YAML output directly using the Key Fields table below.
Key FieldsΒΆ
Parse the JSON output and present a table with these fields per component:
Field |
YAML Path |
Description |
|---|---|---|
Name |
|
Component name |
Namespace |
|
Deployment namespace |
Deployment Status |
|
One of: |
Core APIs |
|
Number of core ExposedAPIs and how many are ready |
Management APIs |
|
Number of management ExposedAPIs and how many are ready |
Security APIs |
|
Number of security ExposedAPIs and how many are ready |
Core Dependent APIs |
|
Number of core DependentAPIs and how many are ready |
Published Events |
|
Number of published event notifications |
Subscribed Events |
|
Number of subscribed event notifications |
Deployment Status ProgressionΒΆ
The deployment_status follows this state machine, where each state corresponds to a different operator completing its work:
In-Progress-CompConβ The Component Operator is creating ExposedAPI child resources and waiting for the API Operator to configure API Gateway routes and report them as readyIn-Progress-IDConfOpβ All ExposedAPIs are ready; the Identity Operator is now configuring Keycloak roles and listeners from the IdentityConfig resourceIn-Progress-SecretManβ Identity is configured; the Secrets Operator is processing the SecretsManagement resource (if declared) to configure vault sidecar injectionIn-Progress-DepApiβ Secrets are done; the Dependency Operator is resolving DependentAPI resources by discovering matching ExposedAPIs from other componentsCompleteβ All operators have finished; the component is fully operational
If a component stays in a status for a long time, check the logs of the corresponding operator:
# Check which operator based on the stuck status:
# In-Progress-CompCon β component operator or api operator
kubectl logs -l app=oda-controller-componentoperator -n canvas --tail=50
kubectl logs -l app=oda-controller-apioperator -n canvas --tail=50
# In-Progress-IDConfOp β identity operator
kubectl logs -l app=oda-controller-identityoperator -n canvas --tail=50
# In-Progress-DepApi β dependency operator
kubectl logs -l app=oda-controller-dependentapi -n canvas --tail=50
Understanding the CRD SchemaΒΆ
After viewing the component list, offer to show the CRD schema for deeper understanding. Use one of these approaches:
Live cluster exploration:
kubectl explain component.spec.componentMetadata
kubectl explain component.spec.coreFunction
kubectl explain component.spec.securityFunction
Read from the CRD template β show relevant sections from charts/oda-crds/templates/oda-component-crd.yaml. Key v1 schema sections:
spec.componentMetadataβ TMFC ID, name, version, functional block, maintainers, ownersspec.coreFunction.exposedAPIs[]β required fields:name,apiType(enum: openapi|mcp|a2a|sse),implementation,path,portspec.coreFunction.dependentAPIs[]β required fields:name,apiTypespec.securityFunction.canvasSystemRoleβ role granted to Canvas controllersspec.securityFunction.componentRole[]β static roles defined by the component
Show a concrete example β read feature-definition-and-test-kit/testData/productcatalog-v1/templates/component-productcatalog.yaml and highlight the key sections.
Drill-DownΒΆ
After showing the summary, offer to drill into a specific component:
kubectl get component <name> -n components -o yaml
Interpret the YAML output to show:
.status['summary/status']β full summary including API URL summaries and developer UI URLs.status.coreAPIs[]β each APIβs name, url, developerUI, ready status.status.identityConfigβ identity provider and listener status.status.securitySecretsManagementβ secrets ready status
After the drill-down, explain what each status section means:
Core APIs with URLs β these are the ExposedAPIs that the API Operator has configured through the API Gateway. The URL is the public-facing endpoint.
Management APIs β typically the Prometheus metrics endpoint (
apiType: prometheus) used by the observability stack.Security APIs β the Party Role Management API used by the Identity Operator to manage roles.
Identity Config β shows which identity provider (e.g., Keycloak) is configured and whether the webhook listener is registered.
You can also view the raw YAML to see the full Component spec and status:
kubectl get component <name> -n components -o yaml
Contextual Next StepsΒΆ
Present these options using ask_questions:
# |
Next Step |
|---|---|
1 |
Drill into a specific component β See detailed API URLs, identity config, and secrets status |
2 |
View ExposedAPIs β See all APIs exposed by these components through the API Gateway |
3 |
View DependentAPIs β Check if any cross-component dependencies are declared and resolved |
4 |
Deploy another component β Add a component to explore the decomposition lifecycle |
5 |
Return to main menu |