README.md

Deploy an EKS Cluster

Description

This GitHub Action automates the deployment of an EKS (Amazon Elastic Kubernetes Service) cluster using Terraform. This action will also install Terraform, awscli, and kubectl. The kube context will be set on the created cluster.

Inputs

name	description	required	default
aws-region	AWS region where the EKS cluster will be deployed	true	""
cluster-name	Name of the EKS cluster to deploy	true	""
additional-terraform-vars	JSON object containing additional Terraform variables	false	{}
s3-backend-bucket	Name of the S3 bucket to store Terraform state	true	""
s3-bucket-region	Region of the bucket containing the resources states, if not set, will fallback on aws-region	false	""
tf-modules-revision	Git revision of the tf modules to use	false	main
tf-modules-path	Path where the tf EKS modules will be cloned	false	./.action-tf-modules/eks/
login	Authenticate the current kube context on the created cluster	false	true
tf-cli-config-credentials-hostname	The hostname of a HCP Terraform/Terraform Enterprise instance to place within the credentials block of the Terraform CLI configuration file. Defaults to app.terraform.io.	false	app.terraform.io
tf-cli-config-credentials-token	The API token for a HCP Terraform/Terraform Enterprise instance to place within the credentials block of the Terraform CLI configuration file.	false	""
tf-terraform-version	The version of Terraform CLI to install. Instead of full version string you can also specify constraint string starting with "<" (for example <1.13.0) to install the latest version satisfying the constraint. A value of latest will install the latest version of Terraform CLI. Defaults to latest.	false	latest
tf-terraform-wrapper	Whether or not to install a wrapper to wrap subsequent calls of the terraform binary and expose its STDOUT, STDERR, and exit code as outputs named stdout, stderr, and exitcode respectively. Defaults to true.	false	true
awscli-version	Version of the aws cli to use	false	2.15.52

Outputs

name	description
eks-cluster-endpoint	The API endpoint of the deployed EKS cluster
terraform-state-url	URL of the Terraform state file in the S3 bucket
all-terraform-outputs	All outputs from Terraform

Runs

This action is a composite action.

Usage

- uses: camunda/camunda-tf-eks-module/.github/actions/eks-manage-cluster@main
  with:
    aws-region:
    # AWS region where the EKS cluster will be deployed
    #
    # Required: true
    # Default: ""

    cluster-name:
    # Name of the EKS cluster to deploy
    #
    # Required: true
    # Default: ""

    additional-terraform-vars:
    # JSON object containing additional Terraform variables
    #
    # Required: false
    # Default: {}

    s3-backend-bucket:
    # Name of the S3 bucket to store Terraform state
    #
    # Required: true
    # Default: ""

    s3-bucket-region:
    # Region of the bucket containing the resources states, if not set, will fallback on aws-region
    #
    # Required: false
    # Default: ""

    tf-modules-revision:
    # Git revision of the tf modules to use
    #
    # Required: false
    # Default: main

    tf-modules-path:
    # Path where the tf EKS modules will be cloned
    #
    # Required: false
    # Default: ./.action-tf-modules/eks/

    login:
    # Authenticate the current kube context on the created cluster
    #
    # Required: false
    # Default: true

    tf-cli-config-credentials-hostname:
    # The hostname of a HCP Terraform/Terraform Enterprise instance to place within the credentials block of the Terraform CLI configuration file. Defaults to `app.terraform.io`.
    #
    # Required: false
    # Default: app.terraform.io

    tf-cli-config-credentials-token:
    # The API token for a HCP Terraform/Terraform Enterprise instance to place within the credentials block of the Terraform CLI configuration file.
    #
    # Required: false
    # Default: ""

    tf-terraform-version:
    # The version of Terraform CLI to install. Instead of full version string you can also specify constraint string starting with "<" (for example `<1.13.0`) to install the latest version satisfying the constraint. A value of `latest` will install the latest version of Terraform CLI. Defaults to `latest`.
    #
    # Required: false
    # Default: latest

    tf-terraform-wrapper:
    # Whether or not to install a wrapper to wrap subsequent calls of the `terraform` binary and expose its STDOUT, STDERR, and exit code as outputs named `stdout`, `stderr`, and `exitcode` respectively. Defaults to `true`.
    #
    # Required: false
    # Default: true

    awscli-version:
    # Version of the aws cli to use
    #
    # Required: false
    # Default: 2.15.52