Open Digital Architecture Canvas

The Open Digital Architecture (ODA) Canvas is an execution environment for ODA Components and the release automation part of a CI/CD pipeline. This repository contains the Reference Implementation, open-source code, use-cases and test-kit for a TM Forum ODA canvas. You are free to use this as a starting point for your own ODA Canvas implementation.

The Usecase Library shows how ODA Components interact with the ODA Canvas. The Feature definition and Test Kit details the features required to be a fully compliant ODA Canvas and a set of tests that can be used to validate any ODA Canvas. The source code contains the source code for the operators that are part of the ODA Canvas.

The Reference Implementation of the ODA Canvas will be used for ODA Component certification.

Installation

see Installation Guide for installation instructions.

Introduction to ODA Canvas

There is an introductory video on the ODA Canvas at:

The ODA Canvas is itself a modular architecture, with independent operators that embed the management and operations activities in software. The Component Management operator manages the lifecycle of each component, and the de-composition into ExposedAPIs, IdentityConfigs and other sub-resources (that are processed by their corresponding operators). The API Management operators manage the API Gateway and/or Service Mesh to provide security, throttling and other non-functional services to allow API endpoints to be exposed to external consumers. You deploy the matching API Management operator for whatever API Gateway or Service Mesh you are using. The Identitiy Config operator configures the Identity Management Services. The Secrets Management operator is an optional operator to configure secrets. The Dependency Management operator provides services to allow a Component to discover API dependencies. We foresee new operator types becoming available as the ODA Canvas matures.

The ODA Canvas reference implementation includes example operators to that are freely available for organizations to re-use, extend or replace with their own implementations. We expect a typical production implementation will use a combination of standard operators and custom operators that can implement that organizations specific operational policies.

For more information see Software Operators

ODA Canvas Design

The design (including ongoing work) of the ODA Canvas is documented in ODA Canvas Design.

Security principles for the ODA Canvas design are documented in ODA Security Principles.

Release notes

For Developers

How to work with this repository:

• How-To work with Dockerimages