create-oda-operator

Automate Kubernetes operator creation for ODA Canvas with Python KOPF.

53|68|Updated Jan 5, 2021
One-click install
npx skills add https://github.com/tmforum-oda/oda-canvas --skill create-oda-operator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-oda-operator
Source: https://github.com/tmforum-oda/oda-canvas/tree/main/skills/create-oda-operator
Command: npx skills add https://github.com/tmforum-oda/oda-canvas --skill create-oda-operator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation and ongoing maintenance of Kubernetes operators for the Open Digital Architecture Canvas (ODA Canvas) using the Python KOPF framework, reducing boilerplate and enabling consistent operator patterns.

Core Features & Use Cases

  • Triple-stacked handlers (resume + create + update) for CRD lifecycle to ensure reliable reconciliation across restarts.
  • Adoption, ownership, and status roll-up patterns that propagate child resource state back to the parent Component/ExposedAPI/DependentAPI CRDs.
  • Data-driven patterns (SEGMENT_CONFIG) and cross-resource orchestration to manage multiple facets of a Canvas component.
  • Documentation templates and references to guide operators from development to production readiness.

Quick Start

Bootstrap a new ODA Canvas operator by following the included templates and example patterns.

Frequently Asked Questions about create-oda-operator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build a Kubernetes operator for ODA Canvas using Python?

You can build a Kubernetes operator for ODA Canvas using Python by leveraging the KOPF framework. This approach automates operator creation, enforces consistent reconciliation patterns like triple-stacked handlers, and reduces boilerplate for component lifecycle management.

How do I manage child resource state propagation across multiple CRDs in KOPF?

To manage child resource state propagation across multiple CRDs in KOPF, implement adoption, ownership, and status roll-up patterns. These patterns ensure the child resource state is consistently propagated back to the parent Component, ExposedAPI, and DependentAPI CRDs.

What are triple-stacked handlers in Kubernetes operator reconciliation?

Triple-stacked handlers in Kubernetes operator reconciliation consist of resume, create, and update handlers for CRD lifecycle management. This pattern ensures reliable reconciliation across operator restarts by consistently processing Custom Resource Definitions.

How do I configure multiple facets of an ODA Canvas component data-driven way?

You can configure multiple facets of an ODA Canvas component in a data-driven way by using SEGMENT_CONFIG patterns. This enables cross-resource orchestration to manage various component facets dynamically within the Kubernetes operator.

Does KOPF support consistent logging and documentation templates for ODA Canvas operators?

KOPF supports consistent logging and documentation templates for ODA Canvas operators. The framework enforces these patterns to guide operators from initial development through to production readiness while maintaining standardized operational outputs.

Why do I need resume handlers in addition to create and update for KOPF operators?

You need resume handlers in addition to create and update for KOPF operators to ensure reliable reconciliation across restarts. This triple-stacked handler approach guarantees the operator correctly recovers and processes existing Custom Resources after interruptions.