Interface KarpenterAddOnProps

Configuration options for the add-on

interface KarpenterAddOnProps {
    chart?: string;
    dependencyMode?: boolean;
    ec2NodeClassSpec?: Ec2NodeClassSpec;
    helmChartTimeout?: Duration;
    installCRDs?: boolean;
    interruptionHandling?: boolean;
    name?: string;
    namespace?: string;
    nodePoolSpec?: NodePoolSpec;
    podIdentity?: boolean;
    release?: string;
    repository?: string;
    skipVersionValidation?: boolean;
    values?: Values;
    version?: string;
}

Hierarchy (view full)

Properties

chart? dependencyMode? ec2NodeClassSpec? helmChartTimeout? installCRDs? interruptionHandling? name? namespace? nodePoolSpec? podIdentity? release? repository? skipVersionValidation? values? version?

Properties

Optionalchart

chart?: string

Chart name

OptionaldependencyMode

dependencyMode?: boolean

Indicate the helm chart provided uses dependency mode (https://helm.sh/docs/helm/helm_dependency/). Dependency mode is widely used in aws-samples/eks-blueprints-add-ons repository, for example: https://github.com/aws-samples/eks-blueprints-add-ons/blob/main/add-ons/appmesh-controller/Chart.yaml Dependency mode requires the chart values to be wrapped within the chart name. This value is only used to turn off dependency mode in case customers choose to copy the whole helm chart into their repo

Default

true

Optionalec2NodeClassSpec

ec2NodeClassSpec?: Ec2NodeClassSpec

This is the top level spec for the AWS Karpenter Provider It contains configuration necessary to launch instances in AWS.

OptionalhelmChartTimeout

helmChartTimeout?: Duration

Timeout duration while installing karpenter helm chart using addHelmChart API

OptionalinstallCRDs

installCRDs?: boolean

OptionalinterruptionHandling

interruptionHandling?: boolean

Flag for enabling Karpenter's native interruption handling

Optionalname

name?: string

Name of the helm chart (add-on)

Optionalnamespace

namespace?: string

Namespace where helm release will be installed

OptionalnodePoolSpec

nodePoolSpec?: NodePoolSpec

This is the top level nodepool specification. Nodepools launch nodes in response to pods that are unschedulable. A single nodepool is capable of managing a diverse set of nodes. Node properties are determined from a combination of nodepool and pod scheduling constraints.

OptionalpodIdentity

podIdentity?: boolean

Use Pod Identity. To use EKS Pod Identities

See

https://docs.aws.amazon.com/eks/latest/userguide/pod-identity.html

Default

false

Optionalrelease

release?: string

Helm release

Optionalrepository

repository?: string

Helm repository

OptionalskipVersionValidation

skipVersionValidation?: boolean

When global helm version validation is enabled with HelmAddOn.validateHelmVersions = true allows to skip validation for a particular helm add-on.

Optionalvalues

values?: Values

Optional values for the helm chart.

Optionalversion

version?: string

Helm chart version.

Settings

Member Visibility

On This Page

Properties