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

[v16] [buddy] feat(charts): Give the possibility to add labels on more resources #49648

Merged
merged 3 commits into from
Dec 2, 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
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,26 @@ put on the `Pod` resources created by the chart.
`annotations.serviceAccount` contains the Kubernetes annotations
put on the `Deployment` resource created by the chart.

## `annotations`

### `labels.deployment`

| Type | Default |
|------|---------|
| `object` | `{}` |

`labels.deployment` contains the Kubernetes labels
put on the `Deployment` resource created by the chart.

### `labels.pod`

| Type | Default |
|------|---------|
| `object` | `{}` |

`labels.pod` contains the Kubernetes labels
put on the `Pod` resources created by the chart.

## `serviceAccount`

### `serviceAccount.create`
Expand Down
105 changes: 104 additions & 1 deletion docs/pages/reference/helm-reference/teleport-cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -655,6 +655,63 @@ the same Kubernetes cluster or installing the CRDs on your own you should not ha

## `operator`

### `operator.annotations.deployment`

| Type | Default value |
|----------|---------------|
| `object` | `{}` |

[Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)

Kubernetes annotations which should be applied to the `Deployment` created by the chart.

`values.yaml` example:

```yaml
operator:
annotations:
deployment:
kubernetes.io/annotation: value
```

### `operator.annotations.pod`

| Type | Default value |
|----------|---------------|
| `object` | `{}` |

[Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)

Kubernetes annotations which should be applied to the `Pod` created by the chart.

`values.yaml` example:

```yaml
operator:
annotations:
pod:
kubernetes.io/annotation: value
```

### `operator.annotations.serviceAccount`

| Type | Default value |
|----------|---------------|
| `object` | `{}` |

[Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)

Kubernetes annotations which should be applied to the `ServiceAccount` created by the chart.

`values.yaml` example:

```yaml
operator:
annotations:
serviceAccount:
kubernetes.io/annotation: value
```

### `operator.enabled`

| Type | Default value |
Expand All @@ -671,7 +728,7 @@ If you are deploying multiple releases of the Helm chart in the same cluster you

```yaml
operator:
enabled: true
enabled: true
```

### `operator.image`
Expand All @@ -692,6 +749,44 @@ This setting requires [`operator.enabled`](#operatorenabled).
image: my.docker.registry/teleport-operator-image-name
```

### `operator.labels.deployment`

| Type | Default value |
|----------|---------------|
| `object` | `{}` |

[Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)

Kubernetes labels which should be applied to the `Deployment` created by the chart.

`values.yaml` example:

```yaml
operator:
labels:
deployment:
label: value
```

### `operator.labels.pod`

| Type | Default value |
|----------|---------------|
| `object` | `{}` |

[Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)

Kubernetes labels which should be applied to the `Pod` created by the chart.

`values.yaml` example:

```yaml
operator:
labels:
pod:
label: value
```

### `operator.resources`

| Type | Default value |
Expand Down Expand Up @@ -1789,6 +1884,14 @@ is true.

`extraLabels.job` are labels to set on the Job run by the Helm hook.

### `extraLabels.jobPod`

| Type | Default value |
|----------|---------------|
| `object` | `{}` |

`extraLabels.jobPod` are labels to set on the Pods created by the Job run by the Helm hook.

### `extraLabels.persistentVolumeClaim`

| Type | Default value |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
labels:
deployment:
kubernetes.io/deployment: "test-label"
kubernetes.io/deployment-different: 3
pod:
kubernetes.io/pod: "test-label"
kubernetes.io/pod-different: 4
teleportAddress: "example.teleport.sh:443"
token: "my-operator-bot"
teleportClusterName: "example.teleport.sh"
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ kind: Deployment
metadata:
name: {{ include "teleport-cluster.operator.fullname" . }}
namespace: {{ .Release.Namespace }}
labels: {{- include "teleport-cluster.operator.labels" . | nindent 4 }}
labels:
{{- include "teleport-cluster.operator.labels" . | nindent 4 }}
{{- if .Values.labels.deployment }}
{{- toYaml .Values.labels.deployment | nindent 4 }}
{{- end }}
{{- if .Values.annotations.deployment }}
annotations: {{- toYaml .Values.annotations.deployment | nindent 4 }}
{{- end }}
Expand All @@ -22,7 +26,11 @@ spec:
{{- if .Values.annotations.pod }}
annotations: {{- toYaml .Values.annotations.pod | nindent 8 }}
{{- end }}
labels: {{- include "teleport-cluster.operator.labels" . | nindent 8 }}
labels:
{{- include "teleport-cluster.operator.labels" . | nindent 8 }}
{{- if .Values.labels.pod }}
{{- toYaml .Values.labels.pod | nindent 8 }}
{{- end }}
spec:
{{- if .Values.nodeSelector }}
nodeSelector: {{- toYaml .Values.nodeSelector | nindent 8 }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,25 @@ tests:
path: metadata.annotations.kubernetes\.io/deployment-different
value: 3

- it: sets labels when specified
values:
- ../.lint/labels.yaml
asserts:
# Pod labels
- equal:
path: spec.template.metadata.labels.kubernetes\.io/pod
value: test-label
- equal:
path: spec.template.metadata.labels.kubernetes\.io/pod-different
value: 4
# Deployment labels
- equal:
path: metadata.labels.kubernetes\.io/deployment
value: test-label
- equal:
path: metadata.labels.kubernetes\.io/deployment-different
value: 3

- it: should mount tls.existingCASecretName and set environment when set in values
values:
- ../.lint/existing-tls-ca.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,15 @@ annotations:
# put on the `Deployment` resource created by the chart.
serviceAccount: {}

# annotations --
labels:
# labels.deployment(object) -- contains the Kubernetes labels
# put on the `Deployment` resource created by the chart.
deployment: {}
# labels.pod(object) -- contains the Kubernetes labels
# put on the `Pod` resources created by the chart.
pod: {}

# serviceAccount --
serviceAccount:
# serviceAccount.create(bool) -- controls if the chart should create the Kubernetes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ metadata:
spec:
backoffLimit: 1
template:
metadata:
labels:
{{- include "teleport-cluster.auth.labels" . | nindent 8 }}
{{- if $auth.extraLabels.jobPod }}
{{- toYaml $auth.extraLabels.jobPod | nindent 8 }}
{{- end }}
spec:
{{- if $auth.affinity }}
affinity: {{- toYaml $auth.affinity | nindent 8 }}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ metadata:
spec:
backoffLimit: 1
template:
metadata:
labels:
{{- include "teleport-cluster.proxy.labels" . | nindent 8 }}
{{- if $proxy.extraLabels.jobPod }}
{{- toYaml $proxy.extraLabels.jobPod | nindent 8 }}
{{- end }}
spec:
{{- if $proxy.affinity }}
affinity: {{- toYaml $proxy.affinity | nindent 8 }}
Expand Down
41 changes: 41 additions & 0 deletions examples/chart/teleport-cluster/tests/predeploy_test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,26 @@ tests:
path: metadata.labels.baz
value: overridden

- it: should set extraLabels.jobPod on auth predeploy job when set in values
template: auth/predeploy_job.yaml
set:
clusterName: helm-lint
extraLabels:
jobPod:
foo: bar
baz: override-me
auth:
extraLabels:
jobPod:
baz: overridden
asserts:
- equal:
path: spec.template.metadata.labels.foo
value: bar
- equal:
path: spec.template.metadata.labels.baz
value: overridden

- it: should set extraLabels on auth predeploy config when set in values
template: auth/predeploy_config.yaml
set:
Expand All @@ -152,6 +172,7 @@ tests:
- equal:
path: metadata.labels.baz
value: overridden

- it: should set extraLabels on proxy predeploy job when set in values
template: proxy/predeploy_job.yaml
set:
Expand All @@ -172,6 +193,26 @@ tests:
path: metadata.labels.baz
value: overridden

- it: should set extraLabels.jobPod on proxy predeploy job when set in values
template: proxy/predeploy_job.yaml
set:
clusterName: helm-lint
extraLabels:
jobPod:
foo: bar
baz: override-me
proxy:
extraLabels:
jobPod:
baz: overridden
asserts:
- equal:
path: spec.template.metadata.labels.foo
value: bar
- equal:
path: spec.template.metadata.labels.baz
value: overridden

- it: should set extraLabels on proxy predeploy config when set in values
template: proxy/predeploy_config.yaml
set:
Expand Down
3 changes: 3 additions & 0 deletions examples/chart/teleport-cluster/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -654,6 +654,9 @@ extraLabels:
ingress: {}
# extraLabels.job(object) -- are labels to set on the Job run by the Helm hook.
job: {}
# extraLabels.jobPod(object) -- are labels to set on the Pods created by the
# Job run by the Helm hook.
jobPod: {}
# extraLabels.persistentVolumeClaim(object) -- are labels to set on the PersistentVolumeClaim.
persistentVolumeClaim: {}
# extraLabels.pod(object) -- are labels to set on the Pods created by the
Expand Down
Loading