Skip to content

Commit b62e0e1

Browse files
committed
[common] Update documentation
1 parent db7f501 commit b62e0e1

File tree

6 files changed

+36
-33
lines changed

6 files changed

+36
-33
lines changed

charts/stable/common/Chart.yaml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
apiVersion: v2
22
name: common
3-
description: Function library for k8s-at-home charts
3+
description: Function library for k8s-home-lab charts
44
type: library
5-
version: 4.5.3
5+
version: 4.5.4
66
kubeVersion: ">=1.32.0"
77
keywords:
88
- k8s-at-home
@@ -15,6 +15,4 @@ maintainers:
1515
annotations:
1616
artifacthub.io/changes: |
1717
- kind: changed
18-
description: Switch to k8s-home-lab org
19-
- kind: changed
20-
description: Fixed global values access
18+
description: Fix documentation

charts/stable/common/README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# common
22

3-
![Version: 4.5.2](https://img.shields.io/badge/Version-4.5.2-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
3+
![Version: 4.5.4](https://img.shields.io/badge/Version-4.5.4-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
44

5-
Function library for k8s-at-home charts
5+
Function library for k8s-home-lab charts
66

7-
Since a lot of the k8s-at-home charts follow a similar pattern, this library was built to reduce maintenance cost between the charts that use it and try achieve a goal of being DRY.
7+
Since a lot of the k8s-home-lab charts follow a similar pattern, this library was built to reduce maintenance cost between the charts that use it and try achieve a goal of being DRY.
88

99
## Requirements
1010

@@ -29,11 +29,11 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
2929
# Chart.yaml
3030
dependencies:
3131
- name: common
32-
version: 4.5.1
33-
repository: https://k8s-at-home.com/charts/
32+
version: 4.5.4
33+
repository: https://k8s-home-lab.github.io/helm-charts/
3434
```
3535
36-
For more information, take a look at the [Docs](http://docs.k8s-at-home.com/our-helm-charts/common-library/).
36+
For more information, take a look at the [README](https://github.com/k8s-home-lab/helm-charts/blob/master/charts/stable/common/README.md).
3737
3838
## Configuration
3939
@@ -45,13 +45,13 @@ N/A
4545
4646
## Values
4747
48-
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
48+
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-home-lab/helm-charts/tree/master/charts/stable/common)
4949
5050
| Key | Type | Default | Description |
5151
|-----|------|---------|-------------|
5252
| additionalContainers | object | `{}` | Specify any additional containers here as dictionary items. Each additional container should have its own key. Helm templates can be used. |
5353
| addons | object | See below | The common chart supports several add-ons. These can be configured under this key. |
54-
| addons.codeserver | object | See values.yaml | The common library supports adding a code-server add-on to access files. It can be configured under this key. For more info, check out [our docs](http://docs.k8s-at-home.com/our-helm-charts/common-library-add-ons/#code-server) |
54+
| addons.codeserver | object | See values.yaml | The common library supports adding a code-server add-on to access files. It can be configured under this key. |
5555
| addons.codeserver.args | list | `["--auth","none"]` | Set codeserver command line arguments. Consider setting --user-data-dir to a persistent location to preserve code-server setting changes |
5656
| addons.codeserver.enabled | bool | `false` | Enable running a code-server container in the pod |
5757
| addons.codeserver.env | object | `{}` | Set any environment variables for code-server here |
@@ -83,7 +83,7 @@ N/A
8383
| addons.promtail.logs | list | `[]` | The paths to logs on the volume |
8484
| addons.promtail.loki | string | `""` | The URL to Loki |
8585
| addons.promtail.volumeMounts | list | `[]` | Specify a list of volumes that get mounted in the promtail container. At least 1 volumeMount is required! |
86-
| addons.vpn | object | See values.yaml | The common chart supports adding a VPN add-on. It can be configured under this key. For more info, check out [our docs](http://docs.k8s-at-home.com/our-helm-charts/common-library-add-ons/#wireguard-vpn) |
86+
| addons.vpn | object | See values.yaml | The common chart supports adding a VPN add-on. It can be configured under this key. |
8787
| addons.vpn.args | list | `[]` | Override the args for the vpn sidecar container |
8888
| addons.vpn.configFile | string | `nil` | Provide a customized vpn configuration file to be used by the VPN. |
8989
| addons.vpn.configFileSecret | string | `nil` | Reference an existing secret that contains the VPN configuration file The chart expects it to be present under the `vpnConfigfile` key. |
@@ -165,7 +165,7 @@ N/A
165165
| initContainers | object | `{}` | Specify any initContainers here as dictionary items. Each initContainer should have its own key. The dictionary item key will determine the order. Helm templates can be used. |
166166
| lifecycle | object | `{}` | Configure the lifecycle for the main container |
167167
| nodeSelector | object | `{}` | Node selection constraint [[ref]](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) |
168-
| persistence | object | See below | Configure persistence for the chart here. Additional items can be added by adding a dictionary key similar to the 'config' key. [[ref]](http://docs.k8s-at-home.com/our-helm-charts/common-library-storage) |
168+
| persistence | object | See below | Configure persistence for the chart here. Additional items can be added by adding a dictionary key similar to the 'config' key. |
169169
| persistence.config | object | See below | Default persistence for configuration files. |
170170
| persistence.config.accessMode | string | `"ReadWriteOnce"` | AccessMode for the persistent volume. Make sure to select an access mode that is supported by your storage provider! [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) |
171171
| persistence.config.enabled | bool | `false` | Enables or disables the persistence item |
@@ -237,6 +237,12 @@ All notable changes to this library Helm chart will be documented in this file.
237237
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
238238
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
239239

240+
### [4.5.4]
241+
242+
#### Fixed
243+
244+
- Fixed global variable merging
245+
240246
### [4.5.2]
241247

242248
#### Fixed
@@ -563,10 +569,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
563569

564570
## Support
565571

566-
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
567-
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
568-
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
569-
- Join our [Discord](https://discord.gg/sTMX7Vh) community
570-
572+
- Open an [issue](https://github.com/k8s-home-lab/helm-charts/issues/new/choose)
571573
----------------------------------------------
572-
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
574+
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)

charts/stable/common/README.md.gotmpl

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{{- define "custom.repository.organization" -}}
2-
k8s-at-home
2+
k8s-home-lab
33
{{- end -}}
44

55
{{- define "custom.repository.url" -}}
6-
https://github.com/k8s-at-home/charts
6+
https://github.com/k8s-home-lab/helm-charts
77
{{- end -}}
88

99
{{- define "custom.helm.url" -}}
10-
https://k8s-at-home.com/charts/
10+
https://k8s-home-lab.github.io/helm-charts/
1111
{{- end -}}
1212

1313
{{- define "custom.helm.path" -}}
@@ -51,18 +51,16 @@ Read through the [values.yaml](./values.yaml) file. It has several commented out
5151
{{- define "custom.valuesSection" -}}
5252
## Values
5353

54-
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
54+
**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-home-lab/helm-charts/tree/master/charts/stable/common)
5555

5656
{{ template "chart.valuesTable" . }}
5757
{{- end -}}
5858

5959
{{- define "custom.support" -}}
6060
## Support
6161

62-
- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
63-
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
64-
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
65-
- Join our [Discord](https://discord.gg/sTMX7Vh) community
62+
- See the [Docs](https://github.com/k8s-home-lab/helm-charts/blob/master/charts/stable/common/README.md)
63+
- Open an [issue](https://github.com/k8s-home-lab/helm-charts/issues/new/choose)
6664
{{- end -}}
6765

6866
{{ template "chart.header" . }}

charts/stable/common/README_CHANGELOG.md.gotmpl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ All notable changes to this library Helm chart will be documented in this file.
1010
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
1111
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
1212

13+
### [4.5.4]
14+
15+
#### Fixed
16+
17+
- Fixed global variable merging
18+
1319
### [4.5.2]
1420

1521
#### Fixed

charts/stable/common/README_CONFIG.md.gotmpl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,4 @@ dependencies:
2525
repository: {{ template "custom.helm.url" }}
2626
```
2727

28-
For more information, take a look at the [Docs](http://docs.k8s-at-home.com/our-helm-charts/common-library/).
2928
{{- end -}}

charts/stable/common/values.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ ingress:
357357

358358
# -- Configure persistence for the chart here.
359359
# Additional items can be added by adding a dictionary key similar to the 'config' key.
360-
# [[ref]](http://docs.k8s-at-home.com/our-helm-charts/common-library-storage)
360+
# [[ref]](https://github.com/k8s-home-lab/helm-charts/blob/master/charts/stable/common/README.md)
361361
# @default -- See below
362362
persistence:
363363
# -- Default persistence for configuration files.
@@ -477,7 +477,7 @@ resources: {}
477477
addons:
478478

479479
# -- The common chart supports adding a VPN add-on. It can be configured under this key.
480-
# For more info, check out [our docs](http://docs.k8s-at-home.com/our-helm-charts/common-library-add-ons/#wireguard-vpn)
480+
# For more info, check out [our docs](https://github.com/k8s-home-lab/helm-charts/blob/master/charts/stable/common/README.md)
481481
# @default -- See values.yaml
482482
vpn:
483483
# -- Enable running a VPN in the pod to route traffic through a VPN
@@ -609,7 +609,7 @@ addons:
609609
# protocol: TCP
610610

611611
# -- The common library supports adding a code-server add-on to access files. It can be configured under this key.
612-
# For more info, check out [our docs](http://docs.k8s-at-home.com/our-helm-charts/common-library-add-ons/#code-server)
612+
# For more info, check out [our docs](https://github.com/k8s-home-lab/helm-charts/blob/master/charts/stable/common/README.md)
613613
# @default -- See values.yaml
614614
codeserver:
615615
# -- Enable running a code-server container in the pod

0 commit comments

Comments
 (0)