Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qubitpi/hashicorp-aws-github-actions

🚚 GitHub Actions for deploying Immutable Infrastructure via HashiCorp
https://github.com/qubitpi/hashicorp-aws-github-actions

aws-ami aws-ec2 ci-cd continuous-delivery continuous-deployment hashicorp hashicorp-packer hashicorp-terraform immutable-infrastructure infrastructure-as-code release-automation

Last synced: 3 months ago
JSON representation

🚚 GitHub Actions for deploying Immutable Infrastructure via HashiCorp

Awesome Lists containing this project

README 

        
GitHub Actions for hashicorp-aws

================================



[![GitHub Actions Marketplace][GitHub Actions Marketplace badge]][GitHub Actions Marketplace URL]

[![GitHub Workflow Status][GitHub Workflow Status badge]][GitHub Workflow Status URL]

[![HashiCorp Packer Badge][HashiCorp Packer badge]][HashiCorp Packer URL]

[![HashiCorp Terraform Badge][HashiCorp Terraform badge]][HashiCorp Terraform URL]

[![Apache License][Apache License badge]][Apache License URL]



Immutable Infrastructure as Code via GitHub Action

--------------------------------------------------



[Application Deployment on AWS through HashiCorp][hashicorp-aws-github-actions] is an opinionated CI/CD [GitHub Action]

that



1. packages application into and registers [AMI image][AWS AMI] on AWS, then

2. deploys an [EC2 instance][AWS EC2] of that AMI onto AWS



![Error loading hashicorp-aws.png](./hashicorp-aws.png)



How to Use HashiCrop AWS GitHub Actions

---------------------------------------



### Step 1 - Setting up HashiCrop Packer & Terraform Template Files



HashiCorp AWS action follows [HashiCrop's best practice][HashiCorp Tutorial] by expecting a directory called

**hashicorp** located at the root of the repository. An example structure looks like this:



```bash

.

└── my-app-repository/

    ├── hashicorp/

    │   ├── images/

    │   │   └── aws-my-app.pkr.hcl

    │   ├── instances/

    │   │   └── aws-my-app.tf

    ├── src

    └── ...

```



- The **aws-my-app.pkr.hcl** is the standard [HashiCorp Packer Template][HashiCorp Packer Template] file

- The **aws-my-app.tf** is the standard [HashiCorp Terraform Config File][HashiCorp Terraform Config File]



### Step 2 - Defining Action File



Under regular `.github/workflows` directory, create a `.yml` file with a preferred name with the following example

contents:



```yaml

---

name: My App CI/CD



"on":

  pull_request:

  push:

    branches:

      - master



jobs:

  hashicorp:

    name: Publish AMI Image and Deploy it to EC2 through HashiCorp

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3



      ...



      - name: Publish my-app AMI image and deploy it to EC2 through HashiCorp

        uses: QubitPi/hashicorp-aws-github-actions@master

        with:

          packer-dir: hashicorp/images

          terraform-dir: hashicorp/instances

          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}

          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

          aws-region: ${{ secrets.AWS_REGION }}

```



> [!TIP]

>

> The values of `packer-dir` and `terraform-dir` is in accordance with the

> [example directory structure above](#step-1---setting-up-hashicrop-packer--terraform-template-files)



Note that the following [GitHub Action Secrets][GitHub Action - How to set up] needs to be setup



- [**AWS_ACCESS_KEY_ID**](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)

- [**AWS_SECRET_ACCESS_KEY**](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)

- [**AWS_REGION**](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)



License

-------



The use and distribution terms for [hashicorp-aws-github-actions] are covered by the [Apache License, Version 2.0].





    

        License Illustration

    




[Apache License, Version 2.0]: http://www.apache.org/licenses/LICENSE-2.0.html

[Apache License badge]: https://img.shields.io/badge/Apache%202.0-F25910.svg?style=for-the-badge&logo=Apache&logoColor=white

[Apache License URL]: https://www.apache.org/licenses/LICENSE-2.0



[AWS AMI]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html

[AWS EC2]: https://aws.amazon.com/ec2/



[GitHub Action]: https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions

[GitHub Action - How to set up]: https://docs.github.com/en/actions/security-guides/encrypted-secrets

[GitHub Actions Marketplace badge]: https://img.shields.io/badge/View%20On%20Marketplace-2088FF?style=for-the-badge&logo=githubactions&logoColor=white

[GitHub Actions Marketplace URL]: https://github.com/marketplace/actions/hashicorp-aws

[GitHub Workflow Status badge]: https://img.shields.io/github/actions/workflow/status/QubitPi/hashicorp-aws-github-actions/ci-cd.yml?branch=master&logo=github&style=for-the-badge

[GitHub Workflow Status URL]: https://github.com/QubitPi/hashicorp-aws-github-actions/actions/workflows/ci-cd.yml



[hashicorp-aws-github-actions]: https://github.com/QubitPi/hashicorp-aws-github-actions

[HashiCorp Packer badge]: https://img.shields.io/badge/Packer-02A8EF?style=for-the-badge&logo=Packer&logoColor=white

[HashiCorp Packer URL]: https://qubitpi.github.io/hashicorp-packer/packer/docs

[HashiCorp Packer Template]: https://developer.hashicorp.com/packer/tutorials/aws-get-started/aws-get-started-build-image#write-packer-template

[HashiCorp Terraform badge]: https://img.shields.io/badge/Terraform-7B42BC?style=for-the-badge&logo=terraform&logoColor=white

[HashiCorp Terraform URL]: https://qubitpi.github.io/hashicorp-terraform/terraform/docs

[HashiCorp Terraform Config File]: https://developer.hashicorp.com/terraform/tutorials/aws-get-started/aws-build#write-configuration

[HashiCorp Tutorial]: https://developer.hashicorp.com/terraform/tutorials/provision/packer