Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
samzhou2 committed Oct 24, 2024
1 parent 687d6ca commit 643efd6
Show file tree
Hide file tree
Showing 67 changed files with 339 additions and 265 deletions.
1 change: 0 additions & 1 deletion modules/cloud/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ nav:
- modules/release-notes/nav.adoc
- modules/solutions/nav.adoc
- modules/security/nav.adoc
- modules/rest-api/nav.adoc
- modules/billing/nav.adoc
- modules/support/nav.adoc
- modules/reference/nav.adoc
2 changes: 1 addition & 1 deletion modules/cloud/modules/support/pages/faqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ A: Yes. If you use V3.0.5+ in TigerGraph Cloud, MultiGraph is supported through

=== *Q: What methods do you support for importing data?*

A: We support AWS S3 import, Google Cloud Storage, and local file upload through GraphStudio. Spark loading is available through our open source JDBC Driver. See https://github.com/tigergraph/ecosys/tree/master/tools/etl[https://github.com/tigergraph/ecosys/tree/master/etl]
A: We support Amazon S3 import, Google Cloud Storage, and local file upload through GraphStudio. Spark loading is available through our open source JDBC Driver. See https://github.com/tigergraph/ecosys/tree/master/tools/etl[https://github.com/tigergraph/ecosys/tree/master/etl]

In addition, for TigerGraph paid tier clusters, users can use the GSQL Web Shell to write GSQL Commands in an interactive command line shell. This GSQL Web Shell opens up more data loading options such as S3 Loader (parquet format), Kafka Loader and other complex loading jobs. Users can access GSQL Web Shell through the cluster panel from their Cloud Portal.

Expand Down
9 changes: 1 addition & 8 deletions modules/cloud4/antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: cloud4
title: TigerGraph Cloud 4

version: main
display_version: default
start_page: overview:index.adoc
Expand All @@ -10,13 +9,7 @@ nav:
- modules/get-started/nav.adoc
- modules/workgroup-workspace/nav.adoc
- modules/graph-development/nav.adoc
# - modules/load-data/nav.adoc
# - modules/schema-designer/nav.adoc
# - modules/gsql-editor/nav.adoc
# - modules/explore-graph/nav.adoc
- modules/rest-api/nav.adoc
- modules/integrations/nav.adoc
- modules/administration/nav.adoc
- modules/rest-api/nav.adoc
- modules/security/nav.adoc
# - modules/billing-manager/nav.adoc
- modules/resources/nav.adoc
3 changes: 3 additions & 0 deletions modules/cloud4/modules/administration/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
* xref:index.adoc[Administration]
** xref:administration:how2-invite-users.adoc[]
** xref:administration:how2-access-mgnt.adoc[]
** xref:administration:security/index.adoc[]
*** xref:administration:security/idp.adoc[]
*** xref:administration:security/password-policy.adoc[]
** xref:administration:billing/index.adoc[Billing]
*** xref:administration:billing/payment-methods.adoc[]
*** xref:administration:billing/invoices.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,9 @@ Learn how you can manage payment methods.

Learn how to view and export invoices.

== xref:cloud4:administration:billing/pricing.adoc[]
== xref:cloud4:overview:pricing.adoc[]

Here you can review pricing information in TigerGraph Cloud 4.

//== xref:cloud4:billing-manager:compute_price.adoc[]

//== xref:cloud4:billing-manager:storage_price.adoc[]



Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ image::invoice-list.png[]

== Next Steps

Next, learn about other billing topics on the xref:billing-manager:index.adoc[] page or check out the xref:resources:index.adoc[] section.
Next, learn about other billing topics on the xref:cloud4:administration:billing/index.adoc[] page or check out the xref:resources:index.adoc[] section.

Return to the page to xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ image::deletecard.png[]

== Next Steps

Next, learn about other billing topics on the xref:billing-manager:index.adoc[] page or check out the xref:resources:index.adoc[] section.
Next, learn about other billing topics on the xref:cloud4:administration:billing/index.adoc[] page or check out the xref:resources:index.adoc[] section.

Return to the page to xref:cloud4:overview:index.adoc[Overview] page for a different topic.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Resource-level permissions determine what actions a user can perform on a specif
These permissions allow you to control access to individual resources based on the needs and responsibilities of different users.
====

You can go to xref:cloud4:workgroup-workspace:how2-workgroup-access.adoc[] to manage access at the resource level.
You can go to xref:cloud4:workgroup-workspace:workgroups/how2-workgroup-access.adoc[] to manage access at the resource level.

== User Level Permission
At the user level, you can define permissions that apply to individual users or groups of users.
Expand Down Expand Up @@ -238,7 +238,7 @@ Please refer to the following tables of the roles and permissions for the organi

== Next Steps

Next, learn about xref:cloud4:administration:how2-use-organization-mgnt.adoc[]
or continue on to learn about xref:security:index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.
Next, learn about xref:cloud4:administration:settings/how2-use-organization-mgnt.adoc[]
or continue on to learn about xref:cloud4:administration:security/index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,6 @@ Select btn:[Cancel] or btn:[OK] to confirm.
== Next Steps

Next, learn about xref:cloud4:administration:how2-access-mgnt.adoc[]
or continue on to learn about xref:security:index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.
or continue on to learn about xref:cloud4:administration:security/index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.
2 changes: 1 addition & 1 deletion modules/cloud4/modules/administration/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ Learn how to create API keys for your organization.

== Next Steps

Next, learn about xref:security:index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.
Next, learn about xref:cloud4:administration:security/index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,12 @@

Here you can learn different security practices and policies in TigerGraph Cloud 4.

[IMPORTANT]
====
TigerGraph Cloud 4 beta is for personal or R&D use and not for production use.

Please see xref:cloud4:resources:terms_conditions.adoc[].
====


== xref:cloud4:security:password-policy.adoc[]
== xref:cloud4:administration:security/password-policy.adoc[]

Learn and understand the password policy in TigerGraph Cloud 4.


== xref:cloud4:security:idp.adoc[]
== xref:cloud4:administration:security/idp.adoc[]

Learn and understand IDP intergration with SSO password policy in TigerGraph Cloud 4.
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Providing a logo adds a professional touch and helps users quickly recognize you

== Next Steps

Next, continue on to learn about xref:security:index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.
Next, continue on to learn about xref:cloud4:administration:security/index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Learn how to create API keys for your organization.

== Next Steps

Next, learn about xref:security:index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.
Next, learn about xref:cloud4:administration:security/index.adoc[] or additional xref:cloud4:resources:index.adoc[] in TigerGraph Cloud 4.

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.
2 changes: 1 addition & 1 deletion modules/cloud4/modules/get-started/pages/how2-login.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ image::orgLogin.png[]

== Next Steps

Once logged in, learn more about xref:cloud4:workgroup-workspace:index.adoc[] or jump right into creating a xref:workgroup-workspace:workgroup.adoc[Workgroup] and xref:workgroup-workspace:workspaces/workspace.adoc[Workspaces].
Once logged in, learn more about xref:cloud4:workgroup-workspace:index.adoc[] or jump right into creating a xref:workgroup-workspace:workgroups/workgroup.adoc[Workgroup] and xref:workgroup-workspace:workspaces/workspace.adoc[Workspaces].

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.
4 changes: 2 additions & 2 deletions modules/cloud4/modules/get-started/pages/how2-signup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ image::loginPage.png[]
. If you are signing up for the first time, you will be prompted to enter a password.
+
[CAUTION]
Please refer to out xref:security:password-policy.adoc[] that applies to TigerGraph Cloud.
Please refer to out xref:cloud4:administration:security/password-policy.adoc[] that applies to TigerGraph Cloud.

. When registering for a new TigerGraph Cloud 4 account, we will ask to confirm your email address.
btn:[ Click ] the link in your email to verify, then log in using your username and password.
+
[NOTE]
====
We automatically create a new organization for you.
You can update your organization on the xref:cloud4:administration:how2-use-organization-mgnt.adoc[] page.
You can update your organization on the xref:cloud4:administration:settings/how2-use-organization-mgnt.adoc[] page.
====

== Next Steps
Expand Down
2 changes: 1 addition & 1 deletion modules/cloud4/modules/get-started/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Learn how to log in to your TigerGraph Cloud 4 Cloud account.

== Next Steps

Once logged in, learn more about xref:cloud4:workgroup-workspace:index.adoc[] or jump right into creating a xref:workgroup-workspace:workgroup.adoc[Workgroup] and xref:workgroup-workspace:workspaces/workspace.adoc[Workspaces].
Once logged in, learn more about xref:cloud4:workgroup-workspace:index.adoc[] or jump right into creating a xref:workgroup-workspace:workgroups/workgroup.adoc[Workgroup] and xref:workgroup-workspace:workspaces/workspace.adoc[Workspaces].

Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions modules/cloud4/modules/graph-development/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
* xref:index.adoc[Graph Management]
** xref:load-data/index.adoc[Load Data]
*** xref:load-data/load-from-local.adoc[]
*** xref:load-data/load-from-s3.adoc[]
*** xref:load-data/load-from-gcs.adoc[]
*** xref:load-data/load-from-blob.adoc[]
*** xref:load-data/load-from-s3.adoc[Load from AWS S3]
*** xref:load-data/load-from-gcs.adoc[Load from GCS]
*** xref:load-data/load-from-blob.adoc[Load from Blob]
*** xref:load-data/token-function.adoc[Token Function]
*** xref:load-data/load-from-other-sources.adoc[]
**** xref:load-data/jdbc.adoc[]
** xref:design-schema/index.adoc[Design Schema]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,6 @@ image::advanced-settings-2.png[]

== Next Steps

Next, learn how to use xref:gsql-editor:index.adoc[GSQL Editor] in TigerGraph Cloud 4.
Next, learn how to use xref:cloud4:graph-development:gsql-editor/index.adoc[GSQL Editor] in TigerGraph Cloud 4.

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ A visual representation of a graph and its data can help identify and explain th

== Prerequisites

Before you can utilize the Explore Graph features you need to xref:cloud4:workgroup-workspace:how2-create-a-workgroup.adoc[Create a Workspace] and xref:cloud4:load-data:index.adoc[Load Data].
Before you can utilize the Explore Graph features you need to xref:cloud4:workgroup-workspace:workgroups/how2-create-a-workgroup.adoc[Create a Workspace] and xref:cloud4:graph-development:load-data/index.adoc[Load Data].

== xref:cloud4:explore-graph:how2-use-pattern-search.adoc[]
== xref:cloud4:graph-development:explore-graph/how2-use-pattern-search.adoc[]

Learn how look for specific patterns or sequences within a dataset or system.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Sharing with the entire organization can be useful when you want to provide broa

== Next Steps

Next, learn to xref:cloud4:explore-graph:index.adoc[].
Next, learn to xref:cloud4:graph-development:explore-graph/index.adoc[].

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The GSQL Editor is a powerful tool for developing and executing GSQL queries, al
The GSQL Editor contains 4 work areas:

image::Screenshot 2024-10-11 at 11.39.23.png[]
* Left image:left.png[] - GSQL xref:gsql-editor:index.adoc#_file_list[File List ] Panel.
* Left image:left.png[] - GSQL xref:cloud4:graph-development:gsql-editor/index.adoc#_file_list[File List ] Panel.
* Bottom image:bottom.png[] - GSQL Result Panel.
* Right image:right.png[] Schema Designer Panel.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,12 @@ You can leverage GSQL's powerful features to transform, validate, and load data
When selecting a data source a step-by-step guide might not always be available.
When this is the case users will see btn:[Open in GSQL Editor] on the bottom right of the panel.

image::load-data:Screenshot 2024-04-25 at 12.31.39 (1).png[width=300]
image::open-in-gsql-editor.png[width=200]

[NOTE]
====
Step-by step-support will be added for all sources, but during the beta release only btn:[Local File] and btn:[AWS S3] is supported with step-by-step.
As of 2024-10-31, Step-by-step guide support load from xref:cloud4:graph-development:load-data/load-from-local.adoc[Local File], xref:cloud4:graph-development:load-data/load-from-s3.adoc[Amazon S3], xref:cloud4:graph-development:load-data/load-from-gcs.adoc[Google Cloud Storage] and xref:cloud4:graph-development:load-data/load-from-blob.adoc[Azure Blob Storage]. We are actively working on adding support for more data sources.
====

== xref:cloud4:graph-development:load-data/load-from-local.adoc[]
Expand All @@ -53,7 +54,7 @@ Check out our step-by-step guide on loading data from a local file.

== xref:cloud4:graph-development:load-data/load-from-s3.adoc[]

Check out our step-by-step guide on loading data from a AWS S3.
Check out our step-by-step guide on loading data from a Amazon S3.

== xref:cloud4:graph-development:load-data/load-from-gcs.adoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,35 +1,33 @@
= Load from Azure Blob Storage
:experimental:

If you store your data in AWS S3, TigerGraph Cloud provides seamless integration for data ingestion.
You can directly load data from your S3 buckets into your graph databases, eliminating the need for manual data transfers.
This simplifies the process of importing large datasets and enables you to leverage the scalability and durability of AWS S3 for your graph analysis.
TigerGraph Cloud 4 allows you to load data directly from Azure Blob Storage. This guide will walk you through the steps to configure and load data from Azure Blob Storage into your TigerGraph workspace.

== 1) Select Source

.Once you’ve selected AWS S3, you will be asked to configure the AWS S3 data source.
. Click on image:Screenshot 2024-04-17 at 9.36.58 PM.png[width=50] to add a new AWS S3 data source.
.Once you’ve selected btn:[Azure Blob Storage], you will be asked to configure the Azure Blob Storage data source.
. Click on image:Screenshot 2024-04-17 at 9.36.58 PM.png[width=50] to add a new Azure Blob Storage data source.
+
image:Screenshot 2024-04-17 at 9.36.27 PM.png[]
image:gcs-empty-data-source.png[]

. You will need to provide your S3 `AWS access key id` and S3 `AWS secret access key`.
. You will need to provide your `ABS Connection String`.
+
image:Screenshot 2024-04-17 at 9.37.32 PM.png[]
. Once you have those configured, you can add one or multiple `S3 URI` within the same S3 bucket.
image:abs-connection-details.png[]
. Once you have those configured, you can add one or multiple `ABS URI` within the same blob storage account.

. Click btn:[ Next ] to process the file(s).
+
[NOTE]
====
The current data loading tool only supports CSV files. Other formats will be available in later releases.
The current data loading tool only supports CSV,TSV and JSON files. Other formats will be available in later releases.
====

== 2) Configure File
.This step lets you configure the source file details.
. The data loading tool will automatically detect the `.csv` separators and line breaks.
The parser automatically splits each line into a series of tokens.
+
image::Screenshot 2024-04-17 at 5.53.45 PM.png[]
image::config-file.png[]
+
[TIP]
====
Expand Down Expand Up @@ -72,25 +70,30 @@ The schema generation feature is still a preview feature. The correctness and ef

. In the `Source` column, you can choose the specific column from the data source that you want to map with the attribute.
+
image::Screenshot 2024-04-17 at 5.56.15 PM.png[]
image::config-mapping-1.png[]
+
. Use the `+` button to create a new attribute of the target vertex or edge.
+
image::Screenshot 2024-04-17 at 5.57.07 PM.png[]
image::config-mapping-2.png[width=400]

. The `Map all to target` button aligns existing attribute names with the corresponding data source headers to establish mappings and also introduces new attributes based on unmatched data source headers.
+
image::Screenshot 2024-04-17 at 5.57.52 PM.png[]
. Click btn:[Next] to proceed.
. Click the btn:[Token Function] button to configure token functions for the selected source. For more details of configuring token functions, please refer to xref:cloud4:graph-development:load-data/token-function.adoc[Token Function].

. Click the btn:[Quick Map] button to quickly map the data source headers to the existing schema attributes.
+
image::quick-map.png[]
+
.. The btn:[Map all to target] button aligns existing attribute names with the corresponding data source headers, it won't introduce new attributes.
.. The btn:[Map all from source] button not only aligns existing attribute names with the corresponding dat asource headers, but also introduces new attributes based on unmatched data source headers.
.. The following list shows the mapping status of each attribute, you can manually adjust the mapping by checking the box next to the attribute name.

. Click btn:[Next] to proceed.

== 4) Confirm

.This step will let you confirm the changes made to the schema and the data mapping you created to load the data.
. Simply review the `Schema to be change` and `Data to be loaded` lists.
. Simply review the `Schema to be changed` and `Data to be loaded` lists.
+
image::Screenshot 2024-04-17 at 5.58.36 PM.png[]
image::confirm.png[]
+
[CAUTION]
====
Expand All @@ -102,7 +105,7 @@ image::Screenshot 2024-04-17 at 5.59.16 PM.png[]

== Next Steps

Next, learn how to use xref:cloud4:graph-development:design-schema/index.adoc[Design Schema] in TigerGraph Cloud 4.
Next, learn how to use xref:cloud4:graph-development:design-schema/index.adoc[Design Schema], xref:cloud4:graph-development:gsql-editor/index.adoc[GSQL Editor] and xref:cloud4:graph-development:explore-graph/index.adoc[Explore Graph] in TigerGraph Cloud 4.

Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic.

Expand Down
Loading

0 comments on commit 643efd6

Please sign in to comment.