Skip to content

A GitHub Action for Kubernetes IN Docker - local clusters for testing Kubernetes

License

Notifications You must be signed in to change notification settings

helm/kind-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kind action

A GitHub Action for Kubernetes IN Docker - local clusters for testing Kubernetes, using kubernetes-sigs/kind.

Usage

Pre-requisites

  1. Create a workflow YAML file in your .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Inputs

For more information on inputs, see the API Documentation

  • version: The kind version to use (default: v0.5.1)
  • config: The path to the kind config file
  • node-image: The Docker image for the cluster nodes
  • name: The name of the cluster to create (default: chart-testing)
  • wait: The duration to wait for the control plane to become ready (default: 60s)
  • log-level: The log level for kind
  • install-local-path-provisioner: If true, Rancher's local-path provisioner is installed which supports dynamic volume provisioning on multi-node clusters. The newly created local-path StorageClass is made the default.

Example workflow

Create a workflow (eg: .github/workflows/create-cluster.yml):

name: Create Cluster

on: pull_request

jobs:
  create-cluster:
    runs-on: ubuntu-latest
    steps:
      - name: Create cluster
        uses: helm/kind-action@master
        with:
          installLocalPathProvisioner: true

This uses @helm/kind-action GitHub Action to spin up a kind Kubernetes cluster on every Pull Request. See @helm/chart-testing-action for a more practical example.

Code of conduct

Participation in the Helm community is governed by the Code of Conduct.