aws-eks-cluster

Elastic Kubernetes Service is an open source container orchestration platform that automates many of the manual processes involved in deploying, managing, and scaling containerized applications.

---

Design

For detailed information, check out our Operator Guide for this bundle.

Usage

Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the Massdriver platform.

What are Bundles?

Bundles are the basic building blocks of infrastructure, applications, and architectures in Massdriver. Read more here.

Bundle

Params

Form input parameters for configuring a bundle for deployment.

View

Properties

• core_services (object): Configure core services in Kubernetes for Massdriver to manage.

  • enable_efs_csi (boolean): Enabling this will install the AWS EFS storage controller into your cluster, allowing you to provision persistent volumes backed by EFS file systems. Default: False.
  • enable_ingress (boolean): Enabling this will create an nginx ingress controller in the cluster, allowing internet traffic to flow into web accessible services within the cluster. Default: False.
  • route53_hosted_zones (array): Route53 Hosted Zones to associate with this cluster. Enables Kubernetes to automatically manage DNS records and SSL certificates. Hosted Zones can be configured at https://app.massdriver.cloud/dns-zones. Default: [].

    • Items (string): .

      Examples:

      "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

      "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

• fargate (object): AWS Fargate provides on-demand, right-sized compute capacity for running containers on EKS without managing node pools or clusters of EC2 instances.

  • enabled (boolean): Enables EKS Fargate. Default: False.

• k8s_version (string): The version of Kubernetes to run. WARNING: Upgrading Kubernetes version must be done one minor version at a time. For example, upgrading from 1.28 to 1.30 requires upgrading to 1.29 first. Must be one of: ['1.22', '1.23', '1.24', '1.25', '1.26', '1.27', '1.28', '1.29', '1.30']. Default: 1.30.

• monitoring (object)

  • control_plane_log_retention (integer): Duration to retain control plane logs in AWS Cloudwatch (Note: control plane logs do not contain application or container logs). Default: 7.
    • One of
      • 7 days
      • 30 days
      • 90 days
      • 180 days
      • 1 year
      • Never expire
  • prometheus (object): Configuration settings for the Prometheus instances that are automatically installed into the cluster to provide monitoring capabilities".
    • grafana_enabled (boolean): Install Grafana into the cluster to provide a metric visualizer. Default: False.
    • persistence_enabled (boolean): This setting will enable persistence of Prometheus data via EBS volumes. However, in small clusters (less than 5 nodes) this can create problems of pod scheduling and placement due EBS volumes being zonally-locked, and thus should be disabled. Default: True.

• node_groups (array): Node groups to provision.

  • Items (object): Definition of a node group.
    • advanced_configuration_enabled (boolean): Default: False.
    • instance_type (string): Instance type to use in the node group.
      • One of
        • C5 High-CPU Large (2 vCPUs, 4.0 GiB)
        • C5 High-CPU XL (4 vCPUs, 8.0 GiB)
        • C5 High-CPU 2XL (8 vCPUs, 16.0 GiB)
        • C5 High-CPU 4XL (16 vCPUs, 32.0 GiB)
        • C5 High-CPU 9XL (36 vCPUs, 72.0 GiB)
        • C5 High-CPU 12XL (48 vCPUs, 96.0 GiB)
        • C5 High-CPU 18XL (72 vCPUs, 144.0 GiB)
        • C5 High-CPU 24XL (96 vCPUs, 192.0 GiB)
        • M5 General Purpose Large (2 vCPUs, 8.0 GiB)
        • M5 General Purpose XL (4 vCPUs, 16.0 GiB)
        • M5 General Purpose 2XL (8 vCPUs, 32.0 GiB)
        • M5 General Purpose 4XL (16 vCPUs, 64.0 GiB)
        • M5 General Purpose 8XL (32 vCPUs, 128.0 GiB)
        • M5 General Purpose 12XL (48 vCPUs, 192.0 GiB)
        • M5 General Purpose 16XL (64 vCPUs, 256.0 GiB)
        • M5 General Purpose 24XL (96 vCPUs, 384.0 GiB)
        • T3 Small (2 vCPUs for a 4h 48m burst, 2.0 GiB)
        • T3 Medium (2 vCPUs for a 4h 48m burst, 4.0 GiB)
        • T3 Large (2 vCPUs for a 7h 12m burst, 8.0 GiB)
        • T3 XL (4 vCPUs for a 9h 36m burst, 16.0 GiB)
        • T3 2XL (8 vCPUs for a 9h 36m burst, 32.0 GiB)
    • max_size (integer): Maximum number of instances in the node group. Minimum: 0. Default: 10.
    • min_size (integer): Minimum number of instances in the node group. Minimum: 0. Default: 1.
    • name_suffix (string): The name of the node group. Default: ``.

Examples

{
    "__name": "Wizard",
    "core_services": {
        "enable_efs_csi": false,
        "enable_ingress": true,
        "route53_hosted_zones": []
    },
    "fargate": {
        "enabled": false
    },
    "k8s_version": "1.30",
    "monitoring": {
        "control_plane_log_retention": 7,
        "prometheus": {
            "grafana_enabled": false,
            "persistence_enabled": false
        }
    },
    "node_groups": [
        {
            "advanced_configuration_enabled": false,
            "instance_type": "t3.medium",
            "max_size": 10,
            "min_size": 1,
            "name_suffix": "shared"
        }
    ]
}

{
    "__name": "Development",
    "k8s_version": "1.30",
    "monitoring": {
        "control_plane_log_retention": 7,
        "prometheus": {
            "grafana_enabled": false,
            "persistence_enabled": false
        }
    },
    "node_groups": [
        {
            "instance_type": "t3.medium",
            "max_size": 10,
            "min_size": 1,
            "name_suffix": "shared"
        }
    ]
}

{
    "__name": "Production",
    "k8s_version": "1.30",
    "monitoring": {
        "control_plane_log_retention": 365,
        "prometheus": {
            "grafana_enabled": false,
            "persistence_enabled": true
        }
    },
    "node_groups": [
        {
            "instance_type": "c5.2xlarge",
            "max_size": 10,
            "min_size": 1,
            "name_suffix": "shared"
        }
    ]
}

Connections

Connections from other bundles that this bundle depends on.

View

Properties

• aws_authentication (object): . Cannot contain additional properties.

  • data (object)

    • arn (string): Amazon Resource Name.

      Examples:

      "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

      "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

    • external_id (string): An external ID is a piece of data that can be passed to the AssumeRole API of the Security Token Service (STS). You can then use the external ID in the condition element in a role's trust policy, allowing the role to be assumed only when a certain value is present in the external ID.

  • specs (object)
    • aws (object): .

      • region (string): AWS Region to provision in.

        Examples:

        "us-west-2"

• vpc (object): . Cannot contain additional properties.

  • data (object)
    • infrastructure (object)

      • arn (string): Amazon Resource Name.

        Examples:

        "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

        "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

      • cidr (string)

        Examples:

        "10.100.0.0/16"

        "192.24.12.0/22"

      • internal_subnets (array)

        • Items (object): AWS VCP Subnet.

          • arn (string): Amazon Resource Name.

            Examples:

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

          Examples:

      • private_subnets (array)

        • Items (object): AWS VCP Subnet.

          • arn (string): Amazon Resource Name.

            Examples:

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

          Examples:

      • public_subnets (array)

        • Items (object): AWS VCP Subnet.

          • arn (string): Amazon Resource Name.

            Examples:

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

          Examples:

  • specs (object)
    • aws (object): .

      • region (string): AWS Region to provision in.

        Examples:

        "us-west-2"

Artifacts

Resources created by this bundle that can be connected to other bundles.

View

Properties

• kubernetes_cluster (object): Kubernetes cluster authentication and cloud-specific configuration. Cannot contain additional properties.

  • data (object)

    • authentication (object)
      • cluster (object)
        • certificate-authority-data (string)
        • server (string)
      • user (object)
        • token (string)
    • infrastructure (object): Cloud specific Kubernetes configuration data.
      • One of

        • AWS EKS infrastructure configobject: . Cannot contain additional properties.

          • arn (string): Amazon Resource Name.

            Examples:

            "arn:aws:rds::ACCOUNT_NUMBER:db/prod"

            "arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"

          • oidc_issuer_url (string): An HTTPS endpoint URL.

            Examples:

            "https://example.com/some/path"

            "https://massdriver.cloud"

        • Infrastructure Configobject: Azure AKS Infrastructure Configuration. Cannot contain additional properties.

          • ari (string): Azure Resource ID.

            Examples:

            "/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"

          • oidc_issuer_url (string)

        • GCP Infrastructure GRNobject: Minimal GCP Infrastructure Config. Cannot contain additional properties.

          • grn (string): GCP Resource Name (GRN).

            Examples:

            "projects/my-project/global/networks/my-global-network"

            "projects/my-project/regions/us-west2/subnetworks/my-subnetwork"

            "projects/my-project/topics/my-pubsub-topic"

            "projects/my-project/subscriptions/my-pubsub-subscription"

            "projects/my-project/locations/us-west2/instances/my-redis-instance"

            "projects/my-project/locations/us-west2/clusters/my-gke-cluster"

  • specs (object)

    • aws (object): .

      • region (string): AWS Region to provision in.

        Examples:

        "us-west-2"

    • azure (object): .

      • region (string): Select the Azure region you'd like to provision your resources in.

    • gcp (object): .

      • project (string)

      • region (string): The GCP region to provision resources in.

        Examples:

        "us-east1"

        "us-east4"

        "us-west1"

        "us-west2"

        "us-west3"

        "us-west4"

        "us-central1"

    • kubernetes (object): Kubernetes distribution and version specifications.

      • cloud (string): Must be one of: ['aws', 'gcp', 'azure'].
      • distribution (string): Must be one of: ['eks', 'gke', 'aks'].
      • platform_version (string)
      • version (string)

Contributing

Bug Reports & Feature Requests

Did we miss something? Please submit an issue to report any bugs or request additional features.

Developing

Note: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the Massdriver platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.

Still want to get involved? First check out our contribution guidelines.

Fix or Fork

If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or create your own bundle from scratch!

Connect

Questions? Concerns? Adulations? We'd love to hear from you!

Please connect with us!