From 20f0f29ca05f4eb1c7f39b903135e7c4f4a01616 Mon Sep 17 00:00:00 2001 From: Bjorn Olsen Date: Fri, 22 Nov 2024 11:10:02 +0200 Subject: [PATCH] chore: Deprecate this repo --- CHANGELOG.md | 24 ++++++++++++------------ README.md | 24 ++++++++++++++++-------- docs/test_badges.md | 6 +++--- tests/terraform/main/terraform.tfvars | 4 ++-- 4 files changed, 33 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f881db..2bf29ff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,46 +2,46 @@ All notable changes to this project will be documented in this file. -## [1.2.0](https://github.com/cloudandthings/terraform-aws-github-runners/compare/v1.1.1...v1.2.0) (2023-02-10) +## [1.2.0](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/compare/v1.1.1...v1.2.0) (2023-02-10) ### Features -* Add `create_instance_profile` ([#38](https://github.com/cloudandthings/terraform-aws-github-runners/issues/38)) ([b3c278d](https://github.com/cloudandthings/terraform-aws-github-runners/commit/b3c278d568ec5ad575e7e1a5ce659067bcedf9b1)) -* Add BASE_PACKAGES software pack ([6dbee94](https://github.com/cloudandthings/terraform-aws-github-runners/commit/6dbee94e533ec03517cf054b988bcbeed0a5b416)) -* Add iam_policy_arns variable ([9037423](https://github.com/cloudandthings/terraform-aws-github-runners/commit/9037423ad4bdfc4cd402c15abc8a2b0162686f17)) +* Add `create_instance_profile` ([#38](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/issues/38)) ([b3c278d](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/b3c278d568ec5ad575e7e1a5ce659067bcedf9b1)) +* Add BASE_PACKAGES software pack ([6dbee94](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/6dbee94e533ec03517cf054b988bcbeed0a5b416)) +* Add iam_policy_arns variable ([9037423](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/9037423ad4bdfc4cd402c15abc8a2b0162686f17)) ### Bug Fixes -* Improved default concurrency ([bc3821d](https://github.com/cloudandthings/terraform-aws-github-runners/commit/bc3821d66df152a07d0c89811e6e4258d6e32892)) +* Improved default concurrency ([bc3821d](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/bc3821d66df152a07d0c89811e6e4258d6e32892)) -### [1.1.1](https://github.com/cloudandthings/terraform-aws-github-runners/compare/v1.1.0...v1.1.1) (2022-12-14) +### [1.1.1](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/compare/v1.1.0...v1.1.1) (2022-12-14) ### Bug Fixes -* **python3:** Add python-dev-is-python3 package ([#34](https://github.com/cloudandthings/terraform-aws-github-runners/issues/34)) ([e74b64a](https://github.com/cloudandthings/terraform-aws-github-runners/commit/e74b64a983a0dca8455c2752fe0d7ffe949dbfcb)) +* **python3:** Add python-dev-is-python3 package ([#34](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/issues/34)) ([e74b64a](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/e74b64a983a0dca8455c2752fe0d7ffe949dbfcb)) -## [1.1.0](https://github.com/cloudandthings/terraform-aws-github-runners/compare/v1.0.1...v1.1.0) (2022-12-08) +## [1.1.0](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/compare/v1.0.1...v1.1.0) (2022-12-08) ### Features -* **software:** Added tfsec ([#33](https://github.com/cloudandthings/terraform-aws-github-runners/issues/33)) ([1e73b96](https://github.com/cloudandthings/terraform-aws-github-runners/commit/1e73b964669e9ba41772e5e910811af6fb009958)) +* **software:** Added tfsec ([#33](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/issues/33)) ([1e73b96](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/1e73b964669e9ba41772e5e910811af6fb009958)) ## 1.0.0 (2022-09-30) ### Features -* Initial commit ([4fb431b](https://github.com/cloudandthings/terraform-aws-github-runners/commit/4fb431bf4666acbbcb36ac4eceea0304b226e54f)) -* Initial commit ([c7bdca2](https://github.com/cloudandthings/terraform-aws-github-runners/commit/c7bdca2a69e4c06ef3cee669a6523e8f0936fb93)) +* Initial commit ([4fb431b](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/4fb431bf4666acbbcb36ac4eceea0304b226e54f)) +* Initial commit ([c7bdca2](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/c7bdca2a69e4c06ef3cee669a6523e8f0936fb93)) ### Bug Fixes -* Auto release process ([#30](https://github.com/cloudandthings/terraform-aws-github-runners/issues/30)) ([c18832d](https://github.com/cloudandthings/terraform-aws-github-runners/commit/c18832d8601e41276027ba4f63482d078703cd99)) +* Auto release process ([#30](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/issues/30)) ([c18832d](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/commit/c18832d8601e41276027ba4f63482d078703cd99)) ### Features diff --git a/README.md b/README.md index bf79e90..9233e60 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ -# terraform-aws-github-runners +# [DEPRECATION NOTICE] + +This repo is deprecated in favor of [terraform-aws-github-runners](https://github.com/cloudandthings/terraform-aws-github-runners-ec2). + +The new repo uses AWS CodeBuild to create ephemeral runners on-demand. + +New projects should start with the new repo, and we recommend that existing projects migrate to the new repo wherever possible. + +# terraform-aws-github-runners-ec2 Simple to use, self-hosted GitHub Action runners. Uses EC2 spot instances with configurable AutoScaling. -[![GitHub repo link](https://github.com/cloudandthings/terraform-aws-github-runners/blob/main/docs/images/icon.gif )](https://github.com/cloudandthings/terraform-aws-github-runners) +[![GitHub repo link](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/blob/main/docs/images/icon.gif )](https://github.com/cloudandthings/terraform-aws-github-runners-ec2) --- -[![Maintenance](https://img.shields.io/badge/Maintained-yes-green.svg)](https://github.com/cloudandthings/terraform-aws-github-runners/graphs/commit-activity) -[![Test Status](https://github.com/cloudandthings/terraform-aws-github-runners/actions/workflows/main.yml/badge.svg)](https://github.com/cloudandthings/terraform-aws-github-runners/actions/workflows/main.yml) +[![Maintenance](https://img.shields.io/badge/Maintained-yes-green.svg)](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/graphs/commit-activity) +[![Test Status](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/actions/workflows/main.yml/badge.svg)](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/actions/workflows/main.yml) ![Terraform Version](https://img.shields.io/badge/tf-%3E%3D0.13.0-blue) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) @@ -41,7 +49,7 @@ A possible workaround could be to [run jobs in a container](https://docs.github. ## How it works -[![Infrastructure diagram](https://github.com/cloudandthings/terraform-aws-github-runners/blob/main/docs/images/runner.svg)](https://github.com/cloudandthings/terraform-aws-github-runners/blob/main/docs/images/runner.svg) +[![Infrastructure diagram](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/blob/main/docs/images/runner.svg)](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/blob/main/docs/images/runner.svg) An AutoScaling group is created to spin up Spot EC2 instances on a schedule. The instances retrieve a pre-configured GitHub access token from AWS SSM Parameter Store, and start one (or more) ephemeral actions runner processes. These authenticate with GitHub and wait for work. @@ -61,7 +69,7 @@ A full list of created resources is shown below. Create a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). Add it to AWS Systems Manager Parameter Store with the `SecureString` type. -[![Parameter Store configuration](https://github.com/cloudandthings/terraform-aws-github-runners/blob/main/docs/images/ssm.png)](https://github.com/cloudandthings/terraform-aws-github-runners/blob/main/docs/images/ssm.png ) +[![Parameter Store configuration](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/blob/main/docs/images/ssm.png)](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/blob/main/docs/images/ssm.png ) ### 2. Configure module @@ -69,8 +77,8 @@ Configure and deploy the module using Terraform. See examples below. ## More info -- Found an issue? Want to help? [Contribute](https://github.com/cloudandthings/terraform-aws-github-runners/.github/contribute.md). -- Review a [cost estimate](https://github.com/cloudandthings/terraform-aws-github-runners/blob/main/docs/cost_estimate.md). +- Found an issue? Want to help? [Contribute](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/.github/contribute.md). +- Review a [cost estimate](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/blob/main/docs/cost_estimate.md). ## Module Docs diff --git a/docs/test_badges.md b/docs/test_badges.md index d3d9e96..c54c851 100644 --- a/docs/test_badges.md +++ b/docs/test_badges.md @@ -1,3 +1,3 @@ -[![Latest Release](https://img.shields.io/github/release/cloudandthings/terraform-aws-github-runners)](https://github.com/cloudandthings/terraform-aws-github-runners/releases/latest) -[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/cloudandthings/terraform-aws-github-runners?label=latest)](https://github.com/cloudandthings/terraform-aws-github-runners/releases/latest) -[![Github All Releases](https://img.shields.io/github/downloads/cloudandthings/terraform-aws-github-runners/total)](https://github.com/cloudandthings/terraform-aws-github-runners/releases) +[![Latest Release](https://img.shields.io/github/release/cloudandthings/terraform-aws-github-runners-ec2)](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/releases/latest) +[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/cloudandthings/terraform-aws-github-runners-ec2?label=latest)](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/releases/latest) +[![Github All Releases](https://img.shields.io/github/downloads/cloudandthings/terraform-aws-github-runners-ec2/total)](https://github.com/cloudandthings/terraform-aws-github-runners-ec2/releases) diff --git a/tests/terraform/main/terraform.tfvars b/tests/terraform/main/terraform.tfvars index d424c3b..57f0bb3 100644 --- a/tests/terraform/main/terraform.tfvars +++ b/tests/terraform/main/terraform.tfvars @@ -1,4 +1,4 @@ -naming_prefix = "test-terraform-aws-github-runners" +naming_prefix = "test-terraform-aws-github-runners-ec2" aws_account_id = "353444730604" region = "eu-west-1" @@ -10,4 +10,4 @@ subnet_ids = [ "subnet-0640faa0e0e882b4d" ] -iam_instance_profile_arn = "arn:aws:iam::353444730604:instance-profile/terraform-aws-github-runners" +iam_instance_profile_arn = "arn:aws:iam::353444730604:instance-profile/terraform-aws-github-runners-ec2"