@aws-quickstart/eks-blueprints
    Preparing search index...

    Interface KarpenterV1AddOnProps

    Configuration options for the add-on

    interface KarpenterV1AddOnProps {
        chart?: string;
        crdRepository?: string;
        dependencyMode?: boolean;
        ec2NodeClassSpec?: Ec2NodeClassV1Spec;
        helmChartTimeout?: Duration;
        installCRDs?: boolean;
        interruptionHandling?: boolean;
        name?: string;
        namespace?: string;
        nodePoolSpec?: NodePoolV1Spec;
        podIdentity?: boolean;
        release?: string;
        repository?: string;
        skipVersionValidation?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    chart?: string

    Chart name

    crdRepository?: string

    Repository URL for the karpenter-crd Helm chart. Override this when mirroring charts to a private registry.

    "oci://public.ecr.aws/karpenter/karpenter-crd"
    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

    true
    ec2NodeClassSpec?: Ec2NodeClassV1Spec

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

    helmChartTimeout?: Duration

    Timeout duration while installing karpenter helm chart using addHelmChart API

    installCRDs?: boolean

    Flag for deploying the karpenter-crd Helm chart to manage CRD lifecycle. When true, the official karpenter-crd chart is deployed before the main karpenter chart, ensuring CRDs are updated on every upgrade — not just on initial install.

    true
    interruptionHandling?: boolean

    Flag for enabling Karpenter's native interruption handling

    name?: string

    Name of the helm chart (add-on)

    namespace?: string

    Namespace where helm release will be installed

    nodePoolSpec?: NodePoolV1Spec

    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.

    podIdentity?: boolean

    Use Pod Identity. To use EKS Pod Identities

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

    false
    release?: string

    Helm release

    repository?: string

    Helm repository

    skipVersionValidation?: boolean

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

    values?: Values

    Optional values for the helm chart.

    version?: string

    Helm chart version.

    Settings

    Member Visibility

    On This Page

    Properties