Kubernetes-native declarative infrastructure for OpenStack.
The Cluster API brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.
The API itself is shared across multiple cloud providers allowing for true OpenStack hybrid deployments of Kubernetes. It is built atop the lessons learned from previous cluster managers such as kops and kubicorn.
Check out the getting started guide for launching a cluster on OpenStack.
- 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
- Deploy clusters with and without LBaaS available
- Support for security groups
- Doesn't use SSH for bootstrapping nodes
This provider's versions are compatible with the following versions of Cluster API:
| Cluster API v1alpha1 (v0.1) | Cluster API v1alpha2 (v0.2) | |
|---|---|---|
| OpenStack Provider v1alpha1 (release-0.1 branch) | ✓ | |
| OpenStack Provider v1alpha2 (v0.2) | ✓ |
This provider's versions are able to install and manage the following versions of Kubernetes:
| Kubernetes 1.13 | Kubernetes 1.14 | Kubernetes 1.15 | |
|---|---|---|---|
| OpenStack Provider v1alpha1 (release-0.1 branch) | ✓ | ✓ | ✓ |
| OpenStack Provider v1alpha2 (v0.2) | ✓ |
This provider's versions are able to install Kubernetes to the following versions of OpenStack:
| OpenStack Pike | OpenStack Queens | OpenStack Rocky | OpenStack Stein | |
|---|---|---|---|---|
| OpenStack Provider v1alpha1 (release-0.1 branch) | ✓ | ✓ | ✓ | ✓ |
| OpenStack Provider v1alpha2 (v0.2) | + | ✓ | + | ✓ |
Key:
✓tested+should work, but we weren't able to test it
Each version of Cluster API for OpenStack will attempt to support 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 aligned with other providers in the Cluster API ecosystem.
Note: Cluster API Provider OpenStack relies on a few prerequisites which have to be already installed in the used operating system images, e.g. a container runtime, kubelet, kubeadm,.. . Reference images can be found in kubernetes-sigs/image-builder. If it isn't possible to pre-install those prerequisites in the image, you can always deploy and execute some custom scripts through the KubeadmConfig.
Documentation is in the /docs directory
Are you interested in contributing to cluster-api-provider-openstack? 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 how to get involved via the cluster-api-openstack channel on Kubernetes Slack or the SIG-Cluster-Lifecycle Mailing List.
In the interest of getting more new people involved we try to tag issues with
good first issue.
These are typically issues that have 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!
This repository uses the Kubernetes bots. See a full list of the commands here. Please also refer to the Contribution Guide and the Development Guide for this project.
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
If you think you have found a bug please follow the instructions below.
- Please spend a small amount of time giving 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 new issue.
- Remember that 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 the Kubernetes Slack.
We also use the issue tracker to track features. If you have an idea for a feature, or think you can help Cluster API Provider OpenStack become even more awesome follow the steps below.
- Open a new issue.
- Remember that 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.
- 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 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.