Skip to main content

A sample JSII construct lib for AWS CDK

Project description

awscdk-jsii-template NPM version PyPI version Release

cdk-eks-spotblocks

cdk-eks-spotblocks is a JSII construct library for AWS CDK to provison Amazon EKS cluster with EC2 Spot Blocks for defined workloads with the advantages of ensured availability and considerable price reduction for your kubernetes workload.

Features

  • support the upstream AWS CDK aws-eks construct libraries by extending its capabilities
  • addSpotFleet() to create your spot fleet for your cluster
  • define your blockDuration, validFrom and validUntil for fine-graned control
  • support any AWS commercial regions which has Amazon EKS and EC2 Spot Block support, including AWS China regions

Sample

import * as eksspot from 'eks-spot-blocks';
import * as cdk from '@aws-cdk/core';
import * as ec2 from '@aws-cdk/aws-ec2';

const clusterStack = new eksspot.EksSpotCluster(stack, 'Cluster', {
  clusterVersion: eks.KubernetesVersion.V1_16,
});

clusterStack.addSpotFleet('FirstFleet', {
  blockDuration: eksspot.BlockDuration.SIX_HOURS,
  targetCapacity: 1,
  defaultInstanceType: new ec2.InstanceType('p3.2xlarge'),
  validUntil: clusterStack.addHours(new Date(), 6).toISOString(),
  terminateInstancesWithExpiration: true
})

clusterStack.addSpotFleet('SecondFleet', {
  blockDuration: eksspot.BlockDuration.ONE_HOUR,
  targetCapacity: 2,
  defaultInstanceType: new ec2.InstanceType('c5.large'),
  validUntil: clusterStack.addHours(new Date(), 1).toISOString(),
  terminateInstancesWithExpiration: true
})

check eks-spot-blocks-demo for a full AWS CDK demo with this construct library.

Custom AMI support

const clusterStack = new EksSpotCluster(stack, 'Cluster', {
  clusterVersion: eks.KubernetesVersion.V1_16,
  customAmiId: 'ami-xxxxxx'
});

FAQ

Does eks-spot-blocks support existing eks clusters created by eksctl, terraform or any other tools?

No. This construct library does not support existing Amazon EKS clusters. You have to create the cluster as well as the spot fleet altogether in this construct library.

Can I write the CDK in other languages like Python and Java?

Not at this moment. But we plan to publish this construct with JSII so we can install this library via npm, pypi, maven or nuget.

How much time can I block the spotfleet?

You can block the fleet with hourly increments up to 6 hours.

What happens after the blockDuration?

Spot Blocks ensure the availability of your spot instances during the blockDuration and avoid termination during the price disruption. After the blockDuration, by default, your spot instances will still be in running state but it doesn't ensure the availability, which means it might be terminated anytime after the blockDuration.

Can I terminate the fleet immediately after the blockDuration to save the money?

Yes. Basically you can configure validFrom, validUntil and terminateInstancesWithExpiration to achieve this.

However, consider the following scenario

<deploy start at 1:00>|--------(one hour)-----------------------|<2:00>
                           |<fleet created at 1:05>--------(one-hour block)-------|<2:05>

Your fleet will be terminated at 2:00 rather at 2:05.

Are tains and labels supported?

Yes.

(samples TBD)

Does it support AWS China regions?

Yes. Including Beijing(cn-north-1) and Ningxia(cn-northwest-1).

How much can I save from the EC2 Spot Block compared to the on-demand?

According to this document

Spot Instances are also available to run for a predefined duration – in hourly increments up to six hours in length – at a discount of up to 30-50% compared to On-Demand pricing.

Will this library become part of the upstream aws-eks construct library?

Probably. As it's still in the preliminary stage, we are still collecting feedbacks from the community to make eks-spot-blocks ready for production workloads. Eventually we will commit this feature to the upstream aws-eks construct library in AWS CDK through pull requests.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eks-spot-blocks-0.2.373.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eks_spot_blocks-0.2.373-py3-none-any.whl (50.8 kB view details)

Uploaded Python 3

File details

Details for the file eks-spot-blocks-0.2.373.tar.gz.

File metadata

  • Download URL: eks-spot-blocks-0.2.373.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.6.4 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.7.10

File hashes

Hashes for eks-spot-blocks-0.2.373.tar.gz
Algorithm Hash digest
SHA256 a5cd7a821c177a1ed5a3a4d34ba27c8637d7f3d8b3eda372192c847bb8566f8d
MD5 ae3cdf925b437b3925649a7d55eee267
BLAKE2b-256 2b6dd2ac92036da916a206c91bf8f3926eb14db4f1af74c400f11842257f1d81

See more details on using hashes here.

File details

Details for the file eks_spot_blocks-0.2.373-py3-none-any.whl.

File metadata

  • Download URL: eks_spot_blocks-0.2.373-py3-none-any.whl
  • Upload date:
  • Size: 50.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.6.4 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.7.10

File hashes

Hashes for eks_spot_blocks-0.2.373-py3-none-any.whl
Algorithm Hash digest
SHA256 1ce1f4e1d19e76b3459508a12f2818a3f49b8938c05360dfe482cf469afccac6
MD5 67e50abbf8e5e5ad77aef6f1e3d2589b
BLAKE2b-256 de2ad91292b8912868fd8315f9f1f4c1b592fa87e9a882af2da0d057c2e33511

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page