README.md

Documentation

Overview

The docs folder contains documentation on the Lifecycle Manager project.

Table of contents

The table of contents lists all the documents in repository with their short description.

• Developer tutorials - a directory containing infrastructure-related guides for developers
  • Provide credential for private OCI registry authentication
  • Local test setup in the control-plane mode using k3d
  • Create a test environment on Google Container Registry (GCR)
  • Provision cluster and OCI registry
  • Enable Webhooks in Lifecycle Manager
• Technical reference - a directory with techncial details on Lifecycle Manager, such as architecture, APIs, or running modes
  • API - a directory with the description of Lifecycle Manager's custom resources (CRs)
    • Kyma CR
    • Manifest CR
    • ModuleTemplate CR
  • Architecture - describes Lifecycle Manager's architecture
  • Controllers - describes Kyma, Manifest and Watcher controllers
  • Running Modes - describes Lifecycle Manager's running modes
  • Declarative Reconciliation Library Reference Documentation
  • Internal Manifest Reconciliation Library Extensions
• User tutorials
  • Managing module enablement with the CustomResourcePolicy
  • Quick Start
• Modularization - describes the modularization concept and its building blocks in the context of Lifecycle Manager