README
¶
Kubernetes Cluster API Provider IBM Cloud
This repository hosts a concrete implementation of an IBM Cloud provider for the cluster-api project.
What is the Cluster API Provider IBM Cloud
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 IBM Cloud hybrid deployments of Kubernetes.
Documentation
Please see our book for in-depth documentation.
Launching a Kubernetes cluster on IBMCloud
Check out the Cluster API IBMCloud Quick Start for launching a cluster on IBMCloud.
Compatibility with Cluster API and Kubernetes Versions
This provider's versions are compatible with the following versions of Cluster API:
| v1alpha3 (v0.3) | v1alpha4 (v0.4) | v1beta1 (v1.x) | |
|---|---|---|---|
| IBMCloud Provider v1alpha4 (v0.1) | ✓ | ✓ | |
| IBMCloud Provider v1beta1 (v0.2, main) | ✓ |
(See Kubernetes support matrix of Cluster API versions).
Community, discussion, contribution, and support
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-ibmcloud channel
- Subscribe to the SIG Cluster Lifecycle Google Group for access to documents and calendars
- Join our Weekly meeting sessions where we share the latest project news, demos, answer questions, and triage issues
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.
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1beta1
Package v1beta1 contains the v1beta1 API implementation.
|
Package v1beta1 contains the v1beta1 API implementation. |
|
v1beta2
Package v1beta2 contains the v1beta2 API implementation.
|
Package v1beta2 contains the v1beta2 API implementation. |
|
cloud
|
|
|
scope
Package scope implements cloud code.
|
Package scope implements cloud code. |
|
Package controllers implements controllers code.
|
Package controllers implements controllers code. |
|
hack
|
|
|
boilerplate/test
Package test contains test boilerplate.
|
Package test contains test boilerplate. |
|
tools
Module
|
|
|
pkg
|
|
|
cloud/services/authenticator
Package authenticator implements authenticator code.
|
Package authenticator implements authenticator code. |
|
cloud/services/powervs
Package powervs implements powervs code.
|
Package powervs implements powervs code. |
|
cloud/services/powervs/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
cloud/services/resourcecontroller
Package resourcecontroller implements resourcecontroller code.
|
Package resourcecontroller implements resourcecontroller code. |
|
cloud/services/utils
Package utils implements utils code.
|
Package utils implements utils code. |
|
cloud/services/vpc
Package vpc implements VPC code.
|
Package vpc implements VPC code. |
|
cloud/services/vpc/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
endpoints
Package endpoints implements endpoints code.
|
Package endpoints implements endpoints code. |
|
options
Package options implements options code.
|
Package options implements options code. |
|
record
Package record implements record framework code.
|
Package record implements record framework code. |
|
test
|
|
|
helpers
Package helpers implements test helpers code.
|
Package helpers implements test helpers code. |
|
Package util implements util code.
|
Package util implements util code. |