Awesome
<!-- markdownlint-disable --><a href="https://cpco.io/homepage"><img src=".github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse-terraform-components/aws-eks-karpenter-controller/releases/latest"><img src="https://img.shields.io/github/release/cloudposse-terraform-components/aws-eks-karpenter-controller.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->This component provisions Karpenter on an EKS cluster. It requires at least version 0.32.0 of Karpenter, though you are encouraged to use the latest version.
Usage
Stack Level: Regional
These instructions assume you are provisioning 2 EKS clusters in the same account and region, named "blue" and "green",
and alternating between them. If you are only using a single cluster, you can ignore the "blue" and "green" references
and remove the metadata
block from the karpenter
module.
components:
terraform:
# Base component of all `karpenter` components
eks/karpenter:
metadata:
type: abstract
vars:
enabled: true
eks_component_name: "eks/cluster"
name: "karpenter"
# https://github.com/aws/karpenter/tree/main/charts/karpenter
chart_repository: "oci://public.ecr.aws/karpenter"
chart: "karpenter"
chart_version: "v0.36.0"
# Enable Karpenter to get advance notice of spot instances being terminated
# See https://karpenter.sh/docs/concepts/#interruption
interruption_handler_enabled: true
resources:
limits:
cpu: "300m"
memory: "1Gi"
requests:
cpu: "100m"
memory: "512Mi"
cleanup_on_fail: true
atomic: true
wait: true
rbac_enabled: true
# "karpenter-crd" can be installed as an independent helm chart to manage the lifecycle of Karpenter CRDs
crd_chart_enabled: true
crd_chart: "karpenter-crd"
# replicas set the number of Karpenter controller replicas to run
replicas: 2
# "settings" controls a subset of the settings for the Karpenter controller regarding batch idle and max duration.
# you can read more about these settings here: https://karpenter.sh/docs/reference/settings/
settings:
batch_idle_duration: "1s"
batch_max_duration: "10s"
# The logging settings for the Karpenter controller
logging:
enabled: true
level:
controller: "info"
global: "info"
webhook: "error"
Provision Karpenter on EKS cluster
Here we describe how to provision Karpenter on an EKS cluster. We will be using the plat-ue2-dev
stack as an example.
Provision Service-Linked Roles for EC2 Spot and EC2 Spot Fleet
Note: If you want to use EC2 Spot for the instances launched by Karpenter, you may need to provision the following Service-Linked Role for EC2 Spot:
- Service-Linked Role for EC2 Spot
This is only necessary if this is the first time you're using EC2 Spot in the account. Since this is a one-time operation, we recommend you do this manually via the AWS CLI:
aws --profile <namespace>-<tenamt>-gbl-<stage>-admin iam create-service-linked-role --aws-service-name spot.amazonaws.com
Note that if the Service-Linked Roles already exist in the AWS account (if you used EC2 Spot or Spot Fleet before), and you try to provision them again, you will see the following errors:
An error occurred (InvalidInput) when calling the CreateServiceLinkedRole operation:
Service role name AWSServiceRoleForEC2Spot has been taken in this account, please try a different suffix
For more details, see:
- https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html
- https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html
The process of provisioning Karpenter on an EKS cluster consists of 3 steps.
1. Provision EKS IAM Role for Nodes Launched by Karpenter
[!NOTE]
VPC assumptions being made
We assume you've already created a VPC using our VPC component and have private subnets already set up. The Karpenter node pools will be launched in the private subnets.
EKS IAM Role for Nodes launched by Karpenter are provisioned by the eks/cluster
component. (EKS can also provision a
Fargate Profile for Karpenter, but deploying Karpenter to Fargate is not recommended.):
components:
terraform:
eks/cluster-blue:
metadata:
component: eks/cluster
inherits:
- eks/cluster
vars:
karpenter_iam_role_enabled: true
[!NOTE]
The AWS Auth API for EKS is used to authorize the Karpenter controller to interact with the EKS cluster.
Karpenter is installed using a Helm chart. The Helm chart installs the Karpenter controller and a webhook pod as a Deployment that needs to run before the controller can be used for scaling your cluster. We recommend a minimum of one small node group with at least one worker node.
As an alternative, you can run these pods on EKS Fargate by creating a Fargate profile for the karpenter namespace. Doing so will cause all pods deployed into this namespace to run on EKS Fargate. Do not run Karpenter on a node that is managed by Karpenter.
See Run Karpenter Controller... for more details.
We provision IAM Role for Nodes launched by Karpenter because they must run with an Instance Profile that grants permissions necessary to run containers and configure networking.
We define the IAM role for the Instance Profile in components/terraform/eks/cluster/controller-policy.tf
.
Note that we provision the EC2 Instance Profile for the Karpenter IAM role in the components/terraform/eks/karpenter
component (see the next step).
Run the following commands to provision the EKS Instance Profile for Karpenter and the IAM role for instances launched by Karpenter on the blue EKS cluster and add the role ARNs to the EKS Auth API:
atmos terraform plan eks/cluster-blue -s plat-ue2-dev
atmos terraform apply eks/cluster-blue -s plat-ue2-dev
For more details, refer to:
2. Provision karpenter
component
In this step, we provision the components/terraform/eks/karpenter
component, which deploys the following resources:
- Karpenter CustomerResourceDefinitions (CRDs) using the Karpenter CRD Chart and the
helm_release
Terraform resource - Karpenter Kubernetes controller using the Karpenter Helm Chart and the
helm_release
Terraform resource - EKS IAM role for Kubernetes Service Account for the Karpenter controller (with all the required permissions)
- An SQS Queue and Event Bridge rules for handling Node Interruption events (i.e. Spot)
Create a stack config for the blue Karpenter component in stacks/catalog/eks/clusters/blue.yaml
:
eks/karpenter-blue:
metadata:
component: eks/karpenter
inherits:
- eks/karpenter
vars:
eks_component_name: eks/cluster-blue
Run the following commands to provision the Karpenter component on the blue EKS cluster:
atmos terraform plan eks/karpenter-blue -s plat-ue2-dev
atmos terraform apply eks/karpenter-blue -s plat-ue2-dev
3. Provision karpenter-node-pool
component
In this step, we provision the components/terraform/eks/karpenter-node-pool
component, which deploys Karpenter
NodePools using the
kubernetes_manifest
resource.
[!TIP]
Why use a separate component for NodePools?
We create the NodePools as a separate component since the CRDs for the NodePools are created by the Karpenter component. This helps manage dependencies.
First, create an abstract component for the eks/karpenter-node-pool
component:
components:
terraform:
eks/karpenter-node-pool:
metadata:
type: abstract
vars:
enabled: true
# Disabling Manifest Experiment disables stored metadata with Terraform state
# Otherwise, the state will show changes on all plans
helm_manifest_experiment_enabled: false
node_pools:
default:
# Whether to place EC2 instances launched by Karpenter into VPC private subnets. Set it to `false` to use public subnets
private_subnets_enabled: true
# You can use disruption to set the maximum instance lifetime for the EC2 instances launched by Karpenter.
# You can also configure how fast or slow Karpenter should add/remove nodes.
# See more: https://karpenter.sh/v0.36/concepts/disruption/
disruption:
max_instance_lifetime: "336h" # 14 days
# Taints can be used to prevent pods without the right tolerations from running on this node pool.
# See more: https://karpenter.sh/v0.36/concepts/nodepools/#taints
taints: []
total_cpu_limit: "1k"
# Karpenter node pool total memory limit for all pods running on the EC2 instances launched by Karpenter
total_memory_limit: "1200Gi"
# Set acceptable (In) and unacceptable (Out) Kubernetes and Karpenter values for node provisioning based on
# Well-Known Labels and cloud-specific settings. These can include instance types, zones, computer architecture,
# and capacity type (such as AWS spot or on-demand).
# See https://karpenter.sh/v0.36/concepts/nodepools/#spectemplatespecrequirements for more details
requirements:
- key: "karpenter.sh/capacity-type"
operator: "In"
# See https://karpenter.sh/docs/concepts/nodepools/#capacity-type
# Allow fallback to on-demand instances when spot instances are unavailable
# By default, Karpenter uses the "price-capacity-optimized" allocation strategy
# https://aws.amazon.com/blogs/compute/introducing-price-capacity-optimized-allocation-strategy-for-ec2-spot-instances/
# It is currently not configurable, but that may change in the future.
# See https://github.com/aws/karpenter-provider-aws/issues/1240
values:
- "on-demand"
- "spot"
- key: "kubernetes.io/os"
operator: "In"
values:
- "linux"
- key: "kubernetes.io/arch"
operator: "In"
values:
- "amd64"
# The following two requirements pick instances such as c3 or m5
- key: karpenter.k8s.aws/instance-category
operator: In
values: ["c", "m", "r"]
- key: karpenter.k8s.aws/instance-generation
operator: Gt
values: ["2"]
Now, create the stack config for the blue Karpenter NodePool component in stacks/catalog/eks/clusters/blue.yaml
:
eks/karpenter-node-pool/blue:
metadata:
component: eks/karpenter-node-pool
inherits:
- eks/karpenter-node-pool
vars:
eks_component_name: eks/cluster-blue
Finally, run the following commands to deploy the Karpenter NodePools on the blue EKS cluster:
atmos terraform plan eks/karpenter-node-pool/blue -s plat-ue2-dev
atmos terraform apply eks/karpenter-node-pool/blue -s plat-ue2-dev
Node Interruption
Karpenter also supports listening for and responding to Node Interruption events. If interruption handling is enabled, Karpenter will watch for upcoming involuntary interruption events that would cause disruption to your workloads. These interruption events include:
- Spot Interruption Warnings
- Scheduled Change Health Events (Maintenance Events)
- Instance Terminating Events
- Instance Stopping Events
[!TIP]
Interruption Handler vs. Termination Handler
The Node Interruption Handler is not the same as the Node Termination Handler. The latter is always enabled and cleanly shuts down the node in 2 minutes in response to a Node Termination event. The former gets advance notice that a node will soon be terminated, so it can have 5-10 minutes to shut down a node.
For more details, see refer to the Karpenter docs and FAQ
To enable Node Interruption handling, set var.interruption_handler_enabled
to true
. This will create an SQS queue
and a set of Event Bridge rules to deliver interruption events to Karpenter.
Custom Resource Definition (CRD) Management
Karpenter ships with a few Custom Resource Definitions (CRDs). In earlier versions of this component, when installing a
new version of the karpenter
helm chart, CRDs were not be upgraded at the same time, requiring manual steps to upgrade
CRDs after deploying the latest chart. However Karpenter now supports an additional, independent helm chart for CRD
management. This helm chart, karpenter-crd
, can be installed alongside the karpenter
helm chart to automatically
manage the lifecycle of these CRDs.
To deploy the karpenter-crd
helm chart, set var.crd_chart_enabled
to true
. (Installing the karpenter-crd
chart
is recommended. var.crd_chart_enabled
defaults to false
to preserve backward compatibility with older versions of
this component.)
Troubleshooting
For Karpenter issues, checkout the Karpenter Troubleshooting Guide
References
For more details on the CRDs, see:
-
https://karpenter.sh/v0.36/getting-started/getting-started-with-karpenter/#5-create-nodepool
-
https://karpenter.sh/v0.36/concepts/disruption/#interruption
-
https://karpenter.sh/v0.36/concepts/nodepools/#spectemplatespecrequirements
-
https://karpenter.sh/v0.36/getting-started/getting-started-with-karpenter/
Requirements
Name | Version |
---|---|
<a name="requirement_terraform"></a> terraform | >= 1.3.0 |
<a name="requirement_aws"></a> aws | >= 4.9.0 |
<a name="requirement_helm"></a> helm | >= 2.0 |
<a name="requirement_kubernetes"></a> kubernetes | >= 2.7.1, != 2.21.0 |
Providers
Name | Version |
---|---|
<a name="provider_aws"></a> aws | >= 4.9.0 |
Modules
Name | Source | Version |
---|---|---|
<a name="module_eks"></a> eks | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
<a name="module_iam_roles"></a> iam_roles | ../../account-map/modules/iam-roles | n/a |
<a name="module_karpenter"></a> karpenter | cloudposse/helm-release/aws | 0.10.1 |
<a name="module_karpenter_crd"></a> karpenter_crd | cloudposse/helm-release/aws | 0.10.1 |
<a name="module_this"></a> this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_cloudwatch_event_rule.interruption_handler | resource |
aws_cloudwatch_event_target.interruption_handler | resource |
aws_iam_policy.v1alpha | resource |
aws_iam_role_policy_attachment.v1alpha | resource |
aws_sqs_queue.interruption_handler | resource |
aws_sqs_queue_policy.interruption_handler | resource |
aws_eks_cluster_auth.eks | data source |
aws_iam_policy_document.interruption_handler | data source |
aws_partition.current | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
<a name="input_additional_tag_map"></a> additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
<a name="input_atomic"></a> atomic | If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used | bool | true | no |
<a name="input_attributes"></a> attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the delimiter <br>and treated as a single ID element. | list(string) | [] | no |
<a name="input_chart"></a> chart | Chart name to be installed. The chart name can be local path, a URL to a chart, or the name of the chart if repository is specified. It is also possible to use the <repository>/<chart> format here if you are running Terraform on a system that the repository has been added to with helm repo add but this is not recommended | string | n/a | yes |
<a name="input_chart_description"></a> chart_description | Set release description attribute (visible in the history) | string | null | no |
<a name="input_chart_repository"></a> chart_repository | Repository URL where to locate the requested chart | string | n/a | yes |
<a name="input_chart_values"></a> chart_values | Additional values to yamlencode as helm_release values | any | {} | no |
<a name="input_chart_version"></a> chart_version | Specify the exact chart version to install. If this is not specified, the latest version is installed | string | null | no |
<a name="input_cleanup_on_fail"></a> cleanup_on_fail | Allow deletion of new resources created in this upgrade when upgrade fails | bool | true | no |
<a name="input_context"></a> context | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as null to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional_tag_map, which are merged. | any | <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no |
<a name="input_crd_chart"></a> crd_chart | The name of the Karpenter CRD chart to be installed, if var.crd_chart_enabled is set to true . | string | "karpenter-crd" | no |
<a name="input_crd_chart_enabled"></a> crd_chart_enabled | karpenter-crd can be installed as an independent helm chart to manage the lifecycle of Karpenter CRDs. Set to true to install this CRD helm chart before the primary karpenter chart. | bool | false | no |
<a name="input_delimiter"></a> delimiter | Delimiter to be used between ID elements.<br>Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
<a name="input_descriptor_formats"></a> descriptor_formats | Describe additional descriptors to be output in the descriptors output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>{<br> format = string<br> labels = list(string)<br>} <br>(Type is any so the map values can later be enhanced to provide additional options.)<br>format is a Terraform format string to be passed to the format() function.<br>labels is a list of labels, in order, to pass to format() function.<br>Label values will be normalized before being passed to format() so they will be<br>identical to how they appear in id .<br>Default is {} (descriptors output will be empty). | any | {} | no |
<a name="input_eks_component_name"></a> eks_component_name | The name of the eks component | string | "eks/cluster" | no |
<a name="input_enabled"></a> enabled | Set to false to prevent the module from creating any resources | bool | null | no |
<a name="input_environment"></a> environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
<a name="input_helm_manifest_experiment_enabled"></a> helm_manifest_experiment_enabled | Enable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the plan | bool | false | no |
<a name="input_id_length_limit"></a> id_length_limit | Limit id to this many characters (minimum 6).<br>Set to 0 for unlimited length.<br>Set to null for keep the existing setting, which defaults to 0 .<br>Does not affect id_full . | number | null | no |
<a name="input_interruption_handler_enabled"></a> interruption_handler_enabled | If true , deploy a SQS queue and Event Bridge rules to enable interruption handling by Karpenter.<br> https://karpenter.sh/docs/concepts/disruption/#interruption | bool | true | no |
<a name="input_interruption_queue_message_retention"></a> interruption_queue_message_retention | The message retention in seconds for the interruption handler SQS queue. | number | 300 | no |
<a name="input_kube_data_auth_enabled"></a> kube_data_auth_enabled | If true , use an aws_eks_cluster_auth data source to authenticate to the EKS cluster.<br>Disabled by kubeconfig_file_enabled or kube_exec_auth_enabled . | bool | false | no |
<a name="input_kube_exec_auth_aws_profile"></a> kube_exec_auth_aws_profile | The AWS config profile for aws eks get-token to use | string | "" | no |
<a name="input_kube_exec_auth_aws_profile_enabled"></a> kube_exec_auth_aws_profile_enabled | If true , pass kube_exec_auth_aws_profile as the profile to aws eks get-token | bool | false | no |
<a name="input_kube_exec_auth_enabled"></a> kube_exec_auth_enabled | If true , use the Kubernetes provider exec feature to execute aws eks get-token to authenticate to the EKS cluster.<br>Disabled by kubeconfig_file_enabled , overrides kube_data_auth_enabled . | bool | true | no |
<a name="input_kube_exec_auth_role_arn"></a> kube_exec_auth_role_arn | The role ARN for aws eks get-token to use | string | "" | no |
<a name="input_kube_exec_auth_role_arn_enabled"></a> kube_exec_auth_role_arn_enabled | If true , pass kube_exec_auth_role_arn as the role ARN to aws eks get-token | bool | true | no |
<a name="input_kubeconfig_context"></a> kubeconfig_context | Context to choose from the Kubernetes config file.<br>If supplied, kubeconfig_context_format will be ignored. | string | "" | no |
<a name="input_kubeconfig_context_format"></a> kubeconfig_context_format | A format string to use for creating the kubectl context name when<br>kubeconfig_file_enabled is true and kubeconfig_context is not supplied.<br>Must include a single %s which will be replaced with the cluster name. | string | "" | no |
<a name="input_kubeconfig_exec_auth_api_version"></a> kubeconfig_exec_auth_api_version | The Kubernetes API version of the credentials returned by the exec auth plugin | string | "client.authentication.k8s.io/v1beta1" | no |
<a name="input_kubeconfig_file"></a> kubeconfig_file | The Kubernetes provider config_path setting to use when kubeconfig_file_enabled is true | string | "" | no |
<a name="input_kubeconfig_file_enabled"></a> kubeconfig_file_enabled | If true , configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS cluster | bool | false | no |
<a name="input_label_key_case"></a> label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the tags input.<br>Possible values: lower , title , upper .<br>Default value: title . | string | null | no |
<a name="input_label_order"></a> label_order | The order in which the labels (ID elements) appear in the id .<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
<a name="input_label_value_case"></a> label_value_case | Controls the letter case of ID elements (labels) as included in id ,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the tags input.<br>Possible values: lower , title , upper and none (no transformation).<br>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br>Default value: lower . | string | null | no |
<a name="input_labels_as_tags"></a> labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the tags output.<br>Set to [] to suppress all generated tags.<br>Notes:<br> The value of the name tag, if included, will be the id , not the name .<br> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored. | set(string) | <pre>[<br> "default"<br>]</pre> | no |
<a name="input_logging"></a> logging | A subset of the logging settings for the Karpenter controller | <pre>object({<br> enabled = optional(bool, true)<br> level = optional(object({<br> controller = optional(string, "info")<br> global = optional(string, "info")<br> webhook = optional(string, "error")<br> }), {})<br> })</pre> | {} | no |
<a name="input_name"></a> name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a tag .<br>The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
<a name="input_namespace"></a> namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
<a name="input_rbac_enabled"></a> rbac_enabled | Enable/disable RBAC | bool | true | no |
<a name="input_regex_replace_chars"></a> regex_replace_chars | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
<a name="input_region"></a> region | AWS Region | string | n/a | yes |
<a name="input_replicas"></a> replicas | The number of Karpenter controller replicas to run | number | 2 | no |
<a name="input_resources"></a> resources | The CPU and memory of the deployment's limits and requests | <pre>object({<br> limits = object({<br> cpu = string<br> memory = string<br> })<br> requests = object({<br> cpu = string<br> memory = string<br> })<br> })</pre> | n/a | yes |
<a name="input_settings"></a> settings | A subset of the settings for the Karpenter controller.<br>Some settings are implicitly set by this component, such as clusterName and<br>interruptionQueue . All settings can be overridden by providing a settings <br>section in the chart_values variable. The settings provided here are the ones<br>mostly likely to be set to other than default values, and are provided here for convenience. | <pre>object({<br> batch_idle_duration = optional(string, "1s")<br> batch_max_duration = optional(string, "10s")<br> })</pre> | {} | no |
<a name="input_stage"></a> stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
<a name="input_tags"></a> tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).<br>Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
<a name="input_tenant"></a> tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
<a name="input_timeout"></a> timeout | Time in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 seconds | number | null | no |
<a name="input_wait"></a> wait | Will wait until all resources are in a ready state before marking the release as successful. It will wait for as long as timeout . Defaults to true | bool | null | no |
Outputs
Name | Description |
---|---|
<a name="output_metadata"></a> metadata | Block status of the deployed release |
Related reading
- https://karpenter.sh
- https://aws.amazon.com/blogs/aws/introducing-karpenter-an-open-source-high-performance-kubernetes-cluster-autoscaler
- https://github.com/aws/karpenter
- https://ec2spotworkshops.com/karpenter.html
- https://www.eksworkshop.com/docs/autoscaling/compute/karpenter/
- https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html
- https://aws.amazon.com/premiumsupport/knowledge-center/fargate-troubleshoot-profile-creation
- https://learn.hashicorp.com/tutorials/terraform/kubernetes-crd-faas
- https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html
[!NOTE] This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
<details><summary><strong>Learn More</strong></summary>It's 100% Open Source and licensed under the APACHE2.
</details>
<a href="https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-karpenter-controller&utm_content=readme_header_link"><img src="https://cloudposse.com/readme/header/img"/></a>
Related Projects
Check out these related projects.
- Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
- Atmos - Atmos is like docker-compose but for your infrastructure
β¨ Contributing
This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:
<a href="https://github.com/cloudposse-terraform-components/aws-eks-karpenter-controller/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse-terraform-components/aws-eks-karpenter-controller&max=24" /> </a>π Bug Reports & Feature Requests
Please use the issue tracker to report any bugs or file feature requests.
π» Developing
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
Hit us up in Slack, in the #cloudposse
channel.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
π Slack Community
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
π° Newsletter
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β and usually a 5-minute read.
π Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-karpenter-controller&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you canβt find anywhere else. It's FREE for everyone!
About
This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-karpenter-controller&utm_content=">Cloud Posse, LLC</a>. <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-karpenter-controller&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>
We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-karpenter-controller&utm_content=commercial_support"><img alt="Learn More" src="https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge"/></a>
Your team can operate like a pro today.
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
<details> <summary>π <strong>See What's Included</strong></summary>- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
<a href="https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-karpenter-controller&utm_content=readme_commercial_support_link"><img src="https://cloudposse.com/readme/commercial-support/img"/></a>
License
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
</details>
Trademarks
All other trademarks referenced herein are the property of their respective owners.
Copyright Β© 2017-2024 Cloud Posse, LLC
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-eks-karpenter-controller&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-terraform-components/aws-eks-karpenter-controller?pixel&cs=github&cm=readme&an=aws-eks-karpenter-controller"/>