README
¶
Kubernetes Cluster API Provider Azure
Kubernetes-native declarative infrastructure for Azure.
What is the Cluster API Provider Azure
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 Azure hybrid deployments of Kubernetes.
Launching a Kubernetes cluster on Azure
Check out the getting started guide for launching a cluster on Azure.
Features
TODO
Support Policy
This provider's versions are compatible with the following versions of Cluster API:
Cluster API v1alpha1 (v0.1.x) |
Cluster API v1alpha2 (v0.2.x) |
|
|---|---|---|
Azure Provider v0.2.x |
✓ | |
Azure Provider v0.3.x |
✓ |
This provider's versions are able to install and manage the following versions of Kubernetes:
Azure Provider v0.2.x |
Azure Provider v0.3.x (unreleased) |
|
|---|---|---|
| Kubernetes 1.13 | ✓ | |
| Kubernetes 1.14 | ✓ | ✓ |
| Kubernetes 1.15 | ✓ | ✓ |
| Kubernetes 1.16 | ✓ |
Each version of Cluster API for Azure will attempt to support two Kubernetes versions e.g., Cluster API for Azure v0.1 may support Kubernetes 1.13 and Kubernetes 1.14.
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.
Documentation
Documentation is in the /docs directory, and the index is here.
Getting involved and contributing
Are you interested in contributing to cluster-api-provider-azure? 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.
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".
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.
Implementer office hours
TODO. Coming soon!
Other ways to communicate with the contributors
Please check in with us in the #cluster-api-azure channel on Slack.
Github issues
Bugs
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 bug report.
- Remember users might be searching for your issue in the future, so please give it a meaningful title to helps 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 you can help kops become even more awesome 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 helps others.
- Clearly define the use case, using concrete examples. EG: I type
thisand cluster-api-provider-azure doesthat. - 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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha2
Package v1alpha2 contains API Schema definitions for the infrastructure v1alpha2 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
|
Package v1alpha2 contains API Schema definitions for the infrastructure v1alpha2 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io |
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
services/availabilityzones/mock_availabilityzones
Package mock_availabilityzones is a generated GoMock package.
|
Package mock_availabilityzones is a generated GoMock package. |
|
services/disks/mock_disks
Package mock_disks is a generated GoMock package.
|
Package mock_disks is a generated GoMock package. |
|
services/groups/mock_groups
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/internalloadbalancers/mock_internalloadbalancers
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/networkinterfaces/mock_networkinterfaces
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/publicips/mock_publicips
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/publicloadbalancers/mock_publicloadbalancers
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/routetables/mock_routetables
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/securitygroups/mock_securitygroups
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/subnets/mock_subnets
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/virtualmachineextensions/mock_virtualmachineextensions
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/virtualmachines/mock_virtualmachines
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/virtualnetworks/mock_virtualnetworks
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
hack
|
|
|
pkg
|
|
|
test
|
|
|
e2e/framework
Package framework is mostly copied from the CAPI repository https://github.com/kubernetes-sigs/cluster-api/tree/master/test/framework Right now, it is hard to use CAPI's test/framework module for two reasons: - It has references to v1alpha3 types - The module has a redirect to a local file system directory
|
Package framework is mostly copied from the CAPI repository https://github.com/kubernetes-sigs/cluster-api/tree/master/test/framework Right now, it is hard to use CAPI's test/framework module for two reasons: - It has references to v1alpha3 types - The module has a redirect to a local file system directory |