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

storage-scrubber: enable jwt auth with storage controller #93

Merged
merged 2 commits into from
Aug 5, 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
2 changes: 1 addition & 1 deletion charts/neon-storage-scrubber/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
name: neon-storage-scrubber
description: neon-storage-scrubber
type: application
version: 1.0.0
version: 1.1.0
appVersion: "v0.1.0"
sources:
- https://github.com/neondatabase/neon/tree/main/storage_scrubber
7 changes: 5 additions & 2 deletions charts/neon-storage-scrubber/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# neon-storage-scrubber

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) [![Lint and Test Charts](https://github.com/neondatabase/helm-charts/actions/workflows/lint-test.yaml/badge.svg)](https://github.com/neondatabase/helm-charts/actions/workflows/lint-test.yaml)
![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) [![Lint and Test Charts](https://github.com/neondatabase/helm-charts/actions/workflows/lint-test.yaml/badge.svg)](https://github.com/neondatabase/helm-charts/actions/workflows/lint-test.yaml)

neon-storage-scrubber

Expand Down Expand Up @@ -44,8 +44,11 @@ $ helm install neon-storage-scrubber neondatabase/neon-storage-scrubber
| settings.sentryUrl | string | `""` | url (will be converted into `SENTRY_DSN` environment variable) used by sentry to collect error/panic events in neon-pg-sni-router |
| storageScrubber.awsBucket | string | `""` | The AWS bucket for the pageserver storage |
| storageScrubber.awsRegion | string | `""` | The AWS region to run the scrubber |
| storageScrubber.command | list | `["/usr/local/bin/storage_scrubber","pageserver-physical-gc","--min-age=1week"]` | The command to run |
| storageScrubber.command | list | `["pageserver-physical-gc","--min-age=1week"]` | The command to run |
| storageScrubber.enableStorageControllerConnection | bool | `false` | Enable storage controller related functionalities |
| storageScrubber.schedule | string | `"0 18 * * *"` | |
| storageScrubber.storageControllerJwtToken | string | `""` | Control plane / storage controller JWT token for connecting to the storage controller |
| storageScrubber.storageControllerUrl | string | `""` | URL of the storage controller |
| storageScrubber.timeZone | string | `"Etc/UTC"` | The timezone for the cron job |
| tolerations | list | `[]` | Tolerations for pod assignment. |

Expand Down
10 changes: 10 additions & 0 deletions charts/neon-storage-scrubber/templates/cronjob.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ spec:
image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
command:
- /usr/local/bin/storage_scrubber
{{- if .Values.storageScrubber.enableStorageControllerConnection }}
- "--controller-jwt"
- "$(STORAGE_CONTROLLER_JWT)"
- "--controller-api"
- {{ .Values.storageScrubber.storageControllerUrl | quote }}
{{- end -}}
{{- toYaml .Values.storageScrubber.command | nindent 16 }}
env:
- name: BUCKET
Expand All @@ -59,6 +66,9 @@ spec:
{{- toYaml . | nindent 16 }}
{{- end }}
{{- end }}
envFrom:
- secretRef:
name: {{ include "neon-storage-scrubber.fullname" . }}-env-vars
resources:
{{- toYaml .Values.resources | nindent 16 }}
{{- with .Values.nodeSelector }}
Expand Down
9 changes: 9 additions & 0 deletions charts/neon-storage-scrubber/templates/secrets.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
apiVersion: v1
kind: Secret
metadata:
name: {{ include "neon-storage-scrubber.fullname" . }}-env-vars
labels:
{{- include "neon-storage-scrubber.labels" . | nindent 4 }}
type: Opaque
data:
STORAGE_CONTROLLER_JWT_TOKEN: {{ .Values.storageScrubber.storageControllerJwtToken | b64enc | quote }}
13 changes: 9 additions & 4 deletions charts/neon-storage-scrubber/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ settings:
sentryUrl: ""
# settings.sentryEnvironment -- "development" or "production". It will be visible in sentry in order to filter issues
sentryEnvironment: "development"
# -- extra env variables when running the job
# settings.extraEnvs -- extra env variables when running the job
extraEnvs:
- name: RUST_BACKTRACE
value: '1'
value: "1"
- name: PAGESERVER_DISABLE_FILE_LOGGING
value: '1'
value: "1"

storageScrubber:
# -- The AWS region to run the scrubber
Expand All @@ -49,9 +49,14 @@ storageScrubber:
schedule: "0 18 * * *"
# -- The command to run
command:
- /usr/local/bin/storage_scrubber
- pageserver-physical-gc
- --min-age=1week
# -- Enable storage controller related functionalities
enableStorageControllerConnection: false
# -- Control plane / storage controller JWT token for connecting to the storage controller
storageControllerJwtToken: ""
# -- URL of the storage controller
storageControllerUrl: ""

# -- Annotations for neon-storage-scrubber pods
podAnnotations: {}
Expand Down
Loading