Skip to content

feat(step-certificates): add custom labels support to service resource #245

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.

Sign up for GitHub

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

Open
jalet wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(step-certificates): add custom labels support to service resource #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions step-certificates/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ chart and their default values.
| `service.targetPort` | Internal port where Step CA runs | `9000` |
| `service.annotations` | Service annotations (YAML) | `{}` |
| `service.externalIPs` | Service externalIPs | `[]` |
| `service.labels` | Custom labels to add to the service resource (YAML) | `{}` |
| `replicaCount` | Number of Step CA replicas. Only one replica is currently supported. | `1` |
| `image.repository` | Repository of the Step CA image | `cr.step.sm/smallstep/step-ca` |
| `image.initContainerRepository` | Repository of the Step CA Init Container image. | `busybox:latest` |
Expand Down Expand Up @@ -350,6 +351,29 @@ helm install --set ca.dns="ca.example.com\,my-release-step-certificates.default.
my-release smallstep/step-certificates
```

### Service Customization

You can add custom labels to the service resource for integration with service meshes, monitoring systems, or compliance requirements:

```console
helm install step-certificates smallstep/step-certificates \
--set service.labels.environment=production \
--set service.labels.team=platform
```

Or using a values file:

```yaml
service:
labels:
environment: production
team: platform
cost-center: engineering
compliance: nis2
```

**Note**: Custom labels are merged with standard Helm labels. Avoid using reserved Kubernetes label prefixes like `app.kubernetes.io/`, `helm.sh/`, or `kubernetes.io/`.

Alternatively, a YAML file that specifies the values for the parameters can be
provided while installing the chart. For example,

Expand Down
3 changes: 3 additions & 0 deletions step-certificates/templates/service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ metadata:
namespace: {{ .Release.Namespace }}
labels:
{{- include "step-certificates.labels" . | nindent 4 }}
{{- with .Values.service.labels }}
{{- toYaml . | nindent 4 }}
{{- end }}
{{- with .Values.service.annotations }}
annotations:
{{- toYaml . | nindent 4 }}
Expand Down
8 changes: 8 additions & 0 deletions step-certificates/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,14 @@ service:
nodePort: ""
annotations: {}
externalIPs: []
# labels is a map of custom labels to add to the service resource.
# These labels are merged with the standard Helm labels.
# Example:
# labels:
# environment: production
# team: platform
# cost-center: engineering
labels: {}

# linkedca contains the token to configure step-ca using the linkedca mode.
#
Expand Down