Open Digital Architecture - Component Accelerator

About the project:

• Introduction to the ODA Component Accelerator Project (ODA-CA)
• Getting started checklist for new members of ODA-CA

Tutorials:

• Tutorial to deploy and observe a running component
  • Reference Implementation environment with Service Mesh
  • Deploying the component
  • How does this work?
  • How do I extend this to get custom business metrics from the component?
• Tutorial to build ODA-Component from Open-API Reference Implementation
  • Step 1. Download Reference Implementation
  • Step 2. (optionally) test locally with local MongoDb.
  • Step 3. Configure for use within Kubernetes.
  • 3.1 Configure MongoDb connection url to use within Kubernetes
  • 3.2 Use environment variables to allow API path to be configured externally
  • 3.3 Add home resource at root of the API, and also move where the docs and api-docs are hosted
  • Step 4. Package the nodejs implementation into a docker image
  • Step 5. Create PartyRole Implementation
  • Step 6. Create PartyRole Initialisation Implementation
  • Step 6.1 Package the nodejs implementation into a docker image following step 4 above.
  • Step 7. Create Component Envelope
  • Step 6. Test component envelope using component CTK
  • Step 8. Deploy the component envelope into Open Digital Lab canvas
  • Directory Structure
  • ISSUES & resolution

Component:

• Design Guidelines to create a new ODA Component
  • Step 1: ODA-Component Metadata
  • Step 2: Add labels to all the standard Kubernetes resources
  • Changes between versions
• ODA Component - CTK
  • Executing the CTK tests
  • Developing and extending the CTK tests

Canvas:

• Open Digital Architecture Canvas
  • Installation
  • ODA Canvas Design
  • Release notes
  • For Developers
• ODA Canvas installation
  • Software Versions
  • Configuration values
  • Environment installation
    • 1. Kubernetes distribution
    • 2. Helm
    • 3. Istio
    • 4. HashiCorp Vault
    • 4. Reference implementation
    • 5. Optionally Install APISIX or Kong Gateway
  • Troubleshooting
    • Error instaling: BackoffLimitExceeded
    • Error installing : Failed post-install
  • Changes
  • oda-canvas helm chart uninstallation

Canvas Design:

• ODA Canvas Design
  • What is the ODA Canvas?
  • How do I buy or build a Canvas?
  • Canvas Design structure
  • Interaction with ODA Component standard
  • Summary
  • Design Epics
• Design Epics
  • Authentication design
    • Use cases
  • Observability design
    • Use cases
    • BDD Features (WIP)
  • Event based integration design
    • Use cases
• ODA Canvas - use-case library
  • ODA Software Operators
  • Use-case list
• Usecase List
  • Install Canvas use case
    • Install ODA Canvas
    • Upgrade ODA Canvas
    • Uninstall ODA Canvas
  • Manage Components use case
    • Install component
    • Upgrade component
    • Delete component
    • Error scenarios
  • Configure Exposed APIs use-case
    • Create Exposed API
    • Update Exposed API
    • Delete Exposed API
  • Configure Published Events use-case
    • Install component
    • Upgrade component - with changed publishedNotifications
    • Upgrade component - with additional publishedNotifications
    • Upgrade component - with deleted publishedNotifications
    • Delete component
    • TODO What if no event manager exists
  • Configure Users and Roles use case
  • Configure Observability use case
  • Discover dependent APIs use case
  • Configure Subscribed Events use-case
    • Install component
    • Upgrade component - with changed API
    • Upgrade component - with additional API
    • Upgrade component - with deleted API
    • Delete component
  • Internal authentication use-case
    • Authentication
  • External authentication use-case
    • Access Management
    • System User Authentication
    • Human user
  • View technical observability use-case
  • View business observability use-case
  • Upgrade Canvas use case
    • Support components of different versions
    • Support operators using different versions
  • Secrets Management for Component
    • Problem
    • Solution Idea
    • Workflow
    • Sequence Diagram
    • Technical Details
    • Example JWT Payload
    • Extension of the Component.yaml
    • Limitations
• Use case naming conventions
• ODA Canvas source code
• Open Digital Architecture - Controllers/Operators
  • ODA Canvas Operators
    • List of Operators
    • Docker Images
  • Component Operator
    • Component Operator - Introduction
    • Buildautomation and Versioning
    • Python modules
  • API Operator: Istio
    • API Operator for Istio/Prometheus - Introduction
    • Python modules
  • API Operator: Kong
    • Kubernetes Kong API Lifecycle Management Operator
    • Python modules
  • API Operator: Apisix
    • Kubernetes Kong API Lifecycle Management Operator
    • Python modules
  • API Operator: WhaleCloud API Gateway
    • API Operator apig - Introduction
    • Python modules
  • Security Operator
    • Security Operator - Introduction
    • Python modules
• Webuooks and Utilities
  • ODA Component webhooks
    • Unit tests
    • System tests
  • ODA Canvas utilities
    • Canvas Log Viewer utility
    • Component Viewer utility

Feature Tests:

• ODA Canvas Features and Test Kit
  • Linkage to use-cases
  • Work breakdown
• List of BDD Features
  • Executing the BDD tests
• Installing and executing the BDD tests
  • How to run the tests
  • Updating the master test status

Contributions and Troubleshooting:

• Contribution guidance
• Troubleshooting Guide
  • ODA-CA Specific guides
  • Generic Kubernetes guides
• Developer How-Tos: Work with Dockerimages
  • TL;DR;
  • Global Rules
  • Versions in values.yaml
  • Example: Update code of Secretsmanagement-Operator
• Summary
• How-To add a new Dockerimage
• How-To define unit tests
• ODA Canvas Development Environment
  • Prerequisites
  • Getting Started
• Installing KOPF (tested in GKE)
• Documentation Process
  • Basic Process
  • Full process

Indices and tables

• Index

• Module Index

• Search Page