fix: Add tmpl in correct location
This commit is contained in:
parent
da4a2dda72
commit
17502367f9
2 changed files with 42 additions and 12 deletions
|
@ -1,22 +1,47 @@
|
||||||
# well-known
|
# 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:** <https://github.com/stenic/well-known/tree/main/charts/well-known>
|
## 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 |
|
## Prerequisites
|
||||||
| ---- | ------ | --- |
|
|
||||||
| Stenic | <dries@stenic.io> | |
|
|
||||||
|
|
||||||
## Source Code
|
- Kubernetes 1.18+
|
||||||
|
- Helm 3.0+
|
||||||
|
|
||||||
* <https://github.com/stenic/well-known>
|
## 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 |
|
| Key | Type | Default | Description |
|
||||||
|-----|------|---------|-------------|
|
|-----|------|---------|-------------|
|
||||||
|
@ -66,5 +91,10 @@ A Helm chart for Kubernetes
|
||||||
| webserver.resources.requests.cpu | string | `"10m"` | |
|
| webserver.resources.requests.cpu | string | `"10m"` | |
|
||||||
| webserver.resources.requests.memory | string | `"10Mi"` | |
|
| webserver.resources.requests.memory | string | `"10Mi"` | |
|
||||||
|
|
||||||
----------------------------------------------
|
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||||||
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
|
|
||||||
|
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
|
||||||
|
```
|
Loading…
Reference in a new issue