docs: Documentation updates

This commit is contained in:
Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs 2022-08-09 10:34:13 +02:00
parent 6a2bee4036
commit 2cf1c54473
No known key found for this signature in database
GPG key ID: BC5E2BD907F9A8EC
7 changed files with 340 additions and 1 deletions

View file

@ -0,0 +1,56 @@
# App Template
## Background
Since Helm [library charts](https://helm.sh/docs/topics/library_charts/) cannot be
installed directly I have created a companion chart for the [common library](../../common-library/introduction).
## Usage
In order to use this template chart, you would deploy it as you would any other Helm chart.
By setting the desired values, the common library chart will render the desired resources.
Be sure to check out the [common library docs](../../common-library/introduction)
and its [`values.yaml`](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common/values.yaml) for
more information about the available configuration options.
#### Example
This is an example `values.yaml` file that would deploy the [echo-server](https://github.com/jmalloc/echo-server)
application.
```yaml
image:
repository: docker.io/jmalloc/echo-server
tag: 0.3.3
service:
main:
ports:
http:
port: 8080
ingress:
main:
enabled: true
ingressClassName: "nginx"
hosts:
- host: &host "echo-server.${INGRESS_DOMAIN}"
paths:
- path: /
tls:
- hosts:
- *host
resources:
requests:
cpu: 15m
memory: 64M
limits:
memory: 128M
```
## Source code
The source code for the app template chart can be found
[here](https://github.com/bjw-s/helm-charts/tree/main/charts/other/app-template).

View file

@ -3,6 +3,8 @@
!!! note
The Common library chart is not meant to be installed directly, application
charts use the Common library as a dependency.
See the [app template](../../app-template/introduction) for an example how to
deploy it.
## Background

View file

@ -14,7 +14,7 @@ Refer to Helm's [documentation](https://helm.sh/docs/) to get started.
helm repo add bjw-s http://bjw-s.github.io/helm-charts/
```
You can then run `helm search repo bjw-s` to see the charts.
You can then run `helm search repo bjw-s` to search the charts.
## How do I find people running Kubernetes at home?