/cluster-api-provider-bringyourownhost

Kubernetes Cluster API Provider BYOH for already-provisioned hosts running Linux.

Primary LanguageGoApache License 2.0Apache-2.0

Kubernetes Cluster API Provider BYOH(Bring Your Own Host)


What is Cluster API Provider BYOH

Cluster API brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.

BYOH is a Cluster API v1beta1 Infrastructure Provider for already-provisioned hosts running Linux.

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
    • 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.

Getting Started

Check out the getting_started guide for launching a BYOH workload cluster

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.

Features

  • Native Kubernetes manifests and API
  • Support for single and multi-node control plane clusters
  • Support already provisioned Linux VMs with Ubuntu 20.04

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.


Compatibility with Cluster API and Kubernetes Versions

Cluster API compatibility Matrix:

Cluster API v1alpha4 (v0.4) Cluster API v1beta1 (v1.0)
BYOH Provider v1alpha1 (v0.1.0)

Kubernetes compatibility Matrix:

Kubernetes 1.20 Kubernetes 1.21 Kubernetes 1.22
BYOH Provider v1alpha1 (v0.1.0)

BYOH in News