Skip to content
This repository has been archived by the owner on Jul 13, 2023. It is now read-only.

Commit

Permalink
docs: add complex value documentation to generic chart
Browse files Browse the repository at this point in the history
  • Loading branch information
morremeyer committed Feb 19, 2022
1 parent 85fa8ea commit b60f6ae
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
2 changes: 1 addition & 1 deletion charts/generic/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
name: generic
description: A chart for generic applications. Use this if you need to deploy something without wanting to build a fully fledged new helm chart.
type: application
version: 3.0.2
version: 3.0.3
maintainers:
- name: morre
email: [email protected]
25 changes: 24 additions & 1 deletion charts/generic/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generic

![Version: 3.0.2](https://img.shields.io/badge/Version-3.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
![Version: 3.0.3](https://img.shields.io/badge/Version-3.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A chart for generic applications. Use this if you need to deploy something without wanting to build a fully fledged new helm chart.

Expand All @@ -10,6 +10,29 @@ A chart for generic applications. Use this if you need to deploy something witho
| ---- | ------ | --- |
| morre | [email protected] | |

## Complex values

### env

You can set environment variables directly with:

```yaml
env:
ENV_VARIABLE_NAME: "value"
```
### envValueFrom
This enables a simplified syntax to set envirnoment variables from a ConfigMap or Secret:
```yaml
envValueFrom:
USER:
secretKeyRef:
name: secret-name
key: user
```
## Upgrading
### To 3.0.0
Expand Down
23 changes: 23 additions & 0 deletions charts/generic/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,29 @@
{{ template "chart.sourcesSection" . }}
{{ template "chart.requirementsSection" . }}

## Complex values

### env

You can set environment variables directly with:

```yaml
env:
ENV_VARIABLE_NAME: "value"
```

### envValueFrom

This enables a simplified syntax to set envirnoment variables from a ConfigMap or Secret:

```yaml
envValueFrom:
USER:
secretKeyRef:
name: secret-name
key: user
```

## Upgrading

### To 3.0.0
Expand Down

0 comments on commit b60f6ae

Please sign in to comment.