From 17502367f9d86092e6f1da16cbdcf166726a18a8 Mon Sep 17 00:00:00 2001 From: Dries De Peuter Date: Tue, 11 Apr 2023 10:39:07 +0200 Subject: [PATCH] fix: Add tmpl in correct location --- charts/well-known/README.md | 54 ++++++++++++++----- .../{templates => }/README.md.gotmpl | 0 2 files changed, 42 insertions(+), 12 deletions(-) rename charts/well-known/{templates => }/README.md.gotmpl (100%) diff --git a/charts/well-known/README.md b/charts/well-known/README.md index 03ee36b..ba16de8 100644 --- a/charts/well-known/README.md +++ b/charts/well-known/README.md @@ -1,22 +1,47 @@ # well-known -![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0](https://img.shields.io/badge/AppVersion-1.1.0-informational?style=flat-square) +## TL;DR; -A Helm chart for Kubernetes +```console +helm repo add k8status https://stenic.github.io/well-known/ +helm install well-known --namespace well-known well-known/well-known +``` -**Homepage:** +## Introduction -## Maintainers +This chart installs `well-known` on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. -| Name | Email | Url | -| ---- | ------ | --- | -| Stenic | | | +## Prerequisites -## Source Code +- Kubernetes 1.18+ +- Helm 3.0+ -* +## Installing the Chart -## Values +To install the chart with the release name `my-release`: + +```console +helm repo add well-known https://stenic.github.io/well-known/ +helm install well-known --namespace well-known well-known/well-known +``` + +These commands deploy well-known on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation. + +> **Tip**: List all releases using `helm list` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +helm delete my-release +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration + +The following tables list the configurable parameters of the well-known chart and their default values. | Key | Type | Default | Description | |-----|------|---------|-------------| @@ -66,5 +91,10 @@ A Helm chart for Kubernetes | webserver.resources.requests.cpu | string | `"10m"` | | | webserver.resources.requests.memory | string | `"10Mi"` | | ----------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. + +Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example, + +```console +helm install my-release -f values.yaml well-known/well-known +``` \ No newline at end of file diff --git a/charts/well-known/templates/README.md.gotmpl b/charts/well-known/README.md.gotmpl similarity index 100% rename from charts/well-known/templates/README.md.gotmpl rename to charts/well-known/README.md.gotmpl