Skip to content

Commit 05e38f4

Browse files
fixed newlines (#436)
Co-authored-by: Martin O'Hanlon <martin.ohanlon@neo4j.com> Co-authored-by: Martin O'Hanlon <martin@ohanlonweb.com>
1 parent 75b5c2d commit 05e38f4

File tree

9 files changed

+187
-18
lines changed

9 files changed

+187
-18
lines changed

asciidoc/courses/aura-fundamentals/modules/1-introduction/lessons/1-about/lesson.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,4 @@ include::questions/1-versus.adoc[leveloffset=+1]
4848
In this lesson, you learned what Neo4j Aura is and how it differs from self-managed Neo4j databases.
4949

5050
In the next lesson, you will learn about the shared responsibilities of Aura and its users.
51+

asciidoc/courses/aura-fundamentals/modules/2-getting-started/lessons/2-create-instance/lesson.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Make sure to **Download and continue** and **keep** the file safe. It contains t
7171

7272
[.slide.discrete]
7373
[NOTE]
74-
.Instance Configuration Notes
74+
.Instance connection details
7575
====
7676
* The instanceid cannot be changed in the lifetime of the instance.
7777
* The user has admin rights on the database.

asciidoc/courses/aura-fundamentals/modules/2-getting-started/lessons/3-manage-instance/lesson.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Cloning makes a copy of an existing instance into:
135135
This is perfect for creating development environments, testing changes, or setting up staging environments that mirror production.
136136

137137
[NOTE]
138-
.Understanding Tier Changes
138+
.Cloning an instance
139139
====
140140
This can be used to shift a database to a higher tier. The difference with **upgrade** is that the URI of the new instance will be different.
141141
====

asciidoc/courses/aura-fundamentals/modules/2-getting-started/lessons/4-backup-and-restore/lesson.adoc

Lines changed: 177 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,25 @@ Aura creates snapshots based on your instance tier:
3232
* **Aura Professional**: Regular automated snapshots with longer retention
3333
* **Aura Business Critical**: Frequent automated snapshots with extended retention periods
3434
35-
// [NOTE]
36-
// ====
37-
// The frequency and retention of snapshots varies by tier. Check your specific tier documentation for exact details.
38-
// ====
35+
[.slide]
36+
== Snapshot frequency and retention
37+
38+
The specific frequency and retention periods vary by tier:
39+
40+
* **Aura Free**: On-demand snapshots only; only the latest snapshot is available
41+
* **Aura Professional**: Daily scheduled snapshots, retained for 7 days
42+
* **Aura Business Critical**: Daily full snapshots plus hourly differential snapshots, retained for 30 days
43+
* **Aura Virtual Dedicated Cloud**: Hourly snapshots for the first 7 days, then daily snapshots from day 8 to 60
44+
45+
[.slide]
46+
== Taking on-demand snapshots
47+
48+
You can manually trigger a snapshot at any time by selecting **Take snapshot** from the Snapshots tab of your instance. This is particularly useful:
49+
50+
* Before major application updates or changes
51+
* After significant data imports
52+
* Before performing risky operations
53+
* When you need a backup outside the regular schedule
3954
[.slide]
4055
== Working with snapshots
4156
@@ -50,23 +65,60 @@ There are three key actions you can take with any snapshot:
5065
== Snapshot actions
5166
image::images/03_snapshot_actions.jpg[snapshotactions,width=300,align=center]
5267

53-
[.slide]
54-
68+
[.slide]
5569
=== Export snapshots
5670

5771
**Export** downloads the snapshot to your local machine. This is crucial for long-term archival beyond Aura's retention period, especially when you need to meet compliance requirements that mandate offline backups.
5872

5973
It's also essential for creating backups before major changes or migrations, and for sharing data securely with development teams.
6074

6175
[.slide]
62-
76+
=== How to export a snapshot
77+
78+
To export a snapshot:
79+
80+
1. Navigate to the **Snapshots** tab within your Aura instance
81+
2. Locate the snapshot you want to export
82+
3. Click the more menu (…​) next to the snapshot
83+
4. Select **Export** to download the snapshot
84+
85+
The download time depends on your database size and network speed.
86+
87+
[.slide]
88+
=== Export file formats
89+
90+
Exported snapshots use different file formats depending on your Neo4j version:
91+
92+
* **Neo4j Version 5**: `.backup` format (changed October 1, 2024)
93+
* **Neo4j Version 4.x**: `.dump` format
94+
95+
Store your exported snapshots in a secure location with a clear naming convention that includes the instance name and export date.
96+
97+
[.slide]
6398
=== Create new instances from snapshots
6499

65100
**Create instance from snapshot** spins up a fresh instance with the snapshot's data. This is perfect for setting up development environments that mirror production, allowing you to test changes on a copy of real data.
66101

67102
You can also use this to create staging environments for application testing, or as part of your disaster recovery scenarios.
103+
68104
[.slide]
69-
105+
=== How to create an instance from a snapshot
106+
107+
To create a new instance from a snapshot:
108+
109+
1. In the **Snapshots** tab, find the snapshot you want to use
110+
2. Click the more menu (…​) next to the snapshot
111+
3. Select **Create instance from snapshot**
112+
4. Choose your desired tier and size (can be different from the original)
113+
5. Follow the prompts to configure the new instance
114+
115+
[NOTE]
116+
.Remember
117+
====
118+
The new instance will be billed separately according to its selected tier and size. The time to create the instance varies based on database size and system load.
119+
====
120+
121+
[.slide]
70122
=== Restoring snapshots
71123

72124
**Restore** reverts your current instance to the snapshot's point in time. You want to use this when you need to roll back problematic changes, when data corruption has occurred, or when you want to return to a known good state after testing.
@@ -76,8 +128,34 @@ You can also use this to create staging environments for application testing, or
76128
====
77129
Restoring a snapshot **overwrites** all current data in your instance. Make sure you export a current snapshot first if you might need to recover the current state later.
78130
====
131+
132+
[.slide]
133+
=== How to restore a snapshot
134+
135+
To restore your instance to a previous snapshot:
136+
137+
1. Go to the **Snapshots** tab in your Aura instance
138+
2. Locate the snapshot you wish to restore
139+
3. Click the restore icon (↩) next to the snapshot
140+
4. Type **RESTORE** to confirm the action
141+
5. Click **Restore** to proceed
142+
143+
[NOTE]
144+
.Restore process
145+
====
146+
Your instance will be temporarily unavailable during the restore process. The duration depends on your database size. Plan for potential downtime when restoring snapshots.
147+
====
148+
149+
[.slide]
150+
=== Previewing snapshot data
151+
152+
There's no direct way to preview snapshot contents before restoring. However, you can:
153+
154+
* Create a new instance from the snapshot to inspect the data
155+
* Verify the snapshot timestamp matches your expected state
156+
* Check the snapshot size as an indicator of data volume
79157
80-
=[.slide]
158+
[.slide]
81159
== Restoring from backup file
82160

83161
image::images/03_restore_from_backup.jpg[restore,width=450,align=center]
@@ -93,6 +171,22 @@ This is particularly useful when:
93171
* Restoring from an exported snapshot
94172
* Loading data from another Neo4j environment
95173
174+
[.slide]
175+
=== How to restore from a local backup file
176+
177+
To restore your instance from a local backup file:
178+
179+
1. Navigate to the **Restore from backup file** tab in your Aura instance
180+
2. Drag and drop your `.backup`, `.dump`, or `.tar` file, or click to browse
181+
3. Confirm the restoration, understanding that this will overwrite all existing data
182+
4. Wait for the process to complete
183+
184+
[NOTE]
185+
.Local restore process
186+
====
187+
Your instance will be unavailable during the restoration process. Duration varies based on file size and system resources.
188+
====
189+
96190

97191
[.slide]
98192
=== Important limitations
@@ -104,7 +198,23 @@ Keep these constraints in mind when restoring from local files:
104198
* **File size limit**: Backup files cannot exceed 4GB for upload through the console
105199
* **Larger files**: Files bigger than 4GB require command-line tools
106200
107-
[.slide]
201+
[.slide]
202+
=== Handling files larger than 4GB
203+
204+
For backup files exceeding 4GB, you'll need to use the Neo4j Admin command-line tool:
205+
206+
[source,bash]
207+
----
208+
neo4j-admin database upload <database-name> \
209+
--from-path=<path-to-backup> \
210+
--to-uri=<aura-instance-uri> \
211+
--to-user=<username> \
212+
--to-password=<password>
213+
----
214+
215+
This command uploads your database directly to your Aura instance, bypassing the console file size limitation.
216+
217+
[.slide]
108218
=== When to use local restore
109219

110220
The use case for local file restore is somewhat limited, but it's a **great** way to get started with smaller databases when moving from self-managed setups to Aura.
@@ -143,6 +253,17 @@ Regularly export important snapshots to your own storage:
143253
* On a scheduled basis for critical production data
144254
* Before performing any potentially risky operations
145255

256+
[.slide]
257+
=== Example backup schedules
258+
259+
Consider these backup schedules based on your environment:
260+
261+
* **Development**: On-demand snapshots before major changes
262+
* **Staging**: Daily scheduled snapshots with weekly exports
263+
* **Production**: Hourly differential and daily full snapshots with weekly exports to external storage
264+
265+
Adjust your schedule based on your data change frequency, recovery time objectives, and compliance requirements.
266+
146267
[.slide]
147268

148269
=== Testing your restore process
@@ -154,6 +275,12 @@ A backup is only as good as your ability to restore from it. Regularly test your
154275
* Document your restore procedures
155276
* Train your team on the restore process
156277

278+
[TIP]
279+
.Snapshot testing
280+
====
281+
Use snapshot testing to validate your backups without affecting your production instance. Create a test instance from a snapshot and run verification queries to ensure data completeness and accuracy.
282+
====
283+
157284
[.slide]
158285

159286
=== Compliance and retention
@@ -165,6 +292,30 @@ Consider your organization's requirements:
165292
* Do you need backups stored in specific geographic regions?
166293
* Are there encryption requirements for exported snapshots?
167294

295+
[.slide]
296+
=== Security and data protection
297+
298+
Neo4j Aura provides built-in security for your backups:
299+
300+
* **Encryption at rest**: All snapshots are stored in encrypted cloud storage buckets
301+
* **Encryption in transit**: Data is encrypted during backup and restore operations
302+
* **Dedicated storage**: Each instance has dedicated, secure storage for backups
303+
* **Access control**: Only authorized users can export, restore, or create instances from snapshots
304+
305+
Your exported snapshot files maintain this security, but you're responsible for securing them once downloaded to your local system or external storage.
306+
307+
[.slide]
308+
=== What's included in snapshots
309+
310+
Snapshots provide a complete backup of your database instance, including:
311+
312+
* All nodes, relationships, and properties
313+
* Indexes and constraints
314+
* Database schema and structure
315+
* Users, roles, and permissions
316+
* Configuration settings
317+
318+
This ensures that when you restore or create an instance from a snapshot, you get an exact replica of your database at that point in time.
168319

169320
[.slide]
170321

@@ -173,6 +324,12 @@ Consider your organization's requirements:
173324
====
174325
You can also restore an instance and create a new instances from a snapshot by its ID through the Aura API.
175326
327+
The API is particularly useful for:
328+
329+
* Automating backup and restore operations
330+
* Integrating with CI/CD pipelines
331+
* Managing multiple instances programmatically
332+
176333
link:https://neo4j.com/docs/aura/platform/api/specification/#/instances/post-instances[View the Aura API reference documentation]
177334
178335
====
@@ -188,8 +345,16 @@ include::questions/2-snapshot-actions.adoc[leveloffset=+1]
188345
[.summary]
189346
== Summary
190347

191-
In this lesson, you learned about Aura's comprehensive backup and restore capabilities.
348+
In this lesson, you learned about Aura's comprehensive backup and restore capabilities, including:
349+
350+
* **Snapshot frequency and retention** - How different tiers (Free, Professional, Business Critical, VDC) handle automated and on-demand snapshots
351+
* **Exporting snapshots** - How to download snapshots in `.backup` or `.dump` format for long-term storage
352+
* **Creating instances from snapshots** - How to spin up new instances from existing snapshots for testing or development
353+
* **Restoring snapshots** - The step-by-step process to revert your instance to a previous state
354+
* **Restoring from local files** - How to upload backup files up to 4GB through the console or use command-line tools for larger files
355+
* **Security considerations** - How Aura encrypts your data at rest and in transit
356+
* **What's included** - Understanding that snapshots contain all your data, schema, indexes, constraints, users, and configuration
192357

193-
You also learned about the important limitations to keep in mind, particularly the 4GB file size limit for console uploads and the various restrictions that apply to different Aura tiers.
358+
You also learned about planning a backup strategy that includes regular exports, testing restore procedures, and meeting compliance requirements.
194359

195360
In the next lesson, you'll move on to connecting to your instance and start working with your data directly.

asciidoc/courses/aura-fundamentals/modules/2-getting-started/lessons/5-connecting/questions/1-connection.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,4 @@ To connect to your Aura instance, you need the following details:
2525
* **Database name**: The name of the specific database you want to connect to within your Aura instance.
2626
2727
You do not need to know the cloud provider to connect to your Aura instance, as this information is abstracted away by the service.
28-
2928
====

asciidoc/courses/aura-fundamentals/modules/3-services-tools/lessons/3-explore/lesson.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ image::images/03_explore_tool_result.jpg[exploretool_result,width=500,align=cent
7979
The results are visualized in the scene area. You can interact with the nodes and relationships by clicking and dragging them around.
8080

8181
[NOTE]
82-
.Zooming for Details
82+
.Zoom in
8383
====
8484
You may have to zoom in a bit before the details are shown.
8585
====
@@ -129,7 +129,7 @@ video::https://cdn.graphacademy.neo4j.com/courses/aura-fundamentals/explore-opti
129129
[.slide]
130130
== Important considerations
131131
[NOTE]
132-
.Understanding Your Data Model
132+
.Important considerations
133133
====
134134
1. The model has to be understood. You can explore the data knowing what the database holds and how it is organized.
135135

asciidoc/courses/aura-fundamentals/modules/4-operations/lessons/1-shared-responsibility/lesson.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,3 +131,4 @@ include::questions/1-choosing.adoc[leveloffset=+1]
131131
In this lesson, you learned about the different responsibilities of Neo4j Aura and its users, and how Aura simplifies the management of graph databases in the cloud.
132132

133133
In the next lesson, you will learn how to access security settings and logs in Neo4j Aura.
134+

asciidoc/courses/aura-fundamentals/modules/4-operations/lessons/2-security-and-logs/lesson.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ You can also download logs for further analysis or compliance purposes.
112112
image::images/4-security-logs.png[Security screenshot]
113113

114114
[NOTE]
115-
.Learn More About Aura Security
115+
.Neo4j Aura Security Whitepaper
116116
====
117117
To learn more about enabling the security features in Neo4j Aura, you can refer to the [Neo4j Aura Security Whitepaper](https://neo4j.com/books/neo4j-aura-security/) for a detailed overview of the security measures and responsibilities in Aura.
118118
====
@@ -135,3 +135,5 @@ You also learned how to access and utilize logs to monitor user activity and dat
135135

136136
In the next lesson, you will explore additional resources and further steps to continue your learning journey with Neo4j Aura.
137137

138+
139+

asciidoc/courses/aura-fundamentals/modules/4-operations/lessons/3-further-steps/lesson.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= Further Steps
22
:type: lesson
33
:order: 3
4+
:slides: true
45

56
[.slide.discrete]
67
== Further steps with Neo4j Aura

0 commit comments

Comments
 (0)