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.
Quick Start
Check out the Cluster API Quick Start to create your first Kubernetes cluster on Azure using Cluster API.
Flavors
See the flavors documentation to know which cluster templates are provided by CAPZ.
Support Policy
This provider's versions are compatible with the following versions of Cluster API:
Cluster API v1alpha2 (v0.2.x) |
Cluster API v1alpha3 (v0.3.x) |
Cluster API v1alpha4 (v0.4.x) |
|
|---|---|---|---|
Azure Provider v0.3.x |
✓ | ||
Azure Provider v0.4.x |
✓ | ||
Azure Provider v0.5.x |
✓ |
This provider's versions are able to install and manage the following versions of Kubernetes:
Azure Provider v0.3.x |
Azure Provider v0.4.x |
Azure Provider v0.5.x |
|
|---|---|---|---|
| Kubernetes 1.15 | ✓ | ||
| Kubernetes 1.16 | ✓ | ✓ | |
| Kubernetes 1.17 | ✓ | ||
| Kubernetes 1.18 | ✓ | ✓ | |
| Kubernetes 1.19 | ✓ | ✓ | |
| Kubernetes 1.20 | ✓ | ✓ | |
| Kubernetes 1.21 | ✓ | ✓ | |
| Kubernetes 1.22 | ✓ |
Each version of Cluster API for Azure will attempt to support at least 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
Please see our Book for in-depth user documentation.
Additional docs 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-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.
To set up your environment checkout 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".
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.
Office hours
The community holds office hours every two weeks, with sessions open to all users and developers.
Office hours are hosted on a zoom video chat every other Thursday at 08:00 (PT) / 11:00 (ET) / 16:00 (UTC), and are published on the Kubernetes community meetings calendar.
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 Cluster API Provider Azure 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 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
|
|
|
v1alpha3
Package v1alpha3 contains API Schema definitions for the infrastructure v1alpha3 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
|
Package v1alpha3 contains API Schema definitions for the infrastructure v1alpha3 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io |
|
v1alpha4
Package v1alpha4 contains API Schema definitions for the infrastructure v1alpha4 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
|
Package v1alpha4 contains API Schema definitions for the infrastructure v1alpha4 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io |
|
mocks
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
scope/mocks
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/agentpools/mock_agentpools
Package mock_agentpools is a generated GoMock package.
|
Package mock_agentpools is a generated GoMock package. |
|
services/availabilitysets/mock_availabilitysets
Package mock_availabilitysets is a generated GoMock package.
|
Package mock_availabilitysets is a generated GoMock package. |
|
services/bastionhosts/mocks_bastionhosts
Package mock_bastionhosts is a generated GoMock package.
|
Package mock_bastionhosts 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
Package mock_groups is a generated GoMock package.
|
Package mock_groups is a generated GoMock package. |
|
services/inboundnatrules/mock_inboundnatrules
Package mock_inboundnatrules is a generated GoMock package.
|
Package mock_inboundnatrules is a generated GoMock package. |
|
services/loadbalancers/mock_loadbalancers
Package mock_loadbalancers is a generated GoMock package.
|
Package mock_loadbalancers is a generated GoMock package. |
|
services/managedclusters/mock_managedclusters
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/natgateways/mock_natgateways
Package mock_natgateways is a generated GoMock package.
|
Package mock_natgateways is a generated GoMock package. |
|
services/networkinterfaces/mock_networkinterfaces
Package mock_networkinterfaces is a generated GoMock package.
|
Package mock_networkinterfaces is a generated GoMock package. |
|
services/privatedns/mock_privatedns
Package mock_privatedns is a generated GoMock package.
|
Package mock_privatedns is a generated GoMock package. |
|
services/publicips/mock_publicips
Package mock_publicips is a generated GoMock package.
|
Package mock_publicips is a generated GoMock package. |
|
services/resourceskus/mock_resourceskus
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
services/roleassignments/mock_roleassignments
Package mock_roleassignments is a generated GoMock package.
|
Package mock_roleassignments is a generated GoMock package. |
|
services/routetables/mock_routetables
Package mock_routetables is a generated GoMock package.
|
Package mock_routetables is a generated GoMock package. |
|
services/scalesets/mock_scalesets
Package mock_scalesets is a generated GoMock package.
|
Package mock_scalesets is a generated GoMock package. |
|
services/scalesetvms/mock_scalesetvms
Package mock_scalesetvms is a generated GoMock package.
|
Package mock_scalesetvms is a generated GoMock package. |
|
services/securitygroups/mock_securitygroups
Package mock_securitygroups is a generated GoMock package.
|
Package mock_securitygroups is a generated GoMock package. |
|
services/subnets/mock_subnets
Package mock_subnets is a generated GoMock package.
|
Package mock_subnets is a generated GoMock package. |
|
services/tags/mock_tags
Package mock_tags is a generated GoMock package.
|
Package mock_tags is a generated GoMock package. |
|
services/virtualmachines/mock_virtualmachines
Package mock_virtualmachines is a generated GoMock package.
|
Package mock_virtualmachines is a generated GoMock package. |
|
services/virtualnetworks/mock_virtualnetworks
Package mock_virtualnetworks is a generated GoMock package.
|
Package mock_virtualnetworks is a generated GoMock package. |
|
services/vmextensions/mock_vmextensions
Package mock_vmextensions is a generated GoMock package.
|
Package mock_vmextensions is a generated GoMock package. |
|
services/vmssextensions/mock_vmssextensions
Package mock_vmssextensions is a generated GoMock package.
|
Package mock_vmssextensions is a generated GoMock package. |
|
api/v1alpha3
Package v1alpha3 contains API Schema definitions for the exp v1alpha3 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
|
Package v1alpha3 contains API Schema definitions for the exp v1alpha3 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io |
|
api/v1alpha4
Package v1alpha4 contains API Schema definitions for the exp v1alpha4 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io
|
Package v1alpha4 contains API Schema definitions for the exp v1alpha4 API group +kubebuilder:object:generate=true +groupName=infrastructure.cluster.x-k8s.io |
|
controllers/mocks
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
hack
|
|
|
internal
|
|
|
test/mock_log
Run go generate to regenerate this mock.
|
Run go generate to regenerate this mock. |
|
pkg
|
|
|
coalescing/mocks
Package mock_coalescing is a generated GoMock package.
|
Package mock_coalescing is a generated GoMock package. |
|
test
|
|
|
util
|
|
|
cache/ttllru/mocks
Package mock_ttllru is a generated GoMock package.
|
Package mock_ttllru is a generated GoMock package. |