Skip to content
cpu

GitHub Action

Deploy ArgoCD

0.8.1 Latest version

Deploy ArgoCD

cpu

Deploy ArgoCD

Deploy on Kubernetes with ArgoCD

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Deploy ArgoCD

uses: cloudposse/github-action-deploy-argocd@0.8.1

Learn more about this action in cloudposse/github-action-deploy-argocd

Choose a version

github-action-deploy-argocd Latest Release Slack Community

Deploy on Kubernetes with ArgoCD


Note

This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

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

README Header

Introduction

Deploy on Kubernetes with Helm/HelmFile and ArgoCD.

Usage

Deploy environment

  name: Pull Request
  on:
    pull_request:
      branches: [ 'main' ]
      types: [opened, synchronize, reopened]

  jobs:
    deploy:
      runs-on: ubuntu-latest
      environment:
        name: preview
        url: ${{ steps.deploy.outputs.webapp-url }}  
      steps:
        
        - name: Configure AWS Credentials
          uses: aws-actions/configure-aws-credentials@v1.7.0
          with:
            aws-region: us-west-2
            role-to-assume: arn:aws:iam::111111111111:role/preview
            role-session-name: deploy
      
        - name: Deploy
          uses: cloudposse/github-action-deploy-argocd@main
          id: deploy
          with:
            cluster: https://github.com/cloudposse/argocd-deploy-non-prod-test/blob/main/plat/ue2-sandbox/apps
            toolchain: helmfile
            environment: preview
            namespace: preview
            application: test-app
            github-pat: ${{ secrets.GITHUB_AUTH_PAT }}
            repository: ${{ github.repository }}
            ref: ${{ github.event.pull_request.head.ref  }}
            image: nginx
            image-tag: latest
            operation: deploy
            debug: false
            synchronously: true

Destroy environment

  name: Pull Request
  on:
    pull_request:
      branches: [ 'main' ]
      types: [closed]

  jobs:
    destroy:
      runs-on: ubuntu-latest
      steps:
        - name: Configure AWS Credentials
          uses: aws-actions/configure-aws-credentials@v1.7.0
          with:
            aws-region: us-west-2
            role-to-assume: arn:aws:iam::111111111111:role/preview
            role-session-name: destroy          
      
        - name: Destroy
          uses: cloudposse/github-action-deploy-helmfile@main
          id: destroy
          with:
            cluster: https://github.com/cloudposse/argocd-deploy-non-prod-test/blob/main/plat/ue2-sandbox/apps
            toolchain: helmfile
            environment: preview
            namespace: preview
            application: test-app
            github-pat: ${{ secrets.GITHUB_AUTH_PAT }}
            repository: ${{ github.repository }}
            ref: ${{ github.event.pull_request.head.ref }}  
            image: "<none>"
            image-tag: "<none>"
            operation: destroy
            debug: false

Inputs

Name Description Default Required
application Application name N/A true
aws-region AWS region us-east-1 false
check-retry-count Check retry count (for synchronously mode) 5 false
check-retry-interval Check retry interval (in seconds) (for synchronously mode) 10 false
cluster Cluster name N/A true
debug Debug mode false false
environment Helmfile environment preview false
github-pat Github PAT to access argocd configuration repository N/A true
gitref-sha Git SHA (Depricated. Use ref instead) false
image Docker image N/A true
image-tag Docker image tag N/A true
namespace Kubernetes namespace N/A true
operation Operation with helmfiles. (valid options - deploy, destroy) deploy true
path The path where lives the helmfile or helm chart. N/A true
ref Git ref N/A true
release_label_name The name of the label used to describe the helm release release false
repository Application GitHub repository full name N/A true
ssm-path SSM path to read environment secrets N/A true
synchronously Wait until ArgoCD successfully apply the changes false false
toolchain Toolchain ('helm', 'helmfile') helmfile false
values_file Helmfile values file false

Outputs

Name Description
sha Git commit SHA into argocd repo
webapp-url Web Application url

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 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 Cloud Posse's 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!

🌎 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.

📰 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!

About

This project is maintained and funded by Cloud Posse, LLC.

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.

README Commercial Support

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.

Copyright © 2017-2024 Cloud Posse, LLC README Footer Beacon