Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/runlevel5/pulumi-eks-custom

Last synced: about 9 hours ago
JSON representation
Host: GitHub
URL: https://github.com/runlevel5/pulumi-eks-custom
Owner: runlevel5
License: apache-2.0
Created: 2021-02-10T10:38:26.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2021-02-10T11:22:00.000Z (almost 4 years ago)
Last Synced: 2024-11-25T17:13:05.551Z (2 months ago)
Size: 95.7 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: securitygroup.d.ts
Awesome Lists containing this project

README

        [![Build Status](https://travis-ci.com/pulumi/pulumi-eks.svg?token=eHg7Zp5zdDDJfTjY8ejq&branch=master)](https://travis-ci.com/pulumi/pulumi-eks)

# Pulumi Amazon Web Services (AWS) EKS Components

Pulumi's library for easily creating and managing EKS Kubernetes clusters.

* [Introduction](#introduction)

* [References](#references)

* [Pre-Requisites](#pre-requisites)

* [Installing](#installing)

* [Quick Examples](#quick-examples)

  * [Create a Default EKS Cluster](#create-a-default-eks-cluster)

  * [Deploying a Helm Chart](#deploying-a-helm-chart)

  * [Deploying a Workload](#deploying-a-workload)

* [Contributing](#contributing)

* [Code of Conduct](#code-of-conduct)

## Introduction

`pulumi/eks` provides a Pulumi component that creates and manages the resources necessary to run an EKS Kubernetes cluster in AWS.

This includes:

- The EKS cluster control plane.

- The cluster's worker nodes configured as node groups, which are managed by an auto scaling group.

- The AWS CNI Plugin [`aws-k8s-cni`](https://github.com/aws/amazon-vpc-cni-k8s/) to manage pod networking in Kubernetes.

## References

* [Reference Documentation](https://www.pulumi.com/docs/reference/clouds/kubernetes/)

* [Node.js API Documentation](https://pulumi.io/reference/pkg/nodejs/@pulumi/eks/index.html)

* [Examples](./examples)

* [Crosswalk for AWS & EKS Guide](https://www.pulumi.com/docs/guides/crosswalk/aws/eks/)

* [Tutorials](https://www.pulumi.com/docs/reference/tutorials/kubernetes/)

## Pre-Requisites

1. [Install Pulumi](https://www.pulumi.com/docs/reference/install).

1. Install [Node.js](https://nodejs.org/en/download).

1. Install a package manager for Node.js, such as [NPM](https://www.npmjs.com/get-npm) or [Yarn](https://yarnpkg.com/lang/en/docs/install).

1. [Install and Configure the AWS CLI](https://www.pulumi.com/docs/reference/clouds/aws/setup/).

    * Use AWS CLI version >= `1.18.17`.

    * See the [AWS docs](https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html) for more details.

1. [Install `kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl).

## Installing

This package is available in JavaScript/TypeScript for use with Node.js. Install it using either `npm` or `yarn`.

`npm`:

```bash

$ npm install @pulumi/eks

```

`yarn`:

```bash

$ yarn add @pulumi/eks

```

## Quick Examples

### Create a Default EKS Cluster

The default cluster configuration will use the default VPC of the AWS user

or role transiently signed in. It will create the EKS control plane and a default

worker node group using an autoscaling group of two `t2.medium` EC2 instances.

```typescript

import * as eks from "@pulumi/eks";

// Create an EKS cluster with the default configuration.

const cluster = new eks.Cluster("my-cluster");

// Export the cluster's kubeconfig.

export const kubeconfig = cluster.kubeconfig;

```

Once the cluster is created, you can deploy into the cluster using usual methods

such as `kubectl` and Helm, or using the

[`@pulumi/kubernetes`][pulumi-kubernetes] SDK to deploy in various ways

as shown below.

You can retrieve the new EKS cluster's `kubeconfig` from Pulumi by querying the

[stack](https://www.pulumi.com/docs/intro/concepts/stack/) for its

[output](https://www.pulumi.com/docs/intro/concepts/stack/#outputs) of exported

variables if working with the `kubectl` or Helm tools directly.

```bash

pulumi stack output kubeconfig > kubeconfig.json

export KUBECONFIG=$PWD/kubeconfig.json

```

### Deploying a Helm Chart

This example creates a EKS cluster and then deploys a Helm chart from the

stable repo. We extract the cluster's `kubeconfig` from its [Pulumi provider](https://www.pulumi.com/docs/reference/programming-model/#providers) to specifically target this cluster for deployments with

[`pulumi-kubernetes`][pulumi-kubernetes].

```typescript

import * as eks from "@pulumi/eks";

import * as k8s from "@pulumi/kubernetes";

// Create an EKS cluster.

const cluster = new eks.Cluster("my-cluster");

// Deploy Wordpress into our cluster.

const wordpress = new k8s.helm.v2.Chart("wordpress", {

    repo: "stable",

    chart: "wordpress",

    values: {

        wordpressBlogName: "My Cool Kubernetes Blog!",

    },

}, { providers: { "kubernetes": cluster.provider } });

// Export the cluster's kubeconfig.

export const kubeconfig = cluster.kubeconfig;

```

### Deploying a Workload

This example creates a EKS cluster and then deploys an NGINX Deployment and

Service using the [`pulumi/kubernetes`][pulumi-kubernetes] SDK, and the

`kubeconfig` credentials from the cluster's

[Pulumi provider](https://www.pulumi.com/docs/reference/programming-model/#providers).

```typescript

import * as eks from "@pulumi/eks";

import * as k8s from "@pulumi/kubernetes";

// Create an EKS cluster with the default configuration.

const cluster = new eks.Cluster("my-cluster");

// Create a NGINX Deployment and Service.

const appName = "my-app";

const appLabels = { appClass: appName };

const deployment = new k8s.apps.v1.Deployment(`${appName}-dep`, {

    metadata: { labels: appLabels },

    spec: {

        replicas: 2,

        selector: { matchLabels: appLabels },

        template: {

            metadata: { labels: appLabels },

            spec: {

                containers: [{

                    name: appName,

                    image: "nginx",

                    ports: [{ name: "http", containerPort: 80 }]

                }],

            }

        }

    },

}, { provider: cluster.provider });

const service = new k8s.core.v1.Service(`${appName}-svc`, {

    metadata: { labels: appLabels },

    spec: {

        type: "LoadBalancer",

        ports: [{ port: 80, targetPort: "http" }],

        selector: appLabels,

    },

}, { provider: cluster.provider });

// Export the URL for the load balanced service.

export const url = service.status.loadBalancer.ingress[0].hostname;

// Export the cluster's kubeconfig.

export const kubeconfig = cluster.kubeconfig;

```

### Contributing

If you are interested in contributing, please see the [contributing docs][contributing].

### Code of Conduct

You can read the code of conduct [here][code-of-conduct].

[pulumi-kubernetes]: https://github.com/pulumi/pulumi-kubernetes

[contributing]: CONTRIBUTING.md

[code-of-conduct]: CODE-OF-CONDUCT.md

[workload-example]: #deploying-a-workload-on-aws-eks

[how-pulumi-works]: https://www.pulumi.com/docs/intro/concepts/how-pulumi-works

[workload-example]: #deploying-a-workload

[faq]: https://www.pulumi.com/docs/intro/cloud-providers/kubernetes/faq/