Skip to content

Add support for additionalCommandArgs and configurable secretKey fields in barmanObjectStore. (fixes #653) #654

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add support for additionalCommandArgs and configurable secretKey fields in barmanObjectStore. (fixes #653) #654

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3aca9b
Add support for additionalCommandArgs and configurable secretKey fiel…
austinmarten1 Aug 21, 2025
c504163
Fixing the issue where there would be mistmatching.
austinmarten1 Sep 22, 2025
9f8d3dd
Fixing comments
austinmarten1 Sep 23, 2025
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
8 changes: 8 additions & 0 deletions charts/cluster/templates/_backup.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,20 @@ backup:
encryption: {{ .Values.backups.wal.encryption }}
{{- end }}
maxParallel: {{ .Values.backups.wal.maxParallel }}
{{- if .Values.backups.wal.additionalCommandArgs }}
additionalCommandArgs:
{{- toYaml .Values.backups.wal.additionalCommandArgs | nindent 8 }}
{{- end }}
data:
compression: {{ .Values.backups.data.compression }}
{{- if .Values.backups.data.encryption }}
encryption: {{ .Values.backups.data.encryption }}
{{- end }}
jobs: {{ .Values.backups.data.jobs }}
{{- if .Values.backups.data.additionalCommandArgs }}
additionalCommandArgs:
{{- toYaml .Values.backups.data.additionalCommandArgs | nindent 8 }}
{{- end }}

{{- $d := dict "chartFullname" (include "cluster.fullname" .) "scope" .Values.backups "secretPrefix" "backup" }}
{{- include "cluster.barmanObjectStoreConfig" $d | nindent 2 }}
Expand Down
4 changes: 2 additions & 2 deletions charts/cluster/templates/_barman_object_store.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
{{- else }}
accessKeyId:
name: {{ $secretName }}
key: ACCESS_KEY_ID
key: {{ .scope.secret.accessKeyIdField | default "ACCESS_KEY_ID" }}
secretAccessKey:
name: {{ $secretName }}
key: ACCESS_SECRET_KEY
key: {{ .scope.secret.secretAccessKeyField | default "ACCESS_SECRET_KEY" }}
{{- end }}
{{- else if eq .scope.provider "azure" }}
{{- if empty .scope.destinationPath }}
Expand Down
4 changes: 2 additions & 2 deletions charts/cluster/templates/backup-s3-creds.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ metadata:
name: {{ default (printf "%s-backup-s3-creds" (include "cluster.fullname" .)) .Values.backups.secret.name }}
namespace: {{ include "cluster.namespace" . }}
data:
ACCESS_KEY_ID: {{ required ".Values.backups.s3.accessKey is required, but not specified." .Values.backups.s3.accessKey | b64enc | quote }}
ACCESS_SECRET_KEY: {{ required ".Values.backups.s3.secretKey is required, but not specified." .Values.backups.s3.secretKey | b64enc | quote }}
{{ .Values.backups.secret.accessKeyIdField | default "ACCESS_KEY_ID" }}: {{ required ".Values.backups.s3.accessKey is required, but not specified." .Values.backups.s3.accessKey | b64enc | quote }}
{{ .Values.backups.secret.secretAccessKeyField | default "ACCESS_SECRET_KEY" }}: {{ required ".Values.backups.s3.secretKey is required, but not specified." .Values.backups.s3.secretKey | b64enc | quote }}
{{- end }}
4 changes: 2 additions & 2 deletions charts/cluster/templates/recovery-s3-creds.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ metadata:
name: {{ default (printf "%s-recovery-s3-creds" (include "cluster.fullname" .)) .Values.recovery.secret.name }}
namespace: {{ include "cluster.namespace" . }}
data:
ACCESS_KEY_ID: {{ required ".Values.recovery.s3.accessKey is required, but not specified." .Values.recovery.s3.accessKey | b64enc | quote }}
ACCESS_SECRET_KEY: {{ required ".Values.recovery.s3.secretKey is required, but not specified." .Values.recovery.s3.secretKey | b64enc | quote }}
{{ .Values.recovery.secret.accessKeyIdField | default "ACCESS_KEY_ID" }}: {{ required ".Values.recovery.s3.accessKey is required, but not specified." .Values.recovery.s3.accessKey | b64enc | quote }}
{{ .Values.recovery.secret.secretAccessKeyField | default "ACCESS_SECRET_KEY" }}: {{ required ".Values.recovery.s3.secretKey is required, but not specified." .Values.recovery.s3.secretKey | b64enc | quote }}
{{- end }}
10 changes: 10 additions & 0 deletions charts/cluster/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ recovery:
create: true
# -- Name of the backup credentials secret
name: ""
# Definable accessKeyIdField to use (Left blank defaults to ACCESS_KEY_ID)
accessKeyIdField: ""
# Definable accessKeyIdField to use (Left blank defaults to ACCESS_SECRET_KEY)
Copy link

@ThisIsntTheWay ThisIsntTheWay Sep 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's have comments be in the format of # -- My comment like the rest to be consistent.

secretAccessKeyField: ""

# See https://cloudnative-pg.io/documentation/1.22/bootstrap/#bootstrap-from-a-live-cluster-pg_basebackup
pgBaseBackup:
Expand Down Expand Up @@ -418,6 +422,10 @@ backups:
create: true
# -- Name of the backup credentials secret
name: ""
# Definable accessKeyIdField to use (Left blank defaults to ACCESS_KEY_ID)
accessKeyIdField: ""
# Definable secretAccessKeyField to use (Left blank defaults to ACCESS_SECRET_KEY)
secretAccessKeyField: ""

wal:
# -- WAL compression method. One of `` (for no compression), `gzip`, `bzip2` or `snappy`.
Expand All @@ -426,13 +434,15 @@ backups:
encryption: AES256
# -- Number of WAL files to be archived or restored in parallel.
maxParallel: 1
additionalCommandArgs: []
data:
# -- Data compression method. One of `` (for no compression), `gzip`, `bzip2` or `snappy`.
compression: gzip
# -- Whether to instruct the storage provider to encrypt data files. One of `` (use the storage container default), `AES256` or `aws:kms`.
encryption: AES256
# -- Number of data files to be archived or restored in parallel.
jobs: 2
additionalCommandArgs: []

scheduledBackups:
-
Expand Down