{Chart Name}¶
Overview¶
{Provide a clear description of what this chart deploys and its purpose within the ODA Canvas. Explain which components of the Canvas architecture this chart supports.}
Architecture¶
This chart is part of the ODA Canvas {module/layer} and works with:
Related Operators: {Link to operator implementation in source/operators/}
Use Cases: {Link to relevant use cases in usecase-library/}
Dependencies: {List other charts or services this depends on}
Integration Points¶
API Gateway/Service Mesh: {How it exposes or consumes APIs}
Identity Management: {How it handles authentication/authorization}
Observability: {What metrics/logs/traces it produces}
Custom Resources: {What CRDs it defines or uses}
Requirements¶
[Auto-generated by helm-docs]
Values¶
[Auto-generated by helm-docs]
Usage Examples¶
Basic Installation¶
Install the chart with default values:
helm install {release-name} ./charts/{chart-name} -n {namespace}
Custom Configuration¶
Install with custom values:
helm install {release-name} ./charts/{chart-name} -n {namespace} \
--set {key.parameter}={value} \
--set {another.parameter}={value}
Verify Installation¶
Check that all resources are created:
kubectl get all -n {namespace} -l app.kubernetes.io/instance={release-name}
# Example: Check operator is running
kubectl get deployment {deployment-name} -n {namespace}
# Example: Verify CRDs are installed
kubectl get crd {custom-resource-name}
Configuration¶
Common Configuration Scenarios¶
Scenario 1: {Common Use Case}¶
# values.yaml
{parameter1}: {value1}
{parameter2}: {value2}
Scenario 2: {Another Common Use Case}¶
# values.yaml
{parameter3}: {value3}
{parameter4}: {value4}
Integration with Other Components¶
API Gateway Integration:
{gateway-specific-config}
Identity Management:
{identity-specific-config}
Troubleshooting¶
Common Issues¶
Issue 1: {Describe Common Problem}¶
Symptoms:
{Symptom description}
Cause: {Explanation of root cause}
Solution:
# Commands to resolve
{resolution-commands}
Issue 2: {Another Common Problem}¶
Symptoms:
{Symptom description}
Cause: {Explanation of root cause}
Solution:
# Commands to resolve
{resolution-commands}
Debugging¶
Check operator logs:
kubectl logs -n {namespace} deployment/{deployment-name} -f
Check custom resource status:
kubectl describe {crd-name} {resource-name} -n {namespace}
Upgrading¶
Upgrade the Chart¶
helm upgrade {release-name} ./charts/{chart-name} -n {namespace}
Breaking Changes¶
Version {X.X.X} → {Y.Y.Y}:
{Description of breaking change}
Migration: {Steps to migrate}
Uninstalling¶
Remove the chart:
helm uninstall {release-name} -n {namespace}
# Clean up any remaining resources
kubectl delete {resource-type} -n {namespace} -l app.kubernetes.io/instance={release-name}
Contributing¶
For information about contributing to this chart, see CONTRIBUTING.md.
License¶
This chart is part of the ODA Canvas project. See LICENSE for details.