cluster-api-provider-azurestackhci

README

Kubernetes Cluster API Provider Azure Stack HCI

---

Kubernetes-native declarative infrastructure for Azure Stack HCI.

What is the Cluster API Provider Azure Stack HCI

The Cluster API brings declarative, Kubernetes-style APIs to cluster creation, configuration and management. Cluster API Provider for Azure Stack HCI(CAPH) is an implementation of Cluster API for Azure Stack HCI.

The API itself is shared across multiple cloud providers allowing for true Azure Stack HCI hybrid deployments of Kubernetes.

Quick Start

Check out the Cluster API Quick Start to create your first Kubernetes cluster on Azure Stack HCI using Cluster API.

---

Support Policy

This provider's versions are compatible with the following versions of Cluster API:

	Cluster API v1beta1 (v1.2)	Cluster API v1beta1 (v1.4)	Cluster API v1beta1 (v1.5)
CAPH v1beta1 (v1.1.8)	✓	X	X
CAPH v1beta1 (v1.1.9)	✓	X	X
CAPH v1beta1 (v1.1.10)	X	✓	X
CAPH v1beta1 (v1.1.11)	X	✓	X
CAPH v1beta1 (v1.1.12)	X	✓	X
CAPH v1beta1 (v1.1.13)	X	✓	X
CAPH v1beta1 (v1.1.14)	X	✓	✓

This provider's versions are able to install and manage the following versions of Kubernetes:

	k8s 1.24	k8s 1.25	k8s 1.26	k8s 1.27
CAPH v1beta1 (v1.1.8)	✓	✓	✓	X
CAPH v1beta1 (v1.1.9)	✓	✓	✓	X
CAPH v1beta1 (v1.1.10)	✓	✓	✓	X
CAPH v1beta1 (v1.1.11)	✓	✓	✓	X
CAPH v1beta1 (v1.1.12)	✓	✓	✓	X
CAPH v1beta1 (v1.1.13)	X	✓	✓	✓
CAPH v1beta1 (v1.1.14)	X	✓	✓	✓

Each version of Cluster API Provider for Azure Stack HCI will attempt to support at least two Kubernetes versions e.g., Cluster API for Azure Stack HCI v1.1.13 supports Kubernetes 1.25, 1.26 and 1.27.

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.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

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 ClusterAPI 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 this and cluster-api-provider-azurestackhci does that.
• 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.