Skip to content

Commit 4bfdc44

Browse files
author
Bledi Feshti
committed
Added support for generic s3 endpoints and deprecate MinIO specific config
1 parent 0a92761 commit 4bfdc44

File tree

1 file changed

+59
-9
lines changed

1 file changed

+59
-9
lines changed

modules/ROOT/pages/kubernetes/operations/backup-restore.adoc

Lines changed: 59 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -287,15 +287,30 @@ You need to create the persistent volume and persistent volume claim before inst
287287
For more information, see xref:kubernetes/persistent-volumes.adoc[Volume mounts and persistent volumes].
288288
====
289289

290-
==== Configure the _backup-values.yaml_ file for using MinIO
290+
==== Configure S3-compatible Storage Endpoints
291291

292-
MinIO is an AWS S3-compatible object storage API.
293-
You can specify the `minioEndpoint` parameter in the _backup-values.yaml_ file to push your backups to your MinIO bucket.
294-
This endpoint must be a s3 API endpoint or else the backup Helm chart will fail.
295-
Only non-TLS/SSL endpoints are supported.
296-
For example:
292+
The backup system supports any S3-compatible storage service. You can configure both TLS and non-TLS endpoints using the following parameters in your _backup-values.yaml_ file:
297293

298-
[source, yaml, role='noheader']
294+
[source, yaml]
295+
----
296+
backup:
297+
# Specify your S3-compatible endpoint (e.g., https://s3.amazonaws.com or your custom endpoint)
298+
s3Endpoint: "https://s3.custom-provider.com"
299+
300+
# Enable TLS for secure connections (default: false)
301+
s3EndpointTLS: true
302+
303+
# Optional: Provide a base64-encoded CA certificate for custom certificate authorities
304+
s3CACert: "base64_encoded_ca_cert_data"
305+
306+
# Optional: Skip TLS verification (not recommended for production)
307+
s3SkipVerify: false
308+
----
309+
310+
===== Configuration Examples
311+
312+
.AWS S3 Standard Endpoint
313+
[source, yaml]
299314
----
300315
neo4j:
301316
image: "neo4j/helm-charts-backup"
@@ -307,8 +322,9 @@ neo4j:
307322
308323
backup:
309324
bucketName: "my-bucket"
310-
databaseAdminServiceName: "standalone-admin"
311-
minioEndpoint: "http://demo.minio.svc.cluster.local:9000"
325+
databaseAdminServiceName: "standalone-admin"
326+
s3Endpoint: "https://s3.amazonaws.com"
327+
s3EndpointTLS: true
312328
database: "neo4j,system"
313329
cloudProvider: "aws"
314330
secretName: "awscreds"
@@ -318,6 +334,40 @@ consistencyCheck:
318334
enabled: true
319335
----
320336

337+
.Custom S3-compatible Provider with Self-signed Certificate
338+
[source, yaml]
339+
----
340+
backup:
341+
bucketName: "my-bucket"
342+
s3Endpoint: "https://custom-s3.example.com"
343+
s3EndpointTLS: true
344+
s3CACert: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0t..." # Base64-encoded CA cert
345+
cloudProvider: "aws"
346+
secretName: "awscreds"
347+
secretKeyName: "credentials"
348+
----
349+
350+
.Legacy MinIO Support (Deprecated)
351+
[source, yaml]
352+
----
353+
backup:
354+
bucketName: "my-bucket"
355+
databaseAdminServiceName: "standalone-admin"
356+
minioEndpoint: "http://minio.example.com:9000" # Deprecated: Use s3Endpoint instead
357+
database: "neo4j,system"
358+
cloudProvider: "aws"
359+
secretName: "awscreds"
360+
secretKeyName: "credentials"
361+
----
362+
363+
[IMPORTANT]
364+
====
365+
* The `s3EndpointTLS` parameter must be set to `true` when using HTTPS endpoints
366+
* When using custom CA certificates, provide them base64-encoded in the `s3CACert` parameter
367+
* The `s3SkipVerify` parameter should only be used in development environments
368+
* Legacy MinIO support through the `minioEndpoint` parameter is deprecated - use `s3Endpoint` instead
369+
====
370+
321371

322372
[[kubernetes-neo4j-backup-on-prem]]
323373
== Prepare to back up a database(s) to on-premises storage

0 commit comments

Comments
 (0)