Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koslib/helm-eks-action
The simplest Github Action for executing Helm commands on EKS - cluster authentication included
https://github.com/koslib/helm-eks-action
actions aws eks github-actions helm kubernetes
Last synced: 4 days ago
JSON representation
The simplest Github Action for executing Helm commands on EKS - cluster authentication included
- Host: GitHub
- URL: https://github.com/koslib/helm-eks-action
- Owner: koslib
- License: mit
- Created: 2020-07-24T20:12:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T13:45:56.000Z (10 months ago)
- Last Synced: 2025-01-02T05:11:59.134Z (11 days ago)
- Topics: actions, aws, eks, github-actions, helm, kubernetes
- Language: Dockerfile
- Homepage:
- Size: 85 KB
- Stars: 63
- Watchers: 2
- Forks: 60
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# helm-eks-action
Github Action for executing Helm commands on EKS (using aws-iam-authenticator).
The Helm version installed is Helm3.
This action was inspired by [kubernetes-action](https://github.com/Jberlinsky/kubernetes-action).
# Instructions
This Github Action was created with EKS in mind, therefore the following example refers to it.
## Input variables
1. `plugins`: you can specify a list of Helm plugins you'd like to install and use later on in your command. eg. helm-secrets or helm-diff. This action does not support only a specific list of Helm plugins, rather any Helm plugin as long as you supply its URL. You can use the following [example](#example) as a reference.
2. `command`: your kubectl/helm command. This supports multiline as per the Github Actions workflow syntax.
example for multiline:
```yaml
...
with:
command: |
helm upgrade --install my-release chart/repo
kubectl get pods
```
## Example
```yaml
name: deploy
on:
push:
branches:
- master
- develop
jobs:
deploy:
runs-on: ubuntu-latest
env:
AWS_REGION: us-east-1
CLUSTER_NAME: my-staging
steps:
- uses: actions/checkout@v3
- name: AWS Credentials
uses: aws-actions/configure-aws-credentials@v1
with:
role-to-assume: arn:aws:iam:::role/github-actions
role-session-name: ci-run-${{ github.run_id }}
aws-region: ${{ env.AWS_REGION }}
- name: kubeconfig
run: |
aws eks update-kubeconfig --name ${{ env.CLUSTER_NAME }} --region ${{ env.AWS_REGION }} --kubeconfig ./kubeconfig
echo 'KUBE_CONFIG_DATA<> $GITHUB_ENV
echo $(cat ./kubeconfig | base64) >> $GITHUB_ENV
echo 'EOF' >> $GITHUB_ENV
- name: helm deploy
uses: koslib/helm-eks-action@master
env:
KUBE_CONFIG_DATA: ${{ env.KUBE_CONFIG_DATA }}
with:
plugins: "https://github.com/jkroepke/helm-secrets" # optional
command: helm secrets upgrade --install --wait -f
```
## Response
Use the output of your command in later steps
```yaml
steps:
- name: Get URL
id: url
uses: koslib/helm-eks-action@master
with:
command: kubectl get svc my_svc -o json | jq -r '.status.loadBalancer.ingress[0].hostname'
- name: Print Response
run: echo "Response was ${{ steps.url.outputs.response }}"
```
# Main dependencies version table
The latest version of this action uses the following dependencies versions:
| Package | Version |
| ----------- | ----------- |
| awscli | 1.24.0 |
| helm | 3.10.1 |
| kubectl | 1.25.4 |
It is very much possible that an update came out and I did not update the action on time. In this please, feel free to [send me a PR](#contributing) and I'll review it as soon as possible.
# Accessing your cluster
It is required to set the `KUBE_CONFIG_DATA` env/secret in order to access your cluster. I recommend you do it dynamically using a step like that:
```
- name: kubeconfig
run: |
aws eks update-kubeconfig --name ${{ env.CLUSTER_NAME }} --region ${{ env.AWS_REGION }} --kubeconfig ./kubeconfig
echo 'KUBE_CONFIG_DATA<> $GITHUB_ENV
echo $(cat ./kubeconfig | base64) >> $GITHUB_ENV
echo 'EOF' >> $GITHUB_ENV
```
If you find this configuration option complicated, you can still supply `KUBE_CONFIG_DATA` as a repository secret, however this is not endorsed by this repository.
# Contributing
Pull requests, issues or feedback of any kind are more than welcome by anyone!
If this action has helped you in any way and enjoyed it, feel free to submit feedback through [issues](https://github.com/koslib/helm-eks-action/issues) or buy me a coffee!
