Skip to content

Latest commit

 

History

History
340 lines (187 loc) · 8.38 KB

API.md

File metadata and controls

340 lines (187 loc) · 8.38 KB

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)
scopeRequired

idRequired
  • Type: string

propsRequired

Methods

nodeTaintUserdata
public nodeTaintUserdata(taint: NodeTaint)
taintRequired

the taint that should be applied to the Nodes.


Properties

additionalNodegroupsRequired
public readonly additionalNodegroups: Nodegroup[];

eks.Nodegroups added to the cluster.


clusterRequired
public readonly cluster: Cluster;

The created cluster.


Structs

AddonProps

Specific properties for EKS managed add-ons.

Initializer

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

const addonProps: AddonProps = { ... }
vpcCniAddonVersionOptional
public readonly vpcCniAddonVersion: 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 = { ... }
effectRequired
public readonly effect: TaintEffect;

keyRequired
public readonly key: string;
  • Type: string

valueRequired
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 = { ... }
hostedZoneRequired
public readonly hostedZone: IHostedZone;

A hosted zone for DNS management.

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


addonPropsOptional
public readonly addonProps: AddonProps;

Specific properties for EKS managed add-ons.


adminRolesOptional
public readonly adminRoles: IRole[];

Additional Roles that should be granted cluster admin privileges.

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


clusterPropsOptional
public readonly clusterProps: ClusterProps;

Wrapper for all cluster props>.


superEksNodegroupPropsOptional
public readonly superEksNodegroupProps: 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)
versionRequired
  • Type: string

add-on version.


Static Functions

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

VpcCniAddonVersion.of(version: string)
versionRequired
  • Type: string

custom add-on version.


Properties

versionRequired
public readonly version: string;
  • Type: string

add-on version.


Constants

V1_6_3

vpc-cni version 1.6.3.


V1_7_5

vpc-cni version 1.7.5.


V1_7_6

vpc-cni version 1.7.6.


V1_7_9

vpc-cni version 1.7.9.


Enums

TaintEffect

Represents a Kubernetes taint effect.

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

NO_SCHEDULE


PREFER_NO_SCHEDULE


NO_EXECUTE