README.md

Documentation Index

Overview

• General Architecture
• Gardener landing page gardener.cloud
• "Gardener, the Kubernetes Botanist" blog on kubernetes.io
• "Gardener Project Update" blog on kubernetes.io

Concepts

• Components
  • Gardener API server
    • In-Tree admission plugins
  • Gardener Controller Manager
  • Gardener Scheduler
  • Gardener Admission Controller
  • Gardener Seed Admission Controller
  • Gardenlet
• Backup Restore
• Network Policies
• Relation between Gardener API and Cluster API

Usage

• Register Shoot as Seed
• API Server Network Proxy Reverse Tunneling
• Audit a Kubernetes cluster
• Auto-Scaling for shoot clusters
• Custom CoreDNS configuration
• Gardener configuration and usage
• ManagedIstio feature
• Network Policies in the Shoot Cluster
• NodeLocalDNS feature
• OpenIDConnect presets
• Projects
• Seed Bootstrapping
• Seed Settings
• Shoot cluster purposes
• Shoot Kubernetes and Operating System Versioning
• Shoot Networking
• Shoot Maintenance
• Shoot Status
• Shoot Updates and Upgrades
• Supported Kubernetes versions
• Tolerations
• Trigger shoot operations
• Troubleshooting guide
• Trusted TLS certificate for shoot control planes
• APIServerSNI environment variable injection
• Reversed Cluster VPN

Proposals

• GEP: Gardener Enhancement Proposal Description
• GEP: Template
• GEP-1: Gardener extensibility and extraction of cloud-specific/OS-specific knowledge
• GEP-2: BackupInfrastructure CRD and Controller Redesign
• GEP-3: Network extensibility
• GEP-4: New core.gardener.cloud/v1alpha1 APIs required to extract cloud-specific/OS-specific knowledge out of Gardener core
• GEP-5: Gardener Versioning Policy
• GEP-6: Integrating etcd-druid with Gardener
• GEP-7: Shoot Control Plane Migration
• GEP-8: SNI Passthrough proxy for kube-apiservers
• GEP-9: Gardener integration test framework
• GEP-10: Support additional container runtimes
• GEP-11: Utilize API Server Network Proxy to Invert Seed-to-Shoot Connectivity
• GEP-12: OIDC Webhook Authenticator
• GEP-13: Automated Seed Management
• GEP-14: Reversed Cluster VPN
• GEP-15: Manage Bastions and SSH Key Pair Rotation
• GEP-16: Dynamic kubeconfig generation for Shoot clusters

Development

• Setting up a local development environment
• Unit Testing and Dependency Management
• Changing the API
• Features, Hotfixes, and Releases
• Adding New Cloud Providers
• Extending the Monitoring Stack
• How to create log parser for container into fluent-bit
• Network Policies in the Seed Cluster

Extensions

• Extensibility overview
• Extension controller registration
• Cluster resource
• Extension points
  • General conventions
  • Trigger for reconcile operations
  • Deploy resources into the shoot cluster
  • Shoot resource customization webhooks
  • Logging and monitoring for extensions
  • Contributing to shoot health status conditions
    • Health Check Library
  • Blob storage providers
    • BackupBucket resource
    • BackupEntry resource
  • DNS providers
    • DNSProvider and DNSEntry resources
  • IaaS/Cloud providers
    • Control plane customization webhooks
    • Bastion resource
    • ControlPlane resource
    • ControlPlane exposure resource
    • Infrastructure resource
    • Worker resource
  • Network plugin providers
    • Network resource
  • Operating systems
    • OperatingSystemConfig resource
  • Container runtimes
    • ContainerRuntime resource
  • Generic (non-essential) extensions
    • Extension resource
• Extending project roles
• Referenced resources
• Control plane migration

Testing

• Integration Testing Manual

Deployment

• Setup Gardener on a Kubernetes cluster
• Deploying Gardenlets
  • Automatic Deployment of Gardenlets
  • Deploy a Gardenlet Manually
  • Scoped API Access for Gardenlets
• Deploying the Gardener and a Seed into an AKS cluster
• Overwrite image vector
• Migration from Gardener v0 to v1
• Feature Gates in Gardener

Monitoring

• Alerting
• User Alerts
• Operator Alerts