Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/helm/kind-action

A GitHub Action for Kubernetes IN Docker - local clusters for testing Kubernetes
https://github.com/helm/kind-action

actions charts ci-cd helm kind kubernetes

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/helm/kind-action
Owner: helm
License: apache-2.0
Created: 2019-11-26T21:31:28.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-06-19T02:13:26.000Z (3 months ago)
Last Synced: 2024-07-23T12:56:22.374Z (2 months ago)
Topics: actions, charts, ci-cd, helm, kind, kubernetes
Language: Shell
Homepage: https://kind.sigs.k8s.io/
Size: 15.5 MB
Stars: 290
Watchers: 10
Forks: 71
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # *Kind* Action

[![](https://github.com/helm/kind-action/workflows/Test/badge.svg?branch=main)](https://github.com/helm/kind-action/actions)

A GitHub Action for Kubernetes IN Docker - local clusters for testing Kubernetes using [kubernetes-sigs/kind](https://kind.sigs.k8s.io/).

## Usage

### Pre-requisites

Create a workflow YAML file in your `.github/workflows` directory. An [example workflow](#example-workflow) is available below.

For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).

### Inputs

For more information on inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input)

- `version`: The kind version to use (default: `v0.21.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.28.6)

- `install_only`: Skips cluster creation, only install kind (default: false)

- `ignore_failed_clean`: Whether to ignore the post delete cluster action failing (default: false)

### Example Workflow

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

```yaml

name: Create Cluster

on: pull_request

jobs:

  create-cluster:

    runs-on: ubuntu-latest

    steps:

      - name: Create k8s Kind Cluster

        uses: helm/kind-action@v1

```

This uses [@helm/kind-action](https://github.com/helm/kind-action) GitHub Action to spin up a [kind](https://kind.sigs.k8s.io/) Kubernetes cluster on every Pull Request.

See [@helm/chart-testing-action](https://github.com/helm/chart-testing-action) for a more practical example.

## Code of conduct

Participation in the Helm community is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).