Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
samzhou2 committed Oct 27, 2024
1 parent 0b17318 commit d5a33ad
Show file tree
Hide file tree
Showing 16 changed files with 137 additions and 75 deletions.
2 changes: 2 additions & 0 deletions modules/cloud/antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
name: cloud
title: TigerGraph Cloud Classic
start_page: start:overview.adoc
version: main
display_version: default

nav:
- modules/start/nav.adoc
Expand Down
4 changes: 2 additions & 2 deletions modules/cloud/modules/start/pages/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ handling all the complexity of deploying and managing your deployments on the cl

[NOTE]
====
TigerGraph Cloud 4 (beta version) was released on Apr. 29th, 2024.
TigerGraph Cloud 4 was released on Oct. 30th, 2024.
Check out the new Cloud 4 beta at https://beta.tgcloud.io or have a look at the xref:cloud4:overview:index.adoc[Documentation] for more details.
Check out the new Cloud 4 at https://portal.tgcloud.io or have a look at the xref:cloud4:overview:index.adoc[Documentation] for more details.
====

[NOTE]
Expand Down
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 @@ -10,7 +10,7 @@ There are two ways to log in, through your account you created through signing u

=== 1) Your Account

If you click btn:[Log In] on the https://beta.tgcloud.io[TigerGraph Cloud landing page].
If you click btn:[Log In] on the https://portal.tgcloud.io[TigerGraph Cloud 4 landing page].
TigerGraph Cloud 4 supports users to log in via Google, LinkedIn, or via a username/password.

[TIP]
Expand Down
2 changes: 1 addition & 1 deletion modules/cloud4/modules/get-started/pages/how2-signup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In order to use TigerGraph Cloud 4 users must first btn:[Sign Up].
This guide will walk you through the necessary steps.

== Sign Up
. Click btn:[Sign Up] https://beta.tgcloud.io[on the TigerGraph Cloud landing page].
. Click btn:[Sign Up] https://portal.tgcloud.io[on the TigerGraph Cloud 4 landing page].
+
image::loginPage.png[]

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion modules/cloud4/modules/overview/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
* xref:index.adoc[Introduction]
** xref:overview:overview.adoc[Overview]
** xref:cloud4:overview:overview.adoc[Overview]
// ** xref:cloud4:overview:architecture.adoc[Architecture]
** xref:cloud4:overview:comparison_table.adoc[Compare Different Offerings]
** xref:cloud4:overview:release-notes.adoc[Release Notes]
** xref:cloud4:overview:pricing.adoc[]
Expand Down
52 changes: 52 additions & 0 deletions modules/cloud4/modules/overview/pages/architecture.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
= TigerGraph Cloud 4 Architecture
:experimental:
:toc:
:toclevels:2

Welcome to the TigerGraph Cloud 4 Architecture documentation. This guide provides an in-depth look at the architecture of TigerGraph Cloud 4, detailing its components, design principles, and how it ensures performance, scalability, and reliability for your graph database applications.



== Overview

These key features of TigerGraph Cloud 4 collectively provide a powerful and user-friendly environment for organizations to perform advanced graph analytics, gain valuable insights from interconnected data, and drive data-driven decision-making and innovation.

=== Separation of Storage and Compute
We introduce a unique architecture that separates storage and compute, allowing users to scale resources independently.
This enables optimized performance and cost-efficiency by allocating resources based on specific workload requirements.
It is designed to scale seamlessly as data and workload demands grow.
It offers elastic scaling capabilities, allowing users to dynamically adjust resources to handle varying workloads and ensure optimal performance.

=== Read-Write and Read-Only Workspaces
We introduce Read-Write and Read-Only Workspaces to connect to the same database, allowing users to dynamically control OLTP and OLAP workloads for complete isolation of analytical and transactional traffic.

=== Streamlined Data Loading Pipeline
The platform simplifies the process of importing and transforming data into a graph database.
With support for various data connectors such as Local File, Amazon S3, Azure Blob Storage, GCP Cloud Storage, Spark, Snowflake, Postgres, Kafka, and BigQuery, the platform offers seamless integration with diverse data sources.
It provides step-by-step data loading for select connectors, automatically detecting formats, schemas, and mappings. This streamlines the data loading process and enables auto schema and mapping generation, making it convenient to leverage existing data assets for graph analytics.

=== Integrations with Solution Kits
TigerGraph Solution Kits are comprehensive, ready-to-use solutions that package TigerGraph's industry-leading graph database and AI technology with domain-specific schema, workflows, and dashboards.
They provide everything users need to get started with graph analytics and AI-driven insights in their respective fields.

=== GSQL Editor
The platform features a dedicated GSQL Editor—an integrated development environment (IDE) tailored for working with GSQL, the query language of TigerGraph.
Designed with user convenience in mind, the GSQL Editor offers a user-friendly interface that simplifies the process of writing, testing, and optimizing GSQL queries.
With syntax highlighting, code completion, query execution, and debugging capabilities, users can easily develop and fine-tune their graph queries. Additionally, the GSQL Editor enables seamless collaboration within organizations by allowing users to share GSQL files, fostering teamwork and facilitating efficient collaboration among colleagues.

=== Graph Explorer
TigerGraph Cloud 4 features a Graph Explorer, a visual interface that allows users to interactively explore and analyze the graph data.
The Graph Explorer provides a rich set of visualization tools, including graph visualizations, charts, and tables, enabling users to gain insights and discover patterns in their data.
It offers intuitive navigation, filtering, and querying capabilities, making it easier for users to explore and understand the relationships and connections within their graph data.

=== Auto Data Profiles
TigerGraph Cloud 4 incorporates auto data profile capabilities that automatically find data insights for users without prior knowledge of their schema and query.
This feature leverages advanced algorithms and machine learning techniques to analyze the graph data and identify meaningful patterns, relationships, and insights.
It helps users discover valuable information within their data even if they are not familiar with the underlying data structure or query language.


== Next Steps

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

Return to xref:cloud4:overview:index.adoc[TigerGraph Cloud 4] for another topic.
15 changes: 2 additions & 13 deletions modules/cloud4/modules/overview/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
= TigerGraph Cloud 4 [Dev branch]
= TigerGraph Cloud 4
: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.

TigerGraph Cloud 4 (https://beta.tgcloud.io) offers a powerful and user-friendly environment for managing, analyzing, and exploring your graph data.
TigerGraph Cloud 4 (https://portal.tgcloud.io) offers a powerful and user-friendly environment for managing, analyzing, and exploring your graph data.
It revolutionizes graph analytics by introducing a groundbreaking separation of compute and storage in its cloud-based graph database platform.

//pass:[<abbr title="Define User Friendly">ToolTip Practice</abbr>]
Expand All @@ -13,17 +13,6 @@ It revolutionizes graph analytics by introducing a groundbreaking separation of

//{tooltip}

[CAUTION]
====
TigerGraph Cloud 4 is still in beta release and the documentation is in progress.
====

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

== Get to Know Your TigerGraph Cloud

[.home-card,cols="2",grid=none,frame=none, separator=¦]
Expand Down
33 changes: 32 additions & 1 deletion modules/cloud4/modules/overview/pages/overview.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,40 @@
= Cloud 4 Overview
= TigerGraph Cloud 4 Overview
:experimental:
:toc: left
:toclevels: 3

Purpose-built for graph analytics, this approach empowers users to independently scale compute and storage resources, optimizing performance and cost-efficiency according to their specific requirements.

The platform also comes with intuitive interfaces, designed to reduce the learning curve and enable users to quickly leverage the benefits of graph analytics.

== TigerGraph Cloud 4 Architecture

TigerGraph Cloud 4 is designed to provide a robust, scalable, and secure environment for deploying graph databases in the cloud. The architecture leverages cloud-native technologies to deliver high performance and reliability, ensuring that your graph database can handle complex queries and large datasets efficiently.

image::cloud4-architecture.png[Architecture Overview, 800, 600]

=== Components

==== *Data Plane - Storage Layer*

The graph storage layer is responsible for persisting graph data in a highly optimized format. Involved storing data in a distributed manner across multiple nodes to ensure high availability and fault tolerance.

==== *Data Plane - Compute Layer*

The copute layer is the heart of TigerGraph Cloud 4, providing the capability to execute complex graph queries with high performance

==== *Control Plane*

The control plane provides UI and APIs for managing and monitoring graph databases in TigerGraph Cloud 4. Key components include:

- **Resource Management:** Resource management in TigerGraph Cloud 4 ensures efficient utilization and allocation of cloud resources to meet the demands of your graph database applications.
- **Infrastructure Management:** Infrastructure management involves the deployment, configuration, and maintenance of the underlying cloud infrastructure that supports TigerGraph Cloud 4.
- **Billing Management:** Billing management in TigerGraph Cloud 4 provides transparency and control over your cloud spending, ensuring you can manage costs effectively.
- **Organization/User Management:** Organization and user management features in TigerGraph Cloud 4 enable you to control access and permissions for different users within your organization.
- **Application Management:** Application management tools in TigerGraph Cloud 4 help you to manage the add-ons and integrations that enhance the functionality of your graph database applications.
- **Monitoring, Auditing and Alerting:** Monitoring, auditing, and alerting features in TigerGraph Cloud 4 provide visibility into system activities and ensure timely notification of critical events.


== Key Features of TigerGraph Cloud 4

These key features of TigerGraph Cloud 4 collectively provide a powerful and user-friendly environment for organizations to perform advanced graph analytics, gain valuable insights from interconnected data, and drive data-driven decision-making and innovation.
Expand Down
11 changes: 6 additions & 5 deletions modules/cloud4/modules/resources/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
* xref:index.adoc[Resources]
** xref:resources:glossary.adoc[]
** xref:resources:support.adoc[]
** xref:resources:quota_policy.adoc[Subscription Plans and Quota Policy]
** xref:resources:terms_conditions.adoc[Terms and Conditions]
* xref:cloud4:resources:index.adoc[Resources]
** xref:cloud4:resources:glossary.adoc[]
** xref:cloud4:resources:support.adoc[]
** xref:cloud4:resources:faqs.adoc[]
** xref:cloud4:resources:quota_policy.adoc[Subscription Plans and Quota Policy]
** xref:cloud4:resources:terms_conditions.adoc[Terms and Conditions]
// ** xref:resources:faqs.adoc[FAQs]
33 changes: 10 additions & 23 deletions modules/cloud4/modules/resources/pages/faqs.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
= TigerGraph Cloud FAQs
= TigerGraph Cloud 4 FAQs
:pp: {plus}{plus}

////
*Feedback for TigerGraph Cloud is welcome at* [email protected]
//
*Feedback for TigerGraph Cloud 4 is welcome at* [email protected]

== Top FAQs

=== Why don't I see a password reset email?
=== *Q: Why don't I see a password reset email?*

If you clicked "forgot password" during sign in to Cloud and never received an email, there could be a few explanations.
A: If you clicked "forgot password" during sign in to Cloud and never received an email, there could be a few explanations.

* If you requested a password reset from an organization login screen, you won't get an email if you don't belong to that organization. Try resetting your password from the main login page at link:tgcloud.io[].
* If you signed up through Google authentication, you cannot use a password to log in to the same account. Try logging in with your Google account.
Expand All @@ -26,9 +26,9 @@ And our starter kits for popular use cases mean you can have an example graph ap
Since it requires far fewer machines to achieve high performance, TigerGraph's price performance sets a new bar for the graph database industry.


=== *Q: How do I migrate to the new December 2020 pricing to lower my bill?*
=== *Q: How do I migrate to the TigerGraph Cloud 4 to lower my bill?*

A: New December 2020 pricing applies to new paid tier clusters provisioned after December 16th, 2020.
A: New November 2024 pricing applies to new paid tier clusters provisioned after December 16th, 2020.
You can keep the old pricing if you keep your paid tier instances provisioned before December 16th, 2020 and keep its state (running or stopped).
If you want to take advantage of the new pricing to lower your cost, you can migrate your workload to a newly provisioned instance, or simply start and stop the old instance.
Note that only TigerGraph Cloud accounts with valid credit cards are eligible for the paid tier migration.
Expand All @@ -51,22 +51,9 @@ For additional information, see link:https://www.tigergraph.com/tigergraph-cloud
TIP: If you need to save your work from a Free Tier instance, export the cluster (which saves your graph and queries) and write queries which print all your data to files.


=== *Q: I cannot start my free tier instances. Why is there a capacity error in "My Activities"?*

A: *Known Capacity Issues:* Free Tier instances are provisioned on a common instance type in a data center region of the cloud provider. During surge cloud usage periods, such as the current global lockdown due to COVID-19, cloud providers across the globe experience capacity issues.

It is possible that when you provision a free tier instance, it will not provision successfully on the first try because of the peak usage in a certain region in the backend cloud platform.
Please be patient and try to provision in another region, or at a later time when there is enough capacity in the region.
Some free tier instances, when stopped, cannot be restarted at certain times due to cloud provider capacity issues.
If this happens to you, try to restart the cluster at a later time when there are more machines available in the region of the cloud provider.
In both scenarios, you can look at the log in "My Activities" and see that the capacity issue is logged. Submit a support ticket if the capacity issue persists.

To reserve an instance for guaranteed capacity, please submit a support ticket and contact link:mailto:[email protected][[email protected]] to arrange a long-term contract for reserved TigerGraph instances.


=== *Q: In what cloud platforms and regions does TigerGraph operate?*
=== *Q: In what cloud platforms and regions does TigerGraph Cloud 4 operate?*

A: TigerGraph Cloud offers three cloud platform options: xref:reference:aws.adoc[Amazon Web Services (AWS)], xref:reference:azure.adoc[Azure] and xref:reference:gcp.adoc[Google Cloud Platform (GCP)].
A: TigerGraph Cloud 4 offers three cloud platform options: xref:reference:aws.adoc[Amazon Web Services (AWS)], xref:reference:azure.adoc[Azure] and xref:reference:gcp.adoc[Google Cloud Platform (GCP)].

Visit each platform's reference page to learn more about the available regions.

Expand Down Expand Up @@ -590,4 +577,4 @@ Contact link:mailto:[email protected][[email protected]] to discuss query
=== *Q: What third-party software is used in TigerGraph Cloud?*

A: A list of third-party software used in the TigerGraph engine and TigerGraph Cloud is available at xref:tigergraph-server:reference:patents-and-third-party-software.adoc[].
////
//
2 changes: 1 addition & 1 deletion modules/cloud4/modules/resources/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Resources provide other documents to help support your TigerGraph Cloud 4 journe

== xref:resources:glossary.adoc[]

Here you can refer terms used in TigerGraph Cloud and the 4.0 (beta).
Here you can refer terms used in TigerGraph Cloud 4.

== xref:resources:support.adoc[]

Expand Down
29 changes: 22 additions & 7 deletions modules/cloud4/modules/resources/pages/support.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
= Support
:experimental:

== Contact Us
If you have any questions, please contact us at [email protected].

//Look to the terms and conditions
//Email the address
//Create a ticket
Expand All @@ -28,4 +22,25 @@ if you already have an account, log in and click btn:[Submit a request] to submi
== Follow up on your ticket

If you have a paid subscription with TigerGraph, a support representative will be reviewing your request and will send you a personal response (usually within 24 hours). You can follow up on your ticket on the Zendesk platform.
////
////
= Support
:sectnums:
:experimental:
TigerGraph provides support for TigerGraph Cloud for customers with non-free-tier clusters. For more information on TigerGraph's support policy, visit our https://www.tigergraph.com/support-policy/[support policy page].
You can submit a support ticket in the TigerGraph Cloud portal or by email.
== Submit a support ticket
Click on the question mark icon in the upper right corner of the screen and select Support from the drop-down menu.
This takes you to TigerGraph's support platform, where you can submit support tickets.
If you don't already have an account, you can create one following the instructions on the page.
if you already have an account, log in and click btn:[Submit a request] to submit a support ticket.
== Follow up on your ticket
If you have a paid subscription with TigerGraph, a support representative will be reviewing your request and will send you a personal response (usually within 24 hours). You can follow up on your ticket on the Zendesk platform.
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ These Terms shall be governed by and construed in accordance with the internal l
Each party hereby consents to the jurisdiction of the federal or state courts of San Mateo County, California, USA. Each party hereby waives any right to a jury trial in any litigation arising out of or related to this Agreement.

== Contact Us
If you have any questions about these Terms, please contact us at beta-[email protected].
If you have any questions about these Terms, please contact us at [email protected].
14 changes: 0 additions & 14 deletions modules/cloud4/modules/workgroup-workspace/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,6 @@
In TigerGraph Cloud 4, the concepts of workgroup, workspace, and database are used to organize and manage projects and data within the platform.
By utilizing xref:cloud4:workgroup-workspace:workgroups/workgroup.adoc[workgroups], xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[workspaces and databases], TigerGraph Cloud 4 provides a flexible and scalable environment for managing projects, allocating compute resources, and working with graph data effectively.

////
[CAUTION]
====
TigerGraph Cloud 4 is still in beta release and the documentation is in progress.
====

[IMPORTANT]
====
TigerGraph Cloud 4 beta is for personal or R&D use and not for production use.
It is not covered by our xref:cloud4:resources:terms_conditions.adoc[].
====
////

== xref:cloud4:workgroup-workspace:workgroups/workgroup.adoc[]

Learn xref:cloud4:workgroup-workspace:workgroups/how2-create-a-workgroup.adoc[] the first step before creating a xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Workspace]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ image::backuprestore4.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.
We have quotas for the number of backups that can be stored. Please make sure to manage your backups accordingly. For details about the backup quota, please refer to xref:cloud4:resources:quota_policy.adoc[Quata Policy].
====

=== How to Setup Scheduled Auto-Backup
Expand All @@ -67,11 +66,10 @@ image::backuprestore5.png[]

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


[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.
We have quotas for the number of backups that can be stored. Please make sure to manage your backups accordingly. For details about the backup quota, please refer to xref:cloud4:resources:quota_policy.adoc[Quata Policy].
====

=== How to Restore a Backup
Expand Down

0 comments on commit d5a33ad

Please sign in to comment.