Skip to content

Commit

Permalink
Change action name and appearance
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaferraro committed Nov 3, 2020
1 parent abc2aad commit c630608
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -38,10 +40,16 @@ jobs:
steps:
- name: Create k8s KinD Cluster
uses: container-tools/[email protected]
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).
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -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)"
Expand Down

0 comments on commit c630608

Please sign in to comment.