Skip to content

Commit 9669a12

Browse files
docs(cf-common): upd values (#2)
* upd readme * bump version * upd docs
1 parent 39f4126 commit 9669a12

File tree

3 files changed

+17
-24
lines changed

3 files changed

+17
-24
lines changed

charts/cf-common/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
appVersion: v0.0.0
33
description: Codefresh library chart
44
name: cf-common
5-
version: 0.0.1
5+
version: 0.0.2
66
type: library
77
keywords:
88
- codefresh

charts/cf-common/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Codefresh library chart
44

5-
![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
5+
![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
66

77
## Installing the Chart
88

@@ -18,7 +18,7 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
1818
# Chart.yaml
1919
dependencies:
2020
- name: cf-common
21-
version: 0.0.1
21+
version: 0.0.2
2222
repository: https://chartmuseum.codefresh.io/cf-common
2323
```
2424
@@ -43,13 +43,12 @@ dependencies:
4343
| configMaps.config.data | object | `{}` | ConfigMap data content. |
4444
| configMaps.config.enabled | bool | `false` | Enable the configMap |
4545
| configMaps.config.labels | object | `{}` | Add additional labels to the configMap |
46-
| container | object | `{"args":[],"command":[],"containerSecurityContext":{},"env":{},"envFrom":[],"extraEnvVars":null,"image":{"pullPolicy":null,"registry":null,"repository":null,"tag":null},"lifecycle":{},"probes":{"liveness":{"enabled":false,"exec":{"command":[]},"httpGet":{"path":null,"port":null},"spec":{"failureThreshold":null,"initialDelaySeconds":null,"periodSeconds":null,"successThreshold":null,"timeoutSeconds":null},"type":null},"readiness":{"enabled":false},"startup":{"enabled":false}},"resources":{"limits":{},"requests":{}},"volumeMounts":{}}` | Main Container parameters |
46+
| container | object | `{"args":[],"command":[],"containerSecurityContext":{},"env":{},"envFrom":[],"image":{"pullPolicy":null,"registry":null,"repository":null,"tag":null},"lifecycle":{},"probes":{"liveness":{"enabled":false,"exec":{"command":[]},"httpGet":{"path":null,"port":null},"spec":{"failureThreshold":null,"initialDelaySeconds":null,"periodSeconds":null,"successThreshold":null,"timeoutSeconds":null},"type":null},"readiness":{"enabled":false},"startup":{"enabled":false}},"resources":{"limits":{},"requests":{}},"volumeMounts":{}}` | Main Container parameters |
4747
| container.args | list | `[]` | Override args for the container |
4848
| container.command | list | `[]` | Override commands for the container |
4949
| container.containerSecurityContext | object | `{}` | Set security context for container |
50-
| container.env | object | `{}` | Set environments variables |
50+
| container.env | object | `{}` | Set environments variables. Helm template supported. |
5151
| container.envFrom | list | `[]` | Set Secrets or ConfigMaps loaded as environment variables. |
52-
| container.extraEnvVars | string | `nil` | Set additional environment variables. Helm template supported. Passed through `tpl`, should be configured as string |
5352
| container.image | object | `{"pullPolicy":null,"registry":null,"repository":null,"tag":null}` | Image parameters |
5453
| container.image.pullPolicy | string | `nil` | Set image pull policy (`Always`, `Never`, `IfNotPresent`) |
5554
| container.image.registry | string | `nil` | Set image registry |
@@ -102,7 +101,7 @@ dependencies:
102101
| secrets.secret.annotation | object | `{}` | Add additional annotations to the secret |
103102
| secrets.secret.enabled | bool | `false` | Enable the secret |
104103
| secrets.secret.labels | object | `{}` | Add additional labels to the secret |
105-
| secrets.secret.stringData | object | `{}` | Secret data content. Plain text |
104+
| secrets.secret.stringData | object | `{}` | Secret data content. Plain text (not base64). Helm template supported. Passed through `tpl`, should be configured as string |
106105
| secrets.secret.type | string | `"Opaque"` | Set secret type (`Opaque`/`kubernetes.io/tls`) |
107106
| services | object | `{"main":{"annotations":{},"enabled":false,"extraSelectorLabels":{},"labels":{},"ports":{"http":{"port":null,"protocol":"HTTP","targetPort":null}},"primary":true,"type":"ClusterIP"}}` | Configure services fo the chart. Additional services can be added by adding a dictionary key similar to the 'main' service. |
108107
| services.main | object | `{"annotations":{},"enabled":false,"extraSelectorLabels":{},"labels":{},"ports":{"http":{"port":null,"protocol":"HTTP","targetPort":null}},"primary":true,"type":"ClusterIP"}` | Service name |

charts/cf-common/values.yaml

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,12 @@ container:
6060
# -- Override args for the container
6161
args: []
6262

63-
# -- Set environments variables
63+
# -- Set environments variables. Helm template supported.
6464
env: {}
65+
# E.g.
66+
# env:
67+
# ALICE: BOB
68+
# FOO: "{{ .Valies.config.foo }}"
6569
# -- Set Secrets or ConfigMaps loaded as environment variables.
6670
envFrom: []
6771
# E.g.
@@ -71,19 +75,6 @@ container:
7175
# - configMapRef:
7276
# name: my-config-map
7377

74-
# -- Set additional environment variables.
75-
# Helm template supported. Passed through `tpl`, should be configured as string
76-
extraEnvVars:
77-
# E.g.
78-
# extraEnvVars: |
79-
# - name: ALICE
80-
# valueFrom:
81-
# secretKeyRef:
82-
# name: "{{ .Release.Name }}-{{ $.Values.global.somekey }}"
83-
# key: alice
84-
# - name: FOO
85-
# value: "{{ .Values.config.foo }}"
86-
8778
# -- Set volume mounts for container
8879
volumeMounts: {}
8980

@@ -185,14 +176,17 @@ secrets:
185176
annotation: {}
186177
# -- Set secret type (`Opaque`/`kubernetes.io/tls`)
187178
type: Opaque
188-
# -- Secret data content. Plain text
179+
# -- Secret data content. Plain text (not base64). Helm template supported. Passed through `tpl`, should be configured as string
189180
stringData: {}
190-
# foo: bar
191-
# Helm template supported. Passed through `tpl`, should be configured as string
181+
# stringData:
182+
# FOO: BAR
192183
# E.g.
193184
# stringData: |
194185
# FOO: "{{ .Values.global.foo }}"
195186
# BAR: "{{ .Values.global.bar }}"
187+
# {{- if .Values.global.something }}
188+
# ALICE: value
189+
# {{- end }}
196190
data: {}
197191
# -- Secret data content. Should be passed as base64 encoded text
198192
# Helm template NOT supported.

0 commit comments

Comments
 (0)