Skip to content

Commit da8fab2

Browse files
J12934Weltraumschaf
authored andcommitted
Switch operator helm chart to use garagefs instead of minio
Signed-off-by: Jannik Hollenbach <jannik.hollenbach@iteratec.com>
1 parent 8349ebe commit da8fab2

12 files changed

Lines changed: 725 additions & 621 deletions

File tree

‎operator/README.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,28 @@ helm install securecodebox-operator oci://ghcr.io/securecodebox/helm/operator
6868
| Key | Type | Default | Description |
6969
|-----|------|---------|-------------|
7070
| allowIstioSidecarInjectionInJobs | bool | `false` | Sets the value of the istio sidecar annotation ("sidecar.istio.io/inject") for jobs started by the operator (scans, parser and hooks). defaults to false to prevent jobs hanging indefinitely due to the sidecar never terminating. If you aren't using istio this setting/annotation has no effect. |
71-
| clusterDomain | string | `"cluster.local"` | The cluster domain to use when building the in-cluster Minio endpoint (`<release>-minio.<namespace>.svc.<clusterDomain>`). Override this if your cluster uses a custom domain instead of the Kubernetes default `cluster.local`. |
71+
| clusterDomain | string | `"cluster.local"` | The cluster domain to use when building the in-cluster Garage endpoint (`<release>-garage.<namespace>.svc.<clusterDomain>`). Override this if your cluster uses a custom domain instead of the Kubernetes default `cluster.local`. |
7272
| customCACertificate | object | `{"certificate":"public.crt","existingCertificate":null}` | Setup for Custom CA certificates. These are automatically mounted into every secureCodeBox component (lurker, parser & hooks). Requires that every namespace has a configmap with the CA certificate(s) |
7373
| customCACertificate.certificate | string | `"public.crt"` | key in the configmap holding the certificate(s) |
7474
| customCACertificate.existingCertificate | string | `nil` | name of the configMap holding the ca certificate(s), needs to be the same across all namespaces |
7575
| extraVolumeMounts | list | `[]` | Additional volume mounts to be mounted to the operator deployment |
7676
| extraVolumes | list | `[]` | Additional volumes to be mounted to the operator deployment |
77+
| garage | object | `{"auth":{"accessKey":"","adminToken":"","existingSecret":"","rpcSecret":"","secretKey":""},"defaultBucket":"securecodebox","enabled":true,"image":{"pullPolicy":"IfNotPresent","repository":"docker.io/dxflrs/garage","tag":"v2.3.0"},"persistence":{"size":"10Gi","storageClass":""},"podSecurityContext":{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000},"resources":{"limits":{"cpu":"500m","ephemeral-storage":"1Gi","memory":"512Mi"},"requests":{"cpu":"100m","memory":"256Mi"}},"securityContext":{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsGroup":1000,"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}}}` | Garage configuration for direct deployment (S3-compatible quickstart storage backend) |
78+
| garage.auth | object | `{"accessKey":"","adminToken":"","existingSecret":"","rpcSecret":"","secretKey":""}` | Authentication configuration |
79+
| garage.auth.accessKey | string | `""` | Default access key (leave empty to generate a secure random one) |
80+
| garage.auth.adminToken | string | `""` | Garage admin API token (leave empty to generate a secure random one). Not used for anything outside the pod on a single-node deployment. |
81+
| garage.auth.existingSecret | string | `""` | Name of existing secret containing garage credentials (if set, auth.accessKey, auth.secretKey, auth.rpcSecret and auth.adminToken are ignored) |
82+
| garage.auth.rpcSecret | string | `""` | Garage inter-node RPC secret (leave empty to generate a secure random one). Not used for anything outside the pod on a single-node deployment. |
83+
| garage.auth.secretKey | string | `""` | Default secret key (leave empty to generate a secure random one) |
84+
| garage.defaultBucket | string | `"securecodebox"` | Default bucket to create on startup |
85+
| garage.enabled | bool | `true` | Enable this to use Garage as storage backend instead of a cloud bucket provider like AWS S3, Google Cloud Storage, DigitalOcean Spaces etc. |
86+
| garage.image | object | `{"pullPolicy":"IfNotPresent","repository":"docker.io/dxflrs/garage","tag":"v2.3.0"}` | Garage image configuration |
87+
| garage.persistence | object | `{"size":"10Gi","storageClass":""}` | Persistence configuration |
88+
| garage.persistence.size | string | `"10Gi"` | Size of the persistent volume |
89+
| garage.persistence.storageClass | string | `""` | Storage class for garage data persistence |
90+
| garage.podSecurityContext | object | `{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000}` | Pod security context for garage |
91+
| garage.resources | object | `{"limits":{"cpu":"500m","ephemeral-storage":"1Gi","memory":"512Mi"},"requests":{"cpu":"100m","memory":"256Mi"}}` | Resource limits and requests for garage |
92+
| garage.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsGroup":1000,"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}}` | Container security context for garage |
7793
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
7894
| image.repository | string | `"docker.io/securecodebox/operator"` | The operator image repository |
7995
| image.tag | string | defaults to the charts version | Parser image tag |
@@ -83,21 +99,6 @@ helm install securecodebox-operator oci://ghcr.io/securecodebox/helm/operator
8399
| lurker.image.tag | string | defaults to the charts version | Parser image tag |
84100
| metrics | object | `{"serviceMonitor":{"enabled":false}}` | Configuration for the metrics the operator exports |
85101
| metrics.serviceMonitor.enabled | bool | `false` | Creates a prometheus operator ServiceMonitor rule to automatically scrape the operators metrics: https://github.com/prometheus-operator/prometheus-operator |
86-
| minio | object | `{"auth":{"existingSecret":"","rootPassword":"","rootUser":"admin"},"defaultBuckets":"securecodebox","enabled":true,"image":{"pullPolicy":"IfNotPresent","repository":"docker.io/minio/minio","tag":"RELEASE.2025-07-23T15-54-02Z"},"persistence":{"size":"10Gi","storageClass":""},"podSecurityContext":{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000},"resources":{"limits":{"cpu":"500m","ephemeral-storage":"1Gi","memory":"512Mi"},"requests":{"cpu":"100m","memory":"256Mi"}},"securityContext":{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsGroup":1000,"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}},"tls":{"enabled":false}}` | Minio configuration for direct deployment |
87-
| minio.auth | object | `{"existingSecret":"","rootPassword":"","rootUser":"admin"}` | Authentication configuration |
88-
| minio.auth.existingSecret | string | `""` | Name of existing secret containing minio credentials (if set, auth.rootUser and auth.rootPassword are ignored) |
89-
| minio.auth.rootPassword | string | `""` | Root password for minio (leave empty to generate a secure random password) |
90-
| minio.auth.rootUser | string | `"admin"` | Root user for minio |
91-
| minio.defaultBuckets | string | `"securecodebox"` | Default buckets to create on startup |
92-
| minio.enabled | bool | `true` | Enable this to use minio as storage backend instead of a cloud bucket provider like AWS S3, Google Cloud Storage, DigitalOcean Spaces etc. |
93-
| minio.image | object | `{"pullPolicy":"IfNotPresent","repository":"docker.io/minio/minio","tag":"RELEASE.2025-07-23T15-54-02Z"}` | Minio image configuration |
94-
| minio.persistence | object | `{"size":"10Gi","storageClass":""}` | Persistence configuration |
95-
| minio.persistence.size | string | `"10Gi"` | Size of the persistent volume |
96-
| minio.persistence.storageClass | string | `""` | Storage class for minio data persistence |
97-
| minio.podSecurityContext | object | `{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000}` | Pod security context for minio |
98-
| minio.resources | object | `{"limits":{"cpu":"500m","ephemeral-storage":"1Gi","memory":"512Mi"},"requests":{"cpu":"100m","memory":"256Mi"}}` | Resource limits and requests for minio |
99-
| minio.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsGroup":1000,"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}}` | Container security context for minio |
100-
| minio.tls | object | `{"enabled":false}` | TLS configuration (currently not implemented) |
101102
| nodeSelector | object | `{}` | |
102103
| podSecurityContext | object | `{}` | Sets the securityContext on the operators pod level. See: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container |
103104
| presignedUrlExpirationTimes | object | `{"hooks":"1h","parsers":"1h","scanners":"12h"}` | Duration how long presigned urls are valid |

‎operator/Taskfile.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -193,12 +193,12 @@ tasks:
193193
- kubectl create namespace integration-tests --dry-run=client -o yaml | kubectl apply -f -
194194
- kubectl create namespace securecodebox-system --dry-run=client -o yaml | kubectl apply -f -
195195
- |
196-
MINIO_ROOT_USER=$(kubectl get secret securecodebox-operator-minio -n securecodebox-system -o=jsonpath='{.data.root-user}' 2>/dev/null | base64 --decode || echo "")
197-
MINIO_ROOT_PASSWORD=$(kubectl get secret securecodebox-operator-minio -n securecodebox-system -o=jsonpath='{.data.root-password}' 2>/dev/null | base64 --decode || echo "")
196+
GARAGE_ACCESS_KEY=$(kubectl get secret securecodebox-operator-garage -n securecodebox-system -o=jsonpath='{.data.access-key}' 2>/dev/null | base64 --decode || echo "")
197+
GARAGE_SECRET_KEY=$(kubectl get secret securecodebox-operator-garage -n securecodebox-system -o=jsonpath='{.data.secret-key}' 2>/dev/null | base64 --decode || echo "")
198198
199-
MINIO_ARGS=""
200-
if [ -n "$MINIO_ROOT_USER" ] && [ -n "$MINIO_ROOT_PASSWORD" ]; then
201-
MINIO_ARGS="--set=minio.auth.rootUser=$MINIO_ROOT_USER --set=minio.auth.rootPassword=$MINIO_ROOT_PASSWORD"
199+
GARAGE_ARGS=""
200+
if [ -n "$GARAGE_ACCESS_KEY" ] && [ -n "$GARAGE_SECRET_KEY" ]; then
201+
GARAGE_ARGS="--set=garage.auth.accessKey=$GARAGE_ACCESS_KEY --set=garage.auth.secretKey=$GARAGE_SECRET_KEY"
202202
fi
203203
204204
helm -n securecodebox-system upgrade --install securecodebox-operator ./ --wait \
@@ -208,7 +208,7 @@ tasks:
208208
--set="lurker.image.repository=docker.io/${IMG_NS}/{{ .LURKER_IMG }}" \
209209
--set="lurker.image.tag=${IMG_TAG}" \
210210
--set="lurker.image.pullPolicy=IfNotPresent" \
211-
$MINIO_ARGS
211+
$GARAGE_ARGS
212212
213213
kind-deploy:
214214
desc: "Import and deploy Docker images to kind"

‎operator/docs/README.ArtifactHub.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,28 @@ helm install securecodebox-operator oci://ghcr.io/securecodebox/helm/operator
7373
| Key | Type | Default | Description |
7474
|-----|------|---------|-------------|
7575
| allowIstioSidecarInjectionInJobs | bool | `false` | Sets the value of the istio sidecar annotation ("sidecar.istio.io/inject") for jobs started by the operator (scans, parser and hooks). defaults to false to prevent jobs hanging indefinitely due to the sidecar never terminating. If you aren't using istio this setting/annotation has no effect. |
76-
| clusterDomain | string | `"cluster.local"` | The cluster domain to use when building the in-cluster Minio endpoint (`<release>-minio.<namespace>.svc.<clusterDomain>`). Override this if your cluster uses a custom domain instead of the Kubernetes default `cluster.local`. |
76+
| clusterDomain | string | `"cluster.local"` | The cluster domain to use when building the in-cluster Garage endpoint (`<release>-garage.<namespace>.svc.<clusterDomain>`). Override this if your cluster uses a custom domain instead of the Kubernetes default `cluster.local`. |
7777
| customCACertificate | object | `{"certificate":"public.crt","existingCertificate":null}` | Setup for Custom CA certificates. These are automatically mounted into every secureCodeBox component (lurker, parser & hooks). Requires that every namespace has a configmap with the CA certificate(s) |
7878
| customCACertificate.certificate | string | `"public.crt"` | key in the configmap holding the certificate(s) |
7979
| customCACertificate.existingCertificate | string | `nil` | name of the configMap holding the ca certificate(s), needs to be the same across all namespaces |
8080
| extraVolumeMounts | list | `[]` | Additional volume mounts to be mounted to the operator deployment |
8181
| extraVolumes | list | `[]` | Additional volumes to be mounted to the operator deployment |
82+
| garage | object | `{"auth":{"accessKey":"","adminToken":"","existingSecret":"","rpcSecret":"","secretKey":""},"defaultBucket":"securecodebox","enabled":true,"image":{"pullPolicy":"IfNotPresent","repository":"docker.io/dxflrs/garage","tag":"v2.3.0"},"persistence":{"size":"10Gi","storageClass":""},"podSecurityContext":{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000},"resources":{"limits":{"cpu":"500m","ephemeral-storage":"1Gi","memory":"512Mi"},"requests":{"cpu":"100m","memory":"256Mi"}},"securityContext":{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsGroup":1000,"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}}}` | Garage configuration for direct deployment (S3-compatible quickstart storage backend) |
83+
| garage.auth | object | `{"accessKey":"","adminToken":"","existingSecret":"","rpcSecret":"","secretKey":""}` | Authentication configuration |
84+
| garage.auth.accessKey | string | `""` | Default access key (leave empty to generate a secure random one) |
85+
| garage.auth.adminToken | string | `""` | Garage admin API token (leave empty to generate a secure random one). Not used for anything outside the pod on a single-node deployment. |
86+
| garage.auth.existingSecret | string | `""` | Name of existing secret containing garage credentials (if set, auth.accessKey, auth.secretKey, auth.rpcSecret and auth.adminToken are ignored) |
87+
| garage.auth.rpcSecret | string | `""` | Garage inter-node RPC secret (leave empty to generate a secure random one). Not used for anything outside the pod on a single-node deployment. |
88+
| garage.auth.secretKey | string | `""` | Default secret key (leave empty to generate a secure random one) |
89+
| garage.defaultBucket | string | `"securecodebox"` | Default bucket to create on startup |
90+
| garage.enabled | bool | `true` | Enable this to use Garage as storage backend instead of a cloud bucket provider like AWS S3, Google Cloud Storage, DigitalOcean Spaces etc. |
91+
| garage.image | object | `{"pullPolicy":"IfNotPresent","repository":"docker.io/dxflrs/garage","tag":"v2.3.0"}` | Garage image configuration |
92+
| garage.persistence | object | `{"size":"10Gi","storageClass":""}` | Persistence configuration |
93+
| garage.persistence.size | string | `"10Gi"` | Size of the persistent volume |
94+
| garage.persistence.storageClass | string | `""` | Storage class for garage data persistence |
95+
| garage.podSecurityContext | object | `{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000}` | Pod security context for garage |
96+
| garage.resources | object | `{"limits":{"cpu":"500m","ephemeral-storage":"1Gi","memory":"512Mi"},"requests":{"cpu":"100m","memory":"256Mi"}}` | Resource limits and requests for garage |
97+
| garage.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsGroup":1000,"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}}` | Container security context for garage |
8298
| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
8399
| image.repository | string | `"docker.io/securecodebox/operator"` | The operator image repository |
84100
| image.tag | string | defaults to the charts version | Parser image tag |
@@ -88,21 +104,6 @@ helm install securecodebox-operator oci://ghcr.io/securecodebox/helm/operator
88104
| lurker.image.tag | string | defaults to the charts version | Parser image tag |
89105
| metrics | object | `{"serviceMonitor":{"enabled":false}}` | Configuration for the metrics the operator exports |
90106
| metrics.serviceMonitor.enabled | bool | `false` | Creates a prometheus operator ServiceMonitor rule to automatically scrape the operators metrics: https://github.com/prometheus-operator/prometheus-operator |
91-
| minio | object | `{"auth":{"existingSecret":"","rootPassword":"","rootUser":"admin"},"defaultBuckets":"securecodebox","enabled":true,"image":{"pullPolicy":"IfNotPresent","repository":"docker.io/minio/minio","tag":"RELEASE.2025-07-23T15-54-02Z"},"persistence":{"size":"10Gi","storageClass":""},"podSecurityContext":{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000},"resources":{"limits":{"cpu":"500m","ephemeral-storage":"1Gi","memory":"512Mi"},"requests":{"cpu":"100m","memory":"256Mi"}},"securityContext":{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsGroup":1000,"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}},"tls":{"enabled":false}}` | Minio configuration for direct deployment |
92-
| minio.auth | object | `{"existingSecret":"","rootPassword":"","rootUser":"admin"}` | Authentication configuration |
93-
| minio.auth.existingSecret | string | `""` | Name of existing secret containing minio credentials (if set, auth.rootUser and auth.rootPassword are ignored) |
94-
| minio.auth.rootPassword | string | `""` | Root password for minio (leave empty to generate a secure random password) |
95-
| minio.auth.rootUser | string | `"admin"` | Root user for minio |
96-
| minio.defaultBuckets | string | `"securecodebox"` | Default buckets to create on startup |
97-
| minio.enabled | bool | `true` | Enable this to use minio as storage backend instead of a cloud bucket provider like AWS S3, Google Cloud Storage, DigitalOcean Spaces etc. |
98-
| minio.image | object | `{"pullPolicy":"IfNotPresent","repository":"docker.io/minio/minio","tag":"RELEASE.2025-07-23T15-54-02Z"}` | Minio image configuration |
99-
| minio.persistence | object | `{"size":"10Gi","storageClass":""}` | Persistence configuration |
100-
| minio.persistence.size | string | `"10Gi"` | Size of the persistent volume |
101-
| minio.persistence.storageClass | string | `""` | Storage class for minio data persistence |
102-
| minio.podSecurityContext | object | `{"fsGroup":1000,"runAsGroup":1000,"runAsUser":1000}` | Pod security context for minio |
103-
| minio.resources | object | `{"limits":{"cpu":"500m","ephemeral-storage":"1Gi","memory":"512Mi"},"requests":{"cpu":"100m","memory":"256Mi"}}` | Resource limits and requests for minio |
104-
| minio.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"runAsGroup":1000,"runAsNonRoot":true,"runAsUser":1000,"seccompProfile":{"type":"RuntimeDefault"}}` | Container security context for minio |
105-
| minio.tls | object | `{"enabled":false}` | TLS configuration (currently not implemented) |
106107
| nodeSelector | object | `{}` | |
107108
| podSecurityContext | object | `{}` | Sets the securityContext on the operators pod level. See: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container |
108109
| presignedUrlExpirationTimes | object | `{"hooks":"1h","parsers":"1h","scanners":"12h"}` | Duration how long presigned urls are valid |

0 commit comments

Comments
 (0)