Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable helm-tool linter and schema generator #80

Merged
merged 2 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 80 additions & 4 deletions deploy/charts/csi-driver-spiffe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,59 @@

<!-- AUTO-GENERATED -->

#### **image.registry** ~ `string`

Target image registry. This value is prepended to the target image repository, if set.
For example:

```yaml
registry: quay.io
repository:
driver: jetstack/cert-manager-csi-driver-spiffe
approver: jetstack/cert-manager-csi-driver-spiffe-approver
```

#### **image.repository.driver** ~ `string`
> Default value:
> ```yaml
> quay.io/jetstack/cert-manager-csi-driver-spiffe
> ```

Target image repository for the csi-driver driver DaemonSet.
#### **image.repository.approver** ~ `string`
> Default value:
> ```yaml
> quay.io/jetstack/cert-manager-csi-driver-spiffe-approver
> ```

Target image repository for the csi-driver approver Deployment.
#### **image.tag** ~ `string`

Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.

#### **image.digest** ~ `object`
> Default value:
> ```yaml
> v0.0.0
> {}
> ```
#### **image.digest.driver** ~ `string`

Target csi-driver driver digest. Override any tag, if set.
For example:

```yaml
driver: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20
```

#### **image.digest.approver** ~ `string`

Target csi-driver approver digest. Override any tag, if set.
For example:

```yaml
approver: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20
```

Target image version tag.
#### **image.pullPolicy** ~ `string`
> Default value:
> ```yaml
Expand Down Expand Up @@ -191,6 +227,16 @@ resources:
cpu: 100m
memory: 128Mi
```
#### **app.driver.nodeDriverRegistrarImage.registry** ~ `string`

Target image registry. This value is prepended to the target image repository, if set.
For example:

```yaml
registry: registry.k8s.io
repository: sig-storage/csi-node-driver-registrar
```

#### **app.driver.nodeDriverRegistrarImage.repository** ~ `string`
> Default value:
> ```yaml
Expand All @@ -204,14 +250,34 @@ Target image repository.
> v2.10.0
> ```

Target image version tag.
Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.

#### **app.driver.nodeDriverRegistrarImage.digest** ~ `string`

Target image digest. Override any tag, if set.
For example:

```yaml
digest: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20
```

#### **app.driver.nodeDriverRegistrarImage.pullPolicy** ~ `string`
> Default value:
> ```yaml
> IfNotPresent
> ```

Kubernetes imagePullPolicy on node-driver.
#### **app.driver.livenessProbeImage.registry** ~ `string`

Target image registry. This value is prepended to the target image repository, if set.
For example:

```yaml
registry: registry.k8s.io
repository: sig-storage/livenessprobe
```

#### **app.driver.livenessProbeImage.repository** ~ `string`
> Default value:
> ```yaml
Expand All @@ -225,7 +291,17 @@ Target image repository.
> v2.12.0
> ```

Target image version tag.
Override the image tag to deploy by setting this variable. If no value is set, the chart's appVersion is used.

#### **app.driver.livenessProbeImage.digest** ~ `string`

Target image digest. Override any tag, if set.
For example:

```yaml
digest: sha256:0e072dddd1f7f8fc8909a2ca6f65e76c5f0d2fcfb8be47935ae3457e8bbceb20
```

#### **app.driver.livenessProbeImage.pullPolicy** ~ `string`
> Default value:
> ```yaml
Expand Down
43 changes: 43 additions & 0 deletions deploy/charts/csi-driver-spiffe/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,46 @@ app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end -}}

{{/*
Util function for generating the image URL based on the provided options.
IMPORTANT: This function is standarized across all charts in the cert-manager GH organization.
Any changes to this function should also be made in cert-manager, trust-manager, approver-policy, ...
See https://github.com/cert-manager/cert-manager/issues/6329 for a list of linked PRs.
*/}}
{{- define "image" -}}
{{- $defaultTag := index . 1 -}}
{{- with index . 0 -}}
{{- if .registry -}}{{ printf "%s/%s" .registry .repository }}{{- else -}}{{- .repository -}}{{- end -}}
{{- if .digest -}}{{ printf "@%s" .digest }}{{- else -}}{{ printf ":%s" (default $defaultTag .tag) }}{{- end -}}
{{- end }}
{{- end }}

{{/*
Variants of the above image template which are addapted for the custom values format used in this chart:
registry: quay.io
repository:
driver: jetstack/cert-manager-csi-driver-spiffe
approver: jetstack/cert-manager-csi-driver-spiffe-approver
tag: vX.Y.Z
digest:
driver: sha256:...
approver: sha256:...
pullPolicy: IfNotPresent
*/}}
{{- define "image-driver" -}}
{{- $defaultTag := index . 1 -}}
{{- with index . 0 -}}
{{- if .registry -}}{{ printf "%s/%s" .registry .repository.driver }}{{- else -}}{{- .repository.driver -}}{{- end -}}
{{- if .digest.driver -}}{{ printf "@%s" .digest.driver }}{{- else -}}{{ printf ":%s" (default $defaultTag .tag) }}{{- end -}}
{{- end }}
{{- end }}

{{- define "image-approver" -}}
{{- $defaultTag := index . 1 -}}
{{- with index . 0 -}}
{{- if .registry -}}{{ printf "%s/%s" .registry .repository.approver }}{{- else -}}{{- .repository.approver -}}{{- end -}}
{{- if .digest.approver -}}{{ printf "@%s" .digest.approver }}{{- else -}}{{ printf ":%s" (default $defaultTag .tag) }}{{- end -}}
{{- end }}
{{- end }}

8 changes: 4 additions & 4 deletions deploy/charts/csi-driver-spiffe/templates/daemonset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ spec:
containers:

- name: node-driver-registrar
image: "{{ .Values.app.driver.nodeDriverRegistrarImage.repository }}:{{ .Values.app.driver.nodeDriverRegistrarImage.tag }}"
image: "{{ template "image" (tuple .Values.app.driver.nodeDriverRegistrarImage $.Chart.AppVersion) }}"
imagePullPolicy: {{ .Values.app.driver.nodeDriverRegistrarImage.pullPolicy }}
args:
- -v={{ .Values.app.logLevel }}
Expand All @@ -40,13 +40,13 @@ spec:
mountPath: /registration

- name: liveness-probe
image: "{{ .Values.app.driver.livenessProbeImage.repository }}:{{ .Values.app.driver.livenessProbeImage.tag }}"
image: "{{ template "image" (tuple .Values.app.driver.livenessProbeImage $.Chart.AppVersion) }}"
imagePullPolicy: {{ .Values.app.driver.livenessProbeImage.pullPolicy }}
args:
- --csi-address=/plugin/csi.sock
- --probe-timeout=3s
- --health-port={{.Values.app.driver.livenessProbe.port}}
- -v={{ .Values.app.logLevel }}
imagePullPolicy: {{ .Values.app.driver.livenessProbeImage.pullPolicy }}
volumeMounts:
- name: plugin-dir
mountPath: /plugin
Expand All @@ -59,7 +59,7 @@ spec:
add: ["SYS_ADMIN"]
allowPrivilegeEscalation: true
runAsUser: 0
image: "{{ .Values.image.repository.driver }}:{{ .Values.image.tag }}"
image: "{{ template "image-driver" (tuple .Values.image $.Chart.AppVersion) }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
args :
- --log-level={{ .Values.app.logLevel }}
Expand Down
2 changes: 1 addition & 1 deletion deploy/charts/csi-driver-spiffe/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
serviceAccountName: {{ include "cert-manager-csi-driver-spiffe.name" . }}-approver
containers:
- name: {{ include "cert-manager-csi-driver-spiffe.name" . }}-approver
image: "{{ .Values.image.repository.approver }}:{{ .Values.image.tag }}"
image: "{{ template "image-approver" (tuple .Values.image $.Chart.AppVersion) }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
ports:
- containerPort: {{ .Values.app.approver.metrics.port }}
Expand Down
1 change: 1 addition & 0 deletions deploy/charts/csi-driver-spiffe/values.linter.exceptions
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
value missing from values.yaml: nameOverride
Loading