Github Action for Kubernetes deployment and rollback

This will apply a deployment using kubectl, verify the deployment and roll it back if it failed.

Thanks to @steebchen for their https://github.com/steebchen/kubectl repository which was used as a development base.

Usage

.github/workflows/push.yml

Normal deploy:

on: push
name: deploy
jobs:
  deploy:
    name: deploy to cluster
    runs-on: ubuntu-latest
    steps:
    - name: Test Deployment
      id: test-deployment
      uses: fractos/kubectl-deploy@master
      env:
        KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
        KUBECTL_VERSION: v1.14.10
        DEPLOYMENT_FILE: deployment.yml
        DEPLOYMENT_NAME: hello-world

Dry run:

on: push
name: deploy
jobs:
  deploy:
    name: deploy to cluster
    runs-on: ubuntu-latest
    steps:
    - name: Test Deployment
      id: test-deployment
      uses: fractos/kubectl-deploy@master
      env:
        KUBE_CONFIG_DATA: ${{ secrets.KUBE_CONFIG_DATA }}
        KUBECTL_VERSION: v1.14.10
        DEPLOYMENT_FILE: deployment.yml
        DEPLOYMENT_NAME: hello-world
        APPLY_FLAGS: --server-dry-run
        UNDO_FLAGS: --server-dry-run

Secrets

KUBE_CONFIG_DATA – required: A base64-encoded kubeconfig file with credentials for Kubernetes to access the cluster. You can get it by running the following command:

cat $HOME/.kube/config | base64

Environment

KUBECTL_VERSION - (optional): Used to specify the kubectl version. If not specified, this defaults to kubectl v1.13.12

DEPLOYMENT_FILE -: The name of the deployment manifest to apply.

DEPLOYMENT_NAME -: The name of the deployment itself (without the deployment/ prefix).

APPLY_FLAGS - (optional): Defaults to empty. Set to "--server-dry-run" (or the appropriate instruction for the kubectl version) to perform a dry run of the kubectl apply command.

UNDO_FLAGS - (optional): Defaults to empty. Set to "--server-dry-run" (or the appropriate instruction for the kubectl version) to perform a dry run of the kubectl rollout undo command.

ATTEMPT_ROLLBACK - (optional): Defaults to "1". Set to "0" to not attempt a rollback if failure of the deployment has been explicitly detected.