Kubernetes Deployment Tester

This GitHub Action deploys an application using a Docker image to a Kubernetes-in-Docker (Kind) cluster and performs a simple HTTP request to verify the deployment.

Features

• Kind Cluster Setup: Automatically sets up a Kind cluster using @helm/kind-action and uses the same parameters.
• Application Deployment: Deploys your application to the Kind cluster using a Kubernetes deployment configuration.
• Testing: Executes a basic test by making an HTTP request to the deployed application.

Usage

Pre-requisites

Create a workflow YAML file in your .github/workflows directory. Example workflows are available below. For more information, see the GitHub Help Documentation for Creating a workflow file.

Inputs

Kubernetes Action Inputs

Input	Description	Required	Default
image_name	The full name of the image (format it accordingly to registry specifications).	Yes	N/A
use_local_image	Set to true to use a local Docker image with kind load docker-image, false to pull from registry. Check example workflows to see how it's used in practice.	Yes	false
cluster_config	Path to the Kind config file.	No	N/A
registry_url	The URL of the registry.	No	ghcr.io
registry_username	The username for the registry.	No	N/A
registry_token	Token or password used to connect to the specified container registry.	No	N/A
command	Command to run at container startup. Check example workflows for format.	No	N/A
args	Arguments for the command. Check example workflows for format.	No	N/A
env_vars	Environment variables in YAML format. Check example workflows for format.	No	N/A
port	The port of the application.	No	80
path	The path to test, also used for readiness and liveness probes.	No	/
timeoutSeconds	Number of seconds to wait for the pod to start.	No	20
initialDelaySeconds	Number of seconds after container start before probes are initiated.	No	5
periodSeconds	Frequency (in seconds) of the probe. Minimum value is 1.	No	10

Kind Action Inputs - check Kind Action Inputs

Input	Description	Required	Default
version	The Kind version to use.	No	v0.20.0
config	Path to the Kind config file.	No	N/A
node_image	The Docker image for the cluster nodes.	No	N/A
cluster_name	Name of the cluster to create.	No	chart-testing
wait	Duration to wait for the control plane to become ready.	No	60s
verbosity	Verbosity level for Kind.	No	0
kubectl_version	The kubectl version to use.	No	v1.26.4
install_only	Skips cluster creation, only installs Kind.	No	N/A
ignore_failed_clean	Whether to ignore post-delete cluster failures.	No	false

Example Workflows

Using the action with a local image

name: Example Workflow with local image

on: [push]

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2

    - name: Set up Docker Buildx
      uses: docker/[email protected]

    - name: Build image and load locally
      run: |
        docker buildx build \
          --file ./Dockerfile \
          --tag <repo_url>/<image_name>:<tag> \
          --load \
          .

    - name: Deploy and Test on Kind Cluster
      uses: Arv1nt3/kubernetes-deployment-tester-action@latest
      with:
        image_name: '<repo_url>/<image_name>:<tag>' # required
        use_local_image: true # required
        registry_url: 'ghcr.io' # optional
        registry_username: ${{ github.actor }} # optional
        registry_token: ${{ secrets.GITHUB_TOKEN }}  # optional
        command: 'your-command' # optional
        args: 'your-args' # optional
        env_vars: | # optional
          - name: YOUR_ENV_VAR
            value: "YourValue"
        port: '80' # optional
        path: '/'  # optional
        timeoutSeconds: '20' # optional
        initialDelaySeconds: '5' # optional
        periodSeconds: '10' # optional

This example workflow will deploy your image loaded locally to a Kind cluster and test it by making an HTTP request to the application's root path. If the request is successful, the workflow will complete successfully. If the request fails, the workflow will fail.

Using the action with a registry image

name: Example Workflow with registry image

on: [push]

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2

    - name: Build image and load locally
      run: |
        docker buildx build \
          --file ./Dockerfile \
          --tag <repo_url>/<image_name>:<tag> \
          --push \
          .

    - name: Deploy and Test on Kind Cluster
      uses: Arv1nt3/kubernetes-deployment-tester-action@latest
      with:
        image_name: '<repo_url>/<image_name>:<tag>' # required
        use_local_image: false # required
        registry_url: 'ghcr.io' # optional
        registry_username: ${{ github.actor }} # optional
        registry_token: ${{ secrets.GITHUB_TOKEN }}  # optional
        command: 'your-command' # optional
        args: 'your-args' # optional
        env_vars: | # optional
          - name: YOUR_ENV_VAR
            value: "YourValue"
        port: '80' # optional
        path: '/'  # optional
        timeoutSeconds: '20' # optional
        initialDelaySeconds: '5' # optional
        periodSeconds: '10' # optional

This example workflow will deploy your image from ghcr.io to a Kind cluster and test it by making an HTTP request to the application's root path. If the request is successful, the workflow will complete successfully. If the request fails, the workflow will fail.

Contributing

Contributions to this action are welcome! Please feel free to submit issues and pull requests. Thanks!