Skip to content

Commit 4d029f2

Browse files
authored
Add tempDir to the aggregate command in K8s (#2292) (#2294)
Cherry-picked from #2292
1 parent 1d266a4 commit 4d029f2

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

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

+39-10
Original file line numberDiff line numberDiff line change
@@ -470,9 +470,9 @@ backup:
470470
# In case of azure the bucket is the container name in the storage account
471471
# bucket: azure-storage-container
472472
bucketName: ""
473-
474-
#address details of the neo4j instance from which backup is to be done (serviceName or ip either one is required)
475-
473+
# Specify multiple backup endpoints as comma-separated string
474+
# e.g. "10.3.3.2:6362,10.3.3.3:6362,10.3.3.4:6362"
475+
databaseBackupEndpoints: ""
476476
#ex: standalone-admin.default.svc.cluster.local:6362
477477
# admin service name - standalone-admin
478478
# namespace - default
@@ -491,12 +491,17 @@ backup:
491491
databaseBackupPort: ""
492492
#default value is cluster.local
493493
databaseClusterDomain: ""
494-
# specify minio endpoint ex: http://demo.minio.svc.cluster.local:9000
495-
# please ensure this endpoint is the s3 api endpoint or else the backup helm chart will fail
496-
# as of now it works only with non tls endpoints
497-
# to be used only when aws is used as cloudProvider
498-
minioEndpoint: ""
499-
494+
# specify S3-compatible endpoint (e.g., http://s3.amazonaws.com or your custom S3 endpoint)
495+
# This can be any S3-compatible endpoint including AWS S3, MinIO, or other S3-compatible storage services
496+
# For TLS endpoints (https), set s3EndpointTLS to true
497+
s3Endpoint: ""
498+
# Enable TLS for S3 endpoint (default: false)
499+
s3EndpointTLS: false
500+
# Optional: Base64-encoded CA certificate for S3 endpoint TLS verification
501+
# Only needed for self-signed certificates or private CA
502+
s3CACert: ""
503+
# Optional: Skip TLS verification (not recommended for production)
504+
s3SkipVerify: false
500505
#name of the database to backup ex: neo4j or neo4j,system (You can provide command separated database names)
501506
# In case of comma separated databases failure of any single database will lead to failure of complete operation
502507
database: ""
@@ -560,6 +565,9 @@ backup:
560565
fromPath: ""
561566
# database name to aggregate. Can contain * and ? for globbing.
562567
database: ""
568+
# Optional temporary directory for aggregation process
569+
# If not specified, will use the backup directory
570+
tempDir: ""
563571
564572
#Below are all neo4j-admin database check flags / options
565573
#To know more about the flags read here : https://neo4j.com/docs/operations-manual/current/tools/neo4j-admin/consistency-checker/
@@ -599,6 +607,14 @@ securityContext:
599607
fsGroup: 7474
600608
fsGroupChangePolicy: "Always"
601609
610+
containerSecurityContext:
611+
runAsNonRoot: true
612+
runAsUser: 7474
613+
runAsGroup: 7474
614+
readOnlyRootFilesystem: false
615+
allowPrivilegeEscalation: false
616+
capabilities:
617+
drop: ["ALL"]
602618
# default ephemeral storage of backup container
603619
resources:
604620
requests:
@@ -676,9 +692,13 @@ The aggregate backup command turns a backup chain into a single backup file.
676692
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.
677693
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].
678694

695+
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.
696+
This is especially useful when the size of the backup chain is larger then the pods ephemeral storage.
697+
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.
698+
679699
[NOTE]
680700
====
681-
The neo4j-admin Helm chart supports aggregating a backup chain stored in an AWS S3 bucket or a local mount.
701+
The _neo4j-admin_ Helm chart supports aggregating a backup chain stored in an AWS S3 bucket or a local mount.
682702
If enabled, normal backup will not be done, only aggregate backup.
683703
====
684704

@@ -717,6 +737,9 @@ backup:
717737
fromPath: "s3://bucket1/bucket2"
718738
# Database name to aggregate. Can contain * and ? for globbing.
719739
database: "neo4j"
740+
# Optional temporary directory for aggregation process
741+
# If not specified, will use the backup directory
742+
tempDir: "/custom/temp/dir"
720743
721744
resources:
722745
requests:
@@ -748,6 +771,9 @@ backup:
748771
fromPath: "s3://bucket1/bucket2"
749772
# Database name to aggregate. Can contain * and ? for globbing.
750773
database: "neo4j"
774+
# Optional temporary directory for aggregation process
775+
# If not specified, will use the backup directory
776+
tempDir: "/custom/temp/dir"
751777
752778
#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.
753779
#{
@@ -801,6 +827,9 @@ backup:
801827
fromPath: "/backups"
802828
# Database name to aggregate. Can contain * and ? for globbing.
803829
database: "neo4j"
830+
# Optional temporary directory for aggregation process
831+
# If not specified, will use the backup directory
832+
tempDir: "/custom/temp/dir"
804833
805834
tempVolume:
806835
persistentVolumeClaim:

0 commit comments

Comments
 (0)