cluster-api-provider-hetzner

README

Guide | Docs Index | Development Docs

Cluster API Book

---

The Kubernetes Cluster API provider Hetzner enables declarative provisioning of multiple Kubernetes clusters on Hetzner infrastructure. The Cluster API simplifies the creation, updates, and operation of production-ready clusters. Self-managed Kubernetes clusters can therefore easily be operated even at a large scale.

Disclaimer: This is no official Hetzner Project! It is maintained by the folks of the cloud-native startup Syself. If you have questions or are interested in running production-ready Kubernetes clusters on Hetzner, then please contact us via e-mail: info@syself.com

📰 What is the Cluster API Provider Hetzner?

The Cluster API orchestrates infrastructure similar to the way Kubernetes manages containers. It implements a declarative API like Kubernetes does and extends the resources of the Kubernetes API server via CRDs. The Cluster API components consist of the CAPI controller, the control-plane provider, the bootstrap provider, and a provider integration that implements the necessary controllers to enable stable and highly available Kubernetes clusters. The controllers ensure that the desired state of the infrastructure is achieved - just as Kubernetes ensures the desired state of containers. This concept is called Infrastructure as Software and has significant advantages over Infrastructure as Code (IaC) solutions because it can react automatically to changes and problems. The best example of this is the MachineHealthCheck, which replaces unhealthy nodes automatically.

Using the Hetzner Provider unites the benefits of declarative infrastructure, cost-effectiveness, and (GDPR compliant) European cloud.

✨ Features

• Native Kubernetes manifests and API
• Choice of Linux distribution (as long as a current cloud-init is available)
• Support for single and multi-node control plane clusters (HA Kubernetes)
• Support for Hetzner Cloud placement groups, network and load balancer
• Complete day 2 operations - updating Kubernetes and nodes, scaling up and down, self-healing
• Custom CSR approver for approving kubelet-serving certificate signing requests
• Hetzner dedicated servers coming soon

🚀 Get Started

If you're looking to jump straight into it, go ahead:

• Cluster API Provider Hetzner 15 Minute Tutorial: Set up a bootstrap cluster using Kind and deploy a Kubernetes cluster on Hetzner
• Develop and test Kubernetes clusters with Tilt: Start using Tilt for rapid testing of various cluster flavors, like with/without a private network.
• Develop and test own node-images: How to Use your own machine images for production systems.

In addition to the pure creation and operation of Kubernetes clusters, this provider can also validate and approve certificate signing requests. This increases security as the kubelets of the nodes can be operated with signed certificates. Click here to read more about the CSR controller.

🔥 Compatibility with Cluster API and Kubernetes Versions

This provider's versions are compatible with the following versions of Cluster API:

	Cluster API v1beta1 (v1.0.x)	Cluster API v1beta1 (v1.1.x)
Hetzner Provider v1.0.x	✓	✓

This provider's versions can install and manage the following versions of Kubernetes:

	Hetzner Provider v1.0.x
Kubernetes 1.22.x	✓
Kubernetes 1.23.x	✓

Test status:

• ✓ tested
• + should work, but we weren't able to test it

Each version of Cluster API for Hetzner will attempt to support at least two Kubernetes versions.

NOTE: As the versioning for this project is tied to the versioning of Cluster API, future modifications to this policy may be made to more closely align with other providers in the Cluster API ecosystem.

---

🔳 Operating system images

Note: Cluster API Provider Hetzner relies on a few prerequisites, which have to be already installed in the used operating system images, e.g. a container runtime, kubelet, and Kubeadm. Reference images can be found in kubernetes-sigs/image-builder and templates/node-image. If it isn't possible to pre-install these prerequisites in the image, you can always deploy and execute some custom scripts through the Kubeadm config. Read more...

---

📖 Documentation

Docs can be found in the /docs directory. Index could be found here.

👥 Getting involved and contributing

Are you interested in contributing to Cluster API Provider Hetzner? We, the maintainers and community, would love your suggestions, contributions, and help! Also, the maintainers can be contacted at any time to learn more about getting involved.

To set up your environment, try out the development guide.

In the interest of getting more new people involved, we tag issues with good first issue. These are typically issues that have a smaller scope but are good ways to start to get acquainted with the codebase.

We also encourage ALL active community participants to act as if they are maintainers, even if you don't have "official" write permissions. This is a community effort, we are here to serve the Kubernetes community. If you have an active interest and you want to get involved, you have real power! Don't assume that the only people who can get things done around here are the "maintainers".

We also would love to add more "official" maintainers, so show us what you can do!

💫 Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

:shipit: Github issues

🐛 Bugs

If you think you have found a bug please follow the instructions below.

• Please take some time to give due diligence to the issue tracker. Your issue might be a duplicate.
• Get the logs from the cluster controllers. Please paste this into your issue.
• Open a bug report.
• Remember users might be searching for your issue in the future, so please give it a meaningful title to help others.
• Feel free to reach out to the Cluster API community on kubernetes slack.

⭐ Tracking new features

We also use the issue tracker to track features. If you have an idea for a feature or think that you can help Cluster API Provider Hetzner become even more awesome, then follow the steps below.

• Open a feature request.
• Remember users might be searching for your issue in the future, so please give it a meaningful title to help others.
• Clearly define the use case, using concrete examples. EG: I type this and Cluster API Provider Hetzner does that.
• Some of our larger features will require some design. If you would like to include a technical design for your feature please include it in the issue.
• After the new feature is well understood, and the design is agreed upon, we can start coding the feature. We would love for you to code it. So please open up a WIP (work in progress) pull request, and happy coding.