sigs.k8s.io/cluster-api-provider-azure@v1.17.0/README.md (about)

     1  # Kubernetes Cluster API Provider Azure
     2  
     3  <p align="center">
     4  <img src="https://github.com/kubernetes/kubernetes/raw/master/logo/logo.png"  width="100">
     5  </p>
     6  <p align="center">
     7  <!-- go doc / reference card -->
     8  <a href="https://pkg.go.dev/sigs.k8s.io/cluster-api-provider-azure">
     9  <img src="https://godoc.org/sigs.k8s.io/cluster-api-provider-azure?status.svg"></a>
    10  <!-- goreportcard badge -->
    11  <a href="https://goreportcard.com/report/kubernetes-sigs/cluster-api-provider-azure">
    12  <img src="https://goreportcard.com/badge/kubernetes-sigs/cluster-api-provider-azure"></a>
    13  <!-- join kubernetes slack channel for cluster-api-azure-provider -->
    14  <a href="https://kubernetes.slack.com/messages/CEX9HENG7">
    15  <img src="https://img.shields.io/badge/join%20slack-%23cluster--api--azure-brightgreen"></a>
    16  </p>
    17  
    18  ------
    19  
    20  Kubernetes-native declarative infrastructure for Azure.
    21  
    22  ## What is the Cluster API Provider Azure (CAPZ)
    23  
    24  The [Cluster API][cluster_api] brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.
    25  
    26  The API itself is shared across multiple cloud providers allowing for true Azure hybrid deployments of Kubernetes.
    27  
    28  CAPZ enables efficient management at scale of self-managed or managed (AKS) clusters on Azure.  Furthermore, the CAPZ management cluster can be utilized with the automatically installed Azure Service Operator (ASO) installation dependency to manage any Azure infrastructure.  For more information see the [roadmap high level vision](https://capz.sigs.k8s.io/roadmap#high-level-vision).
    29  
    30  ## Documentation
    31  
    32  Please see our [Book](https://capz.sigs.k8s.io) for in-depth user documentation.
    33  
    34  Additional docs can be found in the `/docs` directory, and the [index is here](https://github.com/kubernetes-sigs/cluster-api-provider-azure/blob/main/docs/README.md).
    35  
    36  ## Quick Start
    37  
    38  Check out the [Cluster API Quick Start][quickstart] to create your first Kubernetes cluster on Azure using Cluster API.
    39  
    40  ## Flavors
    41  
    42  See the [flavors documentation][flavors_doc] to know which cluster templates are provided by CAPZ.
    43  
    44  ## Getting Help
    45  
    46  If you need help with CAPZ, please visit the [#cluster-api-azure][slack] channel on Slack, open a [GitHub issue](#github-issues), or join us at [Office Hours](#office-hours).
    47  
    48  ------
    49  
    50  ## Compatibility
    51  
    52  ### Cluster API Versions
    53  
    54  Currently, CAPZ is compatible only with the `v1beta1` version of CAPI (v1.0.x). Support for `v1alpha3` (v0.3.x) and `v1alpha4` (v0.4.x) is deprecated and has been removed.
    55  
    56  ### Kubernetes Versions
    57  
    58  The Azure provider is able to install and manage the [versions of Kubernetes supported by the Cluster API (CAPI) project](https://cluster-api.sigs.k8s.io/reference/versions.html#supported-kubernetes-versions).
    59  
    60  #### Managed Clusters (AKS)
    61  
    62  Managed Clusters (AKS) follow their own [Kubernetes version support policy](https://learn.microsoft.com/azure/aks/supported-kubernetes-versions?tabs=azure-cli#kubernetes-version-support-policy). Please use the Azure portal or CLI to [find the versions supported in your cluster's location](https://learn.microsoft.com/azure/aks/supported-kubernetes-versions?tabs=azure-cli#azure-portal-and-cli-versions).
    63  
    64  For more information on Kubernetes version support, see the [Cluster API book](https://cluster-api.sigs.k8s.io/reference/versions.html).
    65  
    66  ------
    67  
    68  ## Getting involved and contributing
    69  
    70  Are you interested in contributing to cluster-api-provider-azure? We, the
    71  maintainers and community, would love your suggestions, contributions, and help!
    72  Also, the maintainers can be contacted at any time to learn more about how to get
    73  involved.
    74  
    75  To set up your environment checkout the [development guide](https://capz.sigs.k8s.io/developers/development.html).
    76  
    77  In the interest of getting more new people involved, we tag issues with
    78  [`good first issue`][good_first_issue].
    79  These are typically issues that have smaller scope but are good ways to start
    80  to get acquainted with the codebase.
    81  
    82  We also encourage ALL active community participants to act as if they are
    83  maintainers, even if you don't have "official" write permissions. This is a
    84  community effort, we are here to serve the Kubernetes community. If you have an
    85  active interest and you want to get involved, you have real power! Don't assume
    86  that the only people who can get things done around here are the "maintainers".
    87  
    88  We also would love to add more "official" maintainers, so show us what you can
    89  do!
    90  
    91  This repository uses the Kubernetes bots.  See a full list of the commands [here][prow].
    92  
    93  ### Office hours
    94  
    95  The community holds office hours every week, with sessions open to all users and
    96  developers.
    97  
    98  Office hours are hosted on a zoom video chat every Thursday
    99  at 09:00 (PT) / 12:00 (ET) [Convert to your timezone](https://www.thetimezoneconverter.com/?t=09:00&tz=PT%20%28Pacific%20Time%29)
   100  and are published on the [Kubernetes community meetings calendar][gcal]. Please add your questions or ideas to [the agenda][capz_agenda].
   101  
   102  ### Other ways to communicate with the contributors
   103  
   104  Please check in with us in the [#cluster-api-azure][slack] channel on Slack.
   105  
   106  ## Github issues
   107  
   108  ### Bugs
   109  
   110  If you think you have found a bug please follow the instructions below.
   111  
   112  - Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate.
   113  - Get the logs from the cluster controllers. Please paste this into your issue.
   114  - Open a [bug report][bug_report].
   115  - Remember users might be searching for your issue in the future, so please give it a meaningful title to help others.
   116  - Feel free to reach out to the cluster-api community on [kubernetes slack][slack_info].
   117  
   118  ### Tracking new features
   119  
   120  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.
   121  
   122  - Open a [feature request][feature_request].
   123  - Remember users might be searching for your issue in the future, so please
   124    give it a meaningful title to help others.
   125  - Clearly define the use case, using concrete examples. EG: I type `this` and
   126    cluster-api-provider-azure does `that`.
   127  - Some of our larger features will require some design. If you would like to
   128    include a technical design for your feature please include it in the issue.
   129  - After the new feature is well understood, and the design agreed upon we can
   130    start coding the feature. We would love for you to code it. So please open
   131    up a **WIP** *(work in progress)* pull request, and happy coding.
   132  
   133  <!-- References -->
   134  
   135  [slack]: https://kubernetes.slack.com/messages/CEX9HENG7
   136  [good_first_issue]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22
   137  [gcal]: https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com
   138  [prow]: https://go.k8s.io/bot-commands
   139  [bug_report]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/issues/new?template=bug_report.md
   140  [feature_request]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/issues/new?template=feature_request.md
   141  [slack_info]: https://github.com/kubernetes/community/tree/master/communication#slack
   142  [cluster_api]: https://github.com/kubernetes-sigs/cluster-api
   143  [quickstart]: https://cluster-api.sigs.k8s.io/user/quick-start.html
   144  [flavors_doc]: https://github.com/kubernetes-sigs/cluster-api-provider-azure/blob/main/templates/flavors/README.md
   145  [capz_agenda]: https://bit.ly/k8s-capz-agenda