Documentation - v0.0.0
    Preparing search index...

    Interface ARCScaleSetProps

    interface ARCScaleSetProps {
        chart?: string;
        containerImages?: Partial<Record<ScaleSetContainer, string>>;
        createNamespace?: boolean;
        dependencyMode?: boolean;
        githubConfigSecret: string;
        githubConfigUrl: string;
        maxRunners?: number;
        minRunners?: number;
        name?: string;
        namespace?: string;
        release?: string;
        repository?: string;
        resources?: Pick<ContainerResources, "cpu" | "memory">;
        runnerGroup?: string;
        runnerScaleSetName?: string;
        skipVersionValidation?: boolean;
        useDindRunner?: boolean;
        values?: Values;
        version?: string;
    }

    Hierarchy

    • HelmAddOnUserProps
      • ARCScaleSetProps
    Index

    Properties

    chart? containerImages? createNamespace? dependencyMode? githubConfigSecret githubConfigUrl maxRunners? minRunners? name? namespace? release? repository? resources? runnerGroup? runnerScaleSetName? skipVersionValidation? useDindRunner? values? version?

    Properties

    chart?: string

    Chart name

    containerImages?: Partial<Record<ScaleSetContainer, string>>

    Image overrides for containers.

    createNamespace?: boolean

    Create namespace.

    true
    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
    githubConfigSecret: string

    Name of github config secret.

    githubConfigUrl: string

    URL where runners should be configured.

    https://github.com/myorg

    https://github.com/myorg/myrepo
    maxRunners?: number

    Maximum number of runners to scale up too.

    5
    minRunners?: number

    Minimum number of runners to scale down too.

    0
    name?: string

    Name of the helm chart (add-on)

    namespace?: string

    Namespace where helm release will be installed

    release?: string

    Helm release

    repository?: string

    Helm repository

    resources?: Pick<ContainerResources, "cpu" | "memory">

    Container resources.

    runnerGroup?: string

    Name of runner group.

    'default'
    runnerScaleSetName?: string

    Name of scale set.

    'arc-runner-set'
    skipVersionValidation?: boolean

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

    useDindRunner?: boolean

    User docker-in-docker runner image.

    values?: Values

    Optional values for the helm chart.

    version?: string

    Helm chart version.

    Settings

    Member Visibility

    On This Page

    Properties