Class ARCScaleSet

Hierarchy

HelmAddOn
- ARCScaleSet

Index

Constructors

constructor

new ARCScaleSet(props?: ARCScaleSetProps): ARCScaleSet
Parameters
- Optionalprops: ARCScaleSetProps
Returns ARCScaleSet
Overrides blueprints.HelmAddOn.constructor
- Defined in packages/stacks/api/src/addons/arc.ts:176

Properties

`Readonly`options

options: ARCScaleSetProps

props

props: HelmChartConfiguration

`Static`failOnVersionValidation

failOnVersionValidation: boolean

`Static`validateHelmVersions

validateHelmVersions: boolean

Accessors

`Protected`containerResources

get containerResources(): {
    dind: {
        limits: { cpu: string; memory: string };
        requests: { cpu: string; memory: string };
    };
    runner: {
        limits: { cpu: string; memory: string };
        requests: { cpu: string; memory: string };
    };
}
Returns {
    dind: {
        limits: { cpu: string; memory: string };
        requests: { cpu: string; memory: string };
    };
    runner: {
        limits: { cpu: string; memory: string };
        requests: { cpu: string; memory: string };
    };
}
- Defined in packages/stacks/api/src/addons/arc.ts:374

`Protected`templateVolumeMounts

get templateVolumeMounts(): {
    [k: string]: | { mountPath: string; name: string; subPathExpr: string }
    | { mountPath: string; name: string; subPathExpr: string }
    | { mountPath: string; name: string }
    | { mountPath: string; name: string; subPathExpr: string }
    | { mountPath: string; name: string; subPathExpr: string }
    | { mountPath: string; name: string; subPathExpr: string };
}
Returns {
    [k: string]:
        | { mountPath: string; name: string; subPathExpr: string }
        | { mountPath: string; name: string; subPathExpr: string }
        | { mountPath: string; name: string }
        | { mountPath: string; name: string; subPathExpr: string }
        | { mountPath: string; name: string; subPathExpr: string }
        | { mountPath: string; name: string; subPathExpr: string };
}
- Defined in packages/stacks/api/src/addons/arc.ts:553

`Protected`templateVolumes

get templateVolumes(): {
    [k: string]: | {
        ephemeral: {
            volumeClaimTemplate: {
                spec: {
                    accessModes: string[];
                    resources: { requests: { storage: string } };
                    storageClassName: string;
                };
            };
        };
        name: string;
    }
    | { emptyDir: {}; name: string }
    | {
        ephemeral: {
            volumeClaimTemplate: {
                spec: {
                    accessModes: string[];
                    resources: { requests: { storage: string } };
                    storageClassName: string;
                };
            };
        };
        name: string;
    }
    | { emptyDir: { medium: string }; name: string }
    | { emptyDir: { medium: string }; name: string }
    | { emptyDir: {}; name: string };
}
Returns {
    [k: string]:
        | {
            ephemeral: {
                volumeClaimTemplate: {
                    spec: {
                        accessModes: string[];
                        resources: { requests: { storage: string } };
                        storageClassName: string;
                    };
                };
            };
            name: string;
        }
        | { emptyDir: {}; name: string }
        | {
            ephemeral: {
                volumeClaimTemplate: {
                    spec: {
                        accessModes: string[];
                        resources: { requests: { storage: string } };
                        storageClassName: string;
                    };
                };
            };
            name: string;
        }
        | { emptyDir: { medium: string }; name: string }
        | { emptyDir: { medium: string }; name: string }
        | { emptyDir: {}; name: string };
}
- Defined in packages/stacks/api/src/addons/arc.ts:513

Methods

`Protected`addHelmChart

addHelmChart(
    clusterInfo: ClusterInfo,
    values?: Values,
    createNamespace?: boolean,
    wait?: boolean,
    timeout?: Duration,
): Construct
Deploys the helm chart in the cluster.
Parameters
- clusterInfo: ClusterInfo
- Optionalvalues: Values
- OptionalcreateNamespace: boolean
- Optionalwait: boolean
- Optionaltimeout: Duration
Returns Construct
Inherited from blueprints.HelmAddOn.addHelmChart
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/addons/helm-addon/index.d.ts:61

`Protected`createDindContainerSpec

createDindContainerSpec(): {
    spec: {
        containers: {
            env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
            image: string;
            imagePullPolicy: string;
            name: ScaleSetContainer;
            resources: {
                limits: { cpu: string; memory: string };
                requests: { cpu: string; memory: string };
            };
            securityContext: { privileged: boolean };
            volumeMounts: { mountPath: string; name: string }[];
        }[];
        initContainers: {
            command: string[];
            env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
            image: string;
            imagePullPolicy: string;
            name: ScaleSetContainer;
            volumeMounts: { mountPath: string; name: string }[];
        }[];
    };
}
Protected
Create the template spec for dind container.

Returns {
    spec: {
        containers: {
            env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
            image: string;
            imagePullPolicy: string;
            name: ScaleSetContainer;
            resources: {
                limits: { cpu: string; memory: string };
                requests: { cpu: string; memory: string };
            };
            securityContext: { privileged: boolean };
            volumeMounts: { mountPath: string; name: string }[];
        }[];
        initContainers: {
            command: string[];
            env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
            image: string;
            imagePullPolicy: string;
            name: ScaleSetContainer;
            volumeMounts: { mountPath: string; name: string }[];
        }[];
    };
}
- Defined in packages/stacks/api/src/addons/arc.ts:299

`Protected`createRunnerContainerSpec

createRunnerContainerSpec(): {
    spec: {
        containers: {
            command: string[];
            env: Record<string, unknown>[];
            image: string;
            imagePullPolicy: string;
            name: ScaleSetContainer;
            resources: {
                limits: { cpu: string; memory: string };
                requests: { cpu: string; memory: string };
            };
            volumeMounts: { mountPath: string; name: string }[];
        }[];
        initContainers: {
            command: string[];
            env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
            image: string;
            imagePullPolicy: string;
            name: ScaleSetContainer;
            volumeMounts: { mountPath: string; name: string }[];
        }[];
    };
}
Protected
Create the template spec for runner container.

Returns {
    spec: {
        containers: {
            command: string[];
            env: Record<string, unknown>[];
            image: string;
            imagePullPolicy: string;
            name: ScaleSetContainer;
            resources: {
                limits: { cpu: string; memory: string };
                requests: { cpu: string; memory: string };
            };
            volumeMounts: { mountPath: string; name: string }[];
        }[];
        initContainers: {
            command: string[];
            env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
            image: string;
            imagePullPolicy: string;
            name: ScaleSetContainer;
            volumeMounts: { mountPath: string; name: string }[];
        }[];
    };
}
- Defined in packages/stacks/api/src/addons/arc.ts:403

`Protected`createStorageClassTemplate

createStorageClassTemplate(
    options: { name: string; reclaimPolicy: "Delete" | "Retain" },
): {
    allowVolumeExpansion: boolean;
    apiVersion: string;
    kind: string;
    metadata: { name: string };
    parameters: { type: string };
    provisioner: string;
    reclaimPolicy: "Delete" | "Retain";
    volumeBindingMode: string;
}
Protected
Create the template spec for storage class.
Parameters
- options: { name: string; reclaimPolicy: "Delete" | "Retain" }
Returns {
    allowVolumeExpansion: boolean;
    apiVersion: string;
    kind: string;
    metadata: { name: string };
    parameters: { type: string };
    provisioner: string;
    reclaimPolicy: "Delete" | "Retain";
    volumeBindingMode: string;
}
- Defined in packages/stacks/api/src/addons/arc.ts:251

`Protected`createTemplate

createTemplate(): {
    metadata: { annotations: { "karpenter.sh/do-not-evict": string } };
    spec: Omit<
        {
            volumes: (
                | {
                    ephemeral: {
                        volumeClaimTemplate: {
                            spec: {
                                accessModes: (...)[];
                                resources: { requests: ... };
                                storageClassName: string;
                            };
                        };
                    };
                    name: string;
                }
                | { emptyDir: {}; name: string }
                | {
                    ephemeral: {
                        volumeClaimTemplate: {
                            spec: {
                                accessModes: (...)[];
                                resources: { requests: ... };
                                storageClassName: string;
                            };
                        };
                    };
                    name: string;
                }
                | { emptyDir: { medium: string }; name: string }
                | { emptyDir: { medium: string }; name: string }
                | { emptyDir: {}; name: string }
            )[];
        },
        never,
    > & Omit<
        {
            containers: {
                command: string[];
                env: Record<string, unknown>[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                resources: {
                    limits: { cpu: string; memory: string };
                    requests: { cpu: string; memory: string };
                };
                volumeMounts: { mountPath: string; name: string }[];
            }[];
            initContainers: {
                command: string[];
                env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                volumeMounts: { mountPath: string; name: string }[];
            }[];
        },
        never,
    > & {};
}
Protected
Create template helm value for runners.

Returns {
    metadata: { annotations: { "karpenter.sh/do-not-evict": string } };
    spec: Omit<
        {
            volumes: (
                | {
                    ephemeral: {
                        volumeClaimTemplate: {
                            spec: {
                                accessModes: (...)[];
                                resources: { requests: ... };
                                storageClassName: string;
                            };
                        };
                    };
                    name: string;
                }
                | { emptyDir: {}; name: string }
                | {
                    ephemeral: {
                        volumeClaimTemplate: {
                            spec: {
                                accessModes: (...)[];
                                resources: { requests: ... };
                                storageClassName: string;
                            };
                        };
                    };
                    name: string;
                }
                | { emptyDir: { medium: string }; name: string }
                | { emptyDir: { medium: string }; name: string }
                | { emptyDir: {}; name: string }
            )[];
        },
        never,
    > & Omit<
        {
            containers: {
                command: string[];
                env: Record<string, unknown>[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                resources: {
                    limits: { cpu: string; memory: string };
                    requests: { cpu: string; memory: string };
                };
                volumeMounts: { mountPath: string; name: string }[];
            }[];
            initContainers: {
                command: string[];
                env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                volumeMounts: { mountPath: string; name: string }[];
            }[];
        },
        never,
    > & {};
}
- Defined in packages/stacks/api/src/addons/arc.ts:607

`Protected`createTemplateSpec

createTemplateSpec(): Omit<
    Omit<{}, never> & Omit<
        {
            spec: {
                volumes: (
                    | {
                        ephemeral: { volumeClaimTemplate: { spec: ... } };
                        name: string;
                    }
                    | { emptyDir: {}; name: string }
                    | { ephemeral: { volumeClaimTemplate: { spec: ... } }; name: string }
                    | { emptyDir: { medium: string }; name: string }
                    | { emptyDir: { medium: string }; name: string }
                    | { emptyDir: {}; name: string }
                )[];
            };
        },
        never,
    > & {},
    "spec",
> & Omit<
    {
        spec: {
            containers: {
                command: string[];
                env: Record<string, unknown>[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                resources: {
                    limits: { cpu: string; memory: string };
                    requests: { cpu: string; memory: string };
                };
                volumeMounts: { mountPath: string; name: string }[];
            }[];
            initContainers: {
                command: string[];
                env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                volumeMounts: { mountPath: string; name: string }[];
            }[];
        };
    },
    "spec",
> & {
    spec: Omit<
        {
            volumes: (
                | {
                    ephemeral: {
                        volumeClaimTemplate: {
                            spec: { accessModes: ...; resources: ...; storageClassName: ... };
                        };
                    };
                    name: string;
                }
                | { emptyDir: {}; name: string }
                | {
                    ephemeral: {
                        volumeClaimTemplate: {
                            spec: { accessModes: ...; resources: ...; storageClassName: ... };
                        };
                    };
                    name: string;
                }
                | { emptyDir: { medium: string }; name: string }
                | { emptyDir: { medium: string }; name: string }
                | { emptyDir: {}; name: string }
            )[];
        },
        never,
    > & Omit<
        {
            containers: {
                command: string[];
                env: Record<string, unknown>[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                resources: {
                    limits: { cpu: string; memory: string };
                    requests: { cpu: string; memory: string };
                };
                volumeMounts: { mountPath: string; name: string }[];
            }[];
            initContainers: {
                command: string[];
                env: { name: string; valueFrom: { fieldRef: { fieldPath: ... } } }[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                volumeMounts: { mountPath: string; name: string }[];
            }[];
        },
        never,
    > & {};
}
Protected
Create the template spec for ephemeral runners.

Returns Omit<
    Omit<{}, never> & Omit<
        {
            spec: {
                volumes: (
                    | {
                        ephemeral: { volumeClaimTemplate: { spec: ... } };
                        name: string;
                    }
                    | { emptyDir: {}; name: string }
                    | { ephemeral: { volumeClaimTemplate: { spec: ... } }; name: string }
                    | { emptyDir: { medium: string }; name: string }
                    | { emptyDir: { medium: string }; name: string }
                    | { emptyDir: {}; name: string }
                )[];
            };
        },
        never,
    > & {},
    "spec",
> & Omit<
    {
        spec: {
            containers: {
                command: string[];
                env: Record<string, unknown>[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                resources: {
                    limits: { cpu: string; memory: string };
                    requests: { cpu: string; memory: string };
                };
                volumeMounts: { mountPath: string; name: string }[];
            }[];
            initContainers: {
                command: string[];
                env: { name: string; valueFrom: { fieldRef: { fieldPath: string } } }[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                volumeMounts: { mountPath: string; name: string }[];
            }[];
        };
    },
    "spec",
> & {
    spec: Omit<
        {
            volumes: (
                | {
                    ephemeral: {
                        volumeClaimTemplate: {
                            spec: { accessModes: ...; resources: ...; storageClassName: ... };
                        };
                    };
                    name: string;
                }
                | { emptyDir: {}; name: string }
                | {
                    ephemeral: {
                        volumeClaimTemplate: {
                            spec: { accessModes: ...; resources: ...; storageClassName: ... };
                        };
                    };
                    name: string;
                }
                | { emptyDir: { medium: string }; name: string }
                | { emptyDir: { medium: string }; name: string }
                | { emptyDir: {}; name: string }
            )[];
        },
        never,
    > & Omit<
        {
            containers: {
                command: string[];
                env: Record<string, unknown>[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                resources: {
                    limits: { cpu: string; memory: string };
                    requests: { cpu: string; memory: string };
                };
                volumeMounts: { mountPath: string; name: string }[];
            }[];
            initContainers: {
                command: string[];
                env: { name: string; valueFrom: { fieldRef: { fieldPath: ... } } }[];
                image: string;
                imagePullPolicy: string;
                name: ScaleSetContainer;
                volumeMounts: { mountPath: string; name: string }[];
            }[];
        },
        never,
    > & {};
}
- Defined in packages/stacks/api/src/addons/arc.ts:588

`Protected`createVolumeClaimTemplate

createVolumeClaimTemplate(
    storageRequest: string,
    storageClassName: string,
): {
    spec: {
        accessModes: string[];
        resources: { requests: { storage: string } };
        storageClassName: string;
    };
}
Protected
Create the template spec for volume claim.
Parameters
- storageRequest: string
  Request amount and unit.
- storageClassName: string
  Storage class name.
Returns {
    spec: {
        accessModes: string[];
        resources: { requests: { storage: string } };
        storageClassName: string;
    };
}
- Defined in packages/stacks/api/src/addons/arc.ts:278

deploy

deploy(clusterInfo: ClusterInfo): Promise<Construct>
Expected to be implemented in concrete subclasses.
Parameters
- clusterInfo: ClusterInfo
Returns Promise<Construct>
Overrides blueprints.HelmAddOn.deploy
- Defined in packages/stacks/api/src/addons/arc.ts:192

`Static`validateVersion

validateVersion(helmChart: HelmChartVersion): void
Parameters
- helmChart: HelmChartVersion
Returns void
Inherited from blueprints.HelmAddOn.validateVersion
- Defined in node_modules/.pnpm/@aws-quickstart+eks-blueprints@1.17.1_aws-cdk-lib@2.192.0_constructs@10.4.2__aws-cdk@2.1020.2/node_modules/@aws-quickstart/eks-blueprints/dist/addons/helm-addon/index.d.ts:46

Class ARCScaleSet

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ARCScaleSet

Properties

Readonlyoptions

props

StaticfailOnVersionValidation

StaticvalidateHelmVersions

Accessors

ProtectedcontainerResources

Returns { dind: { limits: { cpu: string; memory: string }; requests: { cpu: string; memory: string }; }; runner: { limits: { cpu: string; memory: string }; requests: { cpu: string; memory: string }; };}

ProtectedtemplateVolumeMounts

ProtectedtemplateVolumes

Methods

ProtectedaddHelmChart

Parameters

Returns Construct

ProtectedcreateDindContainerSpec

ProtectedcreateRunnerContainerSpec

ProtectedcreateStorageClassTemplate

Parameters

Returns { allowVolumeExpansion: boolean; apiVersion: string; kind: string; metadata: { name: string }; parameters: { type: string }; provisioner: string; reclaimPolicy: "Delete" | "Retain"; volumeBindingMode: string;}

ProtectedcreateTemplate

ProtectedcreateTemplateSpec

ProtectedcreateVolumeClaimTemplate

Parameters

Returns { spec: { accessModes: string[]; resources: { requests: { storage: string } }; storageClassName: string; };}

deploy

Parameters

Returns Promise<Construct>

StaticvalidateVersion

Parameters

Returns void

Settings

On This Page

`Readonly`options

`Static`failOnVersionValidation

`Static`validateHelmVersions

`Protected`containerResources

Returns {
dind: {
limits: { cpu: string; memory: string };
requests: { cpu: string; memory: string };
};
runner: {
limits: { cpu: string; memory: string };
requests: { cpu: string; memory: string };
};
}

`Protected`templateVolumeMounts

`Protected`templateVolumes

`Protected`addHelmChart

`Protected`createDindContainerSpec

`Protected`createRunnerContainerSpec

`Protected`createStorageClassTemplate

Returns {
allowVolumeExpansion: boolean;
apiVersion: string;
kind: string;
metadata: { name: string };
parameters: { type: string };
provisioner: string;
reclaimPolicy: "Delete" | "Retain";
volumeBindingMode: string;
}

`Protected`createTemplate

`Protected`createTemplateSpec

`Protected`createVolumeClaimTemplate

Returns {
spec: {
accessModes: string[];
resources: { requests: { storage: string } };
storageClassName: string;
};
}

`Static`validateVersion