You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit dfd6776
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: documentation/docs/getting-started/installation.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,10 @@ The included [Garage](https://garagehq.deuxfleurs.fr/) instance is intended **on
36
36
This provides better reliability, scalability, and security compared to the embedded single-node Garage instance.
37
37
:::
38
38
39
+
:::note Upgrading from MinIO
40
+
As of release 5.9.0, the bundled storage backend was migrated from `minio` to `garage`. This was necessary because MinIO stopped publishing their own Docker image, and the migration had to happen outside of a major release.
41
+
:::
42
+
39
43
The default secureCodeBox Operator includes a [Garage](https://garagehq.deuxfleurs.fr/) instance, which acts as a local S3 filestorage API used by the secureCodeBox to store the results files of its scans. You can switch it out with a S3 compatible API provided by most cloud providers.
40
44
41
45
Garage doesn't ship a web UI, so you access it with any S3-compatible client (e.g. the [`mc`](https://garagehq.deuxfleurs.fr/documentation/connect/cli/) CLI or `aws s3`) after port forwarding its S3 API:
@@ -61,6 +65,10 @@ For production environments, it is **strongly recommended** to replace the defau
61
65
62
66
To change out the default Garage instance with a S3 Bucket from a cloud provider you can update the helm values to connect the operator with you S3 bucket.
63
67
68
+
:::note Upgrading from MinIO
69
+
As of release 5.9.0, the bundled storage backend was migrated from `minio` to `garage`. This was necessary because MinIO stopped publishing their own Docker image, and the migration had to happen outside of a major release. If you already disabled the bundled instance via `minio.enabled: false` together with your own `s3:` configuration, that value is still honored, so no changes are required. New installs and any values files that still reference other `minio.*` keys should switch to the `garage.*` equivalents described below.
| customCACertificate.existingCertificate | string |`nil`| name of the configMap holding the ca certificate(s), needs to be the same across all namespaces |
75
75
| extraVolumeMounts | list |`[]`| Additional volume mounts to be mounted to the operator deployment |
76
76
| 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) |
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). This replaces the previous `minio` configuration section; if your values file still sets `minio.enabled: false`, it will still be honored and disable Garage as well.|
| garage.auth.accessKey | string |`""`| Default access key (leave empty to generate a secure random one) |
80
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
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. |
82
+
| garage.auth.rpcSecret | string |`""`| Garage inter-node RPC secret, must be exactly 64 hex characters (leave empty to generate a secure random one). Not used for anything outside the pod on a single-node deployment. |
83
83
| garage.auth.secretKey | string |`""`| Default secret key (leave empty to generate a secure random one) |
84
84
| garage.defaultBucket | string |`"securecodebox"`| Default bucket to create on startup |
85
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. |
| customCACertificate.existingCertificate | string |`nil`| name of the configMap holding the ca certificate(s), needs to be the same across all namespaces |
80
80
| extraVolumeMounts | list |`[]`| Additional volume mounts to be mounted to the operator deployment |
81
81
| 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) |
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). This replaces the previous `minio` configuration section; if your values file still sets `minio.enabled: false`, it will still be honored and disable Garage as well.|
| garage.auth.accessKey | string |`""`| Default access key (leave empty to generate a secure random one) |
85
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
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. |
87
+
| garage.auth.rpcSecret | string |`""`| Garage inter-node RPC secret, must be exactly 64 hex characters (leave empty to generate a secure random one). Not used for anything outside the pod on a single-node deployment. |
88
88
| garage.auth.secretKey | string |`""`| Default secret key (leave empty to generate a secure random one) |
89
89
| garage.defaultBucket | string |`"securecodebox"`| Default bucket to create on startup |
90
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. |
Copy file name to clipboardExpand all lines: operator/values.yaml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -120,7 +120,7 @@ lurker:
120
120
# -- 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
121
121
pullPolicy: IfNotPresent
122
122
123
-
# -- Garage configuration for direct deployment (S3-compatible quickstart storage backend)
123
+
# -- Garage configuration for direct deployment (S3-compatible quickstart storage backend). This replaces the previous `minio` configuration section; if your values file still sets `minio.enabled: false`, it will still be honored and disable Garage as well.
124
124
garage:
125
125
# -- Enable this to use Garage as storage backend instead of a cloud bucket provider like AWS S3, Google Cloud Storage, DigitalOcean Spaces etc.
0 commit comments