Skip to content

Commit eec88fd

Browse files
committed
Add tempDir to the aggregate command in K8s (neo4j#2292)
1 parent 5dc5edf commit eec88fd

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

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

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -472,9 +472,9 @@ backup:
472472
# In case of azure the bucket is the container name in the storage account
473473
# bucket: azure-storage-container
474474
bucketName: ""
475-
476-
#address details of the neo4j instance from which backup is to be done (serviceName or ip either one is required)
477-
475+
# Specify multiple backup endpoints as comma-separated string
476+
# e.g. "10.3.3.2:6362,10.3.3.3:6362,10.3.3.4:6362"
477+
databaseBackupEndpoints: ""
478478
#ex: standalone-admin.default.svc.cluster.local:6362
479479
# admin service name - standalone-admin
480480
# namespace - default
@@ -493,12 +493,17 @@ backup:
493493
databaseBackupPort: ""
494494
#default value is cluster.local
495495
databaseClusterDomain: ""
496-
# specify minio endpoint ex: http://demo.minio.svc.cluster.local:9000
497-
# please ensure this endpoint is the s3 api endpoint or else the backup helm chart will fail
498-
# as of now it works only with non tls endpoints
499-
# to be used only when aws is used as cloudProvider
500-
minioEndpoint: ""
501-
496+
# specify S3-compatible endpoint (e.g., http://s3.amazonaws.com or your custom S3 endpoint)
497+
# This can be any S3-compatible endpoint including AWS S3, MinIO, or other S3-compatible storage services
498+
# For TLS endpoints (https), set s3EndpointTLS to true
499+
s3Endpoint: ""
500+
# Enable TLS for S3 endpoint (default: false)
501+
s3EndpointTLS: false
502+
# Optional: Base64-encoded CA certificate for S3 endpoint TLS verification
503+
# Only needed for self-signed certificates or private CA
504+
s3CACert: ""
505+
# Optional: Skip TLS verification (not recommended for production)
506+
s3SkipVerify: false
502507
#name of the database to backup ex: neo4j or neo4j,system (You can provide command separated database names)
503508
# In case of comma separated databases failure of any single database will lead to failure of complete operation
504509
database: ""
@@ -562,6 +567,9 @@ backup:
562567
fromPath: ""
563568
# database name to aggregate. Can contain * and ? for globbing.
564569
database: ""
570+
# Optional temporary directory for aggregation process
571+
# If not specified, will use the backup directory
572+
tempDir: ""
565573
566574
#Below are all neo4j-admin database check flags / options
567575
#To know more about the flags read here : https://neo4j.com/docs/operations-manual/current/tools/neo4j-admin/consistency-checker/
@@ -601,6 +609,14 @@ securityContext:
601609
fsGroup: 7474
602610
fsGroupChangePolicy: "Always"
603611
612+
containerSecurityContext:
613+
runAsNonRoot: true
614+
runAsUser: 7474
615+
runAsGroup: 7474
616+
readOnlyRootFilesystem: false
617+
allowPrivilegeEscalation: false
618+
capabilities:
619+
drop: ["ALL"]
604620
# default ephemeral storage of backup container
605621
resources:
606622
requests:
@@ -678,9 +694,13 @@ The aggregate backup command turns a backup chain into a single backup file.
678694
This is useful when you have a backup chain that you want to restore to a different cluster, or when you want to archive a backup chain.
679695
For more information on the benefits of the aggregate backup chain operation, its syntax and available options, see xref:backup-restore/aggregate.adoc[Aggregate a database backup chain].
680696

697+
Starting from 5.26 LTS, the _neo4j-admin_ Helm chart supports an optional temporary directory to be used by the aggregation process instead of the backup working directory.
698+
This is especially useful when the size of the backup chain is larger then the pods ephemeral storage.
699+
To avoid the backup aggregation job to fail due to lack of disk space, you can set the `tempDir` parameter to a persistent volume claim that has enough space to hold the backup files.
700+
681701
[NOTE]
682702
====
683-
The neo4j-admin Helm chart supports aggregating a backup chain stored in an AWS S3 bucket or a local mount.
703+
The _neo4j-admin_ Helm chart supports aggregating a backup chain stored in an AWS S3 bucket or a local mount.
684704
If enabled, normal backup will not be done, only aggregate backup.
685705
====
686706

@@ -719,6 +739,9 @@ backup:
719739
fromPath: "s3://bucket1/bucket2"
720740
# Database name to aggregate. Can contain * and ? for globbing.
721741
database: "neo4j"
742+
# Optional temporary directory for aggregation process
743+
# If not specified, will use the backup directory
744+
tempDir: "/custom/temp/dir"
722745
723746
resources:
724747
requests:
@@ -750,6 +773,9 @@ backup:
750773
fromPath: "s3://bucket1/bucket2"
751774
# Database name to aggregate. Can contain * and ? for globbing.
752775
database: "neo4j"
776+
# Optional temporary directory for aggregation process
777+
# If not specified, will use the backup directory
778+
tempDir: "/custom/temp/dir"
753779
754780
#The service account must already exist in your cloud provider account and have the necessary permissions to manage your S3 bucket, as well as to download and upload files. See the example policy below.
755781
#{
@@ -803,6 +829,9 @@ backup:
803829
fromPath: "/backups"
804830
# Database name to aggregate. Can contain * and ? for globbing.
805831
database: "neo4j"
832+
# Optional temporary directory for aggregation process
833+
# If not specified, will use the backup directory
834+
tempDir: "/custom/temp/dir"
806835
807836
tempVolume:
808837
persistentVolumeClaim:

0 commit comments

Comments
 (0)