sigs.k8s.io/cluster-api-provider-aws@v1.5.5/README.md (about) 1 # Kubernetes Cluster API Provider AWS 2 3 <p align="center"> 4 <img src="https://github.com/kubernetes/kubernetes/raw/master/logo/logo.png" width="100x"><a href="https://aws.amazon.com/opensource/"><img width="192x" src="https://d0.awsstatic.com/logos/powered-by-aws.png" alt="Powered by AWS Cloud Computing"></a> 5 </p> 6 <p align="center"> 7 <!-- go doc / reference card --> 8 <a href="https://godoc.org/sigs.k8s.io/cluster-api-provider-aws"> 9 <img src="https://godoc.org/sigs.k8s.io/cluster-api-provider-aws?status.svg"></a> 10 <!-- goreportcard badge --> 11 <a href="https://goreportcard.com/report/sigs.k8s.io/cluster-api-provider-aws"> 12 <img src="https://goreportcard.com/badge/sigs.k8s.io/cluster-api-provider-aws"></a> 13 <!-- join kubernetes slack channel for cluster-api-aws-provider --> 14 <a href="http://slack.k8s.io/"> 15 <img src="https://img.shields.io/badge/join%20slack-%23cluster--api--aws-brightgreen"></a> 16 <!-- openssf badge --> 17 <a href="https://bestpractices.coreinfrastructure.org/projects/5688"> 18 <img src="https://bestpractices.coreinfrastructure.org/projects/5688/badge"></a> 19 </p> 20 21 ------ 22 23 Kubernetes-native declarative infrastructure for AWS. 24 25 ## What is the Cluster API Provider AWS 26 27 The [Cluster API][cluster_api] brings 28 declarative, Kubernetes-style APIs to cluster creation, configuration and 29 management. 30 31 The API itself is shared across multiple cloud providers allowing for true AWS 32 hybrid deployments of Kubernetes. It is built atop the lessons learned from 33 previous cluster managers such as [kops][kops] and 34 [kubicorn][kubicorn]. 35 36 ## Documentation 37 38 Please see our [book](https://cluster-api-aws.sigs.k8s.io) for in-depth documentation. 39 40 ## Launching a Kubernetes cluster on AWS 41 42 Check out the [Cluster API Quick Start](https://cluster-api.sigs.k8s.io/user/quick-start.html) for launching a 43 cluster on AWS. 44 45 ## Features 46 47 - Native Kubernetes manifests and API 48 - Manages the bootstrapping of VPCs, gateways, security groups and instances. 49 - Choice of Linux distribution among Amazon Linux 2, CentOS 7, Ubuntu(18.04, 20.04) and Flatcar 50 using [pre-baked AMIs][published_amis]. 51 - Deploys Kubernetes control planes into private subnets with a separate 52 bastion server. 53 - Doesn't use SSH for bootstrapping nodes. 54 - Installs only the minimal components to bootstrap a control plane and workers. 55 - Supports control planes on EC2 instances. 56 - [EKS support][eks_support] 57 58 ------ 59 60 ## Compatibility with Cluster API and Kubernetes Versions 61 62 This provider's versions are compatible with the following versions of Cluster API 63 and support all Kubernetes versions that is supported by its compatible Cluster API version: 64 65 | | Cluster API v1alpha3 (v0.3) | Cluster API v1alpha4 (v0.4) | Cluster API v1beta1 (v1.x) | 66 | --------------------------- | :-------------------------: | :-------------------------: | :-------------------------: | 67 | CAPA v1alpha3 `(v0.6)` | ✓ | ☓ | ☓ | 68 | CAPA v1alpha4 `(v0.7)` | ☓ | ✓ | ☓ | 69 | CAPA v1beta1 `(v1.x, main)`| ☓ | ☓ | ✓ | 70 71 72 (See [Kubernetes support matrix][cluster-api-supported-v] of Cluster API versions). 73 74 ------ 75 76 ## Kubernetes versions with published AMIs 77 78 See [amis] for the list of most recently published AMIs. 79 80 ------ 81 82 ## clusterawsadm 83 84 `clusterawsadm` CLI tool provides bootstrapping, AMI, EKS, and controller related helpers. 85 86 `clusterawsadm` binaries are released with each release, can be found under [assets](https://github.com/kubernetes-sigs/cluster-api-provider-aws/releases/latest) section. 87 88 ------ 89 ## Getting involved and contributing 90 91 Are you interested in contributing to cluster-api-provider-aws? We, the 92 maintainers and community, would love your suggestions, contributions, and help! 93 Also, the maintainers can be contacted at any time to learn more about how to get 94 involved. 95 96 In the interest of getting more new people involved we tag issues with 97 [`good first issue`][good_first_issue]. 98 These are typically issues that have smaller scope but are good ways to start 99 to get acquainted with the codebase. 100 101 We also encourage ALL active community participants to act as if they are 102 maintainers, even if you don't have "official" write permissions. This is a 103 community effort, we are here to serve the Kubernetes community. If you have an 104 active interest and you want to get involved, you have real power! Don't assume 105 that the only people who can get things done around here are the "maintainers". 106 107 We also would love to add more "official" maintainers, so show us what you can 108 do! 109 110 This repository uses the Kubernetes bots. See a full list of the commands [here][prow]. 111 112 ### Build the images locally 113 114 If you want to just build the CAPA containers locally, run 115 116 ``` 117 REGISTRY=docker.io/my-reg make docker-build 118 ``` 119 120 ### Tilt-based development environment 121 122 See [development][development] section for details 123 124 [development]: https://cluster-api-aws.sigs.k8s.io/development/development.html 125 126 127 ### Implementer office hours 128 129 Maintainers hold office hours every two weeks, with sessions open to all 130 developers working on this project. 131 132 Office hours are hosted on a zoom video chat every other Monday 133 at 09:00 (Pacific) / 12:00 (Eastern) / 17:00 (Europe/London), 134 and are published on the [Kubernetes community meetings calendar][gcal]. 135 136 ### Other ways to communicate with the contributors 137 138 Please check in with us in the [#cluster-api-aws][slack] channel on Slack. 139 140 ## Github issues 141 142 ### Bugs 143 144 If you think you have found a bug please follow the instructions below. 145 146 - Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate. 147 - Get the logs from the cluster controllers. Please paste this into your issue. 148 - Open a [new issue][new_issue]. 149 - Remember that users might be searching for your issue in the future, so please give it a meaningful title to help others. 150 - Feel free to reach out to the cluster-api community on the [kubernetes slack][slack]. 151 152 ### Tracking new features 153 154 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. 155 156 - Open a [new issue][new_issue]. 157 - Remember that users might be searching for your issue in the future, so please 158 give it a meaningful title to help others. 159 - Clearly define the use case, using concrete examples. EG: I type `this` and 160 cluster-api-provider-aws does `that`. 161 - Some of our larger features will require some design. If you would like to 162 include a technical design for your feature please include it in the issue. 163 - After the new feature is well understood, and the design agreed upon, we can 164 start coding the feature. We would love for you to code it. So please open 165 up a **WIP** *(work in progress)* pull request, and happy coding. 166 167 >“Amazon Web Services, AWS, and the “Powered by AWS” logo materials are 168 trademarks of Amazon.com, Inc. or its affiliates in the United States 169 and/or other countries." 170 171 ## Our Contributors 172 173 Thank you to all contributors and a special thanks to our current maintainers & reviewers: 174 175 | Maintainers | Reviewers | 176 | ------------------------------------------------- | ---------------------------------------------- | 177 | [@richardcase](https://github.com/richardcase) | [@Ankitasw](https://github.com/Ankitasw) | 178 | [@sedefsavas](https://github.com/sedefsavas) | [@dthorsen](https://github.com/dthorsen) | 179 | | [@dlipovetsky](https://github.com/dlipovetsky) | 180 | | [@pydctw](https://github.com/pydctw) | 181 | | [@shivi28](https://github.com/shivi28) | 182 183 and the previous/emeritus maintainers & reviwers: 184 185 | Emeritus Maintainers | Emeritus Reviewers | 186 | ---------------------------------------------------- | ------------------------------------------------------ | 187 | [@chuckha](https://github.com/chuckha) | [@ashish-amarnath](https://github.com/ashish-amarnath) | 188 | [@detiber](https://github.com/detiber) | [@davidewatson](https://github.com/davidewatson) | 189 | [@ncdc](https://github.com/ncdc) | [@enxebre](https://github.com/enxebre) | 190 | [@randomvariable](https://github.com/randomvariable) | [@ingvagabund](https://github.com/ingvagabund) | 191 | [@rudoi](https://github.com/rudoi) | [@michaelbeaumont](https://github.com/michaelbeaumont) | 192 | [@vincepri](https://github.com/vincepri) | [@sethp-nr](https://github.com/sethp-nr) | 193 194 All the CAPA contributors: 195 196 <p> 197 <a href="https://github.com/kubernetes-sigs/cluster-api-provider-aws/graphs/contributors"> 198 <img src="https://contrib.rocks/image?repo=kubernetes-sigs/cluster-api-provider-aws" /> 199 </a> 200 </p> 201 202 203 <!-- References --> 204 [slack]: https://kubernetes.slack.com/messages/CD6U2V71N 205 [good_first_issue]: https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22 206 [gcal]: https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com 207 [prow]: https://go.k8s.io/bot-commands 208 [new_issue]: https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/new 209 [cluster_api]: https://github.com/kubernetes-sigs/cluster-api 210 [kops]: https://github.com/kubernetes/kops 211 [kubicorn]: http://kubicorn.io/ 212 [tilt]: https://tilt.dev 213 [cluster_api_tilt]: https://master.cluster-api.sigs.k8s.io/developer/tilt.html 214 [amis]: https://cluster-api-aws.sigs.k8s.io/topics/images/amis.html 215 [published_amis]: https://cluster-api-aws.sigs.k8s.io/topics/images/built-amis.html 216 [eks_support]: https://cluster-api-aws.sigs.k8s.io/topics/eks/index.html 217 [cluster-api-supported-v]: https://cluster-api.sigs.k8s.io/reference/versions.html