cluster-api-provider-aws

command module

v2.5.0 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 47 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kubernetes-sigs/cluster-api-provider-aws

Links

Open Source Insights

README ¶

Kubernetes Cluster API Provider AWS

Kubernetes-native declarative infrastructure for AWS.

What is the Cluster API Provider AWS

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 AWS hybrid deployments of Kubernetes. It is built atop the lessons learned from previous cluster managers such as kops and kubicorn.

Documentation

Please see our book for in-depth documentation.

Launching a Kubernetes cluster on AWS

Check out the Cluster API Quick Start for launching a cluster on AWS.

Features

Native Kubernetes manifests and API
Manages the bootstrapping of VPCs, gateways, security groups and instances.
Choice of Linux distribution among Amazon Linux 2, CentOS 7, Ubuntu(18.04, 20.04) and Flatcar using pre-baked AMIs.
Deploys Kubernetes control planes into private subnets with a separate bastion server.
Doesn't use SSH for bootstrapping nodes.
Installs only the minimal components to bootstrap a control plane and workers.
Supports control planes on EC2 instances.
EKS support

Compatibility with Cluster API and Kubernetes Versions

This provider's versions are compatible with the following versions of Cluster API and support all Kubernetes versions that is supported by its compatible Cluster API version:

	Cluster API v1alpha4 (v0.4)	Cluster API v1beta1 (v1.x)
CAPA v1alpha4 `(v0.7)`	✓	☓
CAPA v1beta1 `(v1.x)`	☓	✓
CAPA v1beta2 `(v2.x, main)`	☓	✓

(See Kubernetes support matrix of Cluster API versions).

Kubernetes versions with published AMIs

See amis for the list of most recently published AMIs.

clusterawsadm

clusterawsadm CLI tool provides bootstrapping, AMI, EKS, and controller related helpers.

clusterawsadm binaries are released with each release, can be found under assets section.

clusterawsadm could also be installed via Homebrew on macOS and linux OS. Install the latest release using homebrew:

brew install clusterawsadm

Test to ensure the version you installed is up-to-date:

clusterawsadm version

Getting involved and contributing

Are you interested in contributing to cluster-api-provider-aws? 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.

Build the images locally

If you want to just build the CAPA containers locally, run

  REGISTRY=docker.io/my-reg make docker-build

Tilt-based development environment

See development section for details.

Implementer office hours

Maintainers hold office hours every two weeks, with sessions open to all developers working on this project.

Office hours are hosted on a zoom video chat every other Monday at 09:00 (Pacific) / 12:00 (Eastern) / 17:00 (Europe/London), 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-aws 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 new issue.
Remember that users might be searching for your issue in the future, so please give it a meaningful title to help others.
Feel free to reach out to the cluster-api community on the 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 new issue.
Remember that users might be searching for your issue in the future, so please give it a meaningful title to help others.
Clearly define the use case, using concrete examples. EG: I type this and cluster-api-provider-aws 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.

“Amazon Web Services, AWS, and the “Powered by AWS” logo materials are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries."

Our Contributors

Thank you to all contributors and a special thanks to our current maintainers & reviewers:

Maintainers	Reviewers
@richardcase (from 2020-12-04)	@cnmcavoy (from 2023-10-16)
@Ankitasw (from 2022-10-19)	@AverageMarcus (from 2022-10-19)
@dlipovetsky (from 2021-10-31)	@luthermonson (from 2023-03-08)
@vincepri (og & from 2023-10-16)	@nrb (from 2023-10-16)
	@faiq (from 2023-10-16)
	@fiunchinho (from 2023-11-6)
	@AndiDog (from 2023-12-13)

and the previous/emeritus maintainers & reviewers:

Emeritus Maintainers	Emeritus Reviewers
@chuckha	@ashish-amarnath
@detiber	@davidewatson
@ncdc	@enxebre
@randomvariable	@ingvagabund
@rudoi	@michaelbeaumont
@sedefsavas	@sethp-nr
@Skarlso	@shivi28
	@dthorsen
	@pydctw

All the CAPA contributors:

Documentation ¶

Overview ¶

Package main contains the main entrypoint for the AWS provider components.

Source Files ¶

View all Source files

main.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
api
v1beta1 Package v1beta1 contains the v1beta1 API implementation.	Package v1beta1 contains the v1beta1 API implementation.
v1beta2 Package v1beta2 contains the v1beta2 API implementation.	Package v1beta2 contains the v1beta2 API implementation.
bootstrap
eks/api/v1beta1 Package v1beta1 contains API Schema definitions for the Amazon EKS Bootstrap v1beta1 API group +kubebuilder:object:generate=true +groupName=bootstrap.cluster.x-k8s.io	Package v1beta1 contains API Schema definitions for the Amazon EKS Bootstrap v1beta1 API group +kubebuilder:object:generate=true +groupName=bootstrap.cluster.x-k8s.io
eks/api/v1beta2 Package v1beta2 contains API Schema definitions for the Amazon EKS Bootstrap v1beta2 API group.	Package v1beta2 contains API Schema definitions for the Amazon EKS Bootstrap v1beta2 API group.
eks/controllers Package controllers provides a way to reconcile EKSConfig objects.	Package controllers provides a way to reconcile EKSConfig objects.
eks/internal/userdata Package userdata provides a way to generate ec2 instance userdata.	Package userdata provides a way to generate ec2 instance userdata.
cmd
clusterawsadm Package main is the entrypoint for the clusterawsadm command.	Package main is the entrypoint for the clusterawsadm command.
clusterawsadm/ami Package ami provides a way to interact with AWS AMIs.	Package ami provides a way to interact with AWS AMIs.
clusterawsadm/api/ami/v1beta1 Package v1beta1 contains API Schema definitions for the AMI v1beta1 API group +kubebuilder:object:generate=true +k8s:defaulter-gen=TypeMeta +groupName=ami.aws.infrastructure.cluster.x-k8s.io	Package v1beta1 contains API Schema definitions for the AMI v1beta1 API group +kubebuilder:object:generate=true +k8s:defaulter-gen=TypeMeta +groupName=ami.aws.infrastructure.cluster.x-k8s.io
clusterawsadm/api/ami/v1beta1/scheme Package scheme provides a way to generate a Scheme and CodecFactory f or the bootstrap.aws.infrastructure.cluster.x-k8s.io API group.	Package scheme provides a way to generate a Scheme and CodecFactory f or the bootstrap.aws.infrastructure.cluster.x-k8s.io API group.
clusterawsadm/api/bootstrap/v1alpha1 Package v1alpha1 contains API Schema definitions for the bootstrap v1alpha1 API group +kubebuilder:object:generate=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=bootstrap.aws.infrastructure.cluster.x-k8s.io +k8s:conversion-gen=sigs.k8s.io/cluster-api-provider-aws/v2/cmd/clusterawsadm/api/bootstrap/v1beta1	Package v1alpha1 contains API Schema definitions for the bootstrap v1alpha1 API group +kubebuilder:object:generate=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=bootstrap.aws.infrastructure.cluster.x-k8s.io +k8s:conversion-gen=sigs.k8s.io/cluster-api-provider-aws/v2/cmd/clusterawsadm/api/bootstrap/v1beta1
clusterawsadm/api/bootstrap/v1alpha1/scheme Package scheme provides a way to generate a Scheme and CodecFactory for the bootstrap.aws.infrastructure.cluster.x-k8s.io API group.	Package scheme provides a way to generate a Scheme and CodecFactory for the bootstrap.aws.infrastructure.cluster.x-k8s.io API group.
clusterawsadm/api/bootstrap/v1beta1 Package v1beta1 contains API Schema definitions for the bootstrap v1beta1 API group +kubebuilder:object:generate=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=bootstrap.aws.infrastructure.cluster.x-k8s.io +gencrdrefdocs:force	Package v1beta1 contains API Schema definitions for the bootstrap v1beta1 API group +kubebuilder:object:generate=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=bootstrap.aws.infrastructure.cluster.x-k8s.io +gencrdrefdocs:force
clusterawsadm/api/bootstrap/v1beta1/scheme Package scheme provides a way to generate a Scheme and CodecFactory for the bootstrap.aws.infrastructure.cluster.x-k8s.io API group.	Package scheme provides a way to generate a Scheme and CodecFactory for the bootstrap.aws.infrastructure.cluster.x-k8s.io API group.
clusterawsadm/cloudformation/bootstrap Package bootstrap provides a way to generate a CloudFormation template for IAM policies, users and roles for use by Cluster API Provider AWS.	Package bootstrap provides a way to generate a CloudFormation template for IAM policies, users and roles for use by Cluster API Provider AWS.
clusterawsadm/cloudformation/service Package cloudformation provides the API operation methods for making requests to AWS CloudFormation.	Package cloudformation provides the API operation methods for making requests to AWS CloudFormation.
clusterawsadm/cmd Package cmd implements the clusterawsadm command line utility.	Package cmd implements the clusterawsadm command line utility.
clusterawsadm/cmd/ami Package ami provides a way to generate AMI commands.	Package ami provides a way to generate AMI commands.
clusterawsadm/cmd/ami/common Package common provides common flags and functions for the AMI commands.	Package common provides common flags and functions for the AMI commands.
clusterawsadm/cmd/ami/list Package list provides a way to list AMIs from the default AWS account where AMIs are stored.	Package list provides a way to list AMIs from the default AWS account where AMIs are stored.
clusterawsadm/cmd/bootstrap Package bootstrap provides cli commands for bootstrapping AWS accounts for use with the Kubernetes Cluster API Provider AWS.	Package bootstrap provides cli commands for bootstrapping AWS accounts for use with the Kubernetes Cluster API Provider AWS.
clusterawsadm/cmd/bootstrap/credentials Package credentials provides a way to encode credentials for use with Kubernetes Cluster API Provider AWS.	Package credentials provides a way to encode credentials for use with Kubernetes Cluster API Provider AWS.
clusterawsadm/cmd/bootstrap/iam Package iam provides a way to generate IAM policies and roles.	Package iam provides a way to generate IAM policies and roles.
clusterawsadm/cmd/controller Package controller provides the controller command.	Package controller provides the controller command.
clusterawsadm/cmd/controller/credentials Package credentials provides a CLI utilities for AWS credentials.	Package credentials provides a CLI utilities for AWS credentials.
clusterawsadm/cmd/controller/rollout Package rollout provides the rollout command.	Package rollout provides the rollout command.
clusterawsadm/cmd/eks Package eks provides a CLI to manage EKS clusters.	Package eks provides a CLI to manage EKS clusters.
clusterawsadm/cmd/eks/addons Package addons provides EKS addons commands.	Package addons provides EKS addons commands.
clusterawsadm/cmd/flags Package flags provides a way to add flags to the cli.	Package flags provides a way to add flags to the cli.
clusterawsadm/cmd/gc Package gc provides commands related to garbage collecting external resources of clusters.	Package gc provides commands related to garbage collecting external resources of clusters.
clusterawsadm/cmd/resource Package resource provides commands related to AWS resources.	Package resource provides commands related to AWS resources.
clusterawsadm/cmd/resource/list Package list provides the list command for the resource package.	Package list provides the list command for the resource package.
clusterawsadm/cmd/util Package util provides utility functions.	Package util provides utility functions.
clusterawsadm/cmd/version Package version provides the version information of clusterawsadm.	Package version provides the version information of clusterawsadm.
clusterawsadm/configreader Package configreader provides a way to load a bootstrapv1.AWSIAMConfiguration from a file.	Package configreader provides a way to load a bootstrapv1.AWSIAMConfiguration from a file.
clusterawsadm/controller Package controller contains the controller logic for the capa manager.	Package controller contains the controller logic for the capa manager.
clusterawsadm/controller/credentials Package credentials provides AWS credentials management.	Package credentials provides AWS credentials management.