Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
What is KubeDirector?
KubeDirector uses standard Kubernetes (K8s) facilities of custom resources and API extensions to implement stateful scaleout application clusters. This approach enables transparent integration with K8s user/resource management and existing K8s clients and tools.
In broad terms, KubeDirector is a "custom controller" (itself deployed into K8s) that watches for custom resources of a given type to be created or modified within some K8s namespace(s). On such an event, KubeDirector uses K8s APIs to create or update the resources and configuration of a cluster to bring it into accordance with the spec defined in that custom resource.
Unlike some other custom controller implementations, KubeDirector does not tie a custom resource definition to a particular type of application, or contain hardcoded application-specific logic within the controller. Instead application characteristics are defined by metadata and an associated package of configuration artifacts.
This separation of responsibilities has several useful characteristics, including:
Application experts -- within or outside the organization running KubeDirector -- can enable application deployment without writing "Go" code or understanding the operation of custom controllers. This includes easily making incremental changes to adopt new versions of an application or tweak the setup choices exposed to the end user.
Site administrators can easily manage which application types and versions are available within an organization, without undergoing a custom controller code upgrade that could potentially disrupt operations.
End users can launch and reconfigure clusters using familiar K8s tools, selecting from application-specific choices provided to them by the experts.
KubeDirector concepts can be approached from three perspectives:
- App Definition Authoring for KubeDirector
- Cluster Deployment with KubeDirector
- KubeDirector Architecture Overview
A first-time reader should approach those topics in the above order.
KubeDirector Data Formats
Type Definitions for KubeDirectorApp specifies the KubeDirectorApp object used for app definition authoring.
Type Definitions for KubeDirectorCluster specifies the KubeDirectorCluster object used for virtual cluster deployment.
Type Definitions for KubeDirectorConfig specifies the KubeDirectorConfig object used for administrative configuration of KubeDirector.