kubectl-aws-eks
ActionsTags
(2)This action provides a Docker container with kubectl, aws-cli, and aws-iam-authenticator pre-installed for GitHub Actions workflows. It's specifically designed for managing Kubernetes clusters on AWS EKS (Elastic Kubernetes Service).
This container includes:
- AWS CLI (latest version)
- kubectl (configurable version)
- aws-iam-authenticator (configurable version)
It allows you to easily run kubectl commands against your AWS EKS clusters directly from your GitHub Actions workflows.
Create a workflow file (e.g., .github/workflows/deploy.yml):
name: Deploy to EKS
on: push
jobs:
deploy:
name: Deploy to EKS cluster
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-2
- name: Login to Amazon ECR
id: login-ecr
uses: aws-actions/amazon-ecr-login@v1
- name: Deploy to EKS cluster
uses: kodermax/kubectl-aws-eks@v1
env:
KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
ECR_REPOSITORY: my-app
IMAGE_TAG: ${{ github.sha }}
with:
args: set image deployment/$ECR_REPOSITORY $ECR_REPOSITORY=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
- name: Verify deployment
uses: kodermax/kubectl-aws-eks@v1
env:
KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
with:
args: rollout status deployment/my-appA base64-encoded kubeconfig file with credentials for Kubernetes to access the cluster. You can generate this using:
cat $HOME/.kube/config | base64$base64Data = [Convert]::ToBase64String([IO.File]::ReadAllBytes("$env:USERPROFILE\.kube\config"))
Write-Output $base64DataImportant Security Note: Before encoding your kubeconfig, ensure it doesn't contain an
AWS_PROFILEsection. If present, remove the following section:env: - name: AWS_PROFILE value: github-actions
By default, this action uses the latest stable version of kubectl. To use a specific version:
- name: Deploy to EKS cluster
uses: kodermax/kubectl-aws-eks@v1
env:
KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
ECR_REPOSITORY: my-app
IMAGE_TAG: ${{ github.sha }}
KUBECTL_VERSION: "v1.27.3"
with:
args: set image deployment/$ECR_REPOSITORY $ECR_REPOSITORY=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAGBy default, this action uses the latest version of aws-iam-authenticator. To use a specific version:
- name: Deploy to EKS cluster
uses: kodermax/kubectl-aws-eks@v1
env:
KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
ECR_REPOSITORY: my-app
IMAGE_TAG: ${{ github.sha }}
IAM_VERSION: "0.6.2"
with:
args: set image deployment/$ECR_REPOSITORY $ECR_REPOSITORY=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAGThis example shows how to use the action as a service to forward a port from a Kubernetes service to your GitHub Actions runner, allowing database migrations to be applied:
name: Deploy Database Migrations
on:
pull_request:
branches: [main]
paths:
- 'packages/database/**'
jobs:
deploy:
runs-on: ubuntu-latest
services:
db:
image: kodermax/kubectl-aws-eks:latest
env:
KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA_TEST }}
RUN_COMMAND: port-forward svc/postgresql-1697720510 5432:5432 --address='0.0.0.0'
ports:
- 5432:5432/tcp
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: pnpm/action-setup@v2
with:
version: 8
- name: Install dependencies
run: pnpm install
- name: Apply all pending migrations to the database
env:
DATABASE_URL: ${{ secrets.TEST_DATABASE_URL }}
run: pnpm db-deployYou can run any kubectl command by passing it as the args parameter:
- name: Get pod information
uses: kodermax/kubectl-aws-eks@v1
env:
KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
with:
args: get pods -n my-namespace- name: Apply Kubernetes manifests
uses: kodermax/kubectl-aws-eks@v1
env:
KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
with:
args: apply -f ./kubernetes/manifests/-
Authentication Errors: Ensure your KUBE_CONFIG_DATA is correctly base64 encoded and contains valid credentials.
-
Version Compatibility: If you encounter compatibility issues, try specifying explicit versions for kubectl and aws-iam-authenticator.
-
Permission Issues: Verify that the service account in your kubeconfig has the necessary permissions to perform the actions in your workflow.
-
Store your KUBE_CONFIG_DATA as a GitHub secret, never hardcode it in your workflow files.
-
Use the principle of least privilege when configuring your kubeconfig file.
-
Consider using short-lived credentials or service accounts with limited permissions.
-
Regularly rotate your credentials and audit your GitHub Actions workflows.
kubectl-aws-eks is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)kubectl-aws-eks is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.