feat(common): Release version 2.0.0-beta.1 (#173)

This commit is contained in:
Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs 2023-09-13 11:24:23 +02:00 committed by GitHub
parent 19767d668c
commit 7b6ee00be6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
189 changed files with 3110 additions and 3023 deletions

View file

@ -11,8 +11,7 @@
# Helm Charts
- [Common Library](common-library/introduction.md)
- [Add-ons](common-library/add-ons/index.md)
- [code-server](common-library/add-ons/code-server/index.md)
- [Storage](common-library/storage/index.md)
- [Permissions](common-library/storage/permissions.md)
- [Storage types](common-library/storage/types.md)

View file

@ -1,47 +0,0 @@
# Code Server
The [code-server](https://github.com/cdr/code-server) add-on can be used to
access and modify persistent volume data in your application. This can be
useful when you need to edit the persistent volume data, for example with
Home Assistant.
## Example values
Below is a snippet from a `values.yaml` using the add-on. More configuration
options can be found in our common chart documentation.
```admonish note
This example will mount `/config` into the code-server sidecar.
```
```yaml
addons:
codeserver:
enabled: true
image:
repository: codercom/code-server
tag: 3.9.0
workingDir: "/config"
args:
- --auth
- "none"
- --user-data-dir
- "/config/.vscode"
- --extensions-dir
- "/config/.vscode"
ingress:
enabled: true
annotations:
kubernetes.io/ingress.class: "nginx"
hosts:
- host: app-config.domain.tld
paths:
- path: /
pathType: Prefix
tls:
- hosts:
- app-config.domain.tld
volumeMounts:
- name: config
mountPath: /config
```

View file

@ -1,5 +0,0 @@
# Common library add-ons
The common library chart supplies a few add-ons which are meant to simplify some features
you might be looking for. These are sidecars that run in the same pod as your
application you configured it with.

View file

@ -10,15 +10,14 @@ This feature allows you to set the value of that key to the output of the given
Given the following `values.yaml`
```yaml
image:
repository: k8s.gcr.io/git-sync/git-sync
tag: v3.6.2
additionalContainers:
containers:
subcleaner:
name: subcleaner
image: |-
{{ printf "%s:%s" .Values.image.repository (default .Chart.AppVersion .Values.image.tag) | quote }}
image:
repository: k8s.gcr.io/git-sync/git-sync
tag: {{.Chart.AppVersion}}
args:
- --repo=https://github.com/KBlixt/subcleaner.git
- --branch=master
@ -29,14 +28,14 @@ additionalContainers:
This would render as follows:
```yaml
image:
repository: k8s.gcr.io/git-sync/git-sync
tag: v3.6.2
additionalContainers:
containers:
subcleaner:
name: subcleaner
image: k8s.gcr.io/git-sync/git-sync:v3.6.2
image:
repository: k8s.gcr.io/git-sync/git-sync
tag: v3.6.2
args:
- --repo=https://github.com/KBlixt/subcleaner.git
- --branch=master

View file

@ -1,43 +1,31 @@
# Multiple subPaths for 1 volume
It is possible to mount multiple subPaths from the same volume to the main
It is possible to mount multiple subPaths from the same volume to a
container. This can be achieved by specifying `subPath` with a list
instead of a string.
```admonish note
It is not possible to define `mountPath` at the top level when using this
feature
```
## Examples:
```yaml
persistence:
config:
enabled: true
type: custom
volumeSpec:
configMap:
name: myData
subPath:
- path: myFirstScript.sh
mountPath: /data/myFirstScript.sh
- path: myCertificate.pem
mountPath: /certs/myCertificate.pem
readOnly: true
```
```yaml
persistence:
config:
enabled: true
type: pvc
existingClaim: myAppData
subPath:
- path: .
mountPath: /my_media
- path: Series
mountPath: /series
- path: Downloads
mountPath: /downloads
type: configMap
name: my-configMap
advancedMounts:
main: # the controller with whe "main" identifier
main: # the container with whe "main" identifier
- path: /data/config.yaml
readOnly: false
subPath: config.yaml
- path: /data/secondConfigFile.yaml
readOnly: false
subPath: secondConfigFile.yaml
second-container: # the container with whe "second-container" identifier
- path: /appdata/config
readOnly: true
second-controller: # the controller with whe "second-controller" identifier
main: # the container with whe "main" identifier
- path: /data/config.yaml
readOnly: false
subPath: config.yaml
```

View file

@ -3,7 +3,7 @@
```admonish 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.md ) for an example how to
See the [app template](../app-template/introduction.md ) for an example how to
deploy it.
```
@ -13,9 +13,9 @@ In Helm 3, their team introduced the concept of a
[Library chart](https://helm.sh/docs/topics/library_charts/).
> A library chart is a type of Helm chart that defines chart primitives or
definitions which can be shared by Helm templates in other charts. This
allows users to share snippets of code that can be re-used across charts,
avoiding repetition and keeping charts DRY.
> definitions which can be shared by Helm templates in other charts. This
> allows users to share snippets of code that can be re-used across charts,
> avoiding repetition and keeping charts DRY.
The common library was created because I saw many charts requiring only a
few select configuration options in their Helm charts.