Skip to content

Commit

Permalink
cloudBeta updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Newman authored and Joseph Newman committed Apr 18, 2024
1 parent 381dc91 commit c633939
Show file tree
Hide file tree
Showing 8 changed files with 120 additions and 61 deletions.
Original file line number Diff line number Diff line change
@@ -1,75 +1,118 @@
= Backup and Restore
:experimental:

Data protection and business continuity are critical considerations for any database system.
TigerGraph Cloud provides built-in backup and restore capabilities, allowing you to create backups of your graph databases and restore them when needed.
A built-in backup and restore system, allows users to create backups of graph databases and restore them when needed.

[TIP]
====
This ensures the safety and availability of your data, protecting against accidental data loss or system failures.
====

Discover how to create backup points and restore your workspace to a specific point in time.

[IMPORTANT]
====
Backup functionality is currently available only for xref:cloudBeta:resource-manager:workspaces/writeread_readonly.adoc#_read_write_rw_workspace[Read-Write (RW) workspaces].
Make sure your workspace is in RW mode before attempting to perform a backup.
====
image:backuprestore1.png[]

== Manual backup
In this section, you can find information on how to manually initiate a backup of your data. It will include step-by-step instructions on performing a manual backup using the available tools or commands.
== How to Create a Manual backup
In this section, you can find information on how to manually initiate a backup of your data.

Note:
Backup functionality is currently available only for Read-Write (RW) workspaces. Make sure your workspace is in RW mode before attempting to perform a backup.
.To manually back-up your data, follow these steps:

. Click on image:backupButton.png[width=75,height=75] button to start manual backup.

. Specify a backup tag for a manual backup.
+
[TIP]
Backup tag is used to identify your graph database backup.
+
image:backuprestore2.png[width=250]

To manually backup your data, follow these steps:
. Click on image:backupbutton2.png[width=75] button to start the backup process.
You can see the backup logs displayed in the window.
+
image:backuprestore3.png[width=250]

Click on image:backupButton.png[width=75,height=75] button to start manual backup.
Specify a backup tag for your manual backup. Backup tag is used to identify your graph database backup.
. Once the backup is completed, you will see the newly created backup in the backup list.
+
image:backuprestore4.png[]

image:backuprestore2.png[]
[NOTE]
====
In the beta release, only one manual backup for RW workspace will be allowed.
You will need to delete the previous manual backup in order to make a new manual backup.
====

Click on image:backupbutton2.png[width=75] button to start the backup process. You can see the backup logs displayed in the window.
== How to Setup Scheduled Auto-Backup

image:backuprestore3.png[]
Schedule a recurring automatic backup for your data.

Once the backup is completed, you will see the newly created backup in the backup list.
[TIP]
====
Recurring backup jobs at specified intervals can help ensure regular data protection.
====

image:backuprestore4.png[]
.To enable auto backup:
. Simply toggle on the switch image:backupButton3.png[width=150].

Note:
In the beta release, only one manual backup for RW workspace will be allowed. You will need to delete the previous manual backup in order to make a new manual backup.
. You can specify the auto backup schedule using cron schedule.
You can test out your Cron schedule in Crontab.
+
image:backuprestore5.png[]

== Scheduled auto backup
This section will provide details on configuring and scheduling automatic backups for your data. You will learn how to set up recurring backup jobs at specified intervals to ensure regular data protection.
. Click on btn:[ Save ] button to save the schedule.

To enable auto backup, simply toggle on the switch image:backupButton3.png[width=75].
[NOTE]
====
In the beta release, only one auto backup for RW workspace will be allowed.
The latest backup will automatically overwrite the previous auto backup.
Please make sure to plan your backup strategy accordingly.
====

You can specify the auto backup schedule using cron schedule. You can test out your cron schedule in crontab.
== How to Restore a Backup
To restore your backup to a workspace is straightforward.

image:backuprestore5.png[]
[IMPORTANT]
Restoring is an offline operation. If there are any other operations in progress on the workspace, they will be affected.

Click on Save button to save the schedule.
[TIP]
====
It is recommended to schedule the restore during a time when minimal or no operations are expected on the workspace to avoid any potential disruptions.
====

Note:
In the beta release, only one auto backup for RW workspace will be allowed. The latest backup will automatically overwrite the previous auto backup. Please make sure to plan your backup strategy accordingly.

. Find the backup you wan to restore in the list.
+
image:Screenshot 2024-04-17 at 5.38.09 PM.png[]

== Restore
In the restore section, you will find guidance on how to restore your data from a backup. It will cover the steps involved in restoring data using the backups created, including any considerations or options available during the restoration process.
. Click on the image:Screenshot 2024-04-17 at 5.38.52 PM.png[width=50] button to open the "Restore Drawer".

To restore your backup to a workspace is straightforward.
. After reviewing the backup details, you can click on the btn:[ Restore ] button to proceed.
+
[NOTE]
====
You will need to type in the backup name to confirm the restore.
====
+
image:Screenshot 2024-04-17 at 5.39.34 PM.png[]

image:Screenshot 2024-04-17 at 5.38.09 PM.png[]
. After the restore is triggered, you can see the progress and detailed log in the window.
+
image:Screenshot 2024-04-17 at 5.40.16 PM.png[]

image:Screenshot 2024-04-17 at 5.38.52 PM.png[]

Click on the button to open the Restore drawer.
After reviewing the backup details, you can click on the Restore button to proceed.
You will need to type in the backup name to confirm the restore.

image:Screenshot 2024-04-17 at 5.39.34 PM.png[]

After the restore is triggered, you can see the progress and detailed log in the window

image:Screenshot 2024-04-17 at 5.40.16 PM.png[]
== Next Steps

Next, learn more about how to xref:cloudBeta:resource-manager:connect_via_api.adoc[] a workspace, or xref:cloudBeta:resource-manager:monitor_workspaces.adoc[].

Note:
Please note that restoring an offline operation. If there are any other operations in progress on the workspace, they will be affected. It is recommended to schedule the restore during a time when minimal or no operations are expected on the workspace to avoid any potential disruptions.
Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic.



Expand Down
Original file line number Diff line number Diff line change
@@ -1,33 +1,50 @@
= Expansion and Shrink
:experimental:

As your data grows or changes, you may need to adjust the capacity of your workspaces.
Users can easily expand or shrink workspaces to accommodate the evolving needs of graph databases.

You can scale up or down as required, ensuring optimal performance and cost-effectiveness.

== Expand or Shrink a Workspace

Scale up or down as required, ensuring optimal performance and cost-effectiveness.

[NOTE]
====
Before initiating a downsize operation, a data topology size check is performed to ensure that the workspace size can accommodate the data.
If the size check fails, the downsize operation will not be allowed.
====

image:expandandshrink.png[]
[IMPORTANT]
====
Please be aware that resizing of workspaces is only allowed for Read-Write (RW) workspaces.
You can select a size in the drop menu
Resizing of Read-Only (RO) workspaces is strictly forbidden and not supported.
Recreate a RO workspace if you need to resize it.
====

image:expand2.png[]

Note:
Please be aware that resizing of workspaces is only allowed for Read-Write (RW) workspaces. Resizing of Read-Only (RO) workspaces is strictly forbidden and not supported. You can recreate a RO workspace if you need to resize it.
. Go to the btn:[ Edit ] section on a workspace.
+
image:expandandshrink.png[width="250"]

Resizing typically will take about 2 mins depending on the data size and the workspace size.
. Select a size in the drop menu.
+
image:expand2.png[]
+
Typically, resizing will take about 2 minutes depending on the data size and the workspace size.

Note:
Please note that expansion/shrink is an offline operation.
=== Expansion and Shrink Limitations

An expansion or shrink is an offline operation.
If there are any other operations in progress on the workspace, they will be affected.

It is recommended to schedule the expansion/shrink during a time when minimal or no operations are expected on the workspace to avoid any potential disruptions.
[TIP]
====
It is recommended to schedule the expansion or shrink during a time when minimal or no operations are expected on the workspace to avoid any potential disruptions.
====

== Next Steps

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
= How to create a Workgroup
= How to Create a Workgroup
:experimental:

To learn more about workgroups see xref:cloudBeta:resource-manager:workgroup.adoc[].

To create a workgroup in TigerGraph Cloud 4.0, follow the steps below.

== Create a Workgroup
Expand Down Expand Up @@ -37,3 +36,5 @@ As of 2024-04-23, TigerGraph Cloud 4.0 only offers `AWS` on `US East(N. Virginia
== Next Step

Now, that you have a workgroup learn more about xref:cloudBeta:resource-manager:workspaces/workspace.adoc[Workspaces and Databases] or move on to xref:cloudBeta:resource-manager:workspaces/how2-create-a-workspace.adoc[].

Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
= Workgroup Overview

A workgroup represents a project or a logical group within TigerGraph Cloud 4.0.

It serves as a container that holds multiple xref:workspaces/workspace.adoc[workspaces] and databases related to a specific use case, team, or application.

[TIP]
Workgroups provide a way to organize and manage resources, access controls, and configurations for a particular project or initiative.

== Next Step
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Auto-resume will kick-in when users access tools and rest APIs.

== Next Steps

Next, learn about xref:cloudBeta:resource-manager:workspaces/writeread_readonly.adoc[] or learn more about how to xref:cloudBeta:resource-manager:monitor_workspaces.adoc[].
Next, learn about xref:cloudBeta:resource-manager:workspaces/writeread_readonly.adoc[] or learn more about xref:cloudBeta:resource-manager:workspaces/workspace-size.adoc[].

Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
= How to Create a Workspace
:experimental:

To learn more about workspaces see xref:workspaces/workspace.adoc[]

To learn more about workspaces see xref:workspaces/workspace.adoc[].
To create a workspace in TigerGraph Cloud 4.0, follow the steps below:

== Create a Workspace
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,21 @@ They are typically used for data ingestion, data updates, and running queries th
** *Read-Only Workspaces*: These workspaces are optimized for read-intensive operations.
They are used for executing queries and analytics on the graph data without modifying it.
Read-only workspaces provide improved performance and scalability for read operations.

+
[TIP]
====
The separation of compute and storage in workspaces allows for optimized performance and resource allocation, while the databases ensure the persistence and accessibility of the graph data.
====

* The *Database* in TigerGraph Cloud 4.0 refers to the actual data stored within the platform.
It is separate from the workspaces and can be associated with one or more workspaces within a workgroup.
It holds the persistent data that is loaded into TigerGraph and is accessible for graph analytics and visualization.
+
[NOTE]
====
We only support a maximum of one Read-Write workspace to connect to a database.
====
== Next Steps
See xref:workspaces/how2-create-a-workspace.adoc[] to get started or
return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic.

////
== Size Explanation
=== Size suggestion
== Options
////
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ It is recommended to schedule the update during a time when minimal or no operat

== Next Steps

Next, learn more about how to xref:cloudBeta:resource-manager:monitor_workspaces.adoc[] or how to xref:cloudBeta:resource-manager:expansion_shrink.adoc[Expand and Shrink] a workspace or about xref:workspaces/workspace-size.adoc[Workspace Sizes].
Next, about xref:workspaces/workspace-size.adoc[Workspace Sizes] or learn how to xref:cloudBeta:resource-manager:expansion_shrink.adoc[Expand and Shrink] a workspace.

Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic.

Expand Down

0 comments on commit c633939

Please sign in to comment.