Developer Documentation

This section of the documentation is dedicated to all contributors of the project. It describes the overall system architecture, explains the core concepts of the system and development principles that should be followed when contributing.

Furthermore, the layout of the repository is explained and a complete Python API reference of all modules is provided.

Table of Contents

• Architecture
  • API
  • Control Plane
• Concepts
  • Overview
  • API Conventions
  • Control Plane
  • Authentication and Authorization
• Directories
• Design Principles
  • API
  • Control Logic
  • Architecture
  • Extensibility
  • Availability
  • Development
• Scheduling
  • Application handler
  • Cluster handler
  • Magnum cluster handler
  • Metrics and Metrics Providers
  • Constraints
• Application hooks
  • Complete
  • Shutdown
  • TLS
  • Examples
• Kubernetes Application Controller
  • Reconciliation loop
• Kubernetes Application Observer
  • Reconciliation
  • Kubernetes Application Observer
• Kubernetes Cluster Controller
• Kubernetes Cluster Observer
  • Kubernetes Cluster Status Polling
  • States
  • Node Health
• Infrastructure Controller
  • Reconciliation loop
  • States
• Garbage Collection
  • Dependency mechanism
  • Overview
  • Garbage collection workflow
  • Dependency graph
• API Generation
  • Role
  • Usage
  • Templating
  • Generated elements
• TOSCA
  • Introduction
  • TOSCA Template
  • TOSCA/CSAR Workflow
  • Examples
• Krake Reference
  • Module hierarchy
  • Krake
  • API Server
  • Client
  • Controllers
  • Data Abstraction
• Client Reference
  • Fixtures
  • Command Line Parser