public/helm-charts
1
0
Fork 0
mirror of https://github.com/bjw-s-labs/helm-charts.git synced 2025-07-03 00:27:04 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(common): Update documentation for 2.0.1

Browse source
This commit is contained in:
Bernd Schorgers 2023-10-03 09:37:11 +02:00
parent 66389dec8b
commit 0216bb1a30
No known key found for this signature in database
GPG key ID: BC5E2BD907F9A8EC
5 changed files with 203 additions and 174 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.ci/mkdocs/mkdocs.yml
View file

@ -46,6 +46,7 @@ plugins:
# Extensions
markdown_extensions:
- admonition
- pymdownx.emoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span

13
charts/library/common/README.md
View file

@ -1,6 +1,6 @@
# common
![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
Function library for Helm charts
@ -11,7 +11,7 @@ Kubernetes: `>=1.22.0-0`
## Dependencies
| Repository | Name | Version |
| ---------- | ---- | ------- |
|------------|------|---------|
## Installing the Chart
@ -27,7 +27,7 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
# Chart.yaml
dependencies:
- name: common
version: 2.0.0
version: 2.0.1
repository: https://bjw-s.github.io/helm-charts/
```
@ -47,7 +47,7 @@ The following table contains an overview of available values and their descripti
<summary>Expand</summary>
| Key | Type | Default | Description |
| --------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|-----|------|---------|-------------|
| configMaps | object | See below | Configure configMaps for the chart here. Additional configMaps can be added by adding a dictionary key similar to the 'config' object. |
| configMaps.config.annotations | object | `{}` | Annotations to add to the configMap |
| configMaps.config.data | object | `{}` | configMap data content. Helm template enabled. |
@ -161,7 +161,7 @@ The following table contains an overview of available values and their descripti
| persistence.config.retain | bool | `false` | Set to true to retain the PVC upon `helm uninstall` |
| persistence.config.size | string | `"1Gi"` | The amount of storage that is requested for the persistent volume. |
| persistence.config.storageClass | string | `nil` | Storage Class for the config volume. If set to `-`, dynamic provisioning is disabled. If set to something else, the given storageClass is used. If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. |
| persistence.config.type | string | `"persistentVolumeClaim"` | Sets the persistence type Valid options are persistentVolumeClaim, emptyDir, hostPath, secret, configMap or custom |
| persistence.config.type | string | `"persistentVolumeClaim"` | Sets the persistence type Valid options are persistentVolumeClaim, emptyDir, nfs, hostPath, secret, configMap or custom |
| route | object | See below | Configure the gateway routes for the chart here. Additional routes can be added by adding a dictionary key similar to the 'main' route. [[ref]](https://gateway-api.sigs.k8s.io/references/spec/) |
| route.main.annotations | object | `{}` | Provide additional annotations which may be required. |
| route.main.enabled | bool | `false` | Enables or disables the route |
@ -217,6 +217,5 @@ The following table contains an overview of available values and their descripti
- Open an [issue](https://github.com/bjw-s/helm-charts/issues/new/choose)
- Join the k8s-at-home [Discord](https://discord.gg/k8s-at-home) community
---
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

24
charts/other/app-template/README.md
View file

@ -1,6 +1,6 @@
# app-template
![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square)
![Version: 2.0.1](https://img.shields.io/badge/Version-2.0.1-informational?style=flat-square)
A common powered chart template. This can be useful for small projects that don't have their own chart.
@ -11,8 +11,8 @@ Kubernetes: `>=1.22.0-0`
## Dependencies
| Repository | Name | Version |
| ----------------------------------- | ------ | ------- |
| https://bjw-s.github.io/helm-charts | common | 2.0.0 |
|------------|------|---------|
| https://bjw-s.github.io/helm-charts | common | 2.0.1 |
## Installing the Chart
@ -33,6 +33,9 @@ The [CI tests](../../library/common-test/ci) contain a number of scenarios that
### From 1.x.x to 2.0.x
> :warning: **IMPORTANT** Because a new label has been introduced in the controller labelSelector (which is an immutable field), Deployments cannot be upgraded in place!
> [More details](https://www.datree.io/resources/kubernetes-error-codes-field-is-immutable)
Given the following real-life example values.yaml for app-template v1:
<details>
@ -62,6 +65,10 @@ ingress:
main:
enabled: true
ingressClassName: "ingress-nginx"
hosts:
- host: sabnzbd.bjw-s.dev
paths:
- path: /
persistence:
media:
@ -119,6 +126,13 @@ ingress:
main:
enabled: true
className: "ingress-nginx"
hosts:
- host: sabnzbd.bjw-s.dev
paths:
- path: /
service:
name: main
port: http
persistence:
media:
@ -135,6 +149,7 @@ This is not meant as an exhaustive list of changes, but rather a "most common" e
- `image` has been moved to `controllers.main.containers.main.image` so that multiple containers can be configured.
- `ingress.main.ingressClassName` has been renamed to `ingress.main.className`.
- `ingress.main.enabled` can be removed, since items are considered enabled by default (they can still be disabled by adding `enabled: false`).
- `ingress.main.hosts.*.paths.*.service` is now required since there is no more concept of a default "primary" service.
- `persistence.media.mountPath` has been moved to `persistence.media.globalMounts.*.path` to allow multiple mountPaths for the same persistence item.
- `persistence.media.enabled` can be removed, since items are considered enabled by default (they can still be disabled by adding `enabled: false`).
- `probes` has been moved to `controllers.main.containers.main.probes` so that multiple containers can be configured.
@ -145,6 +160,5 @@ This is not meant as an exhaustive list of changes, but rather a "most common" e
- Open an [issue](https://github.com/bjw-s/helm-charts/issues/new/choose)
- Join the k8s-at-home [Discord](https://discord.gg/k8s-at-home) community
---
----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

15
charts/other/app-template/README.md.gotmpl
View file

@ -37,6 +37,9 @@ The [CI tests](../../library/common-test/ci) contain a number of scenarios that
### From 1.x.x to 2.0.x
> :warning: **IMPORTANT** Because a new label has been introduced in the controller labelSelector (which is an immutable field), Deployments cannot be upgraded in place!
> [More details](https://www.datree.io/resources/kubernetes-error-codes-field-is-immutable)
Given the following real-life example values.yaml for app-template v1:
<details>
@ -66,6 +69,10 @@ ingress:
main:
enabled: true
ingressClassName: "ingress-nginx"
hosts:
- host: sabnzbd.bjw-s.dev
paths:
- path: /
persistence:
media:
@ -123,6 +130,13 @@ ingress:
main:
enabled: true
className: "ingress-nginx"
hosts:
- host: sabnzbd.bjw-s.dev
paths:
- path: /
service:
name: main
port: http
persistence:
media:
@ -139,6 +153,7 @@ This is not meant as an exhaustive list of changes, but rather a "most common" e
- `image` has been moved to `controllers.main.containers.main.image` so that multiple containers can be configured.
- `ingress.main.ingressClassName` has been renamed to `ingress.main.className`.
- `ingress.main.enabled` can be removed, since items are considered enabled by default (they can still be disabled by adding `enabled: false`).
- `ingress.main.hosts.*.paths.*.service` is now required since there is no more concept of a default "primary" service.
- `persistence.media.mountPath` has been moved to `persistence.media.globalMounts.*.path` to allow multiple mountPaths for the same persistence item.
- `persistence.media.enabled` can be removed, since items are considered enabled by default (they can still be disabled by adding `enabled: false`).
- `probes` has been moved to `controllers.main.containers.main.probes` so that multiple containers can be configured.

2
docs/app-template/index.md
View file

@ -32,7 +32,7 @@ examples/helm/values.yaml
## Upgrade instructions
--8<-- "charts/other/app-template/README.md:34:141"
--8<-- "charts/other/app-template/README.md:34:155"
## Source code