Skip to content

Commit 038361f

Browse files
committed
update common docs
1 parent 8837f23 commit 038361f

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

charts/common/README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,18 @@ The `common` chart is a library of common resources that are shared across all o
1313
The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
1414

1515
1. Looks for `keyOverride` in the chart's values.yaml
16-
2. Looks for `global.key` in the chart's values.yaml
17-
3. Uses the `common.defaults.key` value from the table below.
16+
2. Looks for `global.key` in the chart's or parent chart's values.yaml
17+
3. Uses the `key` in the chart's values.yaml
18+
4. Uses the `common.defaults.key` value from the table below.
1819

19-
1 has precendence over 2 over 3 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
20+
1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
2021

2122
Example
2223
```
23-
1) .Values.deployment.resources.limits.memoryOveride = 2048MB
24-
2) .Values.global.deployment.resources.limits.memory = 1024MB
25-
3) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
24+
1) .Values.deployment.resources.limits.memoryOveride = 4096MB
25+
2) .Values.global.deployment.resources.limits.memory = 2048MB
26+
3) .Values.deployment.resources.limits.memory = 1024MB
27+
4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
2628
```
2729

2830
| Key | Type | Default | Description |

charts/common/README.md.gotmpl

+8-6
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,18 @@ The `common` chart is a library of common resources that are shared across all o
1414
The values in the `defaults:` section can be reused from other charts by using the lookup function "common.getKeyValue". It implements lookup on three levels:
1515

1616
1. Looks for `keyOverride` in the chart's values.yaml
17-
2. Looks for `global.key` in the chart's values.yaml
18-
3. Uses the `common.defaults.key` value from the table below.
17+
2. Looks for `global.key` in the chart's or parent chart's values.yaml
18+
3. Uses the `key` in the chart's values.yaml
19+
4. Uses the `common.defaults.key` value from the table below.
1920

20-
1 has precendence over 2 over 3 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
21+
1 has precendence over 2 over 3 over 4 respectively. This approach allows for individual charts to have minimal configuration, while still being able to override parameters locally.
2122

2223
Example
2324
```
24-
1) .Values.deployment.resources.limits.memoryOveride = 2048MB
25-
2) .Values.global.deployment.resources.limits.memory = 1024MB
26-
3) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
25+
1) .Values.deployment.resources.limits.memoryOveride = 4096MB
26+
2) .Values.global.deployment.resources.limits.memory = 2048MB
27+
3) .Values.deployment.resources.limits.memory = 1024MB
28+
4) .Values.common.defaults.deployment.resources.limits.memory = default 512MB
2729
```
2830

2931
{{ template "chart.valuesTable" . }}

0 commit comments

Comments
 (0)