README
¶
Kubernetes Cluster API Provider Bring Your Own Host (BYOH)
What is Cluster API Provider BYOH
Cluster API brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.
BYOH is a Cluster API Infrastructure Provider for already-provisioned hosts running Linux. This provider allows operators to adopt Cluster API for deploying and managing kubernetes nodes without also having to adopt a specific infrastructure service. This enables users to decouple kubernetes node provisioning from host and infrastructure provisioning.
BYOH Glossary
Host - A host is a running computer system. It could be physical or virtual. It has a kernel and some base operating system
BYO Host - A Linux host provisioned and managed outside of Cluster API
BYOH Capacity Pool - A set of BYO Hosts registered in a management cluster & authorized for usage as a capacity for deploying Kubernetes nodes
Kubernetes Node - A Kubernetes Node that runs on top of a Host. There is a 1-to-1 relationship between nodes and hosts (every host has zero or one nodes). Node provisioning and lifecycle management is a Cluster API responsibility
Kubernetes Host Components - The components that run uncontainerized on the host and are required to bootstrap a Kubernetes node. Typically, this is at least kubelet, containerd and kubeadm, but different OS might require different components in this category
Features
- Native Kubernetes manifests and API
- Support for single and multi-node control plane clusters
- Support already provisioned Linux VMs with Ubuntu 20.04 or 22.04
Getting Started
Check out the getting started guide for launching a BYOH workload cluster.
Community, discussion, contribution, and support
The BringYourOwnHost provider is developed in the open, and is constantly being improved by our users, contributors, and maintainers. If you have questions or want to get the latest project news, you can connect with us in the following ways:
- Chat with us on the Kubernetes Slack in the #cluster-api channel
- Subscribe to the SIG Cluster Lifecycle Google Group for access to documents and calendars
- Join our Cluster API Provider for BringYourOwnHost working group sessions where we share the latest project news, demos, answer questions, and triage issues
- Weekly on Wednesdays @ 1:30PM Indian Standard Time on Zoom - Convert to your timezone
- Previous meetings: [ notes | recordings ]
Pull Requests and feedback on issues are very welcome! See the issue tracker if you're unsure where to start, especially the Good first issue and Help wanted tags, and also feel free to reach out to discuss.
See also our contributor guide and the Kubernetes community page for more details on how to get involved.
Project Status
This project is currently a work-in-progress, in an Alpha state, so it may not be production ready. There is no backwards-compatibility guarantee at this point. For more details on the roadmap and upcoming features, check out the project's issue tracker on GitHub.
Getting involved and contributing
Launching a Kubernetes cluster using BYOH source code
Check out the developer guide for launching a BYOH cluster consisting of Docker containers as hosts.
More about development and contributing practices can be found in CONTRIBUTING.md.
Implement Custom Installer controller
An installer controller is responsible to provide the installation and uninstallation scripts for k8s dependencies, prerequisites and components on each BYOHost.
If someone wants to implement their own installer controller then they need to follow the contract defined in installer doc.
Compatibility with Cluster API
- BYOH is currently compatible wth Cluster API v1beta1 (v1.0)
Supported OS and Kubernetes versions
| Operating System | Architecture | Kubernetes v1.24.* | Kubernetes v1.25.* | Kubernetes v1.26.* | Kubernetes v1.29.* |
|---|---|---|---|---|---|
| Ubuntu 20.04.* | amd64 | ✓ | ✓ | ✓ | |
| Ubuntu 22.04.* | amd64 | ✓ |
NOTE: The '*' in OS means that all Ubuntu 20.04 patches are supported.
NOTE: The '*' in the K8s version means that the K8s minor release is supported but it may happen that a BYOH bundle for a specific patch may not exist in the OCI registry.
BYOH in News
- TGIK episode on BYOH
- BYOH presented during Cluster API Office Hours
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cloudinit
Package cloudinit implements write_files and runcmd directives of cloudinit.
|
Package cloudinit implements write_files and runcmd directives of cloudinit. |
|
cloudinit/cloudinitfakes
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
reconciler
Package reconciler contains the host agent controller's reconcile implementation that watches for ByoHost CRD
|
Package reconciler contains the host agent controller's reconcile implementation that watches for ByoHost CRD |
|
registration
Package registration creates a ByoHost CRD in the management cluster This is equivalent to a ByoHost joining a capacity pool
|
Package registration creates a ByoHost CRD in the management cluster This is equivalent to a ByoHost joining a capacity pool |
|
version
Package version defines the versioning scheme for byoh-agent downloadable binary
|
Package version defines the versioning scheme for byoh-agent downloadable binary |
|
apis
|
|
|
infrastructure/v1beta1
Package v1beta1 contains the v1beta1 API implementation.
|
Package v1beta1 contains the v1beta1 API implementation. |
|
controllers
|
|
|
infrastructure
Package controllers implements BYOH infra controllers.
|
Package controllers implements BYOH infra controllers. |
|
test
|
|
|
e2e
Package e2e implements end to end testing of BYOH clusters.
|
Package e2e implements end to end testing of BYOH clusters. |