{Verb} {Object} use case¶
Overview¶
{Provide 2-3 paragraphs explaining:
The business purpose of this use case
The scope and boundaries
The actors involved
The desired outcome }
This use case is {implementation-agnostic/specific to certain Canvas components} and describes {what is being accomplished}.
Assumptions¶
Uses assumptions:
{Assumption 1, e.g., “Component describes requirements in machine-readable spec”}
{Assumption 2, e.g., “Canvas has been installed in Kubernetes cluster”}
{Assumption 3, e.g., “Component conforms to ODA Component API Specification”}
{Additional assumptions as needed}
{Scenario 1 Name}¶
{Brief description of this scenario and what it accomplishes}
Process Flow¶
The {Scenario 1 Name} process follows these steps:
{Step 1}: {Description of what happens}
{Key point or detail}
{Another key point}
{Step 2}: {Description of what happens}
{Key point or detail}
{Step 3}: {Description of what happens}
{Key point or detail}
Expected Outcome¶
Upon successful completion:
{Outcome 1}
{Outcome 2}
{Outcome 3}
{Scenario 2 Name}¶
{Brief description of this scenario}
Process Flow¶
{Similar structure to Scenario 1}
Expected Outcome¶
{Expected results for this scenario}
{Additional Scenarios}¶
Error Scenarios¶
{Error Type 1}¶
Condition: {When does this error occur?}
Status: {What status is reported?}
Resolution: {How is this handled or resolved?}
{Error Type 2}¶
{Similar structure for other error scenarios}
Status Progression¶
The {Resource Name} resource progresses through the following states:
{State 1}: {Description}
{State 2}: {Description}
{State 3}: {Description}
Implementation Notes¶
Operator Responsibilities¶
{Operator Name}: {What this operator handles in this use case}
{Another Operator}: {What this operator handles}
Custom Resources¶
This use case involves the following custom resources:
{CRD Name}: {Purpose in this use case}
{Another CRD}: {Purpose in this use case}
BDD Feature Tests¶
This use case is tested by the following BDD features:
{UC-ID}-F001: {Feature Name}
{Brief description of what this feature tests}
{UC-ID}-F002: {Another Feature Name}
{Brief description}
For information about running these tests, see Executing Tests.
Design References¶
This use case is part of the following design epics:
{Design Epic Name} - {Relevant section}
Standards and Specifications¶
This use case aligns with:
ODA Component Specification: {Version(s) supported}
TM Forum {TMF-XXX}: {Relevant standard if applicable}
Kubernetes Operator Pattern: operatorhub.io
Future Enhancements¶
Potential future enhancements to this use case include:
{Enhancement 1}
{Enhancement 2}
{Enhancement 3}
Glossary¶
{Term 1}: {Definition}
{Term 2}: {Definition}