README
¶
Kubernetes Cluster API Provider IONOS Cloud
Kubernetes-native declarative infrastructure for IONOS Cloud.
What is the Cluster API Provider IONOS Cloud
The Cluster API Provider IONOS Cloud makes declarative provisioning of multiple Kubernetes clusters through Cluster API on IONOS Cloud infrastructure possible.
Cluster API is a Kubernetes sub-project focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.
Started by the Kubernetes Special Interest Group (SIG) Cluster Lifecycle, the Cluster API project uses Kubernetes-style APIs and patterns to automate cluster lifecycle management for platform operators. The supporting infrastructure, like virtual machines, networks, load balancers, and VPCs, as well as the Kubernetes cluster configuration are all defined in the same way that application developers operate deploying and managing their workloads. This enables consistent and repeatable cluster deployments across a wide variety of infrastructure environments.
Quick Start
Check out the Cluster API Quick Start to create your first Kubernetes cluster.
Getting Help
If you need help with CAPIC, please visit the #cluster-api-ionoscloud channel on Slack or open a GitHub issue.
Compatibility
Cluster API Versions
This provider's versions are compatible with the following versions of Cluster API:
| Cluster API v1beta1 (v1.7) | Cluster API v1beta1 (v1.8) | |
|---|---|---|
| CAPIC v1alpha1 (v0.2) | ✓ | ☓ |
| CAPIC v1alpha1 (v0.3) | ✓ | ☓ |
| CAPIC v1alpha1 (v0.4) | ✓ | ✓ |
| CAPIC v1alpha1 (v0.5) | ✓ | ✓ |
Kubernetes Versions
The IONOS Cloud provider is able to install and manage the versions of Kubernetes supported by the Cluster API (CAPI) project.
For more information on Kubernetes version support, see the Cluster API book.
Documentation
Documentation can be found in the /docs directory, and the index is here.
Getting involved and contributing
Are you interested in contributing to cluster-api-provider-ionoscloud? We, the maintainers and the 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.
To set up for your environment, check 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 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".
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
|
Package v1alpha1 contains API Schema definitions for the infrastructure v1alpha1 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io |
|
Package main performs initialization and starts the manager which will continuously reconcile on application defined resources.
|
Package main performs initialization and starts the manager which will continuously reconcile on application defined resources. |
|
internal
|
|
|
controller
Package controller contains the main reconciliation logic for this application.
|
Package controller contains the main reconciliation logic for this application. |
|
ionoscloud
Package ionoscloud offers an interface for abstracting Cloud API SDK, making it testable.
|
Package ionoscloud offers an interface for abstracting Cloud API SDK, making it testable. |
|
ionoscloud/client
Package client contains an implementation of the Client interface defined in internal/ionoscloud.
|
Package client contains an implementation of the Client interface defined in internal/ionoscloud. |
|
service/cloud
Package cloud offers infra resources services for IONOS Cloud machine reconciliation.
|
Package cloud offers infra resources services for IONOS Cloud machine reconciliation. |
|
service/k8s
Package k8s offers services to interact with kubernetes.
|
Package k8s offers services to interact with kubernetes. |
|
util/locker
Package locker provides a mechanism for fine-grained locking.
|
Package locker provides a mechanism for fine-grained locking. |
|
util/ptr
Package ptr offers generic pointer utility functions.
|
Package ptr offers generic pointer utility functions. |
|
Package scope defines the provider scopes for reconciliation.
|
Package scope defines the provider scopes for reconciliation. |