Aggregate backup in neo4j-admin helm chart (#1719) (#1721)

Cherry-picked from #1719

Author: renetapopova

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

@@ -1,6 +1,6 @@
 [role=enterprise-edition]
 [[kubernetes-neo4j-backup-restore]]
-= Back up and restore (online)
+= Back up, aggregate, and restore (online)
 
 [NOTE]
 ====
@@ -323,6 +323,7 @@ consistencyCheck:
   enabled: true
 ----
 
+[role=label--new-5.16]
 [[kubernetes-neo4j-backup-on-prem]]
 == Prepare to back up a database(s) to on-premises storage
 
@@ -390,7 +391,7 @@ disableLookups: false
 
 neo4j:
   image: "neo4j/helm-charts-backup"
-  imageTag: "5.16.0"
+  imageTag: "5.21.0"
   podLabels: {}
 #    app: "demo"
 #    acac: "dcdddc"
@@ -445,7 +446,7 @@ backup:
   database: ""
   # cloudProvider can be either gcp, aws, or azure
   # if cloudProvider is empty then the backup will be done to the /backups mount.
-  # the /backups mount can point to a persitentVolume based on the definition set in tempVolume
+  # the /backups mount can point to a persistentVolume based on the definition set in tempVolume
   cloudProvider: ""
 
 
@@ -490,6 +491,20 @@ backup:
   verbose: true
   heapSize: ""
 
+  # https://neo4j.com/docs/operations-manual/current/backup-restore/aggregate/
+  # Performs aggregate backup. If enabled, NORMAL BACKUP WILL NOT BE DONE only aggregate backup
+  # fromPath supports only s3 or local mount. For s3 , please set cloudProvider to aws and use either serviceAccount or creds
+  aggregate:
+    enabled: false
+    verbose: true
+    keepOldBackup: false
+    parallelRecovery: false
+    # Only AWS S3 or local mount paths are supported
+    # For S3 provide the complete path , Ex: s3://bucket1/bucket2
+    fromPath: ""
+    # database name to aggregate. Can contain * and ? for globbing.
+    database: ""
+
 #Below are all neo4j-admin database check flags / options
 #To know more about the flags read here : https://neo4j.com/docs/operations-manual/current/tools/neo4j-admin/consistency-checker/
 consistencyCheck:
@@ -597,6 +612,162 @@ This pod performs a backup of one or multiple databases, a consistency check of
 . Monitor the backup pod logs using `kubectl logs pod/<neo4j-backup-pod-name>` to check the progress of the backup.
 . Check that the backup files and the consistency check reports have been uploaded to the cloud provider bucket or on-premises storage.
 
+[role=label--new-5.21]
+[[kubernetes-neo4j-backup-aggregate]]
+== Aggregate a database backup chain
+
+The aggregate backup command turns a backup chain into a single backup file.
+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.
+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].
+
+[NOTE]
+====
+The neo4j-admin Helm chart supports aggregating a backup chain stored in an AWS S3 bucket or a local mount.
+If enabled, normal backup will not be done, only aggregate backup.
+====
+
+. To aggregate a backup chain stored in an AWS S3 bucket or a local mount, you need to provide the following information in your _backup-values.yaml_ file:
++
+[.tabbed-example]
+=====
+[.include-with-aws]
+======
+
+If your backup chain is stored on AWS S3, you need to set cloudProvider to `aws` and use either `creds` or `serviceAccount` to connect to your AWS S3 bucket.
+For example:
+
+.Connect to your AWS S3 bucket using the `awscreds` secret
+[source, yaml, role='noheader']
+----
+neo4j:
+  image: "neo4j/helm-charts-backup"
+  imageTag: "5.21.0"
+  jobSchedule: "* * * * *"
+  successfulJobsHistoryLimit: 3
+  failedJobsHistoryLimit: 1
+  backoffLimit: 3
+
+backup:
+
+  cloudProvider: "aws"
+  secretName: "awscreds"
+  secretKeyName: "credentials"
+
+  aggregate:
+    enabled: true
+    verbose: false
+    keepOldBackup: false
+    parallelRecovery: false
+    fromPath: "s3://bucket1/bucket2"
+    # Database name to aggregate. Can contain * and ? for globbing.
+    database: "neo4j"
+
+resources:
+  requests:
+    ephemeralStorage: "4Gi"
+  limits:
+    ephemeralStorage: "5Gi"
+----
+
+.Connect to your AWS S3 bucket using `serviceAccount`
+[source, yaml, role='noheader']
+----
+neo4j:
+  image: "neo4j/helm-charts-backup"
+  imageTag: "5.21.0"
+  jobSchedule: "* * * * *"
+  successfulJobsHistoryLimit: 3
+  failedJobsHistoryLimit: 1
+  backoffLimit: 3
+
+backup:
+
+    cloudProvider: "aws"
+
+    aggregate:
+      enabled: true
+      verbose: false
+      keepOldBackup: false
+      parallelRecovery: false
+      fromPath: "s3://bucket1/bucket2"
+      # Database name to aggregate. Can contain * and ? for globbing.
+      database: "neo4j"
+
+#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.
+#{
+#   "Version": "2012-10-17",
+#    "Id": "Neo4jBackupAggregatePolicy",
+#    "Statement": [
+#        {
+#            "Sid": "Neo4jBackupAggregateStatement",
+#            "Effect": "Allow",
+#            "Action": [
+#                "s3:ListBucket",
+#                "s3:GetObject",
+#                "s3:PutObject",
+#                "s3:DeleteObject"
+#            ],
+#            "Resource": [
+#                "arn:aws:s3:::mybucket/*",
+#                "arn:aws:s3:::mybucket"
+#            ]
+#        }
+#    ]
+#}
+serviceAccountName: "my-service-account"
+
+resources:
+  requests:
+    ephemeralStorage: "4Gi"
+  limits:
+    ephemeralStorage: "5Gi"
+
+----
+======
+[.include-with-local-mount]
+======
+[source, yaml, role='noheader']
+----
+neo4j:
+  image: "neo4j/helm-charts-backup"
+  imageTag: "5.21.0"
+  successfulJobsHistoryLimit: 1
+  failedJobsHistoryLimit: 1
+  backoffLimit: 1
+
+backup:
+
+  aggregate:
+    enabled: true
+    verbose: false
+    keepOldBackup: false
+    parallelRecovery: false
+    fromPath: "/backups"
+    # Database name to aggregate. Can contain * and ? for globbing.
+    database: "neo4j"
+
+tempVolume:
+  persistentVolumeClaim:
+    claimName: aggregate-pv-pvc
+
+resources:
+  requests:
+    ephemeralStorage: "4Gi"
+  limits:
+    ephemeralStorage: "5Gi"
+----
+======
+=====
+. Install the _neo4j-admin_ Helm chart using the configured _backup-values.yaml_ file:
++
+[source, shell, role='noheader']
+----
+helm install backup-name neo4j-admin -f /path/to/your/backup-values.yaml
+----
+. Monitor the pod logs using `kubectl logs pod/<neo4j-aggregate-backup-pod-name>` to check the progress of the aggregate backup operation.
+. Verify that the aggregated backup file has replaced your backup chain in the cloud provider bucket or on-premises storage.
+
+
 [[kubernetes-neo4j-restore]]
 == Restore a single database