Skip to content

Commit

Permalink
cloudupdates
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Newman authored and Joseph Newman committed Apr 25, 2024
1 parent caa2063 commit 0e16fca
Show file tree
Hide file tree
Showing 18 changed files with 161 additions and 117 deletions.
3 changes: 1 addition & 2 deletions modules/cloudbeta/modules/get-started/pages/how2-login.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ This guide will walk you through the necessary steps.

== Log In

.There are two ways to log in, through your account you created through signing up or
though your organization
There are two ways to log in, through your account you created through signing up or though your organization

=== 1) Your Account

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
:experimental:

In order to use TigerGraph Cloud v4.0 users must first btn:[Sign Up].

This guide will walk you through the necessary steps.

== Sign Up
Expand Down
1 change: 0 additions & 1 deletion modules/cloudbeta/modules/get-started/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
:experimental:

To get started with TigerGraph 4.0 Cloud users must first Sign Up and Log In.

These guides will walk you through the necessary steps.

== xref:how2-signup.adoc[]
Expand Down
35 changes: 25 additions & 10 deletions modules/cloudbeta/modules/load-data/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
= Load Data in v4 Beta
= Load Data in TigerGraph Cloud 4.0
:experimental:

Efficiently loading data into your TigerGraph databases is crucial for successful graph analysis. TigerGraph Cloud offers multiple methods for data ingestion:
Efficiently loading data into your TigerGraph databases is crucial for successful graph analysis.

image:Screenshot 2024-04-17 at 5.47.58 PM.png[]
== Load Data Oerveiw
.TigerGraph Cloud offers multiple methods for loading data:
. Navigate to a workspace:
+
image::Screenshot 2024-04-17 at 5.47.58 PM.png[width="500",role="cloud-image"]

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

Click on to load your data into TigerGraph.
. Click on image:Screenshot 2024-04-17 at 5.48.20 PM.png[width="75"] to load your data into TigerGraph.

TigerGraph Cloud provides various types of connectors that allow you to load data into your graph database. The data ingestion tool offers two different approaches to make it easier for users to load their data based on their specific needs and preferences.
. Choose the right connector: TigerGraph Cloud provides various types of connectors that allow you to load data into your graph database.
+
[TIP]
====
The loading data tool offers two different approaches to make it easier for users to load their data based on their specific needs and preferences.
====
+
image::Screenshot 2024-04-17 at 5.49.07 PM.png[width="500",role="cloud-image"]

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

Step-by-Step Guide: The data ingestion tool includes a user-friendly interface that guides you through the data loading process step by step. This approach is suitable for users who prefer a visual and interactive experience. The step-by-step guide helps you configure the data source, map the data to your graph schema, and customize import options.
GSQL Template: For users who prefer a more programmatic approach or have complex data loading requirements, the data ingestion tool provides support for GSQL templates. The GSQL template option allows you to define custom data loading logic using GSQL scripts. With GSQL templates, you have more flexibility and control over the data ingestion process. You can leverage GSQL's powerful features to transform, validate, and load data from various sources into your graph database.

== xref:cloudBeta:load-data:load-from-local.adoc[]

Expand All @@ -24,3 +30,12 @@ GSQL Template: For users who prefer a more programmatic approach or have complex

* xref:cloudBeta:load-data:jdbc.adoc[]

Step-by-Step Guide: The data ingestion tool includes a user-friendly interface that guides you through the data loading process step by step.
This approach is suitable for users who prefer a visual and interactive experience.
The step-by-step guides helps you configure the data source, map the data to your graph schema, and customize import options.

GSQL Template: For users who prefer a more programmatic approach or have complex data loading requirements, the data ingestion tool provides support for GSQL templates.
The GSQL template option allows you to define custom data loading logic using GSQL scripts.
With GSQL templates, you have more flexibility and control over the data ingestion process.
You can leverage GSQL's powerful features to transform, validate, and load data from various sources into your graph database.

10 changes: 2 additions & 8 deletions modules/cloudbeta/modules/overview/pages/comparison_table.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
= Comparison with Other TigerGraph Offerings
= Compare with Other TigerGraph Offering

Most of the documentation for TigerGraph Enterprise Server also applies to TigerGraph Cloud 4.0.

However, since TigerGraph Cloud 4.0 does not have a command-line interface on the OS level, command-line features are not supported in the same way.

In many cases, there is a GUI-based method for the same feature.

For advanced OS-level commands, submit a support ticket for more information.

Here are some differences between the different TigerGraph offerings.
|===
| Topic | TigerGraph Enterprise Server | TigerGraph Cloud Classic | TigerGraph Cloud 4.0

Expand Down
2 changes: 1 addition & 1 deletion modules/cloudbeta/modules/overview/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:experimental:
:page-aliases: cloud-overview.adoc

This documentation will guide you through the various features and functionalities of our brand new cloud-native graph as a service (GaaS) management platform.
This documentation will guide you through the various features and functionalities of our brand new cloud-native Graph-as-a-Service (GaaS) management platform.
TigerGraph Cloud 4.0 offers a powerful and user-friendly environment for managing, analyzing, and exploring your graph data.

//pass:[<abbr title="Define User Friendly">ToolTip Practice</abbr>]
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,20 @@ A built-in backup and restore system, allows users to create backups of graph da
This ensures the safety and availability of your data, protecting against accidental data loss or system failures.
====

== Setup Backup Points
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[]
image::backuprestore1.png[role="cloud-image"]

== How to Create a Manual backup
=== How to Create a Manual Backup
In this section, you can find information on how to manually initiate a backup of your data.

.To manually back-up your data, follow these steps:
.To manually back up your data, follow these steps:

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

Expand All @@ -30,24 +31,24 @@ In this section, you can find information on how to manually initiate a backup o
[TIP]
Backup tag is used to identify your graph database backup.
+
image:backuprestore2.png[width=250]
image::backuprestore2.png[width=250, role="cloud-image"]

. 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]
image::backuprestore3.png[width=250, role="cloud-image"]

. Once the backup is completed, you will see the newly created backup in the backup list.
+
image:backuprestore4.png[]
image::backuprestore4.png[role="cloud-image"]

[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.
====

== How to Setup Scheduled Auto-Backup
=== How to Setup Scheduled Auto-Backup

Schedule a recurring automatic backup for your data.

Expand All @@ -62,7 +63,7 @@ Recurring backup jobs at specified intervals can help ensure regular data protec
. You can specify the auto backup schedule using cron schedule.
You can test out your Cron schedule in Crontab.
+
image:backuprestore5.png[]
image::backuprestore5.png[role="cloud-image"]

. Click on btn:[ Save ] button to save the schedule.

Expand All @@ -73,8 +74,8 @@ The latest backup will automatically overwrite the previous auto backup.
Please make sure to plan your backup strategy accordingly.
====

== How to Restore a Backup
To restore your backup to a workspace is straightforward.
=== How to Restore a Backup
To restore your backup to a workspace is a straightforward process.

[IMPORTANT]
Restoring is an offline operation. If there are any other operations in progress on the workspace, they will be affected.
Expand All @@ -98,11 +99,11 @@ image:Screenshot 2024-04-17 at 5.38.09 PM.png[]
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.39.34 PM.png[role="cloud-image"]

. 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.40.16 PM.png[role="cloud-image"]

== Next Steps

Expand Down
Original file line number Diff line number Diff line change
@@ -1,34 +1,64 @@
= Connect via APIs

TigerGraph provides powerful APIs for seamless integration with your applications and services. You can connect to TigerGraph Cloud programmatically using RESTful APIs, allowing you to interact with your graph databases, run queries, and retrieve results. This enables you to incorporate graph database functionality into your existing workflows and applications, leveraging the power of TigerGraph Cloud.

TigerGraph Cloud provides a convenient way to connect to your graph database using REST APIs. You can view, test, and generate code snippets for all available REST APIs, including built-in queries and user-installed queries. These code snippets are available in JavaScript, cURL, and Python.

To connect via API and interact with your graph database, follow these steps:

Click on Connect From API option on the Connect menu of a workspace.

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

In the Connect From API UI, you can browse through the available APIs, including built-in queries and user-installed queries. These APIs represent different operations that you can perform on your graph database, such as querying data, adding vertices and edges, updating properties, and more.

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

You can go to the schema designer to Create a Graph if there is no graph.

You can go to Edit GSQL Query to write and install a new GSQL query. For GSQL syntax, please refer to https://docs.tigergraph.com/gsql-ref/current/intro/


Click on an API to view its details, including the endpoint URL, HTTP method, input parameters, and expected output. The API details provide information about how to construct the API request and interpret the response.

Enter the required parameters and click on the Test button to test the request. This allows you to verify the functionality of the API and see the response returned by the database.

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

Once you have tested the API and verified its functionality, you can copy the generated code snippets in JavaScript, cURL, and Python. These code snippets provide ready-to-use code examples that you can integrate into your applications or scripts to interact with the graph database programmatically.

Note:
The current Connect from API code generated by TigerGraph Cloud does not support the database secret. If you need to connect using the database secret, please refer to https://docs.tigergraph.com/tigergraph-server/3.9/user-access/user-credentials#_required_privilege.
:experimental:

TigerGraph provides powerful APIs for seamless integration with your applications and services.
You can connect to TigerGraph Cloud programmatically using RESTful APIs, allowing you to interact with your graph databases, run queries, and retrieve results.
This enables you to incorporate graph database functionality into your existing workflows and applications, leveraging the power of TigerGraph Cloud.

== Connect to your Graph Database
TigerGraph Cloud provides a convenient way to connect to your graph database using REST APIs.
You can view, test, and generate code snippets for all available REST APIs, including built-in queries and user-installed queries.


[TIP]
====
These code snippets are available in JavaScript, cURL, and Python.
====

.To connect via APIs and interact with your graph database, follow these steps:
. Click on btn:[Connect From API] option in the btn:[Connect] menu in a workspace.
+
[NOTE]
====
You can go to the xref:cloudBeta:schema-designer:index.adoc[Schema Designer] to btn:[Create a Graph] if you do not have a graph.
====
+
image::Screenshot 2024-04-17 at 5.41.55 PM.png[width="250", role="cloud-image"]
+
. In the btn:[Connect From API] UI, you can browse through the available APIs, including built-in queries and user-installed queries.
+
[TIP]
====
These APIs represent different operations that you can perform on your graph database, such as querying data, adding vertices and edges, updating properties, and more.
====
+
image::Screenshot 2024-04-17 at 5.42.36 PM.png[width="500", role="cloud-image"]

. Go to btn:[Edit GSQL Query] to write and install a new GSQL query.
For GSQL syntax, please refer to xref:3.10.1@gsql-ref:intro:index.adoc[].

. Click on an API to view its details, including the endpoint URL, HTTP method, input parameters, and expected output.
+
[TIP]
====
The API details provide information about how to construct the API request and interpret the response.
====
+
. Enter the required parameters and click on the btn:[Test] button to test the request. This allows you to verify the functionality of the API and see the response returned by the database.
+
image::Screenshot 2024-04-17 at 5.43.22 PM.png[width="350",role="cloud-image"]

. Once you have tested the API and verified its functionality, you can copy the generated code snippets in JavaScript, cURL, and Python.
+
[TIP]
====
These code snippets provide ready-to-use code examples that you can integrate into your applications or scripts to interact with the graph database programmatically.
====

=== Connect via APIs Limitations

The current btn:[Connect from API] code generated by TigerGraph Cloud does not support the database secret.
If you need to connect using the database secret, please refer to xref:3.10.1@tigergraph-server:user-access:user-credentials.adoc#_required_privilege[Required Privilege].

== Next Steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,36 @@
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.


== Expand or Shrink a Workspace

Scale up or down as required, ensuring optimal performance and cost-effectiveness.
Scale up (exapnd) or down (shrink) 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.
====

[IMPORTANT]
====
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.
Recreate a RO workspace if you need to resize it.
====


. Go to the btn:[ Edit ] section on a workspace.
+
image:expandandshrink.png[width="250"]
image::expandandshrink.png[width="250", role="cloud-image"]

. Select a size in the drop menu.
+
image:expand2.png[]
image::expand2.png[role="cloud-image"]
+
[TIP]
====
Typically, resizing will take about 2 minutes depending on the data size and the workspace size.
====

=== Expansion and Shrink Limitations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ To create a workgroup in TigerGraph Cloud 4.0, follow the steps below.

. Log in to your TigerGraph Cloud account.
+
image::loginPage.png[]
image::loginPage.png[role="cloud-image"]

. From the dashboard, navigate to the btn:[Workgroups] section and click on the btn:[Create Workspace] or you can click on the image:plusbutton.png[width=50,height=50] button next to btn:[Workgroups].
+
image::createWorkGroup.png[]
image::createWorkGroup.png[role="cloud-image"]

. Provide a name for the workgroup.
+
Expand All @@ -23,15 +23,15 @@ image::createWorkGroup.png[]
Choose a name that reflects the purpose of your project or initiative.
====
+
image:workgrouppage.png[]
image::Screenshot 2024-04-24 at 8.18.30 PM.png[role="cloud-image"]
. Choose the cloud provider and the region
+
[NOTE]
====
As of 2024-04-23, TigerGraph Cloud 4.0 only offers `AWS` on `US East(N. Virginia)`.
====

. Click on the btn:[Next] button to create the workgroup.
. Finally, click on the btn:[Next] button to create the workgroup.

== Next Step

Expand Down
Loading

0 comments on commit 0e16fca

Please sign in to comment.