Skip to content

Commit 660dd31

Browse files
authored
Add support for backing up multiple dbs with neo4j-admin helm (#933) (#936)
Cherry-picked from #933
1 parent c695e23 commit 660dd31

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

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

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[role=enterprise-edition]
22
[[kubernetes-neo4j-backup-restore]]
3-
= Back up and restore a single database (online)
3+
= Back up and restore (online)
44

55
[NOTE]
66
====
@@ -9,9 +9,10 @@ For more information, see xref:kubernetes/accessing-neo4j.adoc[Accessing Neo4j].
99
====
1010

1111
[[kubernetes-neo4j-backup-cloud]]
12-
== Back up a database to a cloud provider (AWS, GCP, and Azure) bucket
12+
== Back up a database(s) to a cloud provider (AWS, GCP, and Azure) bucket
1313

14-
You can perform a backup of a Neo4j database to any cloud provider (AWS, GCP, and Azure) bucket using the _neo4j/neo4j-admin_ Helm chart.
14+
You can perform a backup of a Neo4j database(s) to any cloud provider (AWS, GCP, and Azure) bucket using the _neo4j/neo4j-admin_ Helm chart.
15+
From version 5.10.0, the _neo4j/neo4j-admin_ Helm chart also supports performing a backup of multiple databases.
1516

1617
=== Prerequisites
1718

@@ -101,16 +102,16 @@ For more information about the available backup parameters, see <<kubernetes-neo
101102
----
102103
neo4j:
103104
image: "neo4j/helm-charts-backup"
104-
imageTag: "5.8.0"
105+
imageTag: "5.10.0"
105106
jobSchedule: "* * * * *"
106107
successfulJobsHistoryLimit: 3
107108
failedJobsHistoryLimit: 1
108-
backoffLimit: 1
109+
backoffLimit: 3
109110
110111
backup:
111112
bucketName: "my-bucket"
112113
databaseAdminServiceName: "standalone-admin" #This is the Neo4j Admin Service name.
113-
database: "neo4j"
114+
database: "neo4j,system"
114115
cloudProvider: "gcp"
115116
secretName: "gcpcreds"
116117
secretKeyName: "credentials"
@@ -126,16 +127,16 @@ consistencyCheck:
126127
----
127128
neo4j:
128129
image: "neo4j/helm-charts-backup"
129-
imageTag: "5.8.0"
130+
imageTag: "5.10.0"
130131
jobSchedule: "* * * * *"
131132
successfulJobsHistoryLimit: 3
132133
failedJobsHistoryLimit: 1
133-
backoffLimit: 1
134+
backoffLimit: 3
134135
135136
backup:
136137
bucketName: "my-bucket"
137138
databaseAdminServiceName: "standalone-admin"
138-
database: "neo4j"
139+
database: "neo4j,system"
139140
cloudProvider: "aws"
140141
secretName: "awscreds"
141142
secretKeyName: "credentials"
@@ -151,16 +152,16 @@ consistencyCheck:
151152
----
152153
neo4j:
153154
image: "neo4j/helm-charts-backup"
154-
imageTag: "5.8.0"
155+
imageTag: "5.10.0"
155156
jobSchedule: "* * * * *"
156157
successfulJobsHistoryLimit: 3
157158
failedJobsHistoryLimit: 1
158-
backoffLimit: 1
159+
backoffLimit: 3
159160
160161
backup:
161162
bucketName: "my-bucket"
162163
databaseAdminServiceName: "standalone-admin"
163-
database: "neo4j"
164+
database: "neo4j,system"
164165
cloudProvider: "azure"
165166
secretName: "azurecreds"
166167
secretKeyName: "credentials"
@@ -195,10 +196,10 @@ For more information, see xref:kubernetes/persistent-volumes.adoc[Volume mounts
195196
helm install backup-name neo4j-admin -f /path/to/your/backup-values.yaml
196197
----
197198
+
198-
The _neo4j/neo4j-admin_ Helm chart installs a cronjob that launches a pod based on the job schedule. This pod performs a backup of the database, a consistency check of the backup file, and uploads both to the cloud provider bucket.
199+
The _neo4j/neo4j-admin_ Helm chart installs a cronjob that launches a pod based on the job schedule. This pod performs a backup of one or multiple databases, a consistency check of the backup file(s), and uploads them to the cloud provider bucket.
199200

200201
. Monitor the backup pod logs using `kubectl logs pod/<neo4j-backup-pod-name>` to check the progress of the backup.
201-
. Check that the backup file and the consistency check report have been uploaded to the cloud provider bucket.
202+
. Check that the backup files and the consistency check reports have been uploaded to the cloud provider bucket.
202203

203204
[[kubernetes-neo4j-backup-parameters]]
204205
=== Backup parameters
@@ -224,7 +225,7 @@ disableLookups: false
224225
225226
neo4j:
226227
image: "neo4j/helm-charts-backup"
227-
imageTag: "5.8.0"
228+
imageTag: "5.10.0"
228229
podLabels: {}
229230
# app: "demo"
230231
# acac: "dcdddc"
@@ -237,7 +238,7 @@ neo4j:
237238
successfulJobsHistoryLimit:
238239
# default is 1
239240
failedJobsHistoryLimit:
240-
# default is 1
241+
# default is 3
241242
backoffLimit:
242243
#add labels if required
243244
labels: {}
@@ -269,7 +270,8 @@ backup:
269270
#default value is cluster.local
270271
databaseClusterDomain: ""
271272
272-
#name of the database to backup ex: neo4j (command separated databases names WILL NOT WORK)
273+
#name of the database to backup ex: neo4j or neo4j,system (You can provide command separated database names)
274+
# In case of comma separated databases failure of any single database will lead to failure of complete operation
273275
database: ""
274276
# cloudProvider can be either gcp, aws, or azure
275277
cloudProvider: ""
@@ -320,6 +322,10 @@ consistencyCheck:
320322
checkGraph: true
321323
checkCounts: true
322324
checkPropertyOwners: true
325+
#The database name for which consistency check needs to be done.
326+
#Defaults to the backup.database values if left empty
327+
#The database name here should match with one of the database names present in backup.database. If not , the consistency check will be ignored
328+
database: ""
323329
maxOffHeapMemory: ""
324330
threads: ""
325331
verbose: true

0 commit comments

Comments
 (0)