diff --git a/README.md b/README.md index 51a37c8..8ba73ee 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -# KinD Action +# Kubernetes KinD Action [![](https://github.com/container-tools/kind-action/workflows/Test/badge.svg?branch=main)](https://github.com/container-tools/kind-action/actions) -A GitHub Action for Kubernetes IN Docker - local clusters for testing Kubernetes using [kubernetes-sigs/kind](https://kind.sigs.k8s.io/). +A GitHub Action for starting a Kubernetes cluster using [KinD](https://kind.sigs.k8s.io/). + +This action provides an optional registry on `localhost:5000` that can be used to publish and deploy container images into KinD. ## Usage @@ -38,10 +40,16 @@ jobs: steps: - name: Create k8s KinD Cluster uses: container-tools/kind-action@v1.0.0 + with: + registry: true ``` This uses [@container-tools/kind-action](https://www.github.com/container-tools/kind-action) GitHub Action to spin up a [KinD](https://kind.sigs.k8s.io/) Kubernetes cluster on every Pull Request. +The `registry: true` option also enables a container registry on `localhost:5000` on both the host and the cluster. +The registry address is stored in the `KIND_REGISTRY` environment variable, also for the subsequent steps. + + ## Credits This action leverages the good work done by the Helm community on [@helm/kind-action](https://www.github.com/helm/kind-action). diff --git a/action.yml b/action.yml index a8c1051..9846c72 100644 --- a/action.yml +++ b/action.yml @@ -1,9 +1,9 @@ -name: "KinD Cluster" -description: "Create a KinD (Kubernetes IN Docker) cluster" +name: "Kubernetes KinD Cluster" +description: "Create a KinD (Kubernetes in Docker) cluster with an optional container image registry" author: "Container Tools developers" branding: color: blue - icon: box + icon: cloud inputs: version: description: "The KinD version to use (default: v0.9.0)"