GithubHelp home page GithubHelp logo

github-actions-workflows-atmos's Introduction

github-actions-workflows-docker-ecr-eks-helmfile

Latest Release Slack Community

README Header

Cloud Posse

Release workflow for Dockerized application using ECR and deploying on EKS with Helmfile.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

Introduction

Use provided GitHub Actions reusable workflows to implement consistent release workflow for any kind of application that use

  • Docker for developing, shipping, and running,
  • ECR to store the Docker images
  • EKS for running application in scale
  • Helmfile as declarative deploy manifest

Preconditions

Application repository reference this reusable workflows should follows this structure

  .
  ├── Dockerfile
  ├── deploy/
  │   └── helmfile.yaml
  └── test/
      ├── docker-compose.yml
      └── test.sh

Workflows

Name Description
Features branch (Pull request) workflow Build, test Docker image, deploy it to EKS preview environment depends of PR labels
Hotfix branch (Pull request into release/* branches) workflow Build, test Docker image, deploy it to EKS hotfix environment depends of PR labels
Hotfix workflow enable For each new release create release/{version} branch that is key puzzle for hotfix workflow.
Hotfix release workflow Build, test Docker image, deploy it to EKS production environment and reintegrate hotfix into the main branch
Main branch workflow Build, test Docker image, deploy it to EKS dev environment and draft new release
Release workflow Promote existing Docker image to release version, deploy it to EKS staging and then production environments.

Features branch (Pull request) workflow

Build, test Docker image, deploy it to EKS preview environment depends of PR labels

Usage

Create in your repo .github/workflows/feature.yaml

  name: Feature Branch
  on:
    pull_request:
      branches: [ 'master' ]
      types: [opened, synchronize, reopened, closed, labeled, unlabeled]
  
  permissions:
    pull-requests: write
    deployments: write
    id-token: write
    contents: read
  
  jobs:
    do:
      uses: cloudposse/github-actions-workflows-docker-ecr-eks-helmfile/.github/workflows/feature-branch.yml@main
      with:
        organization: "${{ github.event.repository.owner.login }}"
        repository: "${{ github.event.repository.name }}"
        open: ${{ github.event.pull_request.state == 'open' }}
        labels: ${{ toJSON(github.event.pull_request.labels.*.name) }}
        ref: ${{ github.event.pull_request.head.ref  }}
      secrets:
        github-private-actions-pat: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
        registry: "${{ secrets.ECR_REGISTRY }}"
        secret-outputs-passphrase: "${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}"
        ecr-region: "${{ secrets.ECR_REGION }}"
        ecr-iam-role: "${{ secrets.ECR_IAM_ROLE }}"

Inputs

Name Description Type Default Required
labels Pull Request labels string ${{ toJSON(github.event.pull_request.labels.*.name) }} false
open Pull Request open/close state. Set true if opened boolean ${{ github.event.pull_request.state == 'open' }} false
organization Repository owner organization (ex. acme for repo acme/example) string ${{ github.event.repository.owner.login }} false
ref The fully-formed ref of the branch or tag that triggered the workflow run string ${{ github.event.pull_request.head.ref }} false
repository Repository name (ex. example for repo acme/example) string ${{ github.event.repository.name }} false

Secrets

Name Description Required
ecr-iam-role IAM Role ARN provide ECR write/read access true
ecr-region ECR AWS region true
github-private-actions-pat Github PAT allow to pull private repos true
registry ECR ARN true
secret-outputs-passphrase Passphrase to encrypt/decrypt secret outputs with gpg. For more information read true

Hotfix branch (Pull request into release/* branches) workflow

Build, test Docker image, deploy it to EKS hotfix environment depends of PR labels

Usage

Create in your repo .github/workflows/hotfix-branch.yaml

  name: Hotfix Branch
  on:
    pull_request:
      branches: [ 'release/**' ]
      types: [opened, synchronize, reopened, closed, labeled, unlabeled]
  
  permissions:
    pull-requests: write
    deployments: write
    id-token: write
    contents: read
  
  jobs:
    do:
      uses: cloudposse/github-actions-workflows-docker-ecr-eks-helmfile/.github/workflows/hotfix-branch.yml@main
      with:
        organization: "${{ github.event.repository.owner.login }}"
        repository: "${{ github.event.repository.name }}"
        open: ${{ github.event.pull_request.state == 'open' }}
        labels: ${{ toJSON(github.event.pull_request.labels.*.name) }}
        ref: ${{ github.event.pull_request.head.ref  }}
      secrets:
        github-private-actions-pat: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
        registry: "${{ secrets.ECR_REGISTRY }}"
        secret-outputs-passphrase: "${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}"
        ecr-region: "${{ secrets.ECR_REGION }}"
        ecr-iam-role: "${{ secrets.ECR_IAM_ROLE }}"

Inputs

Name Description Type Default Required
labels Pull Request labels string ${{ toJSON(github.event.pull_request.labels.*.name) }} false
open Pull Request open/close state. Set true if opened boolean ${{ github.event.pull_request.state == 'open' }} false
organization Repository owner organization (ex. acme for repo acme/example) string ${{ github.event.repository.owner.login }} false
ref The fully-formed ref of the branch or tag that triggered the workflow run string ${{ github.event.pull_request.head.ref }} false
repository Repository name (ex. example for repo acme/example) string ${{ github.event.repository.name }} false

Secrets

Name Description Required
ecr-iam-role IAM Role ARN provide ECR write/read access true
ecr-region ECR AWS region true
github-private-actions-pat Github PAT allow to pull private repos true
registry ECR ARN true
secret-outputs-passphrase Passphrase to encrypt/decrypt secret outputs with gpg. For more information read true

Hotfix workflow enable

For each new release create release/{version} branch that is key puzzle for hotfix workflow.

Usage

Create in your repo .github/workflows/hotfix-enabled.yaml

  name: Release branch
  on:
    release:
      types: [published]

  permissions:
    id-token: write
    contents: write

  jobs:
    hotfix:
      name: release / branch
      uses: cloudposse/github-actions-workflows-docker-ecr-eks-helmfile/.github/workflows/hotfix-mixin.yml@main
      with:
        version: ${{ github.event.release.tag_name }}

or add hotfix job to existing .github/workflows/release.yaml

  jobs:
    hotfix:
      name: release / branch
      uses: cloudposse/github-actions-workflows-docker-ecr-eks-helmfile/.github/workflows/hotfix-mixin.yml@main
      with:
        version: ${{ github.event.release.tag_name }}

Inputs

Name Description Type Default Required
version Release version tag string N/A true

Hotfix release workflow

Build, test Docker image, deploy it to EKS production environment and reintegrate hotfix into the main branch

Usage

Create in your repo .github/workflows/hotfix-release.yaml

  name: Hotfix Release
  on:
    push:
      branches: [ 'release/**' ]
  
  permissions:
    contents: write
    id-token: write
  
  jobs:
    do:
      uses: cloudposse/github-actions-workflows-docker-ecr-eks-helmfile/.github/workflows/hotfix-release.yml@main
      with:
        organization: "${{ github.event.repository.owner.login }}"
        repository: "${{ github.event.repository.name }}"
      secrets:
        github-private-actions-pat: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
        registry: "${{ secrets.ECR_REGISTRY }}"
        secret-outputs-passphrase: "${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}"
        ecr-region: "${{ secrets.ECR_REGION }}"
        ecr-iam-role: "${{ secrets.ECR_IAM_ROLE }}"

Inputs

Name Description Type Default Required
default_branch Default branch for this repo string main true
organization Repository owner organization (ex. acme for repo acme/example) string ${{ github.event.repository.owner.login }} false
repository Repository name (ex. example for repo acme/example) string ${{ github.event.repository.name }} false

Secrets

Name Description Required
ecr-iam-role IAM Role ARN provide ECR write/read access true
ecr-region ECR AWS region true
github-private-actions-pat Github PAT allow to pull private repos true
registry ECR ARN true
secret-outputs-passphrase Passphrase to encrypt/decrypt secret outputs with gpg. For more information read true

Main branch workflow

Build, test Docker image, deploy it to EKS dev environment and draft new release

Usage

Create in your repo .github/workflows/main.yaml

  name: Main Branch
  on:
    push:
      branches: [ master ]
  
  permissions:
    contents: write
    id-token: write
  
  jobs:
    do:
      uses: cloudposse/github-actions-workflows-docker-ecr-eks-helmfile/.github/workflows/main-branch.yml@main
      with:
        organization: "${{ github.event.repository.owner.login }}"
        repository: "${{ github.event.repository.name }}"
      secrets:
        github-private-actions-pat: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
        registry: "${{ secrets.ECR_REGISTRY }}"
        secret-outputs-passphrase: "${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}"
        ecr-region: "${{ secrets.ECR_REGION }}"
        ecr-iam-role: "${{ secrets.ECR_IAM_ROLE }}"

Inputs

Name Description Type Default Required
organization Repository owner organization (ex. acme for repo acme/example) string ${{ github.event.repository.owner.login }} false
repository Repository name (ex. example for repo acme/example) string ${{ github.event.repository.name }} false

Secrets

Name Description Required
ecr-iam-role IAM Role ARN provide ECR write/read access true
ecr-region ECR AWS region true
github-private-actions-pat Github PAT allow to pull private repos true
registry ECR ARN true
secret-outputs-passphrase Passphrase to encrypt/decrypt secret outputs with gpg. For more information read true

Release workflow

Promote existing Docker image to release version, deploy it to EKS staging and then production environments.

Usage

Create in your repo .github/workflows/release.yaml

  name: Release
  on:
    release:
      types: [published]
  
  permissions:
    id-token: write
    contents: write
  
  jobs:
    perform:
      uses: cloudposse/github-actions-workflows-docker-ecr-eks-helmfile/.github/workflows/release.yml@main
      with:
        organization: "${{ github.event.repository.owner.login }}"
        repository: "${{ github.event.repository.name }}"
        version: ${{ github.event.release.tag_name }}
      secrets:
        github-private-actions-pat: "${{ secrets.PUBLIC_REPO_ACCESS_TOKEN }}"
        registry: "${{ secrets.ECR_REGISTRY }}"
        secret-outputs-passphrase: "${{ secrets.GHA_SECRET_OUTPUT_PASSPHRASE }}"
        ecr-region: "${{ secrets.ECR_REGION }}"
        ecr-iam-role: "${{ secrets.ECR_IAM_ROLE }}"

Inputs

Name Description Type Default Required
organization Repository owner organization (ex. acme for repo acme/example) string ${{ github.event.repository.owner.login }} false
repository Repository name (ex. example for repo acme/example) string ${{ github.event.repository.name }} false
version Release version tag string ${{ github.event.release.tag_name }} false

Secrets

Name Description Required
ecr-iam-role IAM Role ARN provide ECR write/read access true
ecr-region ECR AWS region true
github-private-actions-pat Github PAT allow to pull private repos true
registry ECR ARN true
secret-outputs-passphrase Passphrase to encrypt/decrypt secret outputs with gpg. For more information read true

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

  • example-app-on-eks - Example application for CI/CD demonstrations of GitHub Actions deal with Docker, ECR, EKS and Helmfile

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

README Commercial Support

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Learn More

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
  • Site Reliability Engineering. You'll have total visibility into your apps and microservices.
  • Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
  • GitOps. You'll be able to operate your infrastructure via Pull Requests.
  • Training. You'll receive hands-on training so your team can operate what we build.
  • Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
  • Troubleshooting. You'll get help to triage when things aren't working.
  • Code Reviews. You'll receive constructive feedback on Pull Requests.
  • Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

zoom

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2022 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Igor Rodionov
Igor Rodionov

README Footer Beacon

github-actions-workflows-atmos's People

Contributors

goruha avatar

Watchers

avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.