Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
box

GitHub Action

Kind Cluster

v1.5.0

Kind Cluster

box

Kind Cluster

Create a kind (Kubernetes IN Docker) cluster

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Kind Cluster

uses: helm/kind-action@v1.5.0

Learn more about this action in helm/kind-action

Choose a version

Kind Action

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

Usage

Pre-requisites

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.17.0)
  • config: The path to the kind config file
  • node_image: The Docker image for the cluster nodes
  • cluster_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)
  • verbosity: info log verbosity, higher value produces more output
  • kubectl_version: The kubectl version to use (default: v1.23.12)
  • install_only: Skips cluster creation, only install kind (default: false)

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 k8s Kind Cluster
        uses: helm/kind-action@v1.4.0

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.