Skip to content

Commit

Permalink
Update wording and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
samzhou2 committed Jan 21, 2025
1 parent 869b660 commit 0dbe496
Show file tree
Hide file tree
Showing 44 changed files with 103 additions and 137 deletions.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In TigerGraph Savanna, access management allows you to configure permissions at

== Resource Level

At the resource level, you can configure permissions that apply to specific workspaces within your TigerGraph Cloud organization.
At the resource level, you can configure permissions that apply to specific workspaces within your TigerGraph Savanna organization.
Resource-level permissions determine what actions a user can perform on a specific resource.

[TIP]
Expand Down
10 changes: 5 additions & 5 deletions modules/savanna/modules/administration/pages/security/idp.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
= IDP integration with SSO

////
By default, user management in a TigerGraph Cloud organization happens in the xref:manage-org-users.adoc[] section of the TigerGraph Cloud interface.
By default, user management in a TigerGraph Savanna organization happens in the xref:manage-org-users.adoc[] section of the TigerGraph Savanna interface.

If you have another preferred identity provider (IDP), you can integrate with it instead using SAML 2.0 to handle your user management needs outside of TigerGraph Cloud.
If you have another preferred identity provider (IDP), you can integrate with it instead using SAML 2.0 to handle your user management needs outside of TigerGraph Savanna.
////

IDP integration is currently available at the Organization level, so one IDP will handle user management for all clusters in that organization.
Only one IDP can be connected to a single Organization.

== Process Outline

. Have IDP enabled on your TigerGraph Cloud Organization account.
. Create an app integration on the IDP side to configure it to link with TigerGraph Cloud.
. Users log in to the TigerGraph Cloud portal using credentials from your IDP.
. Have IDP enabled on your TigerGraph Savanna Organization account.
. Create an app integration on the IDP side to configure it to link with TigerGraph Savanna.
. Users log in to the TigerGraph Savanna portal using credentials from your IDP.
. Organization Admins assign roles to the users being created in the cloud organization via successful login from the IDP.

== Setup
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Password Policy
:experimental:

TigerGraph Cloud user accounts have their own password requirements separate from the xref:tigergraph-server:security:password-policy.adoc[TigerGraph Server password policy].
TigerGraph Savanna user accounts have their own password requirements separate from the xref:tigergraph-server:security:password-policy.adoc[TigerGraph Server password policy].

No empty passwords are permitted. Each password must be at least 12 characters long and include at least one of the following:

Expand All @@ -11,7 +11,7 @@ No empty passwords are permitted. Each password must be at least 12 characters l
* A digit `0-9`
[NOTE]
This TigerGraph Cloud password policy cannot be changed by users.
This TigerGraph Savanna password policy cannot be changed by users.

Organization Admins do not have access to change or reset user passwords in an Organization account.
If you forget your password, click the btn:[Forgot Password?] button during login, or contact [email protected] for assistance.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The TigerGraph Savanna REST API is currently in preview version. Features and en

== Overview

API keys are essential for authenticating and securing access to the TigerGraph Cloud REST API. This guide will walk you through the steps to create, configure, and manage your API keys.
API keys are essential for authenticating and securing access to the TigerGraph Savanna REST API. This guide will walk you through the steps to create, configure, and manage your API keys.

== Creating an API Key

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,28 @@ As an organization administrator, you have access to organization management fea
.To make organization settings changes:
. Navigate to the btn:[Setting] tag
+
image::Screenshot 2024-04-18 at 10.23.26 AM.png[width=300]
image::branding-example.png[width=300]

. Once clicked, the btn:[Organization Setting] panel will display the btn:[Basic Information] used with each organization.
+
image::Screenshot 2024-04-18 at 10.22.57 AM.png[]
image::edit-org-setting.png[]
+
.Here you will find the basic information to set up a new organization.
* *Organization Name*: The name of your organization within TigerGraph Cloud.
* *Organization Name*: The name of your organization within TigerGraph Savanna.
This is a unique identifier for your organization and is used for administrative purposes.
* *Display Name*: The display name is the name that will be shown in the user interface and other user-facing areas.
It can be a more user-friendly or descriptive name compared to the organization name.
+
[TIP]
====
The display name helps users easily identify your organization within TigerGraph Cloud.
The display name helps users easily identify your organization within TigerGraph Savanna.
====
* *Organization Logo URL*: The URL to the logo image file for your organization.
This logo will be displayed in the TigerGraph Cloud navigation bar and can be used to represent your organization visually.
This logo will be displayed in the TigerGraph Savanna navigation bar and can be used to represent your organization visually.
+
[TIP]
====
Providing a logo adds a professional touch and helps users quickly recognize your organization within TigerGraph Cloud.
Providing a logo adds a professional touch and helps users quickly recognize your organization within TigerGraph Savanna.
====

== Next Steps
Expand Down
Binary file modified modules/savanna/modules/get-started/images/orglogin-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/savanna/modules/get-started/images/signup.png
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
@@ -1,11 +1,11 @@
= Advanced Features
:experimental:

This section covers the powerful and sophisticated functionalities that allow you to leverage TigerGraph Cloud to its fullest potential.
This section covers the powerful and sophisticated functionalities that allow you to leverage TigerGraph Savanna to its fullest potential.

== Write Output to S3

TigerGraph Cloud v4 enables you to write data directly to Amazon S3, providing a seamless way to export and store your graph data in a scalable and cost-effective manner. Click xref:advanced-features/write2-s3.adoc[Export Data to S3] to learn how to configure and use this feature.
TigerGraph Savanna enables you to write data directly to Amazon S3, providing a seamless way to export and store your graph data in a scalable and cost-effective manner. Click xref:advanced-features/write2-s3.adoc[Export Data to S3] to learn how to configure and use this feature.

== Configure User Defined Functions (UDF)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Export Data to S3
:experimental:

Exporting data to Amazon S3 from TigerGraph Cloud v4 allows you to export your graph data efficiently. This feature is particularly useful for backup, data sharing, and integration with other AWS services.
Exporting data to Amazon S3 from TigerGraph Savanna allows you to export your graph data efficiently. This feature is particularly useful for backup, data sharing, and integration with other AWS services.

This documentation have been updated to include all three methods for writing data to S3, providing comprehensive guidance for users.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ You can only share a GSQL file if you are the file owner.

image::Screenshot 2024-04-18 at 10.14.54 AM.png[width=300]

In TigerGraph Cloud, GSQL files have btn:[Viewer] and btn:[Editor] permissions that can be assigned to individual users or shared with the entire organization.
In TigerGraph Savanna, GSQL files have btn:[Viewer] and btn:[Editor] permissions that can be assigned to individual users or shared with the entire organization.

image::Screenshot 2024-04-18 at 10.15.25 AM.png[width=300]

Expand Down
2 changes: 1 addition & 1 deletion modules/savanna/modules/graph-development/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Explore Graph allows users to visually interact with their graph data, helping t

== xref:advanced-features/index.adoc[Advanced Features]

This section covers the powerful and sophisticated functionalities that allow you to leverage TigerGraph Cloud to its fullest potential.
This section covers the powerful and sophisticated functionalities that allow you to leverage TigerGraph Savanna to its fullest potential.

### Key Features:
- Export data to Amazon S3.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
Efficiently loading data into your TigerGraph databases is crucial for successful graph analysis.

== Load Data Overview
.TigerGraph Cloud offers multiple methods for loading data:
.TigerGraph Savanna offers multiple methods for loading data:
. Select an active workspace from the dropdown menu.
+
image::Screenshot 2024-04-17 at 5.47.58 PM.png[width="500"]

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

. Chose one of TigerGraph Cloud various types of connectors that allow you to load data into your graph database.
. Chose one of TigerGraph Savanna various types of connectors that allow you to load data into your graph database.
+
image::Screenshot 2024-04-17 at 5.49.07 PM.png[width="500"]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ $ spark-submit --class org.apache.spark.examples.SparkPi spark/examples/jars/spa

== Set up SSL connection

TigerGraph Cloud uses SSL connections, so we need to create the certificate for Spark to use.
TigerGraph Savanna uses SSL connections, so we need to create the certificate for Spark to use.

For this step and other steps, you need your TigerGraph Cloud cluster URL, which can be found on the Clusters page.
For this step and other steps, you need your TigerGraph Savanna workspace URL, which can be found on the Clusters page.
A typical cluster URL looks like `7c141e8c7669404f923623083ba01da9.i.tgcloud.io`.

[source, console]
----
$ echo | openssl s_client -host <your TigerGraph Cloud URL> -port 443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > ~/tgcloud.crt
$ echo | openssl s_client -host <your TigerGraph Savanna workspace URL> -port 443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > ~/tgcloud.crt
----

This SSL certificate, a `.crt` file, cannot be used directly with the JDBC driver.
Expand All @@ -59,7 +59,7 @@ Create a password and use it where the sample command below has the placeholder

[source, console]
----
$ keytool -import -alias <your TigerGraph Cloud URL> -file ~/tgcloud.crt -keystore ~/trust.jks -storepass <your password>
$ keytool -import -alias <your TigerGraph Savanna workspace URL> -file ~/tgcloud.crt -keystore ~/trust.jks -storepass <your password>
----

== Create the secret key on your TigerGraph instance
Expand All @@ -83,7 +83,7 @@ For more details on how to use the TigerGraph JDBC Connector, see the documentat
The last section of the file, the Loading to TigerGraph section, requires several parameters.
Some are filled in already in the example, but others require your input.

* `url`: Your TigerGraph Cloud URL
* `url`: Your TigerGraph Savanna workspace URL
* `password`: Your secret key created with Admin Portal
* `graph`: The graph for which you created the secret key
* `truststore`: The JKS file you created previously
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Load from Google Cloud Storage (GCS)
:experimental:

If you store your data in Google Cloud Storage (GCS), TigerGraph Cloud provides seamless integration for data ingestion. You can directly load data from your GCS 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 Google Cloud Storage for your graph analysis.
If you store your data in Google Cloud Storage (GCS), TigerGraph Savanna provides seamless integration for data ingestion. You can directly load data from your GCS 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 Google Cloud Storage for your graph analysis.

== 1) Select Source

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Load from Local File
:experimental:

With TigerGraph Cloud, you can easily load data from local files into your graph databases. Whether you have data in CSV, JSON, or other formats, you can use the intuitive data ingestion process to import your data. Simply upload your files, specify the schema mapping, and let TigerGraph Cloud handle the rest. This allows you to quickly populate your graph databases with the necessary data for analysis.
With TigerGraph Savanna, you can easily load data from local files into your graph databases. Whether you have data in CSV, JSON, or other formats, you can use the intuitive data ingestion process to import your data. Simply upload your files, specify the schema mapping, and let TigerGraph Savanna handle the rest. This allows you to quickly populate your graph databases with the necessary data for analysis.

== 1) Select Source

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Load from Amazon S3
:experimental:

If you store your data in Amazon S3, TigerGraph Cloud provides seamless integration for data ingestion.
If you store your data in Amazon S3, TigerGraph Savanna 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 Amazon S3 for your graph analysis.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Token Function
:experimental:

TigerGraph Savanna allows you to enhance your data loading process by adding token functions. Token functions enable you to manipulate and transform data during the loading process, making it easier to prepare your data for graph analysis. This guide will walk you through the steps to add token functions using the TigerGraph Cloud UI. For more details please refer to xref:4.1@gsql-ref:ddl-and-loading:functions/token/index.adoc[Token Functions].
TigerGraph Savanna allows you to enhance your data loading process by adding token functions. Token functions enable you to manipulate and transform data during the loading process, making it easier to prepare your data for graph analysis. This guide will walk you through the steps to add token functions using the TigerGraph Savanna UI. For more details please refer to xref:4.1@gsql-ref:ddl-and-loading:functions/token/index.adoc[Token Functions].

== Add a token function
. Click on the btn:[Token Function] button to configure token functions for your data source.
Expand Down
2 changes: 1 addition & 1 deletion modules/savanna/modules/integrations/pages/add-ons.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Extend the capabilities of TigerGraph Savanna with add-ons tailored to your needs.
Add-ons provide additional functionalities and integrations that enhance your graph database workflow.
Whether you need advanced analytics, machine learning integration, or data visualization tools, TigerGraph Cloud offers a range of add-ons to choose from.
Whether you need advanced analytics, machine learning integration, or data visualization tools, TigerGraph Savanna offers a range of add-ons to choose from.

Explore the available add-ons and learn how to incorporate them into your graph database workflow, enabling you to unlock even more value from your graph data.

Expand Down
2 changes: 1 addition & 1 deletion modules/savanna/modules/integrations/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Marketplace Overview
:experimental:

TigerGraph Cloud seamlessly integrates with various tools and services to enhance your graph database workflow.
TigerGraph Savanna seamlessly integrates with various tools and services to enhance your graph database workflow.

== xref:savanna:integrations:add-ons.adoc[]

Expand Down
2 changes: 1 addition & 1 deletion modules/savanna/modules/overview/pages/architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@ It helps users discover valuable information within their data even if they are

== Next Steps

Next, to understand how TigerGraph cloud differs from other TigerGraph offerings, see xref:overview:comparison_table.adoc[] or see xref:savanna:get-started:index.adoc[] to unlock its full potential.
Next, to understand how TigerGraph Savanna differs from other TigerGraph offerings, see xref:overview:comparison_table.adoc[] or see xref:savanna:get-started:index.adoc[] to unlock its full potential.

Return to xref:savanna:overview:index.adoc[TigerGraph Savanna] for another topic.
2 changes: 1 addition & 1 deletion modules/savanna/modules/overview/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It revolutionizes graph analytics by introducing a groundbreaking separation of

//{tooltip}

== Get to Know Your TigerGraph Cloud
== Get to Know TigerGraph Savanna

[.home-card,cols="2",grid=none,frame=none, separator=¦]
|===
Expand Down
2 changes: 1 addition & 1 deletion modules/savanna/modules/overview/pages/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ It helps users discover valuable information within their data even if they are

== Next Steps

Next, to understand how TigerGraph cloud differs from other TigerGraph offerings see xref:overview:comparison_table.adoc[] or see xref:savanna:get-started:index.adoc[] to unlock its full potential.
Next, to understand how TigerGraph Savanna differs from other TigerGraph offerings see xref:overview:comparison_table.adoc[] or see xref:savanna:get-started:index.adoc[] to unlock its full potential.

Return to xref:savanna:overview:index.adoc[TigerGraph Savanna] for another topic.
4 changes: 2 additions & 2 deletions modules/savanna/modules/overview/pages/pricing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Compute resources on TigerGraph Savanna are billed based on the number of TCRs c

=== TigerGraph Credits

A TigerGraph Credit (TCR) is a unit that represents the cost of using compute resources on TigerGraph Cloud. By using TCRs, you can easily scale your compute resources up or down to meet your performance needs without worrying about complex pricing structures.
A TigerGraph Credit (TCR) is a unit that represents the cost of using compute resources on TigerGraph Savanna. By using TCRs, you can easily scale your compute resources up or down to meet your performance needs without worrying about complex pricing structures.

The exchange rate for TigerGraph Credits is straightforward:

Expand Down Expand Up @@ -191,7 +191,7 @@ Storage on TigerGraph Savanna is billed separately from compute resources. Stora
|===

== Add-on Pricing
TigerGraph Savanna offers a variety of add-ons to enhance your graph database experience. Each add-on is priced individually, allowing you to customize your TigerGraph Cloud environment to fit your specific needs and budget. Add-ons are billed monthly and can be added or removed at any time to provide maximum flexibility.
TigerGraph Savanna offers a variety of add-ons to enhance your graph database experience. Each add-on is priced individually, allowing you to customize your TigerGraph Savanna environment to fit your specific needs and budget. Add-ons are billed monthly and can be added or removed at any time to provide maximum flexibility.
[cols="3", separator=¦ ]
|===
¦Add-On ¦Scope ¦Price
Expand Down
Loading

0 comments on commit 0dbe496

Please sign in to comment.