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

feat: handle s3 region in cnpg-cluster chart #41

Merged
merged 1 commit into from
Feb 23, 2025
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
2 changes: 1 addition & 1 deletion charts/cnpg-cluster/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: v2
name: cnpg-cluster
type: application
version: 0.7.2
version: 0.8.0
appVersion: "1.25.0"
description: A Helm Chart to deploy easily a CNPG cluster
home: https://cloudnative-pg.io
Expand Down
8 changes: 7 additions & 1 deletion charts/cnpg-cluster/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# cnpg-cluster

![Version: 0.7.2](https://img.shields.io/badge/Version-0.7.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.25.0](https://img.shields.io/badge/AppVersion-1.25.0-informational?style=flat-square)
![Version: 0.8.0](https://img.shields.io/badge/Version-0.8.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.25.0](https://img.shields.io/badge/AppVersion-1.25.0-informational?style=flat-square)

A Helm Chart to deploy easily a CNPG cluster

Expand Down Expand Up @@ -41,6 +41,8 @@ A Helm Chart to deploy easily a CNPG cluster
| backup.s3Credentials.accessKeyId.key | string | `"accessKeyId"` | S3 accessKeyId kubernetes secret key used for cnpg backups. |
| backup.s3Credentials.accessKeyId.value | string | `""` | S3 accessKeyId value used for cnpg backups. Only needed if `backup.s3Credentials.create` is set to `true`. |
| backup.s3Credentials.create | bool | `false` | Whether or not to create S3 credentials kubernetes secret used for cnpg backups. It will use `secretName`, `accessKeyId.key`, `accessKeyId.value`, `secretAccessKey.key` and `secretAccessKey.value` to create the secret. |
| backup.s3Credentials.region.key | string | `"region"` | S3 region kubernetes secret key used used for cnpg backups. |
| backup.s3Credentials.region.value | string | `"us-east1"` | S3 region value used used for cnpg backups. Only needed if `backup.s3Credentials.create` is set to `true`. |
| backup.s3Credentials.secretAccessKey.key | string | `"secretAccessKey"` | S3 secretAccessKey kubernetes secret key used for cnpg backups. |
| backup.s3Credentials.secretAccessKey.value | string | `""` | S3 secretAccessKey value used for cnpg backups. Only needed if `backup.s3Credentials.create` is set to `true`. |
| backup.s3Credentials.secretName | string | `""` | S3 kubernetes secret name used for cnpg backups, leave it empty to auto-generate the secret name. |
Expand Down Expand Up @@ -79,6 +81,8 @@ A Helm Chart to deploy easily a CNPG cluster
| recovery.s3Credentials.accessKeyId.key | string | `"accessKeyId"` | S3 accessKeyId kubernetes secret key used used for recovery mode. |
| recovery.s3Credentials.accessKeyId.value | string | `""` | S3 accessKeyId value used used for recovery mode. Only needed if `recovery.s3Credentials.create` is set to `true`. |
| recovery.s3Credentials.create | bool | `false` | Whether or not to create S3 credentials kubernetes secret used used for recovery mode. It will use `secretName`, `accessKeyId.key`, `accessKeyId.value`, `secretAccessKey.key` and `secretAccessKey.value` to create the secret. |
| recovery.s3Credentials.region.key | string | `"region"` | S3 region kubernetes secret key used used for recovery mode. |
| recovery.s3Credentials.region.value | string | `"us-east1"` | S3 region value used used for recovery mode. Only needed if `recovery.s3Credentials.create` is set to `true`. |
| recovery.s3Credentials.secretAccessKey.key | string | `"secretAccessKey"` | S3 secretAccessKey kubernetes secret key used used for recovery mode. |
| recovery.s3Credentials.secretAccessKey.value | string | `""` | S3 secretAccessKey value used used for recovery mode. Only needed if `recovery.s3Credentials.create` is set to `true`. |
| recovery.s3Credentials.secretName | string | `""` | S3 kubernetes secret name used used for recovery mode, leave it empty to auto-generate the secret name. |
Expand All @@ -97,6 +101,8 @@ A Helm Chart to deploy easily a CNPG cluster
| replica.s3Credentials.accessKeyId.key | string | `"accessKeyId"` | S3 accessKeyId kubernetes secret key used used for replica mode. |
| replica.s3Credentials.accessKeyId.value | string | `""` | S3 accessKeyId value used used for replica mode. Only needed if `replica.s3Credentials.create` is set to `true`. |
| replica.s3Credentials.create | bool | `false` | Whether or not to create S3 credentials kubernetes secret used used for replica mode. It will use `secretName`, `accessKeyId.key`, `accessKeyId.value`, `secretAccessKey.key` and `secretAccessKey.value` to create the secret. |
| replica.s3Credentials.region.key | string | `"region"` | S3 region kubernetes secret key used used for replica mode. |
| replica.s3Credentials.region.value | string | `"us-east1"` | S3 region value used used for replica mode. Only needed if `replica.s3Credentials.create` is set to `true`. |
| replica.s3Credentials.secretAccessKey.key | string | `"secretAccessKey"` | S3 secretAccessKey kubernetes secret key used used for replica mode. |
| replica.s3Credentials.secretAccessKey.value | string | `""` | S3 secretAccessKey value used used for replica mode. Only needed if `replica.s3Credentials.create` is set to `true`. |
| replica.s3Credentials.secretName | string | `""` | S3 kubernetes secret name used used for replica mode, leave it empty to auto-generate the secret name. |
Expand Down
1 change: 1 addition & 0 deletions charts/cnpg-cluster/templates/backup-secrets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ metadata:
data:
{{ .Values.backup.s3Credentials.accessKeyId.key | indent 2 -}}: {{ .Values.backup.s3Credentials.accessKeyId.value | b64enc }}
{{ .Values.backup.s3Credentials.secretAccessKey.key | indent 2 -}}: {{ .Values.backup.s3Credentials.secretAccessKey.value | b64enc }}
{{ .Values.backup.s3Credentials.region.key | indent 2 -}}: {{ .Values.backup.s3Credentials.region.value | b64enc }}
{{- end -}}

{{- if and .Values.backup.enabled .Values.backup.endpointCA.create }}
Expand Down
9 changes: 9 additions & 0 deletions charts/cnpg-cluster/templates/pg-cluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ spec:
secretAccessKey:
name: {{ .Values.recovery.s3Credentials.secretName | default (printf "%s-%s" (include "template.fullname" .) "recovery-creds") }}
key: {{ .Values.recovery.s3Credentials.secretAccessKey.key }}
region:
name: {{ .Values.recovery.s3Credentials.secretName | default (printf "%s-%s" (include "template.fullname" .) "recovery-creds") }}
key: {{ .Values.recovery.s3Credentials.region.key }}
{{- else if eq .Values.mode "replica" }}
bootstrap:
recovery:
Expand All @@ -95,6 +98,9 @@ spec:
secretAccessKey:
name: {{ .Values.replica.s3Credentials.secretName | default (printf "%s-%s" (include "template.fullname" .) "replica-creds") }}
key: {{ .Values.replica.s3Credentials.secretAccessKey.key }}
region:
name: {{ .Values.replica.s3Credentials.secretName | default (printf "%s-%s" (include "template.fullname" .) "replica-creds") }}
key: {{ .Values.replica.s3Credentials.region.key }}
connectionParameters:
host: {{ .Values.replica.host }}
port: {{ .Values.replica.port }}
Expand Down Expand Up @@ -130,6 +136,9 @@ spec:
secretAccessKey:
name: {{ .Values.backup.s3Credentials.secretName | default (printf "%s-%s" (include "template.fullname" .) "backup-creds") }}
key: {{ .Values.backup.s3Credentials.secretAccessKey.key }}
region:
name: {{ .Values.backup.s3Credentials.secretName | default (printf "%s-%s" (include "template.fullname" .) "backup-creds") }}
key: {{ .Values.backup.s3Credentials.region.key }}
{{- if .Values.backup.compression }}
data:
compression: {{ .Values.backup.compression }}
Expand Down
1 change: 1 addition & 0 deletions charts/cnpg-cluster/templates/recovery-secrets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ metadata:
data:
{{ .Values.recovery.s3Credentials.accessKeyId.key | indent 2 -}}: {{ .Values.recovery.s3Credentials.accessKeyId.value | b64enc }}
{{ .Values.recovery.s3Credentials.secretAccessKey.key | indent 2 -}}: {{ .Values.recovery.s3Credentials.secretAccessKey.value | b64enc }}
{{ .Values.recovery.s3Credentials.region.key | indent 2 -}}: {{ .Values.recovery.s3Credentials.region.value | b64enc }}
{{- end -}}

{{- if and (eq .Values.mode "recovery") .Values.recovery.endpointCA.create }}
Expand Down
1 change: 1 addition & 0 deletions charts/cnpg-cluster/templates/replica-secrets.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ metadata:
data:
{{ .Values.replica.s3Credentials.accessKeyId.key | indent 2 -}}: {{ .Values.replica.s3Credentials.accessKeyId.value | b64enc }}
{{ .Values.replica.s3Credentials.secretAccessKey.key | indent 2 -}}: {{ .Values.replica.s3Credentials.secretAccessKey.value | b64enc }}
{{ .Values.replica.s3Credentials.region.key | indent 2 -}}: {{ .Values.replica.s3Credentials.region.value | b64enc }}
{{- end -}}

{{- if and (eq .Values.mode "replica") .Values.replica.endpointCA.create }}
Expand Down
18 changes: 18 additions & 0 deletions charts/cnpg-cluster/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,12 @@ recovery:
# -- S3 secretAccessKey value used used for recovery mode.
# Only needed if `recovery.s3Credentials.create` is set to `true`.
value: ""
region:
# -- S3 region kubernetes secret key used used for recovery mode.
key: "region"
# -- S3 region value used used for recovery mode.
# Only needed if `recovery.s3Credentials.create` is set to `true`.
value: "us-east1"
# -- Primary cnpg cluster name used for recovery mode.
clusterName: ""
# -- Extra configuration of the recovery bootstrap process (See. https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-BootstrapRecovery).
Expand Down Expand Up @@ -151,6 +157,12 @@ replica:
# -- S3 secretAccessKey value used used for replica mode.
# Only needed if `replica.s3Credentials.create` is set to `true`.
value: ""
region:
# -- S3 region kubernetes secret key used used for replica mode.
key: "region"
# -- S3 region value used used for replica mode.
# Only needed if `replica.s3Credentials.create` is set to `true`.
value: "us-east1"
# -- Primary cnpg cluster name used for replica mode.
clusterName: ""
# -- Primary cnpg cluster host used for replica mode.
Expand Down Expand Up @@ -201,6 +213,12 @@ backup:
# -- S3 secretAccessKey value used for cnpg backups.
# Only needed if `backup.s3Credentials.create` is set to `true`.
value: ""
region:
# -- S3 region kubernetes secret key used used for cnpg backups.
key: "region"
# -- S3 region value used used for cnpg backups.
# Only needed if `backup.s3Credentials.create` is set to `true`.
value: "us-east1"
# -- Which compression algorithm should be used for cnpg backups (should be one of "gzip", "bzip2" or "snappy"), leave blank to disable compression.
compression: ""
# -- The cron rule used for cnpg backups. By default it runs every 6 hours.
Expand Down