Skip to content

Commit

Permalink
chore(localstack): add extraLabels option and align documentation (#128)
Browse files Browse the repository at this point in the history
  • Loading branch information
@levivannoort
levivannoort authored Nov 27, 2024
1 parent 22d3f64 commit d01ed71
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
9 changes: 6 additions & 3 deletions charts/localstack/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,12 @@ The following table lists the configurable parameters of the Localstack chart an
| `image.tag` | Localstack image tag | `latest` |
| `image.pullPolicy` | Localstack image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Specify docker-registry secret names as an array | `[]` |
| `podLabels` | Additional pod labels for Localstack secondary pods | `{}` |
| `podLabels` | Additional pod labels for Localstack secondary pods | `{}` |
| `podAnnotations` | Additional pod annotations for Localstack secondary pods | `{}` |
| `podSecurityContext` | Enable security context for Localstack pods | `{}` |
| `extraDeploy` | Extra objects to deploy (value evaluated as a template) | `{}` |
| `extraAnnotations` | Add additional annotations to every resource (value evaluated as a template) | `{}` |
| `extraLabels` | Add additional labels to every resource (value evaluated as a template) | `{}` |
| `securityContext` | Localstack container securityContext | `{}` |

### Localstack parameters
Expand All @@ -103,11 +106,11 @@ The following table lists the configurable parameters of the Localstack chart an
|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| `debug` | Specify if debug logs should be enabled | `false` |
| `kinesisErrorProbability` | Specify to randomly inject ProvisionedThroughputExceededException errors into Kinesis API responses | `nil` (Localstack Default) |
| `startServices` | Comma-separated list of AWS CLI service names which should be loaded right when starting LocalStack. If not set, each service is loaded and started on the first request for that service. | `nil` (Localstack Default) |
| `startServices` | Comma-separated list of AWS CLI service names which should be loaded right when starting LocalStack. If not set, each service is loaded and started on the first request for that service. | `nil` (Localstack Default) |
| `lambdaExecutor` | Specify Method to use for executing Lambda functions (partially supported) | `docker` |
| `extraEnvVars` | Extra environment variables to be set on Localstack primary containers | `nil` (Localstack Default) |
| `enableStartupScripts` | Mount `/etc/localstack/init/ready.d` to run startup scripts with `{{ template "localstack.fullname" . }}-init-scripts-config` configMap | `false` |
| `startupScriptContent` | Startup script content when `enableStartupScripts` is `true`. Note: You will need to add a shebang as your first line such as `!#/bin/sh` in order to ensure the startup script is not malformed. | `nil` (Localstack Default) |
| `startupScriptContent` | Startup script content when `enableStartupScripts` is `true`. Note: You will need to add a shebang as your first line such as `!#/bin/sh` in order to ensure the startup script is not malformed. | `nil` (Localstack Default) |

### Deployment parameters

Expand Down
5 changes: 5 additions & 0 deletions charts/localstack/templates/_helpers.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ helm.sh/chart: {{ include "localstack.chart" . }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- with .Values.extraLabels }}
{{- range $label, $value := index . }}
{{ $label }}: {{ tpl $value $ | quote }}
{{- end }}
{{- end }}
{{- end }}

{{/*
Expand Down
5 changes: 4 additions & 1 deletion charts/localstack/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,12 @@ fullnameOverride: ""
##
extraDeploy: []

## Add additional annotations to every resource
## @param extraAnnotations Add additional annotations to every resource (value evaluated as a template)
extraAnnotations: {}

## @param extraLabels Add additional labels to every resource (value evaluated as a template)
extraLabels: {}

serviceAccount:
# Specifies whether a service account should be created
create: true
Expand Down

0 comments on commit d01ed71

Please sign in to comment.