Skip to content

Commit

Permalink
addressing PR + spellcheck on doc
Browse files Browse the repository at this point in the history
  • Loading branch information
youngjeong46 committed Jun 29, 2023
1 parent b32fc52 commit 8847e02
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/addons/karpenter.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ blueprints-addon-karpenter-54fd978b89-hclmp 2/2 Running 0 99m

**NOTE:**
1. The default provisioner is created only if both the subnet tags and the security group tags are provided.
2. Provisioner spec requirement fields are not necessary, as karpenter will dynamically choose (i.e. leaving instance-type blank will let karpenter choose approrpriate sizing).
3. Consolidation, which is a flag that enables , is supported on versions 0.15.0 and later. It is also mutually exclusive with `ttlSecondsAfterempty`, so if you provide both properties, the addon will throw an error.
2. Provisioner spec requirement fields are not necessary, as karpenter will dynamically choose (i.e. leaving instance-type blank will let karpenter choose appropriate sizing).
3. Consolidation, which is a flag that enables , is supported on versions 0.15.0 and later. It is also mutually exclusive with `ttlSecondsAfterEmpty`, so if you provide both properties, the addon will throw an error.
4. Weight, which is a property to prioritize provisioners based on weight, is supported on versions 0.16.0 and later. Addon will throw an error if weight is provided for earlier versions.
5. Interruption Handling, which is a native way to handle interruption due to involuntary interruption events, is supported on versions 0.19.0 and later. For interruption handling in the earlier versions, Karpenter supports using AWS Node Interruption Handler (which you will need to add as an add-on and ***must be in add-on array after the Karpenter add-on*** for it to work.

Expand Down
24 changes: 7 additions & 17 deletions lib/addons/karpenter/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as iam from 'aws-cdk-lib/aws-iam';
import { Construct } from "constructs";
import merge from 'ts-deepmerge';
import { ClusterInfo } from '../../spi';
import { ClusterInfo, Values } from '../../spi';
import { conflictsWith, createNamespace, createServiceAccount, setPath, } from '../../utils';
import { HelmAddOn, HelmAddOnProps, HelmAddOnUserProps } from '../helm-addon';
import { KarpenterControllerPolicy } from './iam';
Expand Down Expand Up @@ -37,21 +37,17 @@ interface KarpenterAddOnProps extends HelmAddOnUserProps {
key: string,
value: string,
effect: "NoSchedule" | "PreferNoSchedule" | "NoExecute",
},
}[],

/**
* Labels applied to all nodes
*/
labels?: {
[key: string]: string
},
labels?: Values,

/**
* Annotations applied to all nodes
*/
annotations?: {
[key: string]: string
}
annotations?: Values,

/**
* Requirement properties for a Provisioner (Optional) - If not provided, the add-on will
Expand All @@ -66,16 +62,12 @@ interface KarpenterAddOnProps extends HelmAddOnUserProps {
/**
* Tags needed for subnets - Subnet tags and security group tags are required for the provisioner to be created
*/
subnetTags?: {
[key: string]: string
}
subnetTags?: Values,

/**
* Tags needed for security groups - Subnet tags and security group tags are required for the provisioner to be created
*/
securityGroupTags?: {
[key: string]: string
}
securityGroupTags?: Values,

/**
* AMI Family: If provided, Karpenter will automatically query the appropriate EKS optimized AMI via AWS Systems Manager
Expand All @@ -85,9 +77,7 @@ interface KarpenterAddOnProps extends HelmAddOnUserProps {
/**
* AMI Selector
*/
amiSelector?: {
[key: string]: string
}
amiSelector?: Values,

/**
* Enables consolidation which attempts to reduce cluster cost by both removing un-needed nodes and down-sizing those that can't be removed.
Expand Down

0 comments on commit 8847e02

Please sign in to comment.