API Reference

Constructs

SuperEks

SuperEks wraps eks.Cluster to include batteries.

Initializers

import { SuperEks } from '@superluminar-io/super-eks'

new SuperEks(scope: Construct, id: string, props: SuperEksProps)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`props`	`SuperEksProps`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`props`^Required

Type: SuperEksProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`nodeTaintUserdata`	Generates `ec2.MultipartUserData` to attach to a `eks.Nodegroup` `ec2.LaunchTemplate` so that the Nodes are getting tainted with the given `NodeTaint`.

`toString`

public toString(): string

Returns a string representation of this construct.

`nodeTaintUserdata`

public nodeTaintUserdata(taint: NodeTaint): MultipartUserData

Generates ec2.MultipartUserData to attach to a eks.Nodegroup ec2.LaunchTemplate so that the Nodes are getting tainted with the given NodeTaint.

`taint`^Required

Type: NodeTaint

the taint that should be applied to the Nodes.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.

`isConstruct`

import { SuperEks } from '@superluminar-io/super-eks'

SuperEks.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`additionalNodegroups`	`aws-cdk-lib.aws_eks.Nodegroup[]`	`eks.Nodegroup`s added to the cluster.
`cluster`	`aws-cdk-lib.aws_eks.Cluster`	The created cluster.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`additionalNodegroups`^Required

public readonly additionalNodegroups: Nodegroup[];

Type: aws-cdk-lib.aws_eks.Nodegroup[]
Default: An internal eks.Nodegroup will be created for super-eks related workloads

eks.Nodegroups added to the cluster.

`cluster`^Required

public readonly cluster: Cluster;

Type: aws-cdk-lib.aws_eks.Cluster

The created cluster.

Structs

AddonProps

Specific properties for EKS managed add-ons.

Initializer

import { AddonProps } from '@superluminar-io/super-eks'

const addonProps: AddonProps = { ... }

Properties

Name	Type	Description
`vpcCniAddonVersion`	`VpcCniAddonVersion`	No description.

`vpcCniAddonVersion`^Optional

public readonly vpcCniAddonVersion: VpcCniAddonVersion;

Type: VpcCniAddonVersion

NodeTaint

Represents a Kubernetes taint.

See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/

Initializer

import { NodeTaint } from '@superluminar-io/super-eks'

const nodeTaint: NodeTaint = { ... }

Properties

Name	Type	Description
`effect`	`TaintEffect`	No description.
`key`	`string`	No description.
`value`	`string`	No description.

`effect`^Required

public readonly effect: TaintEffect;

Type: TaintEffect

`key`^Required

public readonly key: string;

Type: string

`value`^Required

public readonly value: string;

Type: string

SuperEksProps

Constructor properties for SuperEks.

Get merged with defaultSuperEksProps.

Initializer

import { SuperEksProps } from '@superluminar-io/super-eks'

const superEksProps: SuperEksProps = { ... }

Properties

Name	Type	Description
`hostedZone`	`aws-cdk-lib.aws_route53.IHostedZone`	A hosted zone for DNS management.
`addonProps`	`AddonProps`	Specific properties for EKS managed add-ons.
`adminRoles`	`aws-cdk-lib.aws_iam.IRole[]`	Additional Roles that should be granted cluster admin privileges.
`clusterProps`	`aws-cdk-lib.aws_eks.ClusterProps`	Wrapper for all cluster props>.
`superEksNodegroupProps`	`aws-cdk-lib.aws_eks.NodegroupOptions`	Config for the Nodegroup created to host SuperEks specific workloads.

`hostedZone`^Required

public readonly hostedZone: IHostedZone;

Type: aws-cdk-lib.aws_route53.IHostedZone

A hosted zone for DNS management.

Records in this zone will be created for your workloads by 'external-dns'.

`addonProps`^Optional

public readonly addonProps: AddonProps;

Type: AddonProps

Specific properties for EKS managed add-ons.

`adminRoles`^Optional

public readonly adminRoles: IRole[];

Type: aws-cdk-lib.aws_iam.IRole[]

Additional Roles that should be granted cluster admin privileges.

Can also be added manually after cluster creation by using cluster.awsAuth.addMastersRole(role).

`clusterProps`^Optional

public readonly clusterProps: ClusterProps;

Type: aws-cdk-lib.aws_eks.ClusterProps

Wrapper for all cluster props>.

`superEksNodegroupProps`^Optional

public readonly superEksNodegroupProps: NodegroupOptions;

Type: aws-cdk-lib.aws_eks.NodegroupOptions

Config for the Nodegroup created to host SuperEks specific workloads.

If you override the launchTemplateSpec you're responsible for adding the necessary userdata to taint the nodes, see ../config/cluster#nodeTaintUserdata

Classes

VpcCniAddonVersion

vpc-cni add-on versions.

Initializers

import { VpcCniAddonVersion } from '@superluminar-io/super-eks'

new VpcCniAddonVersion(version: string)

Name	Type	Description
`version`	`string`	add-on version.

`version`^Required

Type: string

add-on version.

Static Functions

Name	Description
`of`	Custom add-on version.

`of`

import { VpcCniAddonVersion } from '@superluminar-io/super-eks'

VpcCniAddonVersion.of(version: string)

Custom add-on version.

`version`^Required

Type: string

custom add-on version.

Properties

Name	Type	Description
`version`	`string`	add-on version.

`version`^Required

public readonly version: string;

Type: string

add-on version.

Constants

Name	Type	Description
`V1_6_3`	`VpcCniAddonVersion`	vpc-cni version 1.6.3.
`V1_7_5`	`VpcCniAddonVersion`	vpc-cni version 1.7.5.
`V1_7_6`	`VpcCniAddonVersion`	vpc-cni version 1.7.6.
`V1_7_9`	`VpcCniAddonVersion`	vpc-cni version 1.7.9.

`V1_6_3`^Required

public readonly V1_6_3: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.6.3.

`V1_7_5`^Required

public readonly V1_7_5: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.7.5.

`V1_7_6`^Required

public readonly V1_7_6: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.7.6.

`V1_7_9`^Required

public readonly V1_7_9: VpcCniAddonVersion;

Type: VpcCniAddonVersion

vpc-cni version 1.7.9.

Enums

TaintEffect

Represents a Kubernetes taint effect.

See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/

Members

Name	Description
`NO_SCHEDULE`	No description.
`PREFER_NO_SCHEDULE`	No description.
`NO_EXECUTE`	No description.

Files

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

Constructs

SuperEks

Initializers

scopeRequired

idRequired

propsRequired

Methods

toString

nodeTaintUserdata

taintRequired

Static Functions

isConstruct

xRequired

Properties

nodeRequired

additionalNodegroupsRequired

clusterRequired

Structs

AddonProps

Initializer

Properties

vpcCniAddonVersionOptional

NodeTaint

Initializer

Properties

effectRequired

keyRequired

valueRequired

SuperEksProps

Initializer

Properties

hostedZoneRequired

addonPropsOptional

adminRolesOptional

clusterPropsOptional

superEksNodegroupPropsOptional

Classes

VpcCniAddonVersion

Initializers

versionRequired

Static Functions

of

versionRequired

Properties

versionRequired

Constants

V1_6_3Required

V1_7_5Required

V1_7_6Required

V1_7_9Required

Enums

TaintEffect

Members

NO_SCHEDULE

PREFER_NO_SCHEDULE

NO_EXECUTE

`scope`^Required

`id`^Required

`props`^Required

`toString`

`nodeTaintUserdata`

`taint`^Required

`isConstruct`

`x`^Required

`node`^Required

`additionalNodegroups`^Required

`cluster`^Required

`vpcCniAddonVersion`^Optional

`effect`^Required

`key`^Required

`value`^Required

`hostedZone`^Required

`addonProps`^Optional

`adminRoles`^Optional

`clusterProps`^Optional

`superEksNodegroupProps`^Optional

`version`^Required

`of`

`version`^Required

`version`^Required

`V1_6_3`^Required

`V1_7_5`^Required

`V1_7_6`^Required

`V1_7_9`^Required

`NO_SCHEDULE`

`PREFER_NO_SCHEDULE`

`NO_EXECUTE`