diff --git a/modules/cloud/antora.yml b/modules/cloud/antora.yml index 1a1eea87..f5999bd8 100644 --- a/modules/cloud/antora.yml +++ b/modules/cloud/antora.yml @@ -1,8 +1,8 @@ name: cloud -title: TigerGraph Cloud +title: TigerGraph Cloud Classic +start_page: start:overview.adoc version: main display_version: default -start_page: start:overview.adoc nav: - modules/start/nav.adoc diff --git a/modules/cloud/modules/solutions/pages/access-solution/graphstudio.adoc b/modules/cloud/modules/solutions/pages/access-solution/graphstudio.adoc index 5e8956ac..75de14f4 100644 --- a/modules/cloud/modules/solutions/pages/access-solution/graphstudio.adoc +++ b/modules/cloud/modules/solutions/pages/access-solution/graphstudio.adoc @@ -16,6 +16,6 @@ image::full-cluster-actions-dropdown.png[] == Use GraphStudio -To learn how to use GraphStudio, read our xref:gui:graphstudio:overview.adoc[GraphStudio UI Guide]. +To learn how to use the GraphStudio™ design interface, read our xref:gui:graphstudio:overview.adoc[GraphStudio™ UI Guide]. diff --git a/modules/cloud/modules/start/pages/get_started.adoc b/modules/cloud/modules/start/pages/get_started.adoc index d04ab94c..4179fda2 100644 --- a/modules/cloud/modules/start/pages/get_started.adoc +++ b/modules/cloud/modules/start/pages/get_started.adoc @@ -2,6 +2,12 @@ :experimental: :page-aliases: get-started.adoc +[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[]. +==== + == Sign up Click btn:[Sign Up] on the https://tgcloud.io/[TigerGraph Cloud landing page]. @@ -54,71 +60,21 @@ For advanced OS-level commands, submit a support ticket for more information. |=== | Topic | TigerGraph Enterprise Server | TigerGraph Cloud -| GSQL Graph Algorithm Library -| Yes -| Yes - -| Release Notes -| Yes -| TigerGraph Cloud provides database versions kept up to date with TigerGraph Server releases. - -| GSQL 101 -| Yes -| Basic concepts still apply, most CREATE, INSTALL, LOAD, and RUN commands are replaced with the GraphStudio GUI-based approach. - -| GSQL 102 Pattern Matching -| Yes -| The same patterns can be used in queries. - -| MultiGraph Overview -| Yes -| Yes - -| Hardware and Software Requirements -| Yes -| N/A - -| Installation and Configuration -| Yes -| N/A. There are a few simple steps to install a Starter Kit. See the TigerGraph Cloud FAQs. - -| User Access Management -| Yes -| Yes - -| Data Encryption -| Yes -| N/A. TigerGraph Cloud is setup already for encrypted data at rest and at motion. - -| System Management -| Yes -| The Cloud Admin Portal is enhanced over the TigerGraph Server Admin Portal. Backup and Restore is done through the Cloud Admin Portal. - -| GraphStudio UI Guide -| Yes -| Yes - -| GSQL Demo Examples -| Yes -| Yes - -| GSQL Language Reference, Part 1 Data Definition and Loading -| Yes -| Yes. GSQL Web Shell (Paid Tiers) supports Data Definition and Loading. Data files can be imported into the filesystem through GraphStudio, or submit support request to import into the filesystem. In addition, the operations can be performed through the GraphStudio user interface. - -| GSQL Language Reference, Part 2 Querying -| Yes -| Yes - -| RESTPP API User Guide -| Yes -| Yes. Note the URL assigned to your cluster. - -| Transaction Processing and ACID Support -| Yes -| Yes - -| Data Loader User Guides -| Yes -| S3 Loader can be used through the GraphStudio interface. In addition, S3 Loader and Kafka Loader can be used in GSQL Web Shell (Paid Tiers). +| GSQL Graph Algorithm Library | Yes | Yes +| Release Notes | Yes | TigerGraph Cloud keeps its database instances up to date with the latest TigerGraph Server releases. +| GSQL 101 | Yes | Basic concepts still apply. Most CREATE, INSTALL, LOAD, and RUN commands are replaced with the GraphStudio GUI-based approach. +| GSQL 102 Pattern Matching | Yes | The same patterns can be used in queries. +| MultiGraph Overview | Yes | Yes +| Hardware and Software Requirements | Yes | N/A +| Installation and Configuration | Yes | N/A. There are a few simple steps to install a Starter Kit. See the TigerGraph Cloud FAQs. +| User Access Management | Yes | Yes +| Data Encryption | Yes | N/A. TigerGraph Cloud is setup already for encrypted data at rest and at motion. +| System Management | Yes | The Cloud Admin Portal is enhanced over the TigerGraph Server Admin Portal. Backup and Restore is done through the Cloud Admin Portal. +| GraphStudio UI Guide | Yes | Yes +| GSQL Demo Examples | Yes | Yes +| GSQL Language Reference, Part 1 Data Definition and Loading| Yes | Yes. GSQL Web Shell (Paid Tiers) supports Data Definition and Loading. Data files can be imported into the filesystem through GraphStudio, or submit support request to import into the filesystem. In addition, the operations can be performed through the GraphStudio user interface. +| GSQL Language Reference, Part 2 Querying | Yes | Yes +| RESTPP API User Guide | Yes | Yes. Note the URL assigned to your cluster. +| Transaction Processing and ACID Support | Yes | Yes +| Data Loader User Guides | Yes | S3 Loader can be used through the GraphStudio interface. In addition, S3 Loader and Kafka Loader can be used in GSQL Web Shell (Paid Tiers). |=== diff --git a/modules/cloud/modules/start/pages/overview.adoc b/modules/cloud/modules/start/pages/overview.adoc index 44f17200..b363e424 100644 --- a/modules/cloud/modules/start/pages/overview.adoc +++ b/modules/cloud/modules/start/pages/overview.adoc @@ -1,4 +1,4 @@ -= TigerGraph Cloud += TigerGraph Cloud Classic :experimental: :page-aliases: cloud-overview.adoc @@ -10,11 +10,22 @@ handling all the complexity of deploying and managing your deployments on the cl [NOTE] ==== -TigerGraph Cloud 4.0 (beta version) was released on Apr. 29th, 2024. +TigerGraph Cloud 4 Beta was released on Apr. 29, 2024. -Check out the new Cloud 4.0 beta at https://beta.tgcloud.io or have a look at the xref:cloudBeta: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. ==== +[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[]. +==== + +// [NOTE] +// ==== +// On December 31, 2025, we'll retire the TigerGraph Cloud Classic platform. Before that date, you’ll need to migrate your data from TigerGraph Cloud Classic to TigerGraph Cloud 4. For support, please contact us at support@tigergraph.com. +// ==== + == Get to Know Your TigerGraph Cloud [.home-card,cols="2",grid=none,frame=none, separator=¦] diff --git a/modules/cloud/modules/support/pages/faqs.adoc b/modules/cloud/modules/support/pages/faqs.adoc index ffbac27b..f9a05662 100644 --- a/modules/cloud/modules/support/pages/faqs.adoc +++ b/modules/cloud/modules/support/pages/faqs.adoc @@ -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 loading data from Amazon S3, Google Cloud Storage, and local files 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. diff --git a/modules/cloud4/antora.yml b/modules/cloud4/antora.yml new file mode 100644 index 00000000..b0636616 --- /dev/null +++ b/modules/cloud4/antora.yml @@ -0,0 +1,15 @@ +name: cloud4 +title: TigerGraph Cloud 4 Beta +version: main +display_version: default +start_page: overview:index.adoc + +nav: + - modules/overview/nav.adoc + - modules/get-started/nav.adoc + - modules/workgroup-workspace/nav.adoc + - modules/graph-development/nav.adoc + - modules/rest-api/nav.adoc + - modules/integrations/nav.adoc + - modules/administration/nav.adoc + - modules/resources/nav.adoc diff --git "a/modules/cloudbeta/modules/administration/images/Screenshot 2024-04-18 at 10.21.16\342\200\257AM.png" "b/modules/cloud4/modules/administration/images/Screenshot 2024-04-18 at 10.21.16\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/administration/images/Screenshot 2024-04-18 at 10.21.16\342\200\257AM.png" rename to "modules/cloud4/modules/administration/images/Screenshot 2024-04-18 at 10.21.16\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/administration/images/Screenshot 2024-04-18 at 10.22.57\342\200\257AM.png" "b/modules/cloud4/modules/administration/images/Screenshot 2024-04-18 at 10.22.57\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/administration/images/Screenshot 2024-04-18 at 10.22.57\342\200\257AM.png" rename to "modules/cloud4/modules/administration/images/Screenshot 2024-04-18 at 10.22.57\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/administration/images/Screenshot 2024-04-18 at 10.23.26\342\200\257AM.png" "b/modules/cloud4/modules/administration/images/Screenshot 2024-04-18 at 10.23.26\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/administration/images/Screenshot 2024-04-18 at 10.23.26\342\200\257AM.png" rename to "modules/cloud4/modules/administration/images/Screenshot 2024-04-18 at 10.23.26\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/billing-manager/images/Screenshot 2024-04-28 at 12.11.56\342\200\257PM.png" "b/modules/cloud4/modules/administration/images/Screenshot 2024-04-28 at 12.11.56\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/billing-manager/images/Screenshot 2024-04-28 at 12.11.56\342\200\257PM.png" rename to "modules/cloud4/modules/administration/images/Screenshot 2024-04-28 at 12.11.56\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/administration/images/Screenshot 2024-04-28 at 4.24.00\342\200\257PM.png" "b/modules/cloud4/modules/administration/images/Screenshot 2024-04-28 at 4.24.00\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/administration/images/Screenshot 2024-04-28 at 4.24.00\342\200\257PM.png" rename to "modules/cloud4/modules/administration/images/Screenshot 2024-04-28 at 4.24.00\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/administration/images/Screenshot 2024-04-28 at 4.26.18\342\200\257PM.png" "b/modules/cloud4/modules/administration/images/Screenshot 2024-04-28 at 4.26.18\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/administration/images/Screenshot 2024-04-28 at 4.26.18\342\200\257PM.png" rename to "modules/cloud4/modules/administration/images/Screenshot 2024-04-28 at 4.26.18\342\200\257PM.png" diff --git a/modules/cloudbeta/modules/billing-manager/images/action-colum-options.png b/modules/cloud4/modules/administration/images/action-colum-options.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/action-colum-options.png rename to modules/cloud4/modules/administration/images/action-colum-options.png diff --git a/modules/cloudbeta/modules/billing-manager/images/add-creditcard.png b/modules/cloud4/modules/administration/images/add-creditcard.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/add-creditcard.png rename to modules/cloud4/modules/administration/images/add-creditcard.png diff --git a/modules/cloudbeta/modules/administration/images/addemail.png b/modules/cloud4/modules/administration/images/addemail.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/addemail.png rename to modules/cloud4/modules/administration/images/addemail.png diff --git a/modules/cloudbeta/modules/administration/images/adminleftnav.png b/modules/cloud4/modules/administration/images/adminleftnav.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/adminleftnav.png rename to modules/cloud4/modules/administration/images/adminleftnav.png diff --git a/modules/cloudbeta/modules/administration/images/billing-homecard.png b/modules/cloud4/modules/administration/images/billing-homecard.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/billing-homecard.png rename to modules/cloud4/modules/administration/images/billing-homecard.png diff --git a/modules/cloud4/modules/administration/images/billing-manager.png b/modules/cloud4/modules/administration/images/billing-manager.png new file mode 100644 index 00000000..7a85af51 Binary files /dev/null and b/modules/cloud4/modules/administration/images/billing-manager.png differ diff --git a/modules/cloudbeta/modules/billing-manager/images/billing-nav.png b/modules/cloud4/modules/administration/images/billing-nav.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/billing-nav.png rename to modules/cloud4/modules/administration/images/billing-nav.png diff --git a/modules/cloudbeta/modules/billing-manager/images/creaditcard-list.png b/modules/cloud4/modules/administration/images/creaditcard-list.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/creaditcard-list.png rename to modules/cloud4/modules/administration/images/creaditcard-list.png diff --git a/modules/cloudbeta/modules/billing-manager/images/creaditcardInfomration.png b/modules/cloud4/modules/administration/images/creaditcardInfomration.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/creaditcardInfomration.png rename to modules/cloud4/modules/administration/images/creaditcardInfomration.png diff --git a/modules/cloud4/modules/administration/images/create-api-key.png b/modules/cloud4/modules/administration/images/create-api-key.png new file mode 100644 index 00000000..98d11380 Binary files /dev/null and b/modules/cloud4/modules/administration/images/create-api-key.png differ diff --git a/modules/cloudbeta/modules/administration/images/create-organization.png b/modules/cloud4/modules/administration/images/create-organization.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/create-organization.png rename to modules/cloud4/modules/administration/images/create-organization.png diff --git a/modules/cloudbeta/modules/administration/images/delete.png b/modules/cloud4/modules/administration/images/delete.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/delete.png rename to modules/cloud4/modules/administration/images/delete.png diff --git a/modules/cloudbeta/modules/billing-manager/images/deletecard.png b/modules/cloud4/modules/administration/images/deletecard.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/deletecard.png rename to modules/cloud4/modules/administration/images/deletecard.png diff --git a/modules/cloudbeta/modules/administration/images/documentation-homecard.png b/modules/cloud4/modules/administration/images/documentation-homecard.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/documentation-homecard.png rename to modules/cloud4/modules/administration/images/documentation-homecard.png diff --git a/modules/cloudbeta/modules/administration/images/emailinlist.png b/modules/cloud4/modules/administration/images/emailinlist.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/emailinlist.png rename to modules/cloud4/modules/administration/images/emailinlist.png diff --git a/modules/cloudbeta/modules/administration/images/getstarted-homecard.png b/modules/cloud4/modules/administration/images/getstarted-homecard.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/getstarted-homecard.png rename to modules/cloud4/modules/administration/images/getstarted-homecard.png diff --git a/modules/cloudbeta/modules/administration/images/inviteUserupperffeatures.png b/modules/cloud4/modules/administration/images/inviteUserupperffeatures.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/inviteUserupperffeatures.png rename to modules/cloud4/modules/administration/images/inviteUserupperffeatures.png diff --git a/modules/cloudbeta/modules/administration/images/invitepending.png b/modules/cloud4/modules/administration/images/invitepending.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/invitepending.png rename to modules/cloud4/modules/administration/images/invitepending.png diff --git a/modules/cloudbeta/modules/administration/images/inviteuser-delete.png b/modules/cloud4/modules/administration/images/inviteuser-delete.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/inviteuser-delete.png rename to modules/cloud4/modules/administration/images/inviteuser-delete.png diff --git a/modules/cloudbeta/modules/administration/images/inviteusers.png b/modules/cloud4/modules/administration/images/inviteusers.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/inviteusers.png rename to modules/cloud4/modules/administration/images/inviteusers.png diff --git a/modules/cloudbeta/modules/billing-manager/images/invoice-list.png b/modules/cloud4/modules/administration/images/invoice-list.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/invoice-list.png rename to modules/cloud4/modules/administration/images/invoice-list.png diff --git a/modules/cloudbeta/modules/administration/images/mail again or delete.png b/modules/cloud4/modules/administration/images/mail again or delete.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/mail again or delete.png rename to modules/cloud4/modules/administration/images/mail again or delete.png diff --git a/modules/cloudbeta/modules/administration/images/permissions-select a user.png b/modules/cloud4/modules/administration/images/permissions-select a user.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/permissions-select a user.png rename to modules/cloud4/modules/administration/images/permissions-select a user.png diff --git a/modules/cloudbeta/modules/administration/images/permissions_saveorCancealchanges.png b/modules/cloud4/modules/administration/images/permissions_saveorCancealchanges.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/permissions_saveorCancealchanges.png rename to modules/cloud4/modules/administration/images/permissions_saveorCancealchanges.png diff --git a/modules/cloudbeta/modules/administration/images/permissionschanges.png b/modules/cloud4/modules/administration/images/permissionschanges.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/permissionschanges.png rename to modules/cloud4/modules/administration/images/permissionschanges.png diff --git a/modules/cloudbeta/modules/administration/images/referece-homecard.png b/modules/cloud4/modules/administration/images/referece-homecard.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/referece-homecard.png rename to modules/cloud4/modules/administration/images/referece-homecard.png diff --git a/modules/cloudbeta/modules/administration/images/security-homecard.png b/modules/cloud4/modules/administration/images/security-homecard.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/security-homecard.png rename to modules/cloud4/modules/administration/images/security-homecard.png diff --git a/modules/cloudbeta/modules/administration/images/sendinvite.png b/modules/cloud4/modules/administration/images/sendinvite.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/sendinvite.png rename to modules/cloud4/modules/administration/images/sendinvite.png diff --git a/modules/cloudbeta/modules/administration/images/systemmanagment-homecard.png b/modules/cloud4/modules/administration/images/systemmanagment-homecard.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/systemmanagment-homecard.png rename to modules/cloud4/modules/administration/images/systemmanagment-homecard.png diff --git a/modules/cloudbeta/modules/administration/images/tools-page.png b/modules/cloud4/modules/administration/images/tools-page.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/tools-page.png rename to modules/cloud4/modules/administration/images/tools-page.png diff --git a/modules/cloudbeta/modules/administration/images/userlist.png b/modules/cloud4/modules/administration/images/userlist.png similarity index 100% rename from modules/cloudbeta/modules/administration/images/userlist.png rename to modules/cloud4/modules/administration/images/userlist.png diff --git a/modules/cloud4/modules/administration/nav.adoc b/modules/cloud4/modules/administration/nav.adoc new file mode 100644 index 00000000..361e0865 --- /dev/null +++ b/modules/cloud4/modules/administration/nav.adoc @@ -0,0 +1,12 @@ +* 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[] +** xref:administration:settings/index.adoc[Settings] +*** xref:administration:settings/how2-use-organization-mgnt.adoc[] +*** xref:administration:settings/how2-create-api-key.adoc[] \ No newline at end of file diff --git a/modules/cloud4/modules/administration/pages/billing/index.adoc b/modules/cloud4/modules/administration/pages/billing/index.adoc new file mode 100644 index 00000000..6c30e3e5 --- /dev/null +++ b/modules/cloud4/modules/administration/pages/billing/index.adoc @@ -0,0 +1,24 @@ += Billing Overview +:experimental: + +The Billing Manager allows you to stay in control of your account, optimize resource usage, and manage costs effectively. +Understand the billing process and manage your subscription within TigerGraph Cloud 4 with the billing manager UI. + +image::billing-manager.png[] + +Check out the links below to explore more billing information to utilize. + +== xref:cloud4:administration:billing/payment-methods.adoc[] + +Learn how you can manage payment methods. + +== xref:cloud4:administration:billing/invoices.adoc[] + +Learn how to view and export invoices. + +== xref:cloud4:overview:pricing.adoc[] + +Here you can review pricing information in TigerGraph Cloud 4. + + + diff --git a/modules/cloudbeta/modules/billing-manager/pages/invoices.adoc b/modules/cloud4/modules/administration/pages/billing/invoices.adoc similarity index 69% rename from modules/cloudbeta/modules/billing-manager/pages/invoices.adoc rename to modules/cloud4/modules/administration/pages/billing/invoices.adoc index 925835a6..07741684 100644 --- a/modules/cloudbeta/modules/billing-manager/pages/invoices.adoc +++ b/modules/cloud4/modules/administration/pages/billing/invoices.adoc @@ -1,7 +1,7 @@ = Invoices :experimental: -Here TigerGraph Cloud 4.0 users can check, reference, and export their invoice information. +Here TigerGraph Cloud 4 users can check, reference, and export their invoice information. == View and Export an Invoice @@ -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:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/billing-manager/pages/payment-methods.adoc b/modules/cloud4/modules/administration/pages/billing/payment-methods.adoc similarity index 80% rename from modules/cloudbeta/modules/billing-manager/pages/payment-methods.adoc rename to modules/cloud4/modules/administration/pages/billing/payment-methods.adoc index cfee9950..2739e543 100644 --- a/modules/cloudbeta/modules/billing-manager/pages/payment-methods.adoc +++ b/modules/cloud4/modules/administration/pages/billing/payment-methods.adoc @@ -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:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/billing-manager/pages/storage_price.adoc b/modules/cloud4/modules/administration/pages/billing/storage_price.adoc similarity index 100% rename from modules/cloudbeta/modules/billing-manager/pages/storage_price.adoc rename to modules/cloud4/modules/administration/pages/billing/storage_price.adoc diff --git a/modules/cloudbeta/modules/administration/pages/how2-access-mgnt.adoc b/modules/cloud4/modules/administration/pages/how2-access-mgnt.adoc similarity index 70% rename from modules/cloudbeta/modules/administration/pages/how2-access-mgnt.adoc rename to modules/cloud4/modules/administration/pages/how2-access-mgnt.adoc index 49b951f9..f186616f 100644 --- a/modules/cloudbeta/modules/administration/pages/how2-access-mgnt.adoc +++ b/modules/cloud4/modules/administration/pages/how2-access-mgnt.adoc @@ -2,7 +2,7 @@ :experimental: As an organization administrator, you can define permissions for users, controlling their level of access to workspaces, workgroup and features. This allows you to ensure data security and enforce access control policies within your organization. -In TigerGraph Cloud 4.0, access management allows you to configure permissions at both the *Resource* level and the *User* level. +In TigerGraph Cloud 4, access management allows you to configure permissions at both the *Resource* level and the *User* level. == Resource Level @@ -14,11 +14,11 @@ 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:cloudBeta:resource-manager: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. -User-level permissions determine what actions a user can perform across the entire TigerGraph Cloud 4.0 organization. +User-level permissions determine what actions a user can perform across your entire TigerGraph Cloud 4 organization. [TIP] ==== @@ -52,9 +52,7 @@ Please refer to the following tables of the roles and permissions for the organi .Org Level [cols="7", separator=¦] |=== -¦Feature Flags ¦Org Admin (Owner) ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member - -¦Org Level Permission Scope ¦Organization ¦Organization ¦Organization ¦Workgroup ¦Workspace ¦Workspace +¦Permission ¦Org Admin ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member ¦Manage Organization ¦Yes @@ -134,8 +132,7 @@ Please refer to the following tables of the roles and permissions for the organi .Workgroup Level [cols="7", separator=¦] |=== -¦Feature Flags ¦Org Admin (Owner) ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member -¦Workgroup Level Permission Scope ¦Organization ¦Organization ¦Organization ¦Workgroup ¦Workspace ¦Workspace +¦Permission ¦Org Admin ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member ¦Edit workgroup ¦Yes @@ -175,8 +172,7 @@ Please refer to the following tables of the roles and permissions for the organi .Workspace Level [cols="7", separator=¦] |=== -¦Feature Flags ¦Org Admin (Owner) ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member -¦Workspace Level Permission Scope ¦Organization ¦Organization ¦Organization ¦Workgroup ¦Workspace ¦Workspace +¦Permission ¦Org Admin ¦Billing Admin ¦Billing Viewer ¦Workgroup Admin ¦Workspace Admin¦Workspace Member ¦Edit workspace ¦Yes @@ -236,9 +232,14 @@ Please refer to the following tables of the roles and permissions for the organi |=== +[NOTE] +==== +`*` Additional database role(s) or permission(s) may need to be assigned to the user for certain actions. +==== + == Next Steps -Next, learn about xref:cloudBeta:administration:how2-use-organization-mgnt.adoc[] -or continue on to learn about xref:security:index.adoc[] or additional xref:cloudBeta:resources:index.adoc[] in TigerGraph Cloud 4.0. +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:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/administration/pages/how2-invite-users.adoc b/modules/cloud4/modules/administration/pages/how2-invite-users.adoc similarity index 80% rename from modules/cloudbeta/modules/administration/pages/how2-invite-users.adoc rename to modules/cloud4/modules/administration/pages/how2-invite-users.adoc index 726b0fad..e00e9379 100644 --- a/modules/cloudbeta/modules/administration/pages/how2-invite-users.adoc +++ b/modules/cloud4/modules/administration/pages/how2-invite-users.adoc @@ -1,11 +1,11 @@ = Invite Users :experimental: -When you set up a TigerGraph Cloud 4.0 account, you are granted the privileges of an Organization Admin for your company. +When you set up a TigerGraph Cloud 4 account, you are granted the privileges of an Organization Admin for your organization. An Organization Admin can manage multiple users in your organization and control their access to various resources. [NOTE] -For help with setting up workspaces, visit xref:resource-manager:workspaces/how2-create-a-workspace.adoc[] +For help with setting up workspaces, visit xref:workgroup-workspace:workspaces/how2-create-a-workspace.adoc[] == How to Invite and Delete Users @@ -42,7 +42,7 @@ image::inviteusers.png[width=500] + image::permissionschanges.png[] + -.You will see five coulmn items. +.You will see five column items. * *User Name*: This will be the username for the user. + [TIP] @@ -77,7 +77,7 @@ Select btn:[Cancel] or btn:[OK] to confirm. == Next Steps -Next, learn about xref:cloudBeta:administration:how2-access-mgnt.adoc[] -or continue on to learn about xref:security:index.adoc[] or additional xref:cloudBeta:resources:index.adoc[] in TigerGraph Cloud 4.0. +Next, learn about xref:cloud4:administration:how2-access-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:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/administration/pages/index.adoc b/modules/cloud4/modules/administration/pages/index.adoc new file mode 100644 index 00000000..a910d114 --- /dev/null +++ b/modules/cloud4/modules/administration/pages/index.adoc @@ -0,0 +1,26 @@ += Administration Overview +:experimental: + +Here you can learn about the tools available for organizational administrators. + +== xref:cloud4:administration:how2-invite-users.adoc[] + +Learn how to invite new users to your organizations. + +== xref:cloud4:administration:how2-access-mgnt.adoc[] + +Learn how to manage access to workspaces and resources within TigerGraph Cloud 4. + +== xref:cloud4:administration:settings/how2-use-organization-mgnt.adoc[] + +Learn about the organization management features that allow you to configure organization settings. + +== xref:cloud4:administration:settings/how2-create-api-key.adoc[] + +Learn how to create API keys for your organization. + +== Next Steps + +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. diff --git a/modules/cloudbeta/modules/security/pages/idp.adoc b/modules/cloud4/modules/administration/pages/security/idp.adoc similarity index 88% rename from modules/cloudbeta/modules/security/pages/idp.adoc rename to modules/cloud4/modules/administration/pages/security/idp.adoc index 3a5b47df..c517ffa8 100644 --- a/modules/cloudbeta/modules/security/pages/idp.adoc +++ b/modules/cloud4/modules/administration/pages/security/idp.adoc @@ -19,5 +19,5 @@ Only one IDP can be connected to a single Organization. == Setup This process is currently done through TigerGraph support. -Please contact beta-support@tigergraph.com to reach out to a technical support engineer who will guide you through the process. +Please contact support@tigergraph.com to reach out to a technical support engineer who will guide you through the process. diff --git a/modules/cloud4/modules/administration/pages/security/index.adoc b/modules/cloud4/modules/administration/pages/security/index.adoc new file mode 100644 index 00000000..947b6031 --- /dev/null +++ b/modules/cloud4/modules/administration/pages/security/index.adoc @@ -0,0 +1,15 @@ += Security +:experimental: + + +Here you can learn different security practices and policies in TigerGraph Cloud 4. + + +== xref:cloud4:administration:security/password-policy.adoc[] + +Learn and understand the password policy in TigerGraph Cloud 4. + + +== xref:cloud4:administration:security/idp.adoc[] + +Learn and understand IDP intergration with SSO password policy in TigerGraph Cloud 4. diff --git a/modules/cloudbeta/modules/security/pages/password-policy.adoc b/modules/cloud4/modules/administration/pages/security/password-policy.adoc similarity index 100% rename from modules/cloudbeta/modules/security/pages/password-policy.adoc rename to modules/cloud4/modules/administration/pages/security/password-policy.adoc diff --git a/modules/cloud4/modules/administration/pages/settings/how2-create-api-key.adoc b/modules/cloud4/modules/administration/pages/settings/how2-create-api-key.adoc new file mode 100644 index 00000000..3b757814 --- /dev/null +++ b/modules/cloud4/modules/administration/pages/settings/how2-create-api-key.adoc @@ -0,0 +1,48 @@ += API Keys +:experimental: + +As an organization administrator, you have access to organization management features that allow you to configure organization settings. + +[IMPORTANT] +==== +The TigerGraph Cloud 4 REST API is currently in preview version. Features and endpoints may change as the API evolves. +==== + +== 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. + +== Creating an API Key + +To create an API key, follow these steps: + +.1. **Navigate to Orgnization Settings:** + - Select the `Admin` → `Settings` menu on the navigation bar. + - If you cannot see the menu, please ask your organization administrator for access. + +.2. **Access the API Keys Section:** + - In the settings dashboard, find and click on the `API Keys` tab at the top. + +.3. **Create a New API Key:** + - Click on the btn:[ Create API Keys] button. + - Provide a name or description for the API key to help you identify its purpose later. + - Select the permissions you want to grant to the API key. + - Optionally, set an expiration date for the API key for added security. + +image::create-api-key.png[] + +.4. **Save the API Key:** + - Once the API key is generated, copy it and store it in a secure location. You will not be able to view this key again after you leave the page. + +[NOTE] +==== +Treat your API key like a password. Do not share it or expose it in your code or public repositories. +==== + +== Next Steps + +Next, continue on to learn about xref:cloud4:rest-api:authentication.adoc[] or xref:cloud4:rest-api:endpoints.adoc[] in TigerGraph Cloud 4. + +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. + + diff --git a/modules/cloudbeta/modules/administration/pages/how2-use-organization-mgnt.adoc b/modules/cloud4/modules/administration/pages/settings/how2-use-organization-mgnt.adoc similarity index 85% rename from modules/cloudbeta/modules/administration/pages/how2-use-organization-mgnt.adoc rename to modules/cloud4/modules/administration/pages/settings/how2-use-organization-mgnt.adoc index ae83c515..0a4ddab5 100644 --- a/modules/cloudbeta/modules/administration/pages/how2-use-organization-mgnt.adoc +++ b/modules/cloud4/modules/administration/pages/settings/how2-use-organization-mgnt.adoc @@ -34,8 +34,8 @@ 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:cloudBeta:resources:index.adoc[] in TigerGraph Cloud 4.0. +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:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/administration/pages/settings/index.adoc b/modules/cloud4/modules/administration/pages/settings/index.adoc new file mode 100644 index 00000000..934f4a26 --- /dev/null +++ b/modules/cloud4/modules/administration/pages/settings/index.adoc @@ -0,0 +1,18 @@ += Administrative Settings Overview +:experimental: + +Here you can learn about the configurations for an organization. + +== xref:cloud4:administration:settings/how2-use-organization-mgnt.adoc[] + +Learn about the organization management features that allow you to configure organization settings. + +== xref:cloud4:administration:settings/how2-create-api-key.adoc[] + +Learn how to create API keys for your organization. + +== Next Steps + +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. diff --git a/modules/cloud4/modules/get-started/da.adoc b/modules/cloud4/modules/get-started/da.adoc new file mode 100644 index 00000000..e69de29b diff --git a/modules/cloudbeta/modules/billing-manager/images/billing-homecard.png b/modules/cloud4/modules/get-started/images/billing-homecard.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/billing-homecard.png rename to modules/cloud4/modules/get-started/images/billing-homecard.png diff --git a/modules/cloudbeta/modules/billing-manager/images/create-organization.png b/modules/cloud4/modules/get-started/images/create-organization.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/create-organization.png rename to modules/cloud4/modules/get-started/images/create-organization.png diff --git a/modules/cloudbeta/modules/billing-manager/images/documentation-homecard.png b/modules/cloud4/modules/get-started/images/documentation-homecard.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/documentation-homecard.png rename to modules/cloud4/modules/get-started/images/documentation-homecard.png diff --git a/modules/cloudbeta/modules/billing-manager/images/getstarted-homecard.png b/modules/cloud4/modules/get-started/images/getstarted-homecard.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/getstarted-homecard.png rename to modules/cloud4/modules/get-started/images/getstarted-homecard.png diff --git a/modules/cloudbeta/modules/get-started/images/loginPage.png b/modules/cloud4/modules/get-started/images/loginPage.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/loginPage.png rename to modules/cloud4/modules/get-started/images/loginPage.png diff --git a/modules/cloudbeta/modules/get-started/images/orgLogin.png b/modules/cloud4/modules/get-started/images/orgLogin.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/orgLogin.png rename to modules/cloud4/modules/get-started/images/orgLogin.png diff --git a/modules/cloud4/modules/get-started/images/orglogin-1.png b/modules/cloud4/modules/get-started/images/orglogin-1.png new file mode 100644 index 00000000..aad85ed2 Binary files /dev/null and b/modules/cloud4/modules/get-started/images/orglogin-1.png differ diff --git a/modules/cloudbeta/modules/billing-manager/images/referece-homecard.png b/modules/cloud4/modules/get-started/images/referece-homecard.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/referece-homecard.png rename to modules/cloud4/modules/get-started/images/referece-homecard.png diff --git a/modules/cloudbeta/modules/billing-manager/images/security-homecard.png b/modules/cloud4/modules/get-started/images/security-homecard.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/security-homecard.png rename to modules/cloud4/modules/get-started/images/security-homecard.png diff --git a/modules/cloud4/modules/get-started/images/signup.png b/modules/cloud4/modules/get-started/images/signup.png new file mode 100644 index 00000000..5ad4b743 Binary files /dev/null and b/modules/cloud4/modules/get-started/images/signup.png differ diff --git a/modules/cloudbeta/modules/billing-manager/images/systemmanagment-homecard.png b/modules/cloud4/modules/get-started/images/systemmanagment-homecard.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/systemmanagment-homecard.png rename to modules/cloud4/modules/get-started/images/systemmanagment-homecard.png diff --git a/modules/cloudbeta/modules/billing-manager/images/tools-page.png b/modules/cloud4/modules/get-started/images/tools-page.png similarity index 100% rename from modules/cloudbeta/modules/billing-manager/images/tools-page.png rename to modules/cloud4/modules/get-started/images/tools-page.png diff --git a/modules/cloudbeta/modules/get-started/nav.adoc b/modules/cloud4/modules/get-started/nav.adoc similarity index 100% rename from modules/cloudbeta/modules/get-started/nav.adoc rename to modules/cloud4/modules/get-started/nav.adoc diff --git a/modules/cloudbeta/modules/get-started/pages/how2-login.adoc b/modules/cloud4/modules/get-started/pages/how2-login.adoc similarity index 55% rename from modules/cloudbeta/modules/get-started/pages/how2-login.adoc rename to modules/cloud4/modules/get-started/pages/how2-login.adoc index 1f31df70..a76b76ae 100644 --- a/modules/cloudbeta/modules/get-started/pages/how2-login.adoc +++ b/modules/cloud4/modules/get-started/pages/how2-login.adoc @@ -1,7 +1,7 @@ = How to Log In :experimental: -After first xref:get-started:how2-signup.adoc[signing up] or being xref:cloudBeta:administration:how2-invite-users.adoc[invited by your organization] users must btn:[Log In]. +After first xref:get-started:how2-signup.adoc[signing up] or being xref:cloud4:administration:how2-invite-users.adoc[invited by your organization], users must btn:[Log In]. This guide will walk you through the necessary steps. == Log In @@ -10,8 +10,8 @@ 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]. -TigerGraph Cloud 4.0 supports users to log in via Google, LinkedIn, or via a username/password. +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] ==== @@ -19,7 +19,7 @@ You will be logged into the last active organization. You can switch to another organization via the user btn:[settings] menu. ==== -image::loginPage.png[width=450] +image::signup.png[width=450] === 2) Your Organization @@ -31,10 +31,10 @@ You must provide an organization name before entering your username and password If you were invited by a member of your organization and you do not know the name used for the organization account, contact your organization’s administrator. ==== -image::orgLogin.png[] +image::orglogin-1.png[width=450] == Next Steps -Once logged in, learn more about xref:cloudBeta:resource-manager:index.adoc[] or jump right into creating a xref:resource-manager:workgroup.adoc[Workgroup] and xref:resource-manager: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:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/get-started/pages/how2-signup.adoc b/modules/cloud4/modules/get-started/pages/how2-signup.adoc new file mode 100644 index 00000000..498ccae7 --- /dev/null +++ b/modules/cloud4/modules/get-started/pages/how2-signup.adoc @@ -0,0 +1,33 @@ += How to Sign Up +:experimental: + +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://portal.tgcloud.io[on the TigerGraph Cloud 4 landing page]. ++ +image::signup.png[width=450] + +. If you are signing up for the first time using username and password registration, you will be prompted to enter a password. ++ +[CAUTION] +Please refer to our xref:cloud4:administration:security/password-policy.adoc[] that applies to TigerGraph Cloud 4. + +. 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:settings/how2-use-organization-mgnt.adoc[] page. +==== + +== Next Steps + +The next step is to xref:how2-login.adoc[Log in] your new TigerGraph Cloud 4. + +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. + + + diff --git a/modules/cloud4/modules/get-started/pages/index.adoc b/modules/cloud4/modules/get-started/pages/index.adoc new file mode 100644 index 00000000..f23b3751 --- /dev/null +++ b/modules/cloud4/modules/get-started/pages/index.adoc @@ -0,0 +1,25 @@ += Get Started with TigerGraph Cloud 4 +:experimental: + +To get started with TigerGraph Cloud 4, users must first Sign Up and Log In. +These guides will walk you through the necessary steps. + +== xref:how2-signup.adoc[] + +Learn how to create a TigerGraph Cloud 4 Cloud account and get access to the platform. + +== xref:how2-login.adoc[] + +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: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. + + + + + + diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.47.58\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.47.58\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.47.58\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.47.58\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.48.20\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.48.20\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.48.20\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.48.20\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.49.07\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.49.07\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.49.07\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.49.07\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.52.21\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.52.21\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.52.21\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.52.21\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.53.05\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.53.05\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.53.05\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.53.05\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.53.45\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.53.45\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.53.45\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.53.45\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.54.17\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.54.17\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.54.17\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.54.17\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.54.50\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.54.50\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.54.50\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.54.50\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.55.35\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.55.35\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.55.35\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.55.35\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.56.15\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.56.15\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.56.15\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.56.15\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.57.07\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.57.07\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.57.07\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.57.07\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.57.52\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.57.52\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.57.52\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.57.52\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.58.36\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.58.36\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.58.36\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.58.36\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.59.16\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.59.16\342\200\257PM-old.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 5.59.16\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.59.16\342\200\257PM-old.png" diff --git "a/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.59.16\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.59.16\342\200\257PM.png" new file mode 100644 index 00000000..c01f5cbb Binary files /dev/null and "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 5.59.16\342\200\257PM.png" differ diff --git "a/modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.33.43\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.33.43\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.33.43\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.33.43\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.34.37\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.34.37\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.34.37\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.34.37\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.35.28\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.35.28\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.35.28\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.35.28\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.38.22\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.38.22\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.38.22\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.38.22\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.38.43\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.38.43\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.38.43\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.38.43\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.39.38\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.39.38\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.39.38\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.39.38\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.43.30\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.43.30\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/schema-designer/images/Screenshot 2024-04-17 at 7.43.30\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 7.43.30\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.36.27\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.36.27\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.36.27\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.36.27\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.36.58\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.36.58\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.36.58\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.36.58\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.37.32\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.37.32\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.37.32\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.37.32\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.38.14\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.38.14\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.38.14\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.38.14\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.38.37\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.38.37\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.38.37\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.38.37\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.39.01\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.39.01\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.39.01\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.39.01\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.39.54\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.39.54\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.39.54\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.39.54\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.40.31\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.40.31\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.40.31\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.40.31\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.41.05\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.41.05\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.41.05\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.41.05\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.41.53\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.41.53\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-17 at 9.41.53\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-17 at 9.41.53\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.04.32\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.04.32\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.04.32\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.04.32\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.05.54\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.05.54\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.05.54\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.05.54\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.06.17\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.06.17\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.06.17\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.06.17\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.06.37\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.06.37\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.06.37\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.06.37\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.07.17\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.07.17\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.07.17\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.07.17\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.07.50\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.07.50\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.07.50\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.07.50\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.08.25\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.08.25\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.08.25\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.08.25\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.08.58\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.08.58\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.08.58\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.08.58\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.09.33\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.09.33\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.09.33\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.09.33\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.10.18\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.10.18\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.10.18\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.10.18\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.10.47\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.10.47\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.10.47\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.10.47\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.11.14\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.11.14\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.11.14\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.11.14\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.12.15\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.12.15\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.12.15\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.12.15\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.12.40\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.12.40\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.12.40\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.12.40\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.13.20\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.13.20\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.13.20\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.13.20\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.13.47\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.13.47\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.13.47\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.13.47\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.14.24\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.14.24\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.14.24\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.14.24\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.14.54\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.14.54\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.14.54\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.14.54\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.15.25\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.15.25\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-18 at 10.15.25\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-18 at 10.15.25\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-23 at 10.05.36\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-23 at 10.05.36\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/gsql-editor/images/Screenshot 2024-04-23 at 10.05.36\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-23 at 10.05.36\342\200\257PM.png" diff --git a/modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-25 at 12.31.39 (1).png b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-25 at 12.31.39 (1).png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/Screenshot 2024-04-25 at 12.31.39 (1).png rename to modules/cloud4/modules/graph-development/images/Screenshot 2024-04-25 at 12.31.39 (1).png diff --git "a/modules/cloudbeta/modules/explore-graph/images/Screenshot 2024-04-25 at 7.29.08\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-25 at 7.29.08\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/explore-graph/images/Screenshot 2024-04-25 at 7.29.08\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-25 at 7.29.08\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/explore-graph/images/Screenshot 2024-04-25 at 7.30.16\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-25 at 7.30.16\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/explore-graph/images/Screenshot 2024-04-25 at 7.30.16\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-25 at 7.30.16\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/explore-graph/images/Screenshot 2024-04-25 at 7.30.54\342\200\257PM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-25 at 7.30.54\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/explore-graph/images/Screenshot 2024-04-25 at 7.30.54\342\200\257PM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-25 at 7.30.54\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/explore-graph/images/Screenshot 2024-04-26 at 8.22.55\342\200\257AM.png" "b/modules/cloud4/modules/graph-development/images/Screenshot 2024-04-26 at 8.22.55\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/explore-graph/images/Screenshot 2024-04-26 at 8.22.55\342\200\257AM.png" rename to "modules/cloud4/modules/graph-development/images/Screenshot 2024-04-26 at 8.22.55\342\200\257AM.png" diff --git a/modules/cloud4/modules/graph-development/images/Screenshot 2024-10-11 at 10.59.49.png b/modules/cloud4/modules/graph-development/images/Screenshot 2024-10-11 at 10.59.49.png new file mode 100644 index 00000000..16b9f296 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/Screenshot 2024-10-11 at 10.59.49.png differ diff --git a/modules/cloud4/modules/graph-development/images/Screenshot 2024-10-11 at 11.39.23.png b/modules/cloud4/modules/graph-development/images/Screenshot 2024-10-11 at 11.39.23.png new file mode 100644 index 00000000..58d58a1a Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/Screenshot 2024-10-11 at 11.39.23.png differ diff --git a/modules/cloud4/modules/graph-development/images/abs-connection-details.png b/modules/cloud4/modules/graph-development/images/abs-connection-details.png new file mode 100644 index 00000000..9071bd7b Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/abs-connection-details.png differ diff --git a/modules/cloud4/modules/graph-development/images/add-query.png b/modules/cloud4/modules/graph-development/images/add-query.png new file mode 100644 index 00000000..8ccdd76d Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/add-query.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/addfilter.png b/modules/cloud4/modules/graph-development/images/addfilter.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/addfilter.png rename to modules/cloud4/modules/graph-development/images/addfilter.png diff --git a/modules/cloud4/modules/graph-development/images/advanced-settings-2.png b/modules/cloud4/modules/graph-development/images/advanced-settings-2.png new file mode 100644 index 00000000..651b27ba Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/advanced-settings-2.png differ diff --git a/modules/cloud4/modules/graph-development/images/advanced-settings.png b/modules/cloud4/modules/graph-development/images/advanced-settings.png new file mode 100644 index 00000000..a2bc7d39 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/advanced-settings.png differ diff --git a/modules/cloud4/modules/graph-development/images/attributes.png b/modules/cloud4/modules/graph-development/images/attributes.png new file mode 100644 index 00000000..548b6331 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/attributes.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/billing-homecard.png b/modules/cloud4/modules/graph-development/images/billing-homecard.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/billing-homecard.png rename to modules/cloud4/modules/graph-development/images/billing-homecard.png diff --git a/modules/cloud4/modules/graph-development/images/bottom.png b/modules/cloud4/modules/graph-development/images/bottom.png new file mode 100644 index 00000000..3c18ab13 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/bottom.png differ diff --git a/modules/cloud4/modules/graph-development/images/config-file.png b/modules/cloud4/modules/graph-development/images/config-file.png new file mode 100644 index 00000000..535cd35f Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/config-file.png differ diff --git a/modules/cloud4/modules/graph-development/images/config-mapping-1.png b/modules/cloud4/modules/graph-development/images/config-mapping-1.png new file mode 100644 index 00000000..dbd88ac5 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/config-mapping-1.png differ diff --git a/modules/cloud4/modules/graph-development/images/config-mapping-2.png b/modules/cloud4/modules/graph-development/images/config-mapping-2.png new file mode 100644 index 00000000..5c513073 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/config-mapping-2.png differ diff --git a/modules/cloud4/modules/graph-development/images/config-s3.png b/modules/cloud4/modules/graph-development/images/config-s3.png new file mode 100644 index 00000000..2caf6262 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/config-s3.png differ diff --git a/modules/cloud4/modules/graph-development/images/config-udf.png b/modules/cloud4/modules/graph-development/images/config-udf.png new file mode 100644 index 00000000..e3cb6f07 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/config-udf.png differ diff --git a/modules/cloud4/modules/graph-development/images/confirm.png b/modules/cloud4/modules/graph-development/images/confirm.png new file mode 100644 index 00000000..14d7a387 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/confirm.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/create-organization.png b/modules/cloud4/modules/graph-development/images/create-organization.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/create-organization.png rename to modules/cloud4/modules/graph-development/images/create-organization.png diff --git a/modules/cloud4/modules/graph-development/images/design-schema.png b/modules/cloud4/modules/graph-development/images/design-schema.png new file mode 100644 index 00000000..84a03f5b Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/design-schema.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/documentation-homecard.png b/modules/cloud4/modules/graph-development/images/documentation-homecard.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/documentation-homecard.png rename to modules/cloud4/modules/graph-development/images/documentation-homecard.png diff --git a/modules/cloud4/modules/graph-development/images/gcs-data-source-details.png b/modules/cloud4/modules/graph-development/images/gcs-data-source-details.png new file mode 100644 index 00000000..b9829a2b Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/gcs-data-source-details.png differ diff --git a/modules/cloud4/modules/graph-development/images/gcs-empty-data-source.png b/modules/cloud4/modules/graph-development/images/gcs-empty-data-source.png new file mode 100644 index 00000000..50b0ef77 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/gcs-empty-data-source.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/getstarted-homecard.png b/modules/cloud4/modules/graph-development/images/getstarted-homecard.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/getstarted-homecard.png rename to modules/cloud4/modules/graph-development/images/getstarted-homecard.png diff --git a/modules/cloudbeta/modules/explore-graph/images/graph.png b/modules/cloud4/modules/graph-development/images/graph.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/graph.png rename to modules/cloud4/modules/graph-development/images/graph.png diff --git a/modules/cloud4/modules/graph-development/images/gsql-editor-1.png b/modules/cloud4/modules/graph-development/images/gsql-editor-1.png new file mode 100644 index 00000000..338249da Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/gsql-editor-1.png differ diff --git a/modules/cloud4/modules/graph-development/images/gsql-editor-2.png b/modules/cloud4/modules/graph-development/images/gsql-editor-2.png new file mode 100644 index 00000000..5cbdbc2e Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/gsql-editor-2.png differ diff --git a/modules/cloud4/modules/graph-development/images/gsql-editor-folder-1.png b/modules/cloud4/modules/graph-development/images/gsql-editor-folder-1.png new file mode 100644 index 00000000..2db7a9a2 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/gsql-editor-folder-1.png differ diff --git a/modules/cloud4/modules/graph-development/images/gsql-editor-folder-2.png b/modules/cloud4/modules/graph-development/images/gsql-editor-folder-2.png new file mode 100644 index 00000000..d9910a71 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/gsql-editor-folder-2.png differ diff --git a/modules/cloud4/modules/graph-development/images/gsql-editor-folder-3.png b/modules/cloud4/modules/graph-development/images/gsql-editor-folder-3.png new file mode 100644 index 00000000..1d551613 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/gsql-editor-folder-3.png differ diff --git a/modules/cloud4/modules/graph-development/images/gsql-editor-shorcuts.png b/modules/cloud4/modules/graph-development/images/gsql-editor-shorcuts.png new file mode 100644 index 00000000..a87eeeb1 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/gsql-editor-shorcuts.png differ diff --git a/modules/cloud4/modules/graph-development/images/install-query.png b/modules/cloud4/modules/graph-development/images/install-query.png new file mode 100644 index 00000000..651557d5 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/install-query.png differ diff --git a/modules/cloud4/modules/graph-development/images/left.png b/modules/cloud4/modules/graph-development/images/left.png new file mode 100644 index 00000000..e3220c95 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/left.png differ diff --git a/modules/cloud4/modules/graph-development/images/main.png b/modules/cloud4/modules/graph-development/images/main.png new file mode 100644 index 00000000..5af0a415 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/main.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/nodes.png b/modules/cloud4/modules/graph-development/images/nodes.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/nodes.png rename to modules/cloud4/modules/graph-development/images/nodes.png diff --git a/modules/cloud4/modules/graph-development/images/open-in-gsql-editor.png b/modules/cloud4/modules/graph-development/images/open-in-gsql-editor.png new file mode 100644 index 00000000..1625d554 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/open-in-gsql-editor.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/patternsearch-id.png b/modules/cloud4/modules/graph-development/images/patternsearch-id.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/patternsearch-id.png rename to modules/cloud4/modules/graph-development/images/patternsearch-id.png diff --git a/modules/cloudbeta/modules/explore-graph/images/patternsearch-operator.png b/modules/cloud4/modules/graph-development/images/patternsearch-operator.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/patternsearch-operator.png rename to modules/cloud4/modules/graph-development/images/patternsearch-operator.png diff --git a/modules/cloudbeta/modules/explore-graph/images/patternsearch-selectagraph.png b/modules/cloud4/modules/graph-development/images/patternsearch-selectagraph.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/patternsearch-selectagraph.png rename to modules/cloud4/modules/graph-development/images/patternsearch-selectagraph.png diff --git a/modules/cloudbeta/modules/explore-graph/images/patternsearch-selectaworksapce.png b/modules/cloud4/modules/graph-development/images/patternsearch-selectaworksapce.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/patternsearch-selectaworksapce.png rename to modules/cloud4/modules/graph-development/images/patternsearch-selectaworksapce.png diff --git a/modules/cloudbeta/modules/explore-graph/images/patternsearch-selectshowschema.png b/modules/cloud4/modules/graph-development/images/patternsearch-selectshowschema.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/patternsearch-selectshowschema.png rename to modules/cloud4/modules/graph-development/images/patternsearch-selectshowschema.png diff --git a/modules/cloudbeta/modules/explore-graph/images/patternsearch-showschema.png b/modules/cloud4/modules/graph-development/images/patternsearch-showschema.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/patternsearch-showschema.png rename to modules/cloud4/modules/graph-development/images/patternsearch-showschema.png diff --git a/modules/cloudbeta/modules/explore-graph/images/patternserach-exploregraph.png b/modules/cloud4/modules/graph-development/images/patternserach-exploregraph.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/patternserach-exploregraph.png rename to modules/cloud4/modules/graph-development/images/patternserach-exploregraph.png diff --git a/modules/cloudbeta/modules/explore-graph/images/patternserach-playbutton.png b/modules/cloud4/modules/graph-development/images/patternserach-playbutton.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/patternserach-playbutton.png rename to modules/cloud4/modules/graph-development/images/patternserach-playbutton.png diff --git a/modules/cloud4/modules/graph-development/images/queries.png b/modules/cloud4/modules/graph-development/images/queries.png new file mode 100644 index 00000000..c0069bea Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/queries.png differ diff --git a/modules/cloud4/modules/graph-development/images/query-details.png b/modules/cloud4/modules/graph-development/images/query-details.png new file mode 100644 index 00000000..e0fb8444 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/query-details.png differ diff --git a/modules/cloud4/modules/graph-development/images/query-editor.png b/modules/cloud4/modules/graph-development/images/query-editor.png new file mode 100644 index 00000000..4d95dd12 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/query-editor.png differ diff --git a/modules/cloud4/modules/graph-development/images/quick-map.png b/modules/cloud4/modules/graph-development/images/quick-map.png new file mode 100644 index 00000000..aa0074b2 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/quick-map.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/referece-homecard.png b/modules/cloud4/modules/graph-development/images/referece-homecard.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/referece-homecard.png rename to modules/cloud4/modules/graph-development/images/referece-homecard.png diff --git a/modules/cloud4/modules/graph-development/images/right.png b/modules/cloud4/modules/graph-development/images/right.png new file mode 100644 index 00000000..e592b48c Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/right.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/security-homecard.png b/modules/cloud4/modules/graph-development/images/security-homecard.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/security-homecard.png rename to modules/cloud4/modules/graph-development/images/security-homecard.png diff --git a/modules/cloudbeta/modules/explore-graph/images/select-exploregraph.png b/modules/cloud4/modules/graph-development/images/select-exploregraph.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/select-exploregraph.png rename to modules/cloud4/modules/graph-development/images/select-exploregraph.png diff --git a/modules/cloudbeta/modules/explore-graph/images/showschema.png b/modules/cloud4/modules/graph-development/images/showschema.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/showschema.png rename to modules/cloud4/modules/graph-development/images/showschema.png diff --git a/modules/cloudbeta/modules/explore-graph/images/systemmanagment-homecard.png b/modules/cloud4/modules/graph-development/images/systemmanagment-homecard.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/systemmanagment-homecard.png rename to modules/cloud4/modules/graph-development/images/systemmanagment-homecard.png diff --git a/modules/cloud4/modules/graph-development/images/token-function-1.png b/modules/cloud4/modules/graph-development/images/token-function-1.png new file mode 100644 index 00000000..ef3fa01a Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/token-function-1.png differ diff --git a/modules/cloud4/modules/graph-development/images/token-function-2.png b/modules/cloud4/modules/graph-development/images/token-function-2.png new file mode 100644 index 00000000..e91820fd Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/token-function-2.png differ diff --git a/modules/cloud4/modules/graph-development/images/token-function-3.png b/modules/cloud4/modules/graph-development/images/token-function-3.png new file mode 100644 index 00000000..723a7e6b Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/token-function-3.png differ diff --git a/modules/cloud4/modules/graph-development/images/token-function-4.png b/modules/cloud4/modules/graph-development/images/token-function-4.png new file mode 100644 index 00000000..cf904de2 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/token-function-4.png differ diff --git a/modules/cloudbeta/modules/explore-graph/images/tools-page.png b/modules/cloud4/modules/graph-development/images/tools-page.png similarity index 100% rename from modules/cloudbeta/modules/explore-graph/images/tools-page.png rename to modules/cloud4/modules/graph-development/images/tools-page.png diff --git a/modules/cloudbeta/modules/schema-designer/images/unnamed.gif b/modules/cloud4/modules/graph-development/images/unnamed.gif similarity index 100% rename from modules/cloudbeta/modules/schema-designer/images/unnamed.gif rename to modules/cloud4/modules/graph-development/images/unnamed.gif diff --git a/modules/cloud4/modules/graph-development/images/workspace-connect-menu-1.png b/modules/cloud4/modules/graph-development/images/workspace-connect-menu-1.png new file mode 100644 index 00000000..a360cca7 Binary files /dev/null and b/modules/cloud4/modules/graph-development/images/workspace-connect-menu-1.png differ diff --git a/modules/cloud4/modules/graph-development/nav.adoc b/modules/cloud4/modules/graph-development/nav.adoc new file mode 100644 index 00000000..bf4d1741 --- /dev/null +++ b/modules/cloud4/modules/graph-development/nav.adoc @@ -0,0 +1,17 @@ +* 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[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] +** xref:gsql-editor/index.adoc[GSQL Editor] +*** xref:gsql-editor/how2-edit-gsql-query.adoc[Edit Query] +** xref:explore-graph/index.adoc[Explore Graph] +*** xref:explore-graph/how2-use-pattern-search.adoc[Pattern Search] +** xref:advanced-features/index.adoc[Advanced Features] +*** xref:advanced-features/write2-s3.adoc[Export Data to S3] +*** xref:advanced-features/configure-udf.adoc[Configure UDF] \ No newline at end of file diff --git a/modules/cloud4/modules/graph-development/pages/advanced-features/configure-udf.adoc b/modules/cloud4/modules/graph-development/pages/advanced-features/configure-udf.adoc new file mode 100644 index 00000000..52c1d9bf --- /dev/null +++ b/modules/cloud4/modules/graph-development/pages/advanced-features/configure-udf.adoc @@ -0,0 +1,52 @@ += Configure User Defined Functions (UDFs) On TigerGraph Cloud 4 +:experimental: + +User-Defined Functions (UDFs) in TigerGraph allow you to incorporate custom logic into your GSQL queries. You can configure GSQL to your UDF definitions from a GitHub repository. This is TigerGraph’s recommended approach for managing UDFs. + +== Prerequisites + +* Familiarity with GSQL and UDF syntax. +* An active TigerGraph Cloud 4 workspace. + +== Steps to Update a UDF + +1) Set up the TigerGraph Cloud 4 workspace and ensure it is running. + +2) Edit the workspace by clicking the btn:[...] button of your selected workspace. + +3) Navigate to the btn:[Graph Admin] tab. + +4) Select the btn:[GSQL] section, then configure the following entries: + +image::config-udf.png[] + +.GitHub Configuration For UDFs +[cols="3", separator=¦] +|=== + +¦Input ¦ Description ¦ Example +¦GitHub URL For UDF ¦ Optional parameter used for GitHub Enterprise ¦ `https://api.github.com` +¦GitHub Repository For UDF ¦ The user and repository where the files are held ¦ `sample_user/repository` +¦Repository Branch For UDF ¦ The branch to access ¦ `main` +¦Repository Path For UDF ¦ Path to the directory in the repository that has ExprFunctions.hpp and ExprUtil.hpp ¦ `src/` +¦GitHub User Access Token For UDF ¦ The credential used to access the repository ¦ `anonymous` + +|=== + +5) Click btn:[Save] to apply the changes. + +[NOTE] +==== +Update Graph Admin configurations may require restart of certain services, which may impact the running queries/loading jobs/schema changes. Apply changes with caution. +==== + +== Best Practices + +* Version Control: Keep track of changes to your UDFs using a version control system. +* Testing: Thoroughly test UDFs in a development environment before deploying to production. +* Documentation: Document the purpose and usage of each UDF for future reference. + +== Troubleshooting + +* Syntax Errors: Double-check the syntax of your UDF code. +* Logic Errors: Ensure that the logic within the UDF is correct and handles all edge cases. \ No newline at end of file diff --git a/modules/cloud4/modules/graph-development/pages/advanced-features/index.adoc b/modules/cloud4/modules/graph-development/pages/advanced-features/index.adoc new file mode 100644 index 00000000..05bb5790 --- /dev/null +++ b/modules/cloud4/modules/graph-development/pages/advanced-features/index.adoc @@ -0,0 +1,12 @@ += Advanced Features +:experimental: + +This section covers the powerful and sophisticated functionalities that allow you to leverage TigerGraph Cloud 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. + +== Configure User Defined Functions (UDF) + +User-Defined Functions (UDFs) are a powerful way to extend TigerGraph's capabilities by adding custom logic to your graph queries. This guide will walk you through the process of updating existing UDFs. Click xref:advanced-features/configure-udf.adoc[Configure UDF] to get started. diff --git a/modules/cloud4/modules/graph-development/pages/advanced-features/write2-s3.adoc b/modules/cloud4/modules/graph-development/pages/advanced-features/write2-s3.adoc new file mode 100644 index 00000000..75638798 --- /dev/null +++ b/modules/cloud4/modules/graph-development/pages/advanced-features/write2-s3.adoc @@ -0,0 +1,126 @@ += 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. + +This documentation have been updated to include all three methods for writing data to S3, providing comprehensive guidance for users. + +== Prerequisites + +Before you begin, ensure you have the following: + +* An active TigerGraph Cloud 4 workspace. +* An AWS account with access to S3. +* Appropriate IAM permissions to write to the S3 bucket. + +== Methods to Export Data to S3 + +There are three main methods to write data to S3 from TigerGraph Cloud 4: + +1. Using GSQL Editor +2. Via API +3. Using Graph Admin + +=== Method 1: Using GSQL Editor + +1) Set up the TigerGraph Cloud 4 workspace and ensure it is running. + +2) Open the xref:cloud4:graph-development:gsql-editor/index.adoc[GSQL Editor] in TigerGraph Cloud 4. + +3) **Configure AWS Credentials**: + +Set your AWS credentials and query timeout in the GSQL Editor. + +```sql +set query_timeout=7200000; +set s3_aws_access_key_id = ; +set s3_aws_secret_access_key = ; +``` + +4) **Create and Run the Query**: + +Create a query to write data to S3 and run it. + +```sql +CREATE QUERY print_to_csv_s3() FOR GRAPH ldbc_snb { + FILE f_hello ("s3:///" + "f_hello.csv"); + print "f_hello", "world\n" TO_CSV f_hello; +} + +run query print_to_csv_s3(); +``` + +Replace ``, ``, and `` with your actual AWS credentials and S3 path. + +=== Method 2: Via API + +1) Set up the TigerGraph Cloud 4 workspace and ensure it is running. + +2) **Send a GET Request**: + +Use the following curl command to run the query via API. + +```shell +curl -X GET \ +-H "GSQL-S3AWSAccessKeyId: $AWS_KEY_ID" \ +-H "GSQL-S3AWSSecretAccessKey: $AWS_ACCESS_KEY" \ +-H "GSQL-TIMEOUT: 7200000" \ +https://$HOST_ID.i.tgcloud.io/query/$GRAPH_NAME/$QUERY_NAME +``` + +Replace `$AWS_KEY_ID` and `$AWS_ACCESS_KEY` with your actual AWS credentials, `$HOST_ID` with your TigerGraph Cloud 4 host ID, `$GRAPH_NAME` with your graph name, and `$QUERY_NAME` with your query name. + +=== Method 3: Using Graph Admin + +1) Set up the TigerGraph Cloud 4 workspace and ensure it is running. + +2) Edit the workspace by clicking the btn:[...] button of your selected workspace. + +3) Navigate to the btn:[Graph Admin] tab. + +4) Select the btn:[GPE] section, then configure the following entries: + +image::config-s3.png[] + + * **S3 AWS Access Key ID For Query Output**: Your AWS Access Key ID. + * **S3 AWS Secret Access Key For Query Output**: Your AWS Secret Access Key. + +5) Click btn:[Save] to apply the changes. + +[TIP] +==== +It is recommended to always set up a default s3 access key ID and secret access key in the Graph Admin. This will be the fallback option in case the query does not have the s3 access key ID and secret access key set. +==== + +[NOTE] +==== +Update Graph Admin configurations may require restart of certain services, which may impact the running queries/loading jobs/schema changes. Apply changes with caution. +==== + + +=== Example + +Here’s an example of writing data to S3 using the GSQL Editor: + +```sql + +set query_timeout=7200000; +set s3_aws_access_key_id = "your_aws_access_key_id"; +set s3_aws_secret_access_key = "your_aws_secret_access_key"; + +CREATE QUERY print_to_csv_s3() FOR GRAPH ldbc_snb { + FILE f_hello ("s3://your_s3_bucket/your_path/" + "f_hello.csv"); + print "f_hello", "world\n" TO_CSV f_hello; +} + +run query print_to_csv_s3(); + +``` + +== Troubleshooting + +- **Permission Issues**: Ensure that the IAM role or user has the necessary permissions (`s3:PutObject`, `s3:ListBucket`). +- **Network Issues**: Verify that your TigerGraph workspace can reach the S3 endpoint. +- **Credential Issues**: Ensure that the correct credentials are provided either via GSQL Editor, API headers, or Graph Admin configurations. + +For more detailed troubleshooting, refer to the [AWS S3 Documentation](https://docs.aws.amazon.com/s3/index.html). \ No newline at end of file diff --git a/modules/cloudbeta/modules/schema-designer/pages/index.adoc b/modules/cloud4/modules/graph-development/pages/design-schema/index.adoc similarity index 58% rename from modules/cloudbeta/modules/schema-designer/pages/index.adoc rename to modules/cloud4/modules/graph-development/pages/design-schema/index.adoc index 0e91759b..ca45d459 100644 --- a/modules/cloudbeta/modules/schema-designer/pages/index.adoc +++ b/modules/cloud4/modules/graph-development/pages/design-schema/index.adoc @@ -14,16 +14,18 @@ With the Schema Designer, you can easily modify and manage the schema of your gr * Specifying properties and indexes. * Establish relationships between elements. -image::Screenshot 2024-04-17 at 7.33.43 PM.png[width=400] +image::design-schema.png[width=1200] == 1) Get Started -.Navigate to the Schema Designer. It is accessible from: -* A Workspace page. +Navigate to the Design Schema Page. It is accessible from: + +* Navigation Menu > Design Schema. +* Workspace general page. * GSQL Editor page. -* Load Data pages. +* Load Data page. * Solution Builder page. -image::Screenshot 2024-04-17 at 7.34.37 PM.png[width=300] +image::workspace-connect-menu-1.png[width=300] [TIP] ==== @@ -105,10 +107,33 @@ You can define attributes for vertices and edges to store additional information Attributes can be of different data types, such as strings, integers, booleans, or dates, and they provide valuable context and details to your graph data. ==== -image::Screenshot 2024-04-17 at 7.43.30 PM.png[] +image::attributes.png[] + +== 6) Advanced Settings For Vertex + +The Advanced Settings section allows you to fine tune the definition of a vertex type in your graph database by configuring additional settings. + +You can click on the btn:[ Advanced Settings ] button on a vertex to configure the following settings: + +image::advanced-settings.png[] + +1. Enable *As Attribute* for primary key. For details, please refer to xref:gsql-ref:ddl-and-loading:defining-a-graph-schema.adoc#_with_primary_id_as_attribute[WITH primary_id_as_attribute] documentation. +2. Enable index for non-primary key attributes. Indexes improve the speed of data retrieval operations by providing quick access paths to the data. For details, please refer to xref:gsql-ref:ddl-and-loading:defining-a-graph-schema.adoc#_alter_index[Alter Index] documentation. + +== 7) Advanced Settings For Edge + +The Advanced Settings section allows you to fine tune the definition of an edge type in your graph database by configuring additional settings. + +You can click on the btn:[ Advanced Settings ] button on an edge to configure the following settings: + +image::advanced-settings-2.png[] + +1. Specify other vertex pairs. You can define additional vertex pairs for an edge to establish more complex relationships between different types of vertices. +2. Specify edge discriminators. Discriminators allow you to distinguish between different types of edges or relationships, providing more granularity in your graph schema. For details, please refer to the xref:gsql-ref:ddl-and-loading:defining-a-graph-schema.adoc#_discriminator[DISCRIMINATOR] documentation. +3. For directed edges, you can specify a reverse edge to create a bidirectional relationship. This can be useful for queries that need to traverse edges in both directions. For details, please refer to xref:gsql-ref:ddl-and-loading:defining-a-graph-schema.adoc#_with_reverse_edge[WITH REVERSE_EDGE] documentation. == Next Steps -Next, learn how to use the xref:gsql-editor:index.adoc[GSQL Editor] in TigerGraph Cloud 4.0. +Next, learn how to use xref:cloud4:graph-development:gsql-editor/index.adoc[GSQL Editor] in TigerGraph Cloud 4. -Or return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/explore-graph/pages/how2-use-pattern-search.adoc b/modules/cloud4/modules/graph-development/pages/explore-graph/how2-use-pattern-search.adoc similarity index 86% rename from modules/cloudbeta/modules/explore-graph/pages/how2-use-pattern-search.adoc rename to modules/cloud4/modules/graph-development/pages/explore-graph/how2-use-pattern-search.adoc index e43362f1..b743c519 100644 --- a/modules/cloudbeta/modules/explore-graph/pages/how2-use-pattern-search.adoc +++ b/modules/cloud4/modules/graph-development/pages/explore-graph/how2-use-pattern-search.adoc @@ -3,6 +3,12 @@ Patterns search involves looking for specific patterns or sequences within a dataset or system. It can be used to identify recurring trends, anomalies, or correlations in data. By analyzing patterns, developers can gain insights and make informed decisions. +[CAUTION] +==== +* Pattern search can be resource-intensive and time-consuming, especially for large datasets. +* Due to memory and processing constraints, pattern search is disabled for multi-node workspaces. +==== + == How to use Pattern Search .To get started with btn:[Explore Graph] follow the steps below: @@ -55,7 +61,7 @@ image::patternsearch-operator.png[width=300] + [NOTE] ==== -If nothing appears the data does not exist in the graph data. +If nothing appears the data does not exist in your graph. ==== + image::graph.png[width=300] @@ -65,7 +71,5 @@ image::graph.png[width=300] == Next Steps -Next, learn about TigerGraph xref:copilot-enablement.adoc[] or checkout the xref:cloudBeta:integrations:index.adoc[]. - -Return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/explore-graph/pages/index.adoc b/modules/cloud4/modules/graph-development/pages/explore-graph/index.adoc similarity index 52% rename from modules/cloudbeta/modules/explore-graph/pages/index.adoc rename to modules/cloud4/modules/graph-development/pages/explore-graph/index.adoc index f389d054..d44b07b9 100644 --- a/modules/cloudbeta/modules/explore-graph/pages/index.adoc +++ b/modules/cloud4/modules/graph-development/pages/explore-graph/index.adoc @@ -12,18 +12,14 @@ 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:cloudBeta:resource-manager:how2-create-a-workgroup.adoc[Create a Workspace] and xref:cloudBeta: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:cloudBeta: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. -== xref:copilot-enablement.adoc[] - -Learn how to unlock the full potential of your data by learning how to enable and use TigerGraph Copilot. - == Next Steps -Next, checkout the xref:cloudBeta:integrations:index.adoc[]. +Next, check out the xref:cloud4:integrations:index.adoc[]. -Or return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/gsql-editor/pages/how2-edit-gsql-query.adoc b/modules/cloud4/modules/graph-development/pages/gsql-editor/how2-edit-gsql-query.adoc similarity index 80% rename from modules/cloudbeta/modules/gsql-editor/pages/how2-edit-gsql-query.adoc rename to modules/cloud4/modules/graph-development/pages/gsql-editor/how2-edit-gsql-query.adoc index 863c04c0..7b8e19b2 100644 --- a/modules/cloudbeta/modules/gsql-editor/pages/how2-edit-gsql-query.adoc +++ b/modules/cloud4/modules/graph-development/pages/gsql-editor/how2-edit-gsql-query.adoc @@ -21,44 +21,41 @@ image::Screenshot 2024-04-18 at 10.12.15 AM.png[] + The opened files will be listed on the top tabs on the code edit folder + -image::Screenshot 2024-04-18 at 10.12.40 AM.png[width=300] +image::query-editor.png[] + -[NOTE] -==== -Schema based GSQL autocomplete is not yet supported. -==== == Run GSQL Query .To run a GSQL Query, start by: . Select an active workspace to run the GSQL Query. + -image::Screenshot 2024-04-18 at 10.13.20 AM.png[] -. To run a query, there are two options available: btn:[Run All] and btn:[Run Selected]. +image::gsql-editor-1.png[] + +. To run a query, there are two options available: btn:[Run] and btn:[Run All]. + -image::Screenshot 2024-04-18 at 10.13.47 AM.png[] +image::gsql-editor-2.png[] * *Run All*: The btn:[Run All] option executes the entire GSQL script or query that is currently open in the GSQL Editor. When you click the btn:[Run All] button, it triggers all the GSQL statements in the script from top to bottom. +** *Shortcut*: You can also use the shortcut to btn:[RUN All]: btn:[ Command + Shift + Enter/ Control + Shift + Enter ]. + [TIP] ==== This is useful when you want to run the entire GSQL script or when you have multiple queries in the script that need to be run together. ==== + -** *Shortcut*: You can also use the shortcut to btn:[RUN All]: btn:[ Command + Enter/ Control + Enter]. -* *Run Selected*: The btn:[Run Selected] option allows you to run only a specific portion of the GSQL query. +* *Run*: The btn:[Run] option allows you to run only a specific portion of the GSQL query. To use this option, you need to select the desired portion of the GSQL code within the GSQL Query Editor. -Once you've made the selection, clicking the btn:[Run Selected] button will run only the selected portion of the code. +Once you've made the selection, clicking the btn:[Run] button will run only the selected portion of the code. +** *Shortcut*: You can also use the shortcut to btn:[Run]: btn:[ Command + Enter/ Control + Enter ] + [TIP] ==== -This is helpful when you want to run a specific query or a subset of queries within a larger script. +* This is helpful when you want to run a specific query or a subset of queries within a larger script. +* If no GSQL code is selected, the btn:[Run] button will execute the entire GSQL script. ==== -+ -** *Shortcut*: You can also use the shortcut to btn:[Run Selected]: btn:[ Command + Shift + Enter/ Control + Shift + Enter ] == Share GSQL Files @@ -112,7 +109,7 @@ Sharing with the entire organization can be useful when you want to provide broa == Next Steps -Next, learn to xref:cloudBeta:explore-graph:index.adoc[]. +Next, learn to xref:cloud4:graph-development:explore-graph/index.adoc[]. -Or return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/gsql-editor/pages/index.adoc b/modules/cloud4/modules/graph-development/pages/gsql-editor/index.adoc similarity index 53% rename from modules/cloudbeta/modules/gsql-editor/pages/index.adoc rename to modules/cloud4/modules/graph-development/pages/gsql-editor/index.adoc index e80650e4..f406bf2f 100644 --- a/modules/cloudbeta/modules/gsql-editor/pages/index.adoc +++ b/modules/cloud4/modules/graph-development/pages/gsql-editor/index.adoc @@ -7,25 +7,25 @@ The GSQL Editor is a powerful tool for developing and executing GSQL queries, al The GSQL Editor contains 4 work areas: -image::Screenshot 2024-04-18 at 10.04.32 AM.png[] -* Left image:Screenshot 2024-04-18 at 10.05.54 AM.png[width=50] - GSQL xref:gsql-editor:index.adoc#_file_list[File List ] Panel. -* Bottom image:Screenshot 2024-04-18 at 10.06.17 AM.png[width=50] - GSQL Result Panel. -* Right image:Screenshot 2024-04-18 at 10.06.37 AM.png[width=50] Schema Designer Panel. +image::Screenshot 2024-10-11 at 11.39.23.png[] +* 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. + [NOTE] ==== -For more details please see xref:cloudBeta:schema-designer:index.adoc[]. +For more details please see xref:cloud4:graph-development:design-schema/index.adoc[]. ==== -* Center image:Screenshot 2024-04-23 at 10.05.36 PM.png[width=50] Main GSQL Editing Panel. +* Main area image:main.png[] Main GSQL Editing Panel. [TIP] ==== Additionally, you can use shortcuts to run a GSQL query. -image::Screenshot 2024-04-18 at 10.07.17 AM.png[] +image::gsql-editor-shorcuts.png[] -See xref:gsql-editor:how2-edit-gsql-query.adoc[] for more details. +See xref:cloud4:graph-development:gsql-editor/how2-edit-gsql-query.adoc[] for more details. ==== == File List @@ -35,7 +35,7 @@ It helps you organize and manage your GSQL queries effectively with a list of GS * Navigate through the files and folders by clicking on their names in the list. + -image:Screenshot 2024-04-18 at 10.07.50 AM.png[] +image:Screenshot 2024-10-11 at 10.59.49.png[] + * It also includes a search bar that allows you to search for specific files by their names. + @@ -56,12 +56,12 @@ image:Screenshot 2024-04-18 at 10.09.33 AM.png[] == Folders -The GSQL Editor in TigerGraph Cloud 4.0 has two types of folders presented in the list: +The GSQL Editor in TigerGraph Cloud 4 has two types of folders presented in the list: === Shared Folder The Shared Folder is a special type of folder that facilitates collaboration and sharing of GSQL files. The folder contains all GSQL files that are shared with you from other users with in the organization. -For more information about sharing GSQL files, please refer to xref:how2-edit-gsql-query.adoc#_share_gsql_files[Share GSQL Files]. +For more information about sharing GSQL files, please refer to xref:cloud4:graph-development:gsql-editor/how2-edit-gsql-query.adoc#_share_gsql_files[Share GSQL Files]. === User-defined Folders @@ -74,31 +74,58 @@ You can `create`, `rename`, and/or `delete` these folders as needed to manage yo .To create your first folder: . Click on the btn:[ Folder] from the btn:[ + ] menu. + -image::Screenshot 2024-04-18 at 10.10.18 AM.png[width=250] +image::gsql-editor-folder-1.png[] . Name the folder. + -image::Screenshot 2024-04-18 at 10.10.47 AM.png[width=250] +image::gsql-editor-folder-2.png[] . You can add a new file to the folder by clicking on the btn:[+] button. . You can also rename or delete the folder via the btn:[ … ] menu. + -image::Screenshot 2024-04-18 at 10.11.14 AM.png[width=250] +image::gsql-editor-folder-3.png[] + +== Query List + +The Query List in the GSQL Editor provides an overview of all custom queries for each graph. It helps you manage your queries efficiently, allowing you to create, edit, delete, and install queries. + +* View all custom queries for the current graph. + +image::queries.png[] + +* Create a query by clicking on the btn:[ + ] button on the side of the target graph. + +image::add-query.png[] + +[TIP] +==== +This feature helps you quickly view and edit custom queries on your graph. +==== + +image::query-details.png[] + +* Edit existing queries by selecting the query and clicking the btn:[ Edit ] button. + +* Delete queries that are no longer needed by selecting the query and clicking the btn:[ Delete ] button. + +* If the query is not installed, you can install the query by selecting the query and clicking the btn:[ Install ] button. + +image::install-query.png[] == Edit Schema The schema defines the structure of your graph database, influencing its performance and functionality. -You can easily open the Schema Designer in GSQL Editor by clicking on the image:Screenshot 2024-04-18 at 10.06.37 AM.png[width=50] button. +You can easily open the Schema Designer in GSQL Editor by clicking on the image:right.png[width=50] button. [NOTE] ==== -For more details please see xref:cloudBeta:schema-designer:index.adoc[]. +For more details please see xref:cloud4:graph-development:design-schema/index.adoc[]. ==== == Next Steps -Next, learn more about how to xref:gsql-editor:how2-edit-gsql-query.adoc[]. +Next, learn more about how to xref:cloud4:graph-development:gsql-editor/how2-edit-gsql-query.adoc[]. -Or return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/graph-development/pages/index.adoc b/modules/cloud4/modules/graph-development/pages/index.adoc new file mode 100644 index 00000000..255aa8c9 --- /dev/null +++ b/modules/cloud4/modules/graph-development/pages/index.adoc @@ -0,0 +1,78 @@ += Graph Development + +Welcome! This guide provides an overview of the essential tools and processes for managing and developing your graph databases. Here, you will find comprehensive guides and resources to help you design, load, query, and explore a graph database. Click on the sections below to learn more about each area. + +== xref:load-data/index.adoc[Load Data] + +Efficiently loading data into your TigerGraph databases is crucial for successful graph analysis. + +### Key Features: +- Select an active workspace. +- Use various connectors to load data. +- Choose between a Step-by-Step Guide or GSQL Template for data loading. + +### Learn More: +- xref:load-data/load-from-local.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] + +The Schema Designer provides a user-friendly interface for managing your graph database schema. + +### Key Features: +- Define vertex and edge types. +- Specify properties and indexes. +- Establish relationships between elements. + + +== xref:gsql-editor/index.adoc[GSQL Editor] + +The GSQL Editor is a powerful tool for developing and executing GSQL queries. + +### Key Features: +- Four work areas: File List Panel, Result Panel, Schema Designer Panel, and Main GSQL Editing Panel. +- Shortcuts for efficient query execution. +- File List for organizing and managing GSQL queries. +- Query List for managing custom queries. + +### Learn More: +- xref:gsql-editor/how2-edit-gsql-query.adoc[Edit Query] + +== xref:explore-graph/index.adoc[Explore Graph] + +Explore Graph allows users to visually interact with their graph data, helping to navigate and understand complex data structures. + +### Key Features: +- Visual representation of graph data. +- Identify and explain relationships between data points or entities. + +### Prerequisites: +- Active workspace with loaded data. +- xref:load-data/index.adoc[Load Data] completed. + +### Learn More: +- xref:explore-graph/how2-use-pattern-search.adoc[Pattern Search] + +== 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. + +### Key Features: +- Export data to Amazon S3. +- Configure User Defined Functions (UDF). + +### Learn More: +- xref:advanced-features/write2-s3.adoc[Export Data to S3] +- xref:advanced-features/configure-udf.adoc[Configure UDF] + +--- + + +== Next Steps + +Learn how to manage your workgroups and workspaces in xref:cloud4:workgroup-workspace:index.adoc[Workgroup and Workspace Management]. diff --git a/modules/cloudbeta/modules/load-data/pages/index.adoc b/modules/cloud4/modules/graph-development/pages/load-data/index.adoc similarity index 56% rename from modules/cloudbeta/modules/load-data/pages/index.adoc rename to modules/cloud4/modules/graph-development/pages/load-data/index.adoc index 9c8c8025..2ab9b295 100644 --- a/modules/cloudbeta/modules/load-data/pages/index.adoc +++ b/modules/cloud4/modules/graph-development/pages/load-data/index.adoc @@ -1,4 +1,4 @@ -= Load Data in TigerGraph Cloud 4.0 += Load Data in TigerGraph Cloud 4 :experimental: Efficiently loading data into your TigerGraph databases is crucial for successful graph analysis. @@ -40,29 +40,39 @@ 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 Oct. 31, 2024, the step-by-step guide supports loading 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:cloudBeta:load-data:load-from-local.adoc[] +== xref:cloud4:graph-development:load-data/load-from-local.adoc[] Check out our step-by-step guide on loading data from a local file. -== xref:cloudBeta:load-data:load-from-cloud.adoc[] +== xref:cloud4:graph-development:load-data/load-from-s3.adoc[] + +Check out our step-by-step guide on loading data from a Amazon S3. + +== xref:cloud4:graph-development:load-data/load-from-gcs.adoc[] + +Check out our step-by-step guide on loading data from a Google Cloud Storage. + +== xref:cloud4:graph-development:load-data/load-from-blob.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 Azure Blob Storage. -== xref:cloudBeta:load-data:load-from-other-sources.adoc[] +== xref:cloud4:graph-development:load-data/load-from-other-sources.adoc[] -Here you can check out the status of loading data form other sources in TigerGraph Cloud 4.0. -Or check out our xref:cloudBeta:load-data:jdbc.adoc[]. +Here you can check the status of loading data form other sources in TigerGraph Cloud 4. +Or check out our xref:cloud4:graph-development:load-data/jdbc.adoc[]. == Next Steps -Next, learn more about how to xref:cloudBeta:schema-designer:index.adoc[]. +Next, learn more about how to xref:cloud4:graph-development:design-schema/index.adoc[]. -Or return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/load-data/pages/jdbc.adoc b/modules/cloud4/modules/graph-development/pages/load-data/jdbc.adoc similarity index 100% rename from modules/cloudbeta/modules/load-data/pages/jdbc.adoc rename to modules/cloud4/modules/graph-development/pages/load-data/jdbc.adoc diff --git a/modules/cloud4/modules/graph-development/pages/load-data/load-from-blob.adoc b/modules/cloud4/modules/graph-development/pages/load-data/load-from-blob.adoc new file mode 100644 index 00000000..26af0985 --- /dev/null +++ b/modules/cloud4/modules/graph-development/pages/load-data/load-from-blob.adoc @@ -0,0 +1,112 @@ += Load from Azure Blob Storage +:experimental: + +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 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:gcs-empty-data-source.png[] + +. You will need to provide your `ABS Connection String`. ++ +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,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::config-file.png[] ++ +[TIP] +==== +If the parsing is *not* correct, click on the image:Screenshot 2024-04-17 at 5.54.17 PM.png[width=75] +button to configure a different option for the delimiter, such as `eol`, or `quote and header`. + +image:Screenshot 2024-04-17 at 5.54.50 PM.png[] +==== ++ +The enclosing character is used to mark the boundaries of a token, overriding the delimiter character. ++ +==== +For example, if your delimiter is a comma, but you have commas in some strings, then you can define single or double quotes as the enclosing character to mark the endpoints of your string tokens. +==== ++ +[NOTE] +==== +It is not necessary for every token to have enclosing characters. The parser uses enclosing characters when it encounters them. +==== ++ +[TIP] +==== +You can edit the header line of the parsing result to give each column a more intuitive name, since you will be referring to these names when loading data to the graph. +The header name is ignored during data loading. +==== + +. Once you are satisfied with the file settings, click btn:[ Next ] to proceed. + +== 3) Configure Map + +If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:graph-development:design-schema/index.adoc[Design Schema]. +. Select `Generate the schema only` or `Generate the schema and data mapping`. ++ +image::Screenshot 2024-04-17 at 5.55.35 PM.png[] ++ +[CAUTION] +==== +The schema generation feature is still a preview feature. The correctness and efficiency of the resulting graph schema and mapping could vary. +==== + +. In the `Source` column, you can choose the specific column from the data source that you want to map with the attribute. ++ +image::config-mapping-1.png[] ++ +. Use the `+` button to create a new attribute of the target vertex or edge. ++ +image::config-mapping-2.png[width=400] + +. 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 changed` and `Data to be loaded` lists. ++ +image::confirm.png[] ++ +[CAUTION] +==== +Please be aware that some schema changes will result in unintentional deletion of the data. Please carefully review the warning message before confirming the loading. +==== +. Click on the btn:[Confirm] button to run the loading jobs and monitor their `Status`. ++ +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], 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. + + diff --git a/modules/cloud4/modules/graph-development/pages/load-data/load-from-gcs.adoc b/modules/cloud4/modules/graph-development/pages/load-data/load-from-gcs.adoc new file mode 100644 index 00000000..2dee77cb --- /dev/null +++ b/modules/cloud4/modules/graph-development/pages/load-data/load-from-gcs.adoc @@ -0,0 +1,112 @@ += 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. + +== 1) Select Source + +.Once you’ve selected btn:[Google Cloud Storage], you will be asked to configure the GCS data source. +. Click on image:Screenshot 2024-04-17 at 9.36.58 PM.png[width=50] to add a new GCS data source. ++ +image:gcs-empty-data-source.png[] + +. You will need to provide your GCS service account key by providing the service account file in JSON format. ++ +image:gcs-data-source-details.png[] +. Once you have those configured, you can add one or multiple `GCS URI` within the same GCS account. + +. Click btn:[ Next ] to process the file(s). ++ +[NOTE] +==== +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::config-file.png[] ++ +[TIP] +==== +If the parsing is *not* correct, click on the image:Screenshot 2024-04-17 at 5.54.17 PM.png[width=75] +button to configure a different option for the delimiter, such as `eol`, or `quote and header`. + +image:Screenshot 2024-04-17 at 5.54.50 PM.png[] +==== ++ +The enclosing character is used to mark the boundaries of a token, overriding the delimiter character. ++ +==== +For example, if your delimiter is a comma, but you have commas in some strings, then you can define single or double quotes as the enclosing character to mark the endpoints of your string tokens. +==== ++ +[NOTE] +==== +It is not necessary for every token to have enclosing characters. The parser uses enclosing characters when it encounters them. +==== ++ +[TIP] +==== +You can edit the header line of the parsing result to give each column a more intuitive name, since you will be referring to these names when loading data to the graph. +The header name is ignored during data loading. +==== + +. Once you are satisfied with the file settings, click btn:[ Next ] to proceed. + +== 3) Configure Map + +.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:graph-development:design-schema/index.adoc[Design Schema]. +. Select `Generate the schema only` or `Generate the schema and data mapping`. ++ +image::Screenshot 2024-04-17 at 5.55.35 PM.png[] ++ +[CAUTION] +==== +The schema generation feature is still a preview feature. The correctness and efficiency of the resulting graph schema and mapping could vary. +==== + +. In the `Source` column, you can choose the specific column from the data source that you want to map with the attribute. ++ +image::config-mapping-1.png[] ++ +. Use the `+` button to create a new attribute of the target vertex or edge. ++ +image::config-mapping-2.png[width=400] + +. 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 changed` and `Data to be loaded` lists. ++ +image::confirm.png[] ++ +[CAUTION] +==== +Please be aware that some schema changes will result in unintentional deletion of the data. Please carefully review the warning message before confirming the loading. +==== +. Click on the btn:[Confirm] button to run the loading jobs and monitor their `Status`. ++ +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], 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. + + diff --git a/modules/cloudbeta/modules/load-data/pages/load-from-local.adoc b/modules/cloud4/modules/graph-development/pages/load-data/load-from-local.adoc similarity index 63% rename from modules/cloudbeta/modules/load-data/pages/load-from-local.adoc rename to modules/cloud4/modules/graph-development/pages/load-data/load-from-local.adoc index b0e176d3..c8812042 100644 --- a/modules/cloudbeta/modules/load-data/pages/load-from-local.adoc +++ b/modules/cloud4/modules/graph-development/pages/load-data/load-from-local.adoc @@ -14,16 +14,16 @@ image::Screenshot 2024-04-17 at 5.53.05 PM.png[] + [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. +* The maximum supported file size is 2GB. ==== == 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] ==== @@ -54,41 +54,42 @@ The header name is ignored during data loading. == 3) Configure Map -.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloudBeta:schema-designer:index.adoc[Schema Designer]. +.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:graph-development:design-schema/index.adoc[Design Schema]. . Select `Generate the schema only` or `Generate the schema and data mapping`. + image::Screenshot 2024-04-17 at 5.55.35 PM.png[] + [CAUTION] ==== -TigerGraph Cloud 4.0 is still in beta release and the schema generation feature is still a preview feature. -The correctness and efficiency of the resulting graph schema and mapping could vary. +The schema generation feature is still a preview feature. The correctness and efficiency of the resulting graph schema and mapping could vary. ==== . 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] + +. 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]. -. 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. +. Click the btn:[Quick Map] button to quickly map the data source headers to the existing schema attributes. + -image::Screenshot 2024-04-17 at 5.57.52 PM.png[] -. Click btn:[Next] to proceed. +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. -//// -== Configure mappings: -. You can configure the attributes and mappings here. -Configure attributes: https://docs.google.com/document/d/1kB2zyJgSZWZy0RWhTRJHT7rcxkFs4MiHvpx0LHnI6Ck/edit#heading=h.4tb91cptojyw -//// +. 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] ==== @@ -100,8 +101,8 @@ image::Screenshot 2024-04-17 at 5.59.16 PM.png[] == Next Steps -Next, learn how to use the xref:cloudBeta:schema-designer:index.adoc[Schema Designer] in TigerGraph Cloud 4.0. +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:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/graph-development/pages/load-data/load-from-other-sources.adoc b/modules/cloud4/modules/graph-development/pages/load-data/load-from-other-sources.adoc new file mode 100644 index 00000000..95309dbf --- /dev/null +++ b/modules/cloud4/modules/graph-development/pages/load-data/load-from-other-sources.adoc @@ -0,0 +1,14 @@ += Load from Other Sources + +TigerGraph Cloud 4 supports various data sources for ingestion, providing flexibility in integrating with your existing data infrastructure. +GSQL templates can be used for connectors that are not yet supported in the step-by-step loading guide. +See xref:tigergraph-server:data-loading:index.adoc[Data Loading in TigerGraph DB] for guides to loading data into TigerGraph. + +Additionally, data can also be loaded from a JDBC Connection as well, See xref:cloud4:graph-development:load-data/jdbc.adoc[] for more details. + +== Next Steps + +Next, learn how to use xref:cloud4:graph-development:design-schema/index.adoc[Design Schema] in TigerGraph Cloud 4. + +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. + diff --git a/modules/cloudbeta/modules/load-data/pages/load-from-cloud.adoc b/modules/cloud4/modules/graph-development/pages/load-data/load-from-s3.adoc similarity index 58% rename from modules/cloudbeta/modules/load-data/pages/load-from-cloud.adoc rename to modules/cloud4/modules/graph-development/pages/load-data/load-from-s3.adoc index 9e975da4..1b9ab096 100644 --- a/modules/cloudbeta/modules/load-data/pages/load-from-cloud.adoc +++ b/modules/cloud4/modules/graph-development/pages/load-data/load-from-s3.adoc @@ -1,14 +1,14 @@ -= Load from the AWS S3 += Load from Amazon S3 :experimental: -If you store your data in AWS S3, TigerGraph Cloud provides seamless integration for data ingestion. +If you store your data in Amazon 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. +This simplifies the process of importing large datasets and enables you to leverage the scalability and durability of Amazon S3 for your graph analysis. == 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:[Amazon S3], you will be asked to configure the Amazon S3 data source. +. Click on image:Screenshot 2024-04-17 at 9.36.58 PM.png[width=50] to add a new Amazon S3 data source. + image:Screenshot 2024-04-17 at 9.36.27 PM.png[] @@ -21,7 +21,7 @@ image:Screenshot 2024-04-17 at 9.37.32 PM.png[] + [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 @@ -29,7 +29,7 @@ The current data loading tool only supports CSV files. Other formats will be ava . 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] ==== @@ -60,38 +60,42 @@ The header name is ignored during data loading. == 3) Configure Map -.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloudBeta:schema-designer:index.adoc[Schema Designer]. +.If you are loading data into a brand new graph, you will be prompted to let our engine generate a schema and mapping for you. Or you can start from scratch. For more details of schema design please refer to xref:cloud4:graph-development:design-schema/index.adoc[Design Schema]. . Select `Generate the schema only` or `Generate the schema and data mapping`. + image::Screenshot 2024-04-17 at 5.55.35 PM.png[] + [CAUTION] ==== -TigerGraph Cloud 4.0 is still in beta release and the schema generation feature is still a preview feature. -The correctness and efficiency of the resulting graph schema and mapping could vary. +The schema generation feature is still a preview feature. The correctness and efficiency of the resulting graph schema and mapping could vary. ==== . 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] ==== @@ -103,8 +107,8 @@ image::Screenshot 2024-04-17 at 5.59.16 PM.png[] == Next Steps -Next, learn how to use the xref:cloudBeta:schema-designer:index.adoc[Schema Designer] in TigerGraph Cloud 4.0. +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:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/graph-development/pages/load-data/token-function.adoc b/modules/cloud4/modules/graph-development/pages/load-data/token-function.adoc new file mode 100644 index 00000000..7ba4e101 --- /dev/null +++ b/modules/cloud4/modules/graph-development/pages/load-data/token-function.adoc @@ -0,0 +1,52 @@ += Token Function +:experimental: + +TigerGraph Cloud 4 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:gsql-ref:ddl-and-loading:functions:token.adoc[Token Functions]. + +== Add a token function +. Click on the btn:[Token Function] button to configure token functions for your data source. + ++ +image::config-mapping-2.png[width=400] ++ +. Click on the btn:[+] button to create a new token function, or select one from the list to edit. ++ +image::token-function-1.png[] ++ + +. Select the token function you want to use from the `Type` dropdown menu. This will automatically populate the output data type and the required parameters. You can also check the sample input and output by hovering over the btn:[?] icon. Please refer to the xref:gsql-ref:ddl-and-loading:functions:token.adoc[Token Functions] documentation for more details. + ++ +image::token-function-3.png[] ++ + +. Configure the parameters in the *Parameters* section of the window. You can click on the btn:[+] button to add more data columns from the source file. + ++ +image::token-function-2.png[] ++ + +. Click on the btn:[Save] button to save the token function. + +. Select the token function you just created in the source column to map to the target attribute. + ++ +image::token-function-4.png[] ++ + +[TIP] +==== +You can also apply nested token functions to maximize the potential of TigerGraph. +==== + ++ +[NOTE] +==== +Custom token functions are not supported in the TigerGraph Cloud 4 UI. +==== + +== Next Steps +Next, learn more about how to xref:cloud4:graph-development:load-data/index.adoc[]. + +Or return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. + diff --git "a/modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-18 at 10.17.39\342\200\257AM.png" "b/modules/cloud4/modules/integrations/images/Screenshot 2024-04-18 at 10.17.39\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-18 at 10.17.39\342\200\257AM.png" rename to "modules/cloud4/modules/integrations/images/Screenshot 2024-04-18 at 10.17.39\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-18 at 10.18.19\342\200\257AM.png" "b/modules/cloud4/modules/integrations/images/Screenshot 2024-04-18 at 10.18.19\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-18 at 10.18.19\342\200\257AM.png" rename to "modules/cloud4/modules/integrations/images/Screenshot 2024-04-18 at 10.18.19\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-18 at 10.18.53\342\200\257AM.png" "b/modules/cloud4/modules/integrations/images/Screenshot 2024-04-18 at 10.18.53\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-18 at 10.18.53\342\200\257AM.png" rename to "modules/cloud4/modules/integrations/images/Screenshot 2024-04-18 at 10.18.53\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-18 at 10.19.26\342\200\257AM.png" "b/modules/cloud4/modules/integrations/images/Screenshot 2024-04-18 at 10.19.26\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-18 at 10.19.26\342\200\257AM.png" rename to "modules/cloud4/modules/integrations/images/Screenshot 2024-04-18 at 10.19.26\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-26 at 8.22.55\342\200\257AM.png" "b/modules/cloud4/modules/integrations/images/Screenshot 2024-04-26 at 8.22.55\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-26 at 8.22.55\342\200\257AM.png" rename to "modules/cloud4/modules/integrations/images/Screenshot 2024-04-26 at 8.22.55\342\200\257AM.png" diff --git "a/modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-27 at 2.34.38\342\200\257PM.png" "b/modules/cloud4/modules/integrations/images/Screenshot 2024-04-27 at 2.34.38\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-27 at 2.34.38\342\200\257PM.png" rename to "modules/cloud4/modules/integrations/images/Screenshot 2024-04-27 at 2.34.38\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-27 at 2.34.48\342\200\257PM.png" "b/modules/cloud4/modules/integrations/images/Screenshot 2024-04-27 at 2.34.48\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/integrations/images/Screenshot 2024-04-27 at 2.34.48\342\200\257PM.png" rename to "modules/cloud4/modules/integrations/images/Screenshot 2024-04-27 at 2.34.48\342\200\257PM.png" diff --git a/modules/cloudbeta/modules/integrations/images/add-graphql-addon.png b/modules/cloud4/modules/integrations/images/add-graphql-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/add-graphql-addon.png rename to modules/cloud4/modules/integrations/images/add-graphql-addon.png diff --git a/modules/cloudbeta/modules/integrations/images/add-graphstudio-addon.png b/modules/cloud4/modules/integrations/images/add-graphstudio-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/add-graphstudio-addon.png rename to modules/cloud4/modules/integrations/images/add-graphstudio-addon.png diff --git a/modules/cloudbeta/modules/integrations/images/add-insights-addon.png b/modules/cloud4/modules/integrations/images/add-insights-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/add-insights-addon.png rename to modules/cloud4/modules/integrations/images/add-insights-addon.png diff --git "a/modules/cloudbeta/modules/integrations/images/add-on-images/Screenshot 2024-04-27 at 1.57.35\342\200\257PM.png" "b/modules/cloud4/modules/integrations/images/add-on-images/Screenshot 2024-04-27 at 1.57.35\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/integrations/images/add-on-images/Screenshot 2024-04-27 at 1.57.35\342\200\257PM.png" rename to "modules/cloud4/modules/integrations/images/add-on-images/Screenshot 2024-04-27 at 1.57.35\342\200\257PM.png" diff --git a/modules/cloudbeta/modules/integrations/images/addon-nav.png b/modules/cloud4/modules/integrations/images/addon-nav.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/addon-nav.png rename to modules/cloud4/modules/integrations/images/addon-nav.png diff --git a/modules/cloudbeta/modules/get-started/images/billing-homecard.png b/modules/cloud4/modules/integrations/images/billing-homecard.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/billing-homecard.png rename to modules/cloud4/modules/integrations/images/billing-homecard.png diff --git a/modules/cloudbeta/modules/get-started/images/create-organization.png b/modules/cloud4/modules/integrations/images/create-organization.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/create-organization.png rename to modules/cloud4/modules/integrations/images/create-organization.png diff --git a/modules/cloudbeta/modules/integrations/images/disable-graphql-addon.png b/modules/cloud4/modules/integrations/images/disable-graphql-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/disable-graphql-addon.png rename to modules/cloud4/modules/integrations/images/disable-graphql-addon.png diff --git a/modules/cloudbeta/modules/integrations/images/disable-graphstudio-addon.png b/modules/cloud4/modules/integrations/images/disable-graphstudio-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/disable-graphstudio-addon.png rename to modules/cloud4/modules/integrations/images/disable-graphstudio-addon.png diff --git a/modules/cloudbeta/modules/integrations/images/disable-insights-addon.png b/modules/cloud4/modules/integrations/images/disable-insights-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/disable-insights-addon.png rename to modules/cloud4/modules/integrations/images/disable-insights-addon.png diff --git a/modules/cloudbeta/modules/get-started/images/documentation-homecard.png b/modules/cloud4/modules/integrations/images/documentation-homecard.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/documentation-homecard.png rename to modules/cloud4/modules/integrations/images/documentation-homecard.png diff --git a/modules/cloudbeta/modules/integrations/images/enable-graphql-addon.png b/modules/cloud4/modules/integrations/images/enable-graphql-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/enable-graphql-addon.png rename to modules/cloud4/modules/integrations/images/enable-graphql-addon.png diff --git a/modules/cloudbeta/modules/integrations/images/enable-graphstudio-addon.png b/modules/cloud4/modules/integrations/images/enable-graphstudio-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/enable-graphstudio-addon.png rename to modules/cloud4/modules/integrations/images/enable-graphstudio-addon.png diff --git a/modules/cloudbeta/modules/integrations/images/enable-insights-addon.png b/modules/cloud4/modules/integrations/images/enable-insights-addon.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/enable-insights-addon.png rename to modules/cloud4/modules/integrations/images/enable-insights-addon.png diff --git a/modules/cloudbeta/modules/get-started/images/getstarted-homecard.png b/modules/cloud4/modules/integrations/images/getstarted-homecard.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/getstarted-homecard.png rename to modules/cloud4/modules/integrations/images/getstarted-homecard.png diff --git a/modules/cloudbeta/modules/get-started/images/referece-homecard.png b/modules/cloud4/modules/integrations/images/referece-homecard.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/referece-homecard.png rename to modules/cloud4/modules/integrations/images/referece-homecard.png diff --git a/modules/cloudbeta/modules/get-started/images/security-homecard.png b/modules/cloud4/modules/integrations/images/security-homecard.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/security-homecard.png rename to modules/cloud4/modules/integrations/images/security-homecard.png diff --git a/modules/cloudbeta/modules/get-started/images/systemmanagment-homecard.png b/modules/cloud4/modules/integrations/images/systemmanagment-homecard.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/systemmanagment-homecard.png rename to modules/cloud4/modules/integrations/images/systemmanagment-homecard.png diff --git a/modules/cloudbeta/modules/get-started/images/tools-page.png b/modules/cloud4/modules/integrations/images/tools-page.png similarity index 100% rename from modules/cloudbeta/modules/get-started/images/tools-page.png rename to modules/cloud4/modules/integrations/images/tools-page.png diff --git a/modules/cloudbeta/modules/integrations/nav.adoc b/modules/cloud4/modules/integrations/nav.adoc similarity index 55% rename from modules/cloudbeta/modules/integrations/nav.adoc rename to modules/cloud4/modules/integrations/nav.adoc index cab74b5c..ea5320b6 100644 --- a/modules/cloudbeta/modules/integrations/nav.adoc +++ b/modules/cloud4/modules/integrations/nav.adoc @@ -1,9 +1,8 @@ * xref:index.adoc[Marketplace] ** xref:solutions.adoc[] ** xref:add-ons.adoc[] -*** xref:cloudBeta:explore-graph:copilot-enablement.adoc[] *** xref:graphstudio.adoc[] *** xref:insights.adoc[] -*** xref:cloudBeta:integrations:graphql.adoc[] +*** xref:cloud4:integrations:graphql.adoc[] diff --git a/modules/cloudbeta/modules/integrations/pages/add-ons.adoc b/modules/cloud4/modules/integrations/pages/add-ons.adoc similarity index 55% rename from modules/cloudbeta/modules/integrations/pages/add-ons.adoc rename to modules/cloud4/modules/integrations/pages/add-ons.adoc index edff82c9..97247c02 100644 --- a/modules/cloudbeta/modules/integrations/pages/add-ons.adoc +++ b/modules/cloud4/modules/integrations/pages/add-ons.adoc @@ -1,24 +1,20 @@ = Add-Ons -Extend the capabilities of TigerGraph Cloud 4.0 with add-ons tailored to your needs. +Extend the capabilities of TigerGraph Cloud 4 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. 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. -== xref:cloudBeta:integrations:copilot.adoc[] - -CoPilot empowers business analysts, data scientists, and developers to use natural language to run real-time queries against up-to-date data at scale. - -== xref:cloudBeta:integrations:insights.adoc[] +== xref:cloud4:integrations:insights.adoc[] TigerGraph Insights is a no-code visual graph analyzer that makes building data analytics dashboards intuitive. -== xref:cloudBeta:integrations:graphstudio.adoc[] +== xref:cloud4:integrations:graphstudio.adoc[GraphStudio™] -GraphStudio offers a range of features and tools to simplify the graph development process. +The GraphStudio™ design interface offers a range of features and tools to simplify the graph development process. -== xref:cloudBeta:integrations:graphql.adoc[] +== xref:cloud4:integrations:graphql.adoc[] TigerGraph GraphQL enables users to access and modify graph data in TigerGraph using GraphQL queries. diff --git a/modules/cloudbeta/modules/integrations/pages/graphql.adoc b/modules/cloud4/modules/integrations/pages/graphql.adoc similarity index 78% rename from modules/cloudbeta/modules/integrations/pages/graphql.adoc rename to modules/cloud4/modules/integrations/pages/graphql.adoc index 74faf101..9f47d72f 100644 --- a/modules/cloudbeta/modules/integrations/pages/graphql.adoc +++ b/modules/cloud4/modules/integrations/pages/graphql.adoc @@ -7,7 +7,7 @@ With TigerGraph GraphQL, you can use any GraphQL client or simply submit GraphQL [TIP] ==== -To learn more about GraphStudio read our xref:3.9@graphql:ROOT:index.adoc[]. +To learn more about GraphQL read our xref:graphql:ROOT:index.adoc[]. ==== == Get Started GraphQL Add-on @@ -31,7 +31,7 @@ image::disable-graphql-addon.png[width=350] == Next Steps -Now, learn about additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn about the xref:administration:index.adoc[Administration] features or xref:security:index.adoc[] in TigerGraph Cloud 4.0. +Now, learn about additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn about the xref:administration:index.adoc[Administration] features or xref:cloud4:administration:security/index.adoc[] in TigerGraph Cloud 4. -Return to the page to xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/integrations/pages/graphstudio.adoc b/modules/cloud4/modules/integrations/pages/graphstudio.adoc similarity index 73% rename from modules/cloudbeta/modules/integrations/pages/graphstudio.adoc rename to modules/cloud4/modules/integrations/pages/graphstudio.adoc index 1ec1bad3..efe283a9 100644 --- a/modules/cloudbeta/modules/integrations/pages/graphstudio.adoc +++ b/modules/cloud4/modules/integrations/pages/graphstudio.adoc @@ -1,14 +1,14 @@ = GraphStudio :experimental: -GraphStudio offers a range of features and tools to simplify the graph development process. +The GraphStudio™ design interface offers a range of features and tools to simplify the graph development process. It allows users to visually design and model their graph schema, define the structure of vertices and edges, and set up various graph algorithms and analytics. The platform supports a wide range of data types and allows users to import data from various sources, including CSV files, databases, and cloud storage. [TIP] ==== -To learn more about GraphStudio read our xref:gui:graphstudio:overview.adoc[GraphStudio Documentation] +To learn more about xref:gui:graphstudio:overview.adoc[GraphStudio] ==== == Get Started GraphStudio Add-on @@ -32,7 +32,7 @@ image::disable-graphstudio-addon.png[width=350] == Next Steps -Now, learn about additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn about the xref:administration:index.adoc[Administration] features or xref:security:index.adoc[] in TigerGraph Cloud 4.0. +Now, learn about additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn about the xref:administration:index.adoc[Administration] features or xref:cloud4:administration:security/index.adoc[] in TigerGraph Cloud 4. -Return to the page to xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/integrations/pages/how2-use-soultions.adoc b/modules/cloud4/modules/integrations/pages/how2-use-soultions.adoc similarity index 100% rename from modules/cloudbeta/modules/integrations/pages/how2-use-soultions.adoc rename to modules/cloud4/modules/integrations/pages/how2-use-soultions.adoc diff --git a/modules/cloud4/modules/integrations/pages/index.adoc b/modules/cloud4/modules/integrations/pages/index.adoc new file mode 100644 index 00000000..d4db3a85 --- /dev/null +++ b/modules/cloud4/modules/integrations/pages/index.adoc @@ -0,0 +1,23 @@ += Marketplace Overview +:experimental: + +TigerGraph Cloud seamlessly integrates with various tools and services to enhance your graph database workflow. + +== xref:cloud4:integrations:add-ons.adoc[] + +Learn how to extend the capabilities of TigerGraph Cloud 4 with add-ons tailored to your needs. + +* xref:cloud4:integrations:insights.adoc[] +* xref:cloud4:integrations:graphstudio.adoc[] +* xref:cloud4:integrations:graphql.adoc[] + +== xref:cloud4:integrations:solutions.adoc[] + +Here you can learn about our array of industry standard prebuilt solutions for diverse industries and use cases. +Designed for users to swiftly adopt graph technology. + +== Next Steps + +Now learn about xref:administration:index.adoc[Administration] features or xref:cloud4:administration:security/index.adoc[] in TigerGraph Cloud 4. + +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/integrations/pages/insights.adoc b/modules/cloud4/modules/integrations/pages/insights.adoc similarity index 84% rename from modules/cloudbeta/modules/integrations/pages/insights.adoc rename to modules/cloud4/modules/integrations/pages/insights.adoc index 87345c75..9423ea68 100644 --- a/modules/cloudbeta/modules/integrations/pages/insights.adoc +++ b/modules/cloud4/modules/integrations/pages/insights.adoc @@ -31,6 +31,6 @@ image::disable-insights-addon.png[width=350] == Next Steps -Now, learn about additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn about the xref:administration:index.adoc[Administration] features or xref:security:index.adoc[] in TigerGraph Cloud 4.0. +Now, learn about additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn about the xref:administration:index.adoc[Administration] features or xref:cloud4:administration:security/index.adoc[] in TigerGraph Cloud 4. -Or return to the page to xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/integrations/pages/solutions.adoc b/modules/cloud4/modules/integrations/pages/solutions.adoc similarity index 81% rename from modules/cloudbeta/modules/integrations/pages/solutions.adoc rename to modules/cloud4/modules/integrations/pages/solutions.adoc index eb528912..13c86b19 100644 --- a/modules/cloudbeta/modules/integrations/pages/solutions.adoc +++ b/modules/cloud4/modules/integrations/pages/solutions.adoc @@ -1,7 +1,7 @@ = Solutions :experimental: -TigerGraph Cloud 4.0 offers pre-built solution kits that address common use cases and industry-specific challenges. +TigerGraph Cloud 4 offers pre-built solution kits that address common use cases and industry-specific challenges. These solutions provide a starting point for your graph database projects, offering pre-configured schemas, sample data, and query templates. [TIP] @@ -9,10 +9,15 @@ These solutions provide a starting point for your graph database projects, offer By leveraging solutions, you can accelerate development, reduce time-to-insights, and focus on extracting value from your graph data. ==== +[NOTE] +==== +We limit the number of solutions that can be installed in a workspace to one to ensure that the workspace is not overloaded with unnecessary data and queries. +==== + Explore the available solutions and experiment with them in your own specific use cases. == Prerequisites -To start creating your first solution you will need to have a xref:cloudBeta:resource-manager:workspaces/writeread_readonly.adoc#_read_write_rw_workspace[Read-Write Workspace] already created. +To start creating your first solution you will need to have a xref:cloud4:workgroup-workspace:workspaces/readwrite-readonly.adoc#_read_write_rw_workspace[Read-Write Workspace] already created. == Get Started with Solutions @@ -56,7 +61,7 @@ You can import your data from various sources, such as CSV files, databases, or + [TIP] ==== -For more details on loading data see xref:cloudBeta:load-data:index.adoc[]. +For more details on loading data see xref:cloud4:graph-development:load-data/index.adoc[]. ==== * *No Data*: If you choose the btn:[No Data] option, the solution kit will be set up without any pre-loaded or user-provided data. @@ -73,7 +78,7 @@ image::Screenshot 2024-04-18 at 10.19.26 AM.png[] == Next Steps -Now, learn about additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn more about xref:security:index.adoc[] in TigerGraph Cloud 4.0. +Now, learn about additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn more about xref:cloud4:administration:security/index.adoc[] in TigerGraph Cloud 4. -Or return to the page to xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Or return to the page to xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/overview/images/ArchtectureOverview-homecard.png b/modules/cloud4/modules/overview/images/ArchtectureOverview-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/ArchtectureOverview-homecard.png rename to modules/cloud4/modules/overview/images/ArchtectureOverview-homecard.png diff --git a/modules/cloudbeta/modules/overview/images/DataLoading-Homecard.png b/modules/cloud4/modules/overview/images/DataLoading-Homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/DataLoading-Homecard.png rename to modules/cloud4/modules/overview/images/DataLoading-Homecard.png diff --git a/modules/cloudbeta/modules/overview/images/TG_Icon_Library-135.png b/modules/cloud4/modules/overview/images/TG_Icon_Library-135.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/TG_Icon_Library-135.png rename to modules/cloud4/modules/overview/images/TG_Icon_Library-135.png diff --git a/modules/cloudbeta/modules/overview/images/TG_Icon_Library-218.png b/modules/cloud4/modules/overview/images/TG_Icon_Library-218.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/TG_Icon_Library-218.png rename to modules/cloud4/modules/overview/images/TG_Icon_Library-218.png diff --git a/modules/cloudbeta/modules/gsql-editor/images/billing-homecard.png b/modules/cloud4/modules/overview/images/billing-homecard.png similarity index 100% rename from modules/cloudbeta/modules/gsql-editor/images/billing-homecard.png rename to modules/cloud4/modules/overview/images/billing-homecard.png diff --git a/modules/cloud4/modules/overview/images/cloud4-architecture.png b/modules/cloud4/modules/overview/images/cloud4-architecture.png new file mode 100644 index 00000000..443e870e Binary files /dev/null and b/modules/cloud4/modules/overview/images/cloud4-architecture.png differ diff --git a/modules/cloudbeta/modules/gsql-editor/images/create-organization.png b/modules/cloud4/modules/overview/images/create-organization.png similarity index 100% rename from modules/cloudbeta/modules/gsql-editor/images/create-organization.png rename to modules/cloud4/modules/overview/images/create-organization.png diff --git a/modules/cloudbeta/modules/gsql-editor/images/documentation-homecard.png b/modules/cloud4/modules/overview/images/documentation-homecard.png similarity index 100% rename from modules/cloudbeta/modules/gsql-editor/images/documentation-homecard.png rename to modules/cloud4/modules/overview/images/documentation-homecard.png diff --git a/modules/cloudbeta/modules/overview/images/edtions-homecard.png b/modules/cloud4/modules/overview/images/edtions-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/edtions-homecard.png rename to modules/cloud4/modules/overview/images/edtions-homecard.png diff --git a/modules/cloudbeta/modules/gsql-editor/images/getstarted-homecard.png b/modules/cloud4/modules/overview/images/getstarted-homecard.png similarity index 100% rename from modules/cloudbeta/modules/gsql-editor/images/getstarted-homecard.png rename to modules/cloud4/modules/overview/images/getstarted-homecard.png diff --git a/modules/cloudbeta/modules/overview/images/insights.png b/modules/cloud4/modules/overview/images/insights.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/insights.png rename to modules/cloud4/modules/overview/images/insights.png diff --git a/modules/cloudbeta/modules/gsql-editor/images/referece-homecard.png b/modules/cloud4/modules/overview/images/referece-homecard.png similarity index 100% rename from modules/cloudbeta/modules/gsql-editor/images/referece-homecard.png rename to modules/cloud4/modules/overview/images/referece-homecard.png diff --git a/modules/cloudbeta/modules/overview/images/schema-homecard.png b/modules/cloud4/modules/overview/images/schema-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/schema-homecard.png rename to modules/cloud4/modules/overview/images/schema-homecard.png diff --git a/modules/cloudbeta/modules/gsql-editor/images/security-homecard.png b/modules/cloud4/modules/overview/images/security-homecard.png similarity index 100% rename from modules/cloudbeta/modules/gsql-editor/images/security-homecard.png rename to modules/cloud4/modules/overview/images/security-homecard.png diff --git a/modules/cloudbeta/modules/gsql-editor/images/systemmanagment-homecard.png b/modules/cloud4/modules/overview/images/systemmanagment-homecard.png similarity index 100% rename from modules/cloudbeta/modules/gsql-editor/images/systemmanagment-homecard.png rename to modules/cloud4/modules/overview/images/systemmanagment-homecard.png diff --git a/modules/cloudbeta/modules/gsql-editor/images/tools-page.png b/modules/cloud4/modules/overview/images/tools-page.png similarity index 100% rename from modules/cloudbeta/modules/gsql-editor/images/tools-page.png rename to modules/cloud4/modules/overview/images/tools-page.png diff --git a/modules/cloud4/modules/overview/nav.adoc b/modules/cloud4/modules/overview/nav.adoc new file mode 100644 index 00000000..791b3b3c --- /dev/null +++ b/modules/cloud4/modules/overview/nav.adoc @@ -0,0 +1,8 @@ +* xref:index.adoc[Introduction] +** 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[] +** xref:cloud4:overview:cost-estimation.adoc[] + diff --git a/modules/cloudbeta/modules/overview/pages/overview.adoc b/modules/cloud4/modules/overview/pages/architecture.adoc similarity index 59% rename from modules/cloudbeta/modules/overview/pages/overview.adoc rename to modules/cloud4/modules/overview/pages/architecture.adoc index a69f6a14..cfb5c0dd 100644 --- a/modules/cloudbeta/modules/overview/pages/overview.adoc +++ b/modules/cloud4/modules/overview/pages/architecture.adoc @@ -1,12 +1,15 @@ -= Cloud 4.0 Overview += TigerGraph Cloud 4 Architecture +:experimental: +:toc: +:toclevels:2 -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. +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. -The platform also comes with intuitive interfaces, designed to reduce the learning curve and enable users to quickly leverage the benefits of graph analytics. -== Key Features of TigerGraph Cloud 4.0 -These key features of TigerGraph Cloud 4.0 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. +== 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. @@ -19,14 +22,9 @@ We introduce Read-Write and Read-Only Workspaces to connect to the same database === 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, AWS S3, Azure Blob Storage, GCP Cloud Storage, Spark, Snowflake, Postgres, Kafka, and BigQuery, the platform offers seamless integration with diverse data sources. +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. -=== CoPilot -CoPilot is an AI assistant for your TigerGraph-powered solutions and tools that will boost your productivity and simplify many of your business analytics, development and administration tasks. -TigerGraph CoPilot enables you to ask questions in natural language about your data, and analyze the results delivered to you in natural language, graph visualizations, and other views. -Whether you are a business analyst, data scientist, or developer, CoPilot has you covered. - === 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. @@ -34,21 +32,21 @@ They provide everything users need to get started with graph analytics and AI-dr === 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. +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.0 features a Graph Explorer, a visual interface that allows users to interactively explore and analyze the graph data. +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 Insights -TigerGraph Cloud 4.0 incorporates auto data insights capabilities that automatically find data insights for users without prior knowledge of their schema and query. +=== 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:cloudBeta:get-started:index.adoc[] to unlock its full potential. +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:cloudBeta:overview:index.adoc[TigerGraph Cloud 4.0] for another topic. +Return to xref:cloud4:overview:index.adoc[TigerGraph Cloud 4] for another topic. diff --git a/modules/cloud4/modules/overview/pages/comparison_table.adoc b/modules/cloud4/modules/overview/pages/comparison_table.adoc new file mode 100644 index 00000000..d08b5f42 --- /dev/null +++ b/modules/cloud4/modules/overview/pages/comparison_table.adoc @@ -0,0 +1,45 @@ += Compare TigerGraph Offerings + +Most of the documentation for TigerGraph Enterprise Server also applies to TigerGraph Cloud 4. +Here are some differences between the different TigerGraph offerings. + +|=== +| Category | Topic | TigerGraph Enterprise Server | TigerGraph Cloud Classic | TigerGraph Cloud 4 Beta +.7+| Architecture and Deployment | Architecture | Integrated storage and compute | Integrated storage and compute | Separate storage and compute +| Hardware and Software Requirements | Yes | N/A | N/A +| Installation and Configuration | Yes | There are a few simple steps to install a Starter Kit, See the xref:cloud:support:faqs.adoc[] | Users can install solutions at any time +| Kubernetes Support | Yes, custom setup required | No | Yes, built-in support +| Amazon Web Service (AWS) | Yes, TigerGraph Lite on marketplace or custom deployment | Yes | Yes +| Google Cloud Platform (GCP) | Yes, TigerGraph Lite on marketplace or custom deployment | Yes | No, we are activly working on it +| Microsoft Azure | Yes, TigerGraph Lite on marketplace or custom deployment | Yes | No, we are activly working on it + +.13+| Features and Capabilities +| Release Notes| Yes| TigerGraph Cloud provides database versions kept up to date with TigerGraph Server 3.x releases | TigerGraph Cloud 4 provides the latest TigerGraph Server 4.x +| GSQL Graph Algorithm Library | Yes| Yes| Yes +| Transaction Processing and ACID Support | Yes | Yes | Yes +| GSQL 101 | Yes | Basic concepts still apply, most CREATE, INSTALL, LOAD, and RUN commands are replaced with the GraphStudio GUI-based approach | Fully supported using GSQL Editor +| GSQL 102 Pattern Matching | Yes | The same patterns can be used in queries | The same patterns can be used in queries +| MultiGraph Overview | Yes | Yes | Yes +| GraphStudio™ | Yes | Yes | Yes, add-on +| GSQL Demo Examples | Yes | Yes | Yes +| GSQL Language Reference, Part 1 Data Definition and Loading | Yes| Yes. GSQL Web Shell (Paid Tiers) supports Data Definition and Loading. Data files can be imported into the filesystem through GraphStudio™, or submit support request to import into the filesystem. In addition, the operations can be performed through GraphStudio™ | Yes, Load Data UI +| GSQL Language Reference, Part 2 Querying | Yes | Yes | Yes, GSQL Editor +| RESTPP API User Guide | Yes | Yes. Note the URL assigned to your cluster. | Yes, Connect From APIs option on all workspaces. +| Data Loader User Guides | Yes | S3 Loader can be used through the GraphStudio™ interface. In addition, S3 Loader and Kafka Loader can be used in GSQL Web Shell (Paid Tiers). | Yes. Step-by-step guide to load local/S3/GCS/ABS files. Provide a GSQL template for all other connectors. +| Schema Designer | Yes, GraphStudio™ | Yes, GraphStudio™ | Yes, Cloud Portal & GraphStudio™ + +.5+|Security and Management +| User Access Management | Yes | Yes | Yes +| Data Encryption | Yes | TigerGraph Cloud is set up already for encrypted data at rest and at motion | TigerGraph Cloud is set up already for encrypted data at rest and at motion +| System Management | Yes | The Cloud Portal is enhanced over the TigerGraph Server Admin Portal. Backup and Restore is done through the Cloud Portal. | The Cloud Portal is enhanced over the TigerGraph Server Admin Portal. Backup and Restore is done through the Cloud Portal. +| HA and DR | Yes | Yes | Yes +| Monitoring | Yes, requires custom setup using Informant APIs | TigerGraph Server Admin Portal | Build-in Grafana dashboard & TigerGraph Server Admin Portal +| Alerting | Yes, requires custom setup | No | Yes + +|=== + +== Next Steps + +Next, 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. diff --git a/modules/cloud4/modules/overview/pages/cost-estimation.adoc b/modules/cloud4/modules/overview/pages/cost-estimation.adoc new file mode 100644 index 00000000..2e78557a --- /dev/null +++ b/modules/cloud4/modules/overview/pages/cost-estimation.adoc @@ -0,0 +1,31 @@ += Cost Estimation + +Here, you can configure various parameters to estimate your monthly costs for using TigerGraph Cloud 4. This tool allows you to tailor your workspace size, monthly usage, and database size to get a clear understanding of your anticipated expenses. + +++++ + + + + +++++ + +== Next Steps + +Next, 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. \ No newline at end of file diff --git a/modules/cloud4/modules/overview/pages/index.adoc b/modules/cloud4/modules/overview/pages/index.adoc new file mode 100644 index 00000000..5c1b818a --- /dev/null +++ b/modules/cloud4/modules/overview/pages/index.adoc @@ -0,0 +1,137 @@ += TigerGraph Cloud 4 Beta +: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://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. + +[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[]. +==== + +//pass:[ToolTip Practice] + +//:tooltip: pass:[Hover over this text] + +//{tooltip} + +== Get to Know Your TigerGraph Cloud + +[.home-card,cols="2",grid=none,frame=none, separator=¦] +|=== +¦ +image:getstarted-homecard.png[alt=getstarted,width=74,height=74] +*Get Started* + +xref:cloud4:get-started:index.adoc[Get Started] using TigerGraph Cloud 4 or explore key features in our xref:overview:overview.adoc[]. + +xref:get-started:how2-signup.adoc[How to Sign Up] | +xref:cloud4:get-started:how2-login.adoc[] +¦ +image:insights.png[alt=workspace,width=74,height=74] +*Workgroups and Workspaces* + +Learn how to dynamically allocate compute and storage resources. + +xref:workgroup-workspace:index.adoc[Overview] | +xref:workgroup-workspace:workgroups/workgroup.adoc[Workgroup] | +xref:workgroup-workspace:workspaces/workspace.adoc[Workspace] + +¦ +image:DataLoading-Homecard.png[alt=load data,width=74,height=74] +*Load Data* + +Learn how to Load Data into TigerGraph Cloud 4. + + + +xref:cloud4:graph-development:load-data/index.adoc[Overview] | +xref:cloud4:graph-development:load-data/load-from-local.adoc[Local] | +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] | +xref:cloud4:graph-development:load-data/load-from-blob.adoc[Azure Blob Storage] | +xref:cloud4:graph-development:load-data/load-from-other-sources.adoc[Other Sources] +¦ +image:TG_Icon_Library-135.png[alt=schemadesigner,width=74,height=74] +*Design Schema* + +xref:cloud4:graph-development:design-schema/index.adoc[Design Schema] teaches you how you can easily modify and manage the schema of your graph databases using Schema Designer UI. + +¦ +image:schema-homecard.png[alt=gsqlEditor,width=74,height=74] +*GSQL Editor* + +The GSQL Editor is a powerful tool for developing and executing GSQL queries, allowing you to unlock insights from your graph databases. + +xref:cloud4:graph-development:gsql-editor/index.adoc[Overview] | xref:cloud4:graph-development:gsql-editor/how2-edit-gsql-query.adoc[] +¦ +image:TG_Icon_Library-218.png[alt=exploreGraph,width=74,height=74] +*Explore Graph* + +Visualize your data and navigate to understand complex connections and dependencies. + +xref:cloud4:graph-development:explore-graph/index.adoc[Overview] | +xref:cloud4:graph-development:explore-graph/how2-use-pattern-search.adoc[] + +¦ +image:ArchtectureOverview-homecard.png[alt=integration,width=74,height=74] +*Marketplace* + +TigerGraph Cloud 4 offers several powerful integration tools. + +xref:cloud4:integrations:index.adoc[Overview] | +xref:cloud4:integrations:insights.adoc[] | +xref:cloud4:integrations:graphstudio.adoc[] | +xref:cloud4:integrations:graphql.adoc[] +¦ +image:edtions-homecard.png[alt=billing,width=74,height=74] +*Administration* + +Here you can learn about the tools available for organizational administrators. + +xref:cloud4:administration:index.adoc[Overview] | +xref:cloud4:administration:how2-invite-users.adoc[] | +xref:cloud4:administration:how2-access-mgnt.adoc[] | +xref:cloud4:administration:settings/how2-use-organization-mgnt.adoc[Org Management] +¦ +image:security-homecard.png[alt=security,width=74,height=74] +*Security* + +Learn about xref:cloud4:administration:security/index.adoc[] in TigerGraph Cloud 4. + +xref:cloud4:administration:security/password-policy.adoc[] | +xref:cloud4:administration:security/idp.adoc[] +¦ +image:billing-homecard.png[alt=billing,width=74,height=74] +*Billing* + +The xref:cloud4:administration:billing/index.adoc[Billing] window allows users to pay only for their specific usage of storage, data access, and compute resources. + +xref:cloud4:administration:billing/payment-methods.adoc[] | +xref:cloud4:administration:billing/invoices.adoc[] | +xref:cloud4:overview:pricing.adoc[] +¦ +image:referece-homecard.png[alt=support,width=74,height=74] +*Release Notes* + +View the xref:cloud4:overview:release-notes.adoc[Release Notes] to get update information on features and releases. +¦ +image:documentation-homecard.png[alt=support,width=74,height=74] +*Resources* + +View any additional xref:resources:index.adoc[Resources] for TigerGraph Cloud 4. + +xref:cloud4:resources:glossary.adoc[] | +xref:cloud4:resources:terms_conditions.adoc[ Beta Terms and Conditions] | +xref:cloud4:resources:support.adoc[] + +|=== \ No newline at end of file diff --git a/modules/cloud4/modules/overview/pages/overview.adoc b/modules/cloud4/modules/overview/pages/overview.adoc new file mode 100644 index 00000000..dbfaddd7 --- /dev/null +++ b/modules/cloud4/modules/overview/pages/overview.adoc @@ -0,0 +1,80 @@ += TigerGraph Cloud 4 Overview +:experimental: +:toc: left +:toclevels: 3 + +Purpose-built for graph analytics, TigerGraph Cloud 4 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 compute 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. + +=== 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. diff --git a/modules/cloud4/modules/overview/pages/pricing.adoc b/modules/cloud4/modules/overview/pages/pricing.adoc new file mode 100644 index 00000000..a391393a --- /dev/null +++ b/modules/cloud4/modules/overview/pages/pricing.adoc @@ -0,0 +1,211 @@ += Pricing + +TigerGraph Cloud 4 offers a flexible and transparent pricing model designed to accommodate a wide range of usage scenarios, from small-scale projects to large enterprise deployments. Our pricing structure is crafted to provide you with the best value while ensuring your graph database solutions are scalable, reliable, and high-performing. + +== Select Platform and Region +:provider: AWS +:region: us-east-1 +++++ + +
+ +Platform + + +Region + +
+++++ + +== Compute Pricing +Compute resources on TigerGraph Cloud 4 are billed based on the number of TCRs consumed per hour. + +=== 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. + +The exchange rate for TigerGraph Credits is straightforward: + +*1 TCR = $4.00* + + +This means that for every TigerGraph Credit you consume, you will be billed $4.00. + +=== Compute Pricing Table + +The following table outlines the cost in TCRs for different sizes of compute resources. +The compute costs are distinct from the storage fees listed below and are metered based on actual usage. For inquiries about pricing, volume discounts, or deploying in other regions, please contact us at sales@tigergraph.com. + +++++ + +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + +
SizevCPUsMemory (GB)Price (TCR/hour)

TG-00

2

16

0.25

TG-0

4

32

0.50

TG-1

8

64

1.00

TG-2

16

128

2.00

TG-4

32

256

4.00

TG-6

48

384

6.00

TG-8

64

512

8.00

TG-16

128

1,024

16.00

TG-24

192

1,536

24.00

TG-32

256

2,048

32.00

TG-40

320

2,560

40.00

TG-48

384

3,072

48.00

TG-56

448

3,584

56.00

TG-64

512

4,096

64.00

+
+ + +++++ + + + +=== High Availability (HA) + +High Availability (HA) on TigerGraph Cloud 4 ensures your graph database remains operational even during disruptions. When HA is enabled, the price is calculated using a multiplier based on the size of your TigerGraph compute resource. + +[cols="3", separator=¦ ] +|=== +¦ Compute Size ¦ Replica Factor ¦ Cost Mutiplier +¦ Sizes equal or below TG-8 ¦ 3 ¦ 2.8x +¦ Sizes above TG-8 ¦ 2 ¦ 1.95x + +|=== + +== Storage Pricing + +Storage on TigerGraph Cloud 4 is billed separately from compute resources. Storage fees are calculated based on the amount of data stored and are metered with fine-grained precision to ensure you only pay for what you use. This includes the storage of your graph data, backups, and any associated metadata. Our storage pricing is designed to be transparent and flexible, allowing you to scale your storage needs up or down as required. + +[cols="2", separator=¦ ] +|=== +¦ Tier ¦ Price per average GB per Month + +¦ Tier 1 ¦ $0.025 +¦ Tier 2 ¦ $0.027 +¦ Tier 3 ¦ $0.028 +¦ Tier 4 ¦ $0.044 +// ¦ BYOC ¦ Billed From Your Cloud Provider + +|=== + +== Add-on Pricing +TigerGraph Cloud 4 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. +[cols="3", separator=¦ ] +|=== +¦Add-On ¦Scope ¦Price + +¦ Insights ¦ Workspace ¦ 10% of the compute usage +¦ GraphStudio™ ¦ Workspace ¦ Free +¦ GraphQL ¦ Workspace ¦ Free + +|=== +Learn more about the available add-ons xref:integrations:add-ons.adoc[here]. + +== Next Steps + +Next, see xref:cloud4:overview:cost-estimation.adoc[] or learn more billing topics at xref:cloud4:administration:billing/index.adoc[]. + +Return to the page to xref:cloud4:overview:index.adoc[Overview] page for a different topic. + diff --git a/modules/cloud4/modules/overview/pages/release-notes.adoc b/modules/cloud4/modules/overview/pages/release-notes.adoc new file mode 100644 index 00000000..b4e0fd33 --- /dev/null +++ b/modules/cloud4/modules/overview/pages/release-notes.adoc @@ -0,0 +1,185 @@ += TigerGraph Cloud 4 Release Notes +:experimental: +//:page-aliases: change-log.adoc, release-notes.adoc +:toc: +:toclevels:2 + +[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[]. +==== + +== Oct 2024 +=== 2024-10-15 + +==== Workspace Enhancements + +* xref:cloud4:workgroup-workspace:workspaces/schedule.adoc[Scheduled Workspace Expansion and Shrink]: Schedule workspace expansion and shrink operations to align with your usage patterns and optimize resource allocation. +* Support HA with Cross-Zone Resiliency: Ensure business continuity and minimize downtime with the introduction of cross-zone high availability support, allowing you to deploy and manage resilient graph database clusters across multiple availability zones for enhanced fault tolerance and disaster recovery capabilities. + +==== Observability Enhancements + +* xref:cloud4:workgroup-workspace:workspaces/settings.adoc#_alerts_[Alerting] System: Stay informed about critical events and performance anomalies through the new alerting system, enabling proactive management of your graph database workspaces. + +==== Stability Enhancements + +* Improved stability and performance. + +==== Other Enhancements + +* Bug fixes. + +== Sep 2024 +=== 2024-09-28 + +==== General + +* Release xref:4.1@tigergraph-server:release-notes:index.adoc[TigerGraph Server 4.1 Preview] on TigerGraph Cloud 4. + +==== Workspace Enhancements + +* Output to Amazon S3: Benefit from integration with Amazon S3 for data output, enabling you to store and retrieve data from Amazon S3 buckets directly from your TigerGraph Cloud environment. +* Built-in Read-only Algorithms: Run built-in read-only algorithms on read-only workspaces, empowering users to leverage algorithmic capabilities for analysis and insights. + +==== GSQL Editor Enhancements + +* Improved User Interface: The GSQL Editor has undergone a significant facelift, providing a more intuitive and user-friendly interface for writing and executing GSQL queries. +* Syntax Highlighting: Enjoy enhanced code readability with syntax highlighting for GSQL queries, making it easier to identify keywords, variables, and functions. +* Auto-Completion: Boost your productivity with auto-completion suggestions that help you write GSQL queries faster and with fewer errors. + +==== Data Loading and Solution Kits + +* Enhanced xref:cloud4:graph-development:load-data/index.adoc[Data Loading] Capabilities: Experience faster and more efficient data loading processes with optimized performance and reliability. +* Customizable UDF: Customize user-defined functions (UDFs) to extend the functionality of your graph database workspaces, enabling you to implement custom logic and algorithms for advanced analytics and insights. + +==== Other Enhancements +* xref:cloud4:workgroup-workspace:workgroups/how2-config-network-access.adoc[Network Configuration]: Set up IP allow lists to protect your workspaces, allowing you to control access and enhance the security of your graph database workspaces. +* xref:cloud4:rest-api:index.adoc[Controller APIs] Support: Enable APIs to operate on TigerGraph Cloud workspaces by providing support for API keys, enhancing the flexibility and security of interacting with your graph database through APIs. +* Bug fixes. + +=== 2024-09-12 + +==== Workspace Enhancements + +* xref:cloud4:workgroup-workspace:workspaces/settings.adoc#_workspace_size_suggestion[Capacity Planning]: Benefit from capacity planning features that help you estimate and plan your workspace size and cost more efficiently. + +==== Other Enhancements + +* Bug fixes. + +== Aug 2024 +=== 2024-08-27 + +==== Workspace Enhancements + +* xref:cloud4:workgroup-workspace:workspaces/settings.adoc#_auto_suspend[Auto Suspend] Enhancement: Auto Suspend feature now supports detection of installing queries, running queries, loading jobs and changing schema. + +==== Other Enhancements + +* Bug fixes. + +=== 2024-08-14 + +==== Data Loading and Solution Kits + +* xref:cloud4:integrations:solutions.adoc[Solution Kits]: Explore an expanded collection of solution kits tailored to specific use cases, providing pre-built templates and workflows for accelerated graph database development. + +== Jul 2024 +=== 2024-07-31 + +==== General + +* Support GSQL API v2: Introducing GSQL API v2 support for enhanced query performance and efficiency, enabling users to leverage the latest GSQL features and optimizations. + +==== Obvervability Enhancements + +* Enhanced xref:cloud4:workgroup-workspace:workgroups/monitor-workspaces.adoc[Monitoring] Tools: Gain deeper insights into your TigerGraph Cloud environment with improved monitoring tools, allowing you to track performance metrics and diagnose issues effectively. + +==== Other Enhancements + +* Bug fixes. + +=== 2024-07-13 + +==== Workspace Enhancements + +* xref:cloud4:workgroup-workspace:workspaces/readwrite-readonly.adoc#_update_read_onlyro_workspace[Syncing Read-only Data with Read-write]: Enable synchronization of read-only data with read-write workspaces, ensuring consistency across different workspace types. + +==== Other Enhancements + +* Bug fixes. + +== Apr 2024 + +=== TigerGraph Cloud 4 (Beta) was released on Monday, April 29th, 2024. + +//* xref:cloud4:get-started:index.adoc[Get Started] using TigerGraph Cloud with the 4.0. +* xref:cloud4:overview:overview.adoc#_separation_of_storage_and_compute[Separation of Storage and Compute] - Introduction of a unique architecture that separates storage and compute, allowing users to scale resources independently. + +* xref:workgroup-workspace:workgroups/workgroup.adoc[Workgroups] and xref:workgroup-workspace:workspaces/workspace.adoc[Workspaces] give users control over resource management. + +* xref:cloud4:graph-development:load-data/index.adoc[] - Load Data into TigerGraph Cloud 4 and unlock its potential. + +* xref:cloud4:graph-development:design-schema/index.adoc[Design Schema] - Easily modify and manage the schema of your graph databases using Schema Designer UI. + +* xref:cloud4:graph-development:gsql-editor/index.adoc[GSQL Editor] - The GSQL Editor is a powerful tool for developing and executing GSQL queries, allowing you to unlock insights from your graph databases by xref:cloud4:graph-development:gsql-editor/how2-edit-gsql-query.adoc[Editing, Running, and Sharing a GSQL Query.]. + +* xref:cloud4:graph-development:explore-graph/index.adoc[] and xref:cloud4:graph-development:explore-graph/how2-use-pattern-search.adoc[] - Visualize your data and navigate to understand complex connections and dependencies. + +* xref:integrations:index.adoc[] - TigerGraph Cloud 4 offers several powerful integration tools in our marketplace. +** xref:cloud4:integrations:solutions.adoc[] - Pre-built solution kits that address common use cases and industry-specific challenges. +** xref:cloud4:integrations:add-ons.adoc[] - Extend the capabilities of TigerGraph Cloud 4 with add-ons tailored to your needs. Add-ons provide additional functionalities and integrations that enhance your graph database workflow. +*** xref:cloud4:integrations:insights.adoc[Insights Add-On] - TigerGraph Insights is a no-code visual graph analyzer that makes building data analytics dashboards intuitive. +*** xref:cloud4:integrations:graphstudio.adoc[GraphStudio™ Add-On] - TigerGraph GraphStudio™ offers a range of features and tools to simplify the graph development process. +*** xref:cloud4:integrations:graphql.adoc[GraphQL Add-On] - TigerGraph GraphQL enables users to access and modify graph data in TigerGraph using GraphQL queries. + +* xref:cloud4:administration:index.adoc[] - The tools for organizational administrators to xref:cloud4:administration:how2-invite-users.adoc[] +, xref:cloud4:administration:how2-access-mgnt.adoc[Mange Access], xref:cloud4:administration:settings/how2-use-organization-mgnt.adoc[Manage Organization]. + +* xref:cloud4:administration:billing/index.adoc[Billing UI] - The new billing UI allows users to check and pay only for their specific usage of storage, data access, and compute resources +with an xref:cloud4:administration:billing/payment-methods.adoc[easy-to-use Payment Method manager], and the xref:cloud4:administration:billing/invoices.adoc[ability to check and export invoices]. + +//// +== Fixed issues +=== Fixed and Improved [v number] + +==== Functionality +* Description (Ticket Number) + +==== Crashes and Deadlocks + +* Description (Ticket Number) + +==== Improvements + +* Description (Ticket Number) + +== Known Issues and Limitations + +[cols="4", separator=¦ ] +|=== +¦ Description ¦ Found In ¦ Workaround ¦ Fixed In + +|=== + +=== Compatibility Issues + +[cols="2", separator=¦ ] +|=== +¦ Description ¦ Version Introduced + +|=== + +=== Deprecations + +[cols="3", separator=¦ ] +|=== +¦ Description ¦ Deprecated ¦ Removed + +|=== + +== Release notes for previous versions +* TBD +//// + diff --git a/modules/cloudbeta/modules/integrations/images/billing-homecard.png b/modules/cloud4/modules/resources/images/billing-homecard.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/billing-homecard.png rename to modules/cloud4/modules/resources/images/billing-homecard.png diff --git a/modules/cloudbeta/modules/integrations/images/create-organization.png b/modules/cloud4/modules/resources/images/create-organization.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/create-organization.png rename to modules/cloud4/modules/resources/images/create-organization.png diff --git a/modules/cloudbeta/modules/integrations/images/documentation-homecard.png b/modules/cloud4/modules/resources/images/documentation-homecard.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/documentation-homecard.png rename to modules/cloud4/modules/resources/images/documentation-homecard.png diff --git a/modules/cloudbeta/modules/integrations/images/getstarted-homecard.png b/modules/cloud4/modules/resources/images/getstarted-homecard.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/getstarted-homecard.png rename to modules/cloud4/modules/resources/images/getstarted-homecard.png diff --git a/modules/cloudbeta/modules/integrations/images/referece-homecard.png b/modules/cloud4/modules/resources/images/referece-homecard.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/referece-homecard.png rename to modules/cloud4/modules/resources/images/referece-homecard.png diff --git a/modules/cloudbeta/modules/integrations/images/security-homecard.png b/modules/cloud4/modules/resources/images/security-homecard.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/security-homecard.png rename to modules/cloud4/modules/resources/images/security-homecard.png diff --git a/modules/cloudbeta/modules/integrations/images/systemmanagment-homecard.png b/modules/cloud4/modules/resources/images/systemmanagment-homecard.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/systemmanagment-homecard.png rename to modules/cloud4/modules/resources/images/systemmanagment-homecard.png diff --git a/modules/cloudbeta/modules/integrations/images/tools-page.png b/modules/cloud4/modules/resources/images/tools-page.png similarity index 100% rename from modules/cloudbeta/modules/integrations/images/tools-page.png rename to modules/cloud4/modules/resources/images/tools-page.png diff --git a/modules/cloud4/modules/resources/nav.adoc b/modules/cloud4/modules/resources/nav.adoc new file mode 100644 index 00000000..3b79737e --- /dev/null +++ b/modules/cloud4/modules/resources/nav.adoc @@ -0,0 +1,10 @@ +* xref:cloud4:resources:index.adoc[Resources] +** xref:cloud4:resources:aws.adoc[] +** xref:cloud4:resources:gcp.adoc[] +** xref:cloud4:resources:azure.adoc[] +** 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] diff --git a/modules/cloud4/modules/resources/pages/aws.adoc b/modules/cloud4/modules/resources/pages/aws.adoc new file mode 100644 index 00000000..c49b5d5f --- /dev/null +++ b/modules/cloud4/modules/resources/pages/aws.adoc @@ -0,0 +1,35 @@ += Amazon Web Services (AWS) + +TigerGraph Cloud 4 leverages Amazon Web Services (AWS) to provide reliable and scalable infrastructure. Below are the supported AWS regions where TigerGraph Cloud 4 is available. + +== Supported AWS Regions + +* US East (N. Virginia) - us-east-1 +* US East (Ohio) - us-east-2 +* US West (Oregon) - us-west-2 +* Europe (Frankfurt) - eu-central-1 +* Europe (Ireland) - eu-west-1 +* Europe (London) - eu-west-2 +* South America (Sao Paulo) - sa-east-1 +* Asia Pacific (Singapore) - ap-southeast-1 +* Asia Pacific (Sydney) - ap-southeast-2 +* Asia Pacific (Tokyo) - ap-northeast-1 + +Please contact support for any inquiries regarding additional regions. + +== Storage + +TigerGraph Cloud 4 utilizes various AWS storage services to ensure optimal performance and data management: + +https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html[Amazon Elastic Block Store (EBS)]: EBS provides high-performance block storage for use with Amazon EC2 instances. In TigerGraph Cloud, EBS is used to store system data, Kafka data, and logs, ensuring faster access and high availability for these critical components. + +https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html[Amazon Elastic File System (EFS)]: EFS offers scalable file storage for use with AWS Cloud services and on-premises resources. TigerGraph Cloud uses EFS to store graph IDS data, providing a scalable and managed file system that can grow and shrink automatically as you add and remove files. + +https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html[Amazon Simple Storage Service (S3)]: S3 provides object storage with industry-leading scalability, data availability, security, and performance. In TigerGraph Cloud 4, S3 is also utilized to store the graph data, logs, other metadata and backups, offering a highly durable and cost-effective storage solution. + +== Data Encryption +All data stored on AWS services is encrypted-at-rest using platform-managed keys to ensure data security and compliance. + +== Next Steps + +Learn how much it costs to run TigerGraph Cloud 4 on AWS in xref:cloud4:overview:pricing.adoc[]. \ No newline at end of file diff --git a/modules/cloud4/modules/resources/pages/azure.adoc b/modules/cloud4/modules/resources/pages/azure.adoc new file mode 100644 index 00000000..6d138877 --- /dev/null +++ b/modules/cloud4/modules/resources/pages/azure.adoc @@ -0,0 +1,5 @@ += Microsoft Azure + +We do not support Azure at this time, we are actively working on it. Please check back soon. + +Please refer to xref:cloud4:resources:aws.adoc[AWS] for more information. \ No newline at end of file diff --git a/modules/cloud4/modules/resources/pages/faqs.adoc b/modules/cloud4/modules/resources/pages/faqs.adoc new file mode 100644 index 00000000..8b4aba61 --- /dev/null +++ b/modules/cloud4/modules/resources/pages/faqs.adoc @@ -0,0 +1,530 @@ += TigerGraph Cloud 4 FAQs +:experimental: +:pp: {plus}{plus} + +// +*Feedback for TigerGraph Cloud 4 is welcome at* tgcloud-feedback@tigergraph.com + +== Top FAQs + +=== *Q: I can't find my registration activation email after registering for the first time. Where can I find it?* + +A: Please check your spam folder. If you can't find it in the spam folder, and still cannot receive the verification email in your mailbox after resending the verification email, please https://tigergraph.zendesk.com/hc/en-us/[open a support ticket] so that we can assist you with manual email verification process. + +=== *Q: Why don't I see a password reset email?* + +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:portal.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. +* Check your junk/spam email folder or run a search for "TigerGraph" in case the email automatically got filtered to another inbox. +* Double-check the email address you entered to make sure it matches the one you signed up with. + +If you're still unable to log in or reset your password, contact TigerGraph Support at support@tigergraph.com for individualized help with your issue. + +=== *Q: How does TigerGraph Cloud 4 compare with other DBaaS offerings?* + +A: TigerGraph Cloud 4 offers unique advantages such as a graph-native architecture, high performance for complex queries, and features like separation of storage and compute, which are optimized for graph analytics. +TigerGraph Cloud 4 stands out among Database-as-a-Service (DBaaS) offerings due to its unique features and capabilities tailored specifically for graph analytics. Here are some key aspects where TigerGraph Cloud 4 excels: + +* Graph-Native Architecture: Unlike traditional DBaaS offerings that are built on relational or NoSQL databases, TigerGraph Cloud 4 is designed from the ground up for graph analytics. This ensures high performance and efficiency for complex graph queries. +* Real-Time Analytics: TigerGraph Cloud 4 supports real-time graph analytics, allowing you to derive insights from your data as it changes. +* Solution Kits Support: TigerGraph Cloud 4 offers a variety of solution kits tailored for specific use cases such as fraud detection, recommendation engines, and supply chain optimization. These kits come with pre-configured schemas, data, and queries to help you get started quickly. +* Add-Ons and Features +** GraphStudio™: An intuitive visual interface for designing, querying, and exploring your graph data. GraphStudio™ simplifies the process of building and managing your graph database. +** Insights: Advanced analytics tools that provide deeper insights into your graph data. Insights help you visualize patterns, trends, and anomalies within your data. +* Monitoring and Alerting +** Built-In Monitoring Tools: TigerGraph Cloud 4 includes comprehensive monitoring tools that provide real-time insights into the performance, usage, and health of your graph database. +** Alerting: Set up custom alerts to notify you of important events such as performance degradation, resource utilization thresholds, and system errors. +* Expansion and Shrink +** Scalability: Easily scale your TigerGraph Cloud 4 instances up or down based on your workload requirements. This includes adding or removing nodes and adjusting disk sizes. +** Elasticity: TigerGraph Cloud 4 supports schduled scaling, allowing you to automatically adjust resources by pre-defined schdule. +* User Management +** Role-Based Access Control (RBAC): Manage user permissions and access with fine-grained control. Assign roles to users based on their responsibilities and ensure secure access to your graph database. +** Single Sign-On (SSO) Integration: Integrate TigerGraph Cloud 4 with your existing SSO system for streamlined user authentication and management. +* Read-Write and Read-Only Workspaces +** Workspace Management: Create and manage multiple workspaces within a single TigerGraph Cloud 4 account. Assign read-write or read-only permissions to users based on their roles. +** Isolation: Ensure data isolation and security by managing access at the workspace level. +* Additional Features +** Automated Backups: Schedule automated backups to ensure data protection and recovery. +** High Availability: Deploy your graph database across multiple nodes to ensure high availability and reliability. +** Data Encryption: Support for encryption of data in transit and at rest to ensure data security. +** Integration with Cloud Storage: Import and export data using popular cloud storage solutions like Amazon S3, Azure Blob Storage, and Google Cloud Storage. +** RESTful API: Access and interact with your graph database using a comprehensive RESTful API. +* Competitive Edge +** Performance: TigerGraph Cloud 4 is optimized for high performance, handling complex queries and large datasets efficiently. +** Flexibility: Support for various deployment options. +** Community and Support: Access to a vibrant community of users and dedicated support from TigerGraph experts. + +In summary, TigerGraph Cloud 4 offers a robust, scalable, and high-performance graph database solution with a wide range of features and tools that set it apart from other DBaaS offerings. Whether you are looking for advanced analytics, ease of use, or scalability, TigerGraph Cloud provides the capabilities you need to succeed. + +[#q-are-there-free-tier-instances-or-free-credits-for-the-system] +=== *Q: Are there Free Tier Instances or Free Credits for the System?* + +A: There are free credits but no free instances at TigerGraph Cloud 4. You can complete the onboarding tasks to get free credits to get started without paying anything. + + +=== *Q: In what cloud platforms and regions does TigerGraph Cloud 4 operate?* + +A: TigerGraph Cloud 4 currently only operates on xref:cloud4:resources:aws.adoc[]. We are actively working on expanding to xref:cloud4:resources:gcp.adoc[] and xref:cloud4:resources:azure.adoc[]. Visit each platform's reference page to learn more about the available regions. + +=== *Q: Can I choose different versions of TigerGraph on TigerGraph Cloud 4?* + +A: Yes, TigerGraph Cloud 4 allows you to choose from different versions of TigerGraph during the workspace setup process. +For security and stability reasons, only some legacy versions are available. +There is no difference in cost for using different versions of TigerGraph. + +=== *Q: Does TigerGraph Cloud support distributed databases?* + +A: Yes, TigerGraph Cloud supports distributed databases, allowing you to scale your graph database across multiple nodes for improved performance and reliability. The partition factor is automatically defined based on your data size. You can also set up High Availability (HA), which adds a replication factor of 2 or 3 during the workspace setup process. For workspaces TG-8 and below, the replication factor is set to 3 if HA is enabled. For TG-16 and above, the replication factor is set to 2 if HA is enabled. + +=== *Q: What type of server should I use for my data size and workload?* + +A: The type of server you need depends on your data size and workload requirements. Please see the section on pricing on our website at our link:https://www.tigergraph.com/cloud/[TigerGraph Cloud main page]. For further assistance, contact TigerGraph at link:mailto:sales@tigergraph.com[sales@tigergraph.com] + + +=== *Q: What kind of services do I get?* + +A: TigerGraph Cloud 4 includes automatic scheduled backup, built-in encryption and other security features, patching, replication and distributed database option. In addition, you can now provision a distributed database as well as a replica cluster for high availability. +As a cloud service, many of the administrative and operational tasks - for monitoring, restoring, upgrading, for example - are just a click away. +In addition to operations and management for your TigerGraph databases, TigerGraph Cloud 4 also offers Solution Kits to provide instant experience to various graph analytics use cases. +The list of Solution Kits can be found here: link:https://www.tigergraph.com/solutions/[TigerGraph Cloud Solutions] + +[#q-is-there-a-quota-for-the-number-of-workspaces-i-can-create-in-a-single-account] +=== *Q: Is there a quota for the number of workspaces I can create in a single account?* + +A: Yes. For details, please refer to the xref:cloud4:resources:quota_policy.adoc[]. + +To allow more workspaces, please contact TigerGraph at link:mailto:sales@tigergraph.com[sales@tigergraph.com]. + +=== *Q: Can I run queries directly after sample solution kits are installed/provisioned?* + +A: Yes, you can run queries directly after provisioning sample solution kits. These kits come pre-configured with sample data and queries to help you get started quickly. Some of the solutions also come with one or two Insights applications. + +Please visit our link:http://tigergraph.com/solutiions/[TigerGraph Cloud Solutions] page to watch the overview video for each solution. + + +=== *Q: How can I monitor my TigerGraph Cloud service?* + +A: You can monitor your TigerGraph Cloud service using the built-in monitoring tools provided in the TigerGraph Cloud portal. These tools offer insights into performance, usage, and system health. + +See TigerGraph's xref:cloud4:workgroup-workspace:workgroups/monitor-workspaces.adoc[Monitor Workspace] for more detailed information. + + +=== *Q: Is TigerGraph Cloud cloud-agnostic?* + +A: While TigerGraph Cloud 4 currently operates on xref:cloud4:resources:aws.adoc[] only, we are actively developing support for xref:cloud4:resources:gcp.adoc[] and xref:cloud4:resources:azure.adoc[]. It is not entirely cloud-agnostic as it leverages specific services and integrations from these cloud providers. If you require immediate assistance managing TigerGraph on another cloud provider, please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com]. + + +=== *Q: Is the support for TigerGraph Cloud the same as the support for TigerGraph Enterprise?* + +A: Yes, TigerGraph supports TigerGraph cloud 4 users using paid/premium/enterprise tiers. See the Support Policy terms at link:https://www.tigergraph.com/support-policy/[www.tigergraph.com/support-policy]. +Support is not included for free tier users; therefore, support tickets for free tier users are answered when support staff bandwidth allows. +See Section 1.4 in link:https://www.tigergraph.com/tigergraph-cloud-subscription-terms/[www.tigergraph.com/tigergraph-cloud-subscription-terms]. +For additional developer resources for free tier users, join the TigerGraph developer community at link:https://community.tigergraph.com[community.tigergraph.com]. + + +=== *Q: What is the user interface for the TigerGraph Cloud 4?* + +A: The TigerGraph Cloud 4 portal provides a browser-based interface that makes it easy to manage, monitor, and operate your graph database. Through this portal, you can load data, design schemas, write queries, and explore your graph. Additionally, you have access to a suite of add-ons, including the TigerGraph xref:gui:graphstudio:overview.adoc[GraphStudio™ UI (User Interface)] and TigerGraph xref:insights:intro:index.adoc[Insights]. + +=== *Q: What graph query language does TigerGraph support?* + +A: TigerGraph uses GSQL, the query language designed for fast and scalable graph operations and analytics. GSQL's similarity to SQL, high-level syntax, Turing completeness, and built-in parallelism brings faster performance, faster development and the ability to describe any algorithm. + +You can start learning GSQL from our xref:3.5@gsql-ref:tutorials:gsql-101/index.adoc[GSQL tutorials]. We also support a RESTful API and JSON output for easy integration with application languages like Python, Java, and C{pp}. + +Start learning GSQL and become a TigerGraph Certified Associate today with our link:https://www.tigergraph.com/certification/[Certification Program]. + + +=== *Q: Can I have multiple graphs in one TigerGraph Cloud instance?* + +A: Yes. If you use V3.0.5+ in TigerGraph Cloud, MultiGraph is supported through GraphStudio™. Please refer to our xref:gui:graphstudio:design-schema.adoc[] page for the new MultiGraph Support through GraphStudio™. + +=== *Q: What methods do you support for importing data?* + +A: We support loading data from Amazon S3, Google Cloud Storage, Azure Blob Storage, local files and many more data sources. Please refer to xref:cloud4:graph-development:load-data/index.adoc[]. + +For complex loading jobs through GSQL Editor for paid tier clusters, please submit a support ticket from your cloud portal for more information. + +=== *Q: How do I develop a customized application on top of TigerGraph Cloud?* + +A: Please see https://info.tigergraph.com/graph-gurus-24[Graph Gurus episode 24], where we presented "How to Build Innovative Applications with a Native Graph Database". + + +=== *Q: Can I upgrade from V2.x, V3.x to V4.x?* + +A: TigerGraph Cloud 4 only support TigerGraph database version 4.0.0 and above. If you are using an older version, you can migrate your data to a new workspace with the latest version. Please submit a support ticket from your cloud portal for more information. + +== Pricing + +See xref:cloud4:overview:pricing.adoc[Pricing] for detailed information. + +=== *Q: What billing models are available?* +A: TigerGraph Cloud 4 offers different billing models and pricing options to accommodate various usage scenarios and customer needs. The available billing models include: + +* Pay-as-you-go: This model allows you to pay for the resources you consume on an hourly basis. You are charged based on the number and type of workspaces you use, the storage capacity you require, and the additional services you purchased. Pay-as-you-go provides flexibility as you can scale resources up or down based on your usage patterns. +* Prepaid: The prepaid model allows you to purchase credits in advance, which can be used to cover the costs of your TigerGraph Cloud usage. With prepaid credits, you have the advantage of predictable costs and the ability to allocate resources as needed within the prepaid budget. Please contact sales@tigergraph.com for more information on prepaid credits. + +For more information on pricing and billing models, please refer to the xref:cloud4:overview:pricing.adoc[Pricing] page. + +=== *Q: Do you offer a discount for annual contracts/commitments?* + +A: Yes, there is a discount for contracting with TigerGraph for a one-year term. Please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com] to request your discount. + +=== *Q: Can I purchase credits?* + +A: Yes. You can purchase credits applied to TigerGraph Cloud usage. Please refer to https://www.tigergraph.com/cloud-credits/ + + +=== *Q: If I delete my workspace before the end of the month, what will I have to pay?* + +A: If you are subscribed to our standard hourly service, you will be charged only for your hours of use. + + +=== *Q: If I add a workspace mid-month, when do I start paying for it?* + +A: We bill you and charge your credit card at the end of each calendar month. + + +=== *Q: If I have a billing problem that I can't solve online, how do I contact you?* + +A: You can either open a support ticket from the cloud portal by clicking "`Support`" on the menu at the left of the page, or you can send an email to link:mailto:billing@tigergraph.com[billing@tigergraph.com]. + + +=== *Q: What happens if my monthly costs exceed the credit limit on my credit card?* + +A: If this happens you can contact link:mailto:sales@tigergraph.com[sales@tigergraph.com] and we will provide you with other payment options. + + +=== *Q: Where can I find TigerGraph's terms and conditions for its products and services?* + +A: You can find our terms and conditions here: http://www.tigergraph.com/terms[www.tigergraph.com/terms]. + + +=== *Q: How is TigerGraph Cloud priced for development, test, or QA environments?* + +A: With TigerGraph Cloud, you only pay for what you use. For long term contracts, please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com]. + +== Sizing and Scaling + + +=== *Q: How do I determine the instance needed for my workload?* +A: To determine the appropriate instance for your workload, follow these guidelines: + +* **Check Available Instance Types:** Refer to xref:index.adoc[] to see the instance types offered by each cloud provider in each region. Larger graphs require more RAM, while higher performance necessitates both more CPUs and more RAM. +* **Use the Pricing Table:** Our xref:cloud4:overview:pricing.adoc[pricing table] provides initial recommendations for which instance to start with based on the amount of data you plan to load into the graph. This input data is referred to as your "raw data." TigerGraph reorganizes your data into a graph, encoding and compressing it. Typically, the stored graph will be about 70% of the size of your raw data, although this is a conservative estimate and it’s often smaller. +* **Consider RAM Requirements:** In addition to storage, you need sufficient RAM for graph querying and computation. Different applications of TigerGraph can require varying amounts of RAM. We recommend that your total RAM be about 1.5 times the maximum amount of raw data you expect to load. +* **Scale as Needed:** If you find you need more space or compute power, you can easily scale up your instance. +* **Use Tools for Assistance:** +** xref:cloud4:workgroup-workspace:workspaces/settings.adoc#_workspace_size_suggestion[Workspace Size Suggestion]: This tool helps you determine the appropriate instance size for your workload. +** xref:cloud4:overview:cost-estimation.adoc[Cost Estimation]: This tool helps you estimate the cost of your TigerGraph Cloud environment. + +For additional assistance, you can submit a support ticket through the TigerGraph Cloud Portal or https://tigergraph.zendesk.com/hc/en-us/[from Zendesk]. + +=== *Q: How do I expand the disk size?* + +There is no need to expand the disk size on TigerGraph Cloud 4, since the graph data is stored separately from the instance. You can scale up your instance to a larger size if you need more RAM or CPU power. + + +=== *Q: Can I migrate my database to a larger (or smaller) workpace?* + +A: Yes, you can just expand or shrink your existing workspace. To do this, simply edit your workspace settings as described in the xref:cloud4:workgroup-workspace:workspaces/settings.adoc[] documentation. Alternatively, you can set up an expand/shrink operation on a predefined schedule by following the instructions in the xref:cloud4:workgroup-workspace:workspaces/schedule.adoc[] documentation. + +=== *Q: Can I deploy a distributed TigerGraph database across a cluster of instances?* + +A: Yes, you can provision a distributed database in TigerGraph Cloud 4. Please refer to the xref:cloud4:workgroup-workspace:workspaces/workspace-size.adoc[] documentation for more information. + +== Hardware + + +=== *Q: What type of disks are attached to the provisioned TigerGraph Instances?* + +A: The provisioned TigerGraph instances have the following disk configurations: + +Root Disk: EBS (Elastic Block Store) based root disks is attached to the TigerGraph workspace. +Graph Data Storage: The graph data is stored in EFS (Elastic File System) and S3 (Simple Storage Service). + +=== *Q: What browsers are supported?* + +A: As of Oct 2024, TigerGraph Cloud 4 is certified on the following browsers: + +|=== +|Chrome |Safari |Firefox |Edge + +|Version 107.0.5304.107 (Official Build) (arm64) +|Version 15.4 (17613.1.17.1.13) +|Version 106.0.3 +|Version 107.0.1418.42 (Official build) (arm64) +|=== + + +Not all features are guaranteed to work on other browsers. +Please make sure to enable JavaScript and cookies in your browser settings. + + + +== Provisioning, Backup and Restore + + +=== *Q: What is a workgroup, workspace, database?* + +A: In TigerGraph Cloud 4, the concepts of workgroup, workspace, and database are used to organize and manage projects and data within the platform. Here's a breakdown of each term: + +* Workgroup: A workgroup represents a project or a logical group within TigerGraph Cloud. It serves as a container that holds multiple workspaces and databases related to a specific use case, team, or application. Workgroups provide a way to organize and manage resources, access controls, and configurations for a particular project or initiative. +* Workspace: A workspace is a compute unit within a TigerGraph database. It is where the graph processing and analytics take place. TigerGraph Cloud 4 supports two types of workspaces: read-write workspaces and read-only workspaces. +** Read-write workspaces: These workspaces allow read and write operations on the graph data. They are typically used for data ingestion, data updates, and running queries that modify the graph structure or properties. +** 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. +* Database: The database in TigerGraph Cloud 4 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. We only support a maximum of one ready-write workspace to connect to a database. + +By utilizing workgroups, workspaces, and databases, TigerGraph Cloud 4 provides a flexible and scalable environment for managing projects, allocating compute resources, and working with graph data effectively. 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. + + + +=== *Q: Is there a warm-up period for TigerGraph workspaces?* + +A: When you provision or restart a workspace, there will be a warm-up period for the workspace. +The larger the data size and the greater the size of workspace, the longer the warm-up period will be. + + +=== *Q: What is the difference between stopping, pausing, and terminating a workspace?* + +A: + +Stopping a Workspace: + +* **Action**: Shuts down the workspace without listening to incoming requests. +* **State**: The TigerGraph database is frozen in its current state. +* **Billing**: Billing for the machine instance stops, but you will still incur charges for disk storage and backups. +* **Backups**: Scheduled backups stop, but existing backup copies are kept in storage. +* **Recovery**: You can start the workspace again, and after a warmup period, it will return to its previous state. + +Pausing a Workspace: + +* **Action**: Suspends the workspace but listening to incoming requests. +* **State**: The TigerGraph database is frozen in its current state. +* **Billing**: Billing for the machine instance stops, but you will still incur charges for disk storage and backups. +* **Backups**: Scheduled backups stop, but existing backup copies are kept in storage. +* **Recovery**: The workspace will resume automatically if incoming requests are detected or can be manually started. After a warmup period, it will return to its previous state. + +Terminating a Workspace: + +* **Action**: Deprovisions the workspace and the attached disk space. +* **State**: The workspace and all its data are deleted according to the cloud platform's policies. +* **Billing**: All associated billing stops, including for the virtual machine instance, disk storage, and backups. +* **Backups**: We will keep the latest backup in storage for 15 days and then delete. +* **Recovery**: The workspace cannot be recovered once terminated. + +In summary: + +* **Stopping**: Shuts down the workspace but keeps data and backups; can be restarted. +* **Pausing**: Suspends the workspace while still listening for requests. +* **Terminating**: Completely deletes the workspace and its data; cannot be recovered. + +=== *Q: Do you offer backup in TigerGraph Cloud?* + +A: Yes. Please see our guide for using xref:cloud4:workgroup-workspace:workgroups/backup-and-restore.adoc[] in the TigeGraph Cloud 4 Portal. + + +=== *Q: What backup options are available?* + +A: TigerGraph Cloud offers full backups on a scheduled or on-demand basis. +By default, backup is turned on when instances are running and will be done daily. +There are four backup schedules you can choose from: daily, weekly, monthly, and ad hoc. +Please refer to the xref:cloud4:workgroup-workspace:workgroups/backup-and-restore.adoc[] documentation for more information. You can also check the quota policy for the backup in the xref:cloud4:resources:quota_policy.adoc[Quota Policy] documentation. + +=== *Q: Can I restore from a backup from another workspace in my account?* + +A: Cross workspace restore is not supported yet. Contact TigerGraph Support to restore from another workspace backup. + + +=== *Q: What happens to my automated backups if I terminate my workspace?* + +A: We will keep the latest backup for 15 days and then delete. +Within that 15 days, you may use your backup to restore into another similar cluster if it is a single server cluster. +To restore a cluster within 15 days, please submit a support ticket through the cloud portal. + + +=== *Q: How soon can I restore from a backup that I just made?* + +A: After you perform a backup, you should wait at least 15 minutes. + + +=== *Q: How can I delete my TigerGraph Cloud account?* + +A: Please submit a support ticket through the cloud portal. + +== High Availability and Replication + + +=== *Q: What kind of replicas does TigerGraph Cloud support?* + +A: TigerGraph Distributed Cloud offers active-active replication for increased availability and automatic failover. + +A TigerGraph system with High Availability (HA) is a cluster of server machines which uses replication to provide continuous service when one or more servers are not available or when some service components fail. +TigerGraph HA service provides loading balancing when all components are operational, as well as automatic failover in the event of a service disruption. + +[#q-what-is-the-replication-factor] +=== *Q: What is the replication factor?* + +A: Replication factor means how many copies of data are stored, each on a separate machine. +You can enable HA, which adds a replication factor of 2 or 3 for your workspace. For workspaces TG-8 and below, the replication factor is set to 3 if HA is enabled. For TG-16 and above, the replication factor is set to 2 if HA is enabled. + +[#q-what-is-the-partition-factor] +=== *Q: What is the partition factor?* + +A: Partition factor means the number of parts or components your graph data is split into, which also equals the number of instances that collectively store one copy of the full graph. +For example, if you select a partition factor of 3, each instance will hold approximately 1/3 of your data. +Please read the xref:tigergraph-server:cluster-and-ha-management:ha-cluster.adoc[] documentation for additional details about partitions and replications. For the partition factor for each workspace size, please refer to the xref:cloud4:workgroup-workspace:workspaces/workspace-size.adoc[] documentation. + +[#q-what-is-the-difference-between-replication-and-partition] + + +=== *Q: How long do I need to wait for the cluster to be ready after provisioning process starts?* + +A: It currently takes about 4 minutes to provision a workspace. It might take longer for Read-Only workspaces or Read-Write workspaces with a solution kit selected. + +== Network, Security and User Management + +=== *Q: Does TigerGraph Cloud support encrypting my data in transit and at rest?* + +A: Yes, TigerGraph Cloud encrypts all data in transit and at rest. + + +=== *Q: Am I sharing data storage with other customers? Is TigerGraph a multi-tenant cluster?* + +A: You are not sharing storage with other customers. For compute resources: + +* TG-2 and below: You share the virtual machine with other customers, but the TigerGraph database runs as containers, which are completely isolated from each other. Your data storage remains secure and isolated. +* TG-4 and above: Each TigerGraph workspace is provisioned as one or more dedicated virtual machine instances of the TigerGraph engine, used exclusively for your account. These instances come with their own dedicated disk space, ensuring that no two accounts share the same TigerGraph database. + +Additionally, the network is completely isolated per workgroup, providing an extra layer of security and ensuring that your network traffic is segregated from that of other customers. + +This approach guarantees that your data and network remain private and secure, regardless of the compute resource tier you are using. + +=== *Q: How do I access my TigerGraph Cloud 4 account (e.g., username and password)?* + +A: When you register your account, you can select either a username and password or Google SSO for authentication. You can then log in anytime at link:http://portal.tgcloud.io/[portal.tgcloud.io]. We also support Okta and AAD integration. If you are a paid tier customer, please submit a support ticket to request advanced service to integrate into an SSO system TigerGraph supports. + +=== *Q: How do I access my TigerGraph database and POST to TigerGraph?* + +A: You can access the database through the TigerGraph Cloud 4 portal, TigerGraph GraphStudio™ visual interface and through RESTful endpoints. Use RESTful endpoints to POST to TigerGraph clusters and develop applications. Please refer to the xref:tigergraph-server:API:index.adoc[RESTful API User Guide] for more information. To find the RESTful endpoints for queries created in GraphStudio™, please read our documentation on xref:gui:graphstudio:write-queries.adoc[showing query endpoints]. There is also a recorded webinar which demos the process in detail: link:https://info.tigergraph.com/graph-gurus-24[Graph Gurus Episode 24] + +*Here is the step-by-step instructions:* + +TigerGraph cloud enables xref:tigergraph-server:API:authentication.adoc[REST{pp} Authentication] to securely connect TigerGraph Cloud clusters with your application through an endpoint on port 443 at `443/restpp/`. + + +*Step 1:* (First time only) Navigate to the TigerGraph cluster's Admin Portal, and generate a secret from User Management. + +For example, the URL for the cluster is: + +[source,text] +---- +https://SOLUTIONID.i.tgcloud.io:443/admin/#/user-management +---- + +and the generated secret is `abcd1234` from the Admin Portal. + +*Step 2:* (Need to renew every lifetime) Use the secret generated in step 1 to get a RESTPP token (for example, xyz789) using `curl`. Access RESTPP endpoints on port 443 using the syntax `443/restpp/`. + +Here is an example where you obtain a token with a lifetime of 1,000,000 seconds (11 days): + +[source,text] +---- +curl -X POST 'https://SOLUTIONID.i.tgcloud.io:443/restpp/requesttoken -d '{"secret"="abcd1234", "lifetime"="1000000"}' +---- + +[source,text] +---- +{ + "code":"REST-0000", + "expiration":1570727825, + "error":false, + "message":"Generate new token successfully.", + "token":"xyz789" +} +---- + +*Step 3:* Now in your application, use the token in the REST call as follows: + +[source,text] +---- +curl -X GET -H "Authorization: Bearer xyz789" 'https://SOLUTIONID.i.tgcloud.io:443/restpp/graph/MyGraph/vertices/Account?limit=3' +---- + + +=== *Q: Does TigerGraph Cloud offer Role Based Access Control?* + +A: TigerGraph's role-based access control with MultiGraph and User Management is available if you use TigerGraph V3.0.5+. + + +=== *Q: What happens to my data if I terminate an instance or if my account is closed?* + +A: When you terminate an instance in TigerGraph Distributed Cloud, the virtual machine instance and its associated storage volume are deleted according to the policies of the underlying cloud infrastructure vendor. + + +=== *Q: How does TigerGraph Cloud secure my data?* + +A: TigerGraph Cloud encrypts data at rest and in transit, and SSL is enabled for secure access. + + +=== *Q: Can I integrate TigerGraph Cloud into my single sign on system?* + +A: The ability to use cloud portal to integrate TigerGraph Cloud into an SSO system will be provided at a future date. +If you are a paid tier customer, please submit a support ticket to request advanced service to integrate into an SSO system TigerGraph supports. + +// == Upgrade + + +// === Q: Can I upgrade TigerGraph version on my cluster? + +// A: For free tier clusters, upgrading is not supported unless you are migrating to paid tier clusters. +// If you want to change the database version in your free tier, you can terminate the existing free tier cluster, and create a new free tier with the new version. +// In each TigerGraph Cloud account, you can have one free tier cluster. +// If you want to migrate to paid tier clusters, please send a support ticket through your cloud portal. + +// For paid tier clusters, please submit a support ticket for upgrade assistance. +// Downtime is expected during this upgrade. +// It is recommended to create a new blank cluster, import your data and copy the GSQL queries to test and experiment before upgrading your production instance. + +== TigerGraph Cloud Support + + +=== *Q: How do I submit a support ticket?* + +A: In your cloud portal, on the navigation menu, you can submit the support ticket by clicking on the btn:[ Support ] on the lower left corner. + +This will generate a support ticket in TigerGraph's Zendesk support system. +You can track the ticket status in Zendesk. + + +=== *Q: How do I submit a support ticket if I cannot access the Cloud Portal?* + +A: If in rare cases, you cannot submit TigerGraph Cloud support tickets through the cloud portal for your account, you can also https://tigergraph.zendesk.com/hc/en-us/[open a support ticket] from Zendesk. +This action automatically generates a new Zendesk support ticket, and you can track the support ticket in the Freshdesk portal. + +== Performance + + +=== *Q: Is TigerGraph built on a NoSQL database or a relational database?* + +A: TigerGraph is a native parallel graph database built on C{pp}. It is not built on a NoSQL database or relational database. + + +=== *Q: How can I monitor the speed or throughput of queries and data loading?* + +A: You can monitor the loading speed on the xref:cloud4:graph-development:load-data/index.adoc[] page. For query perormance, you can use the monitoring tools in the xref:cloud4:workgroup-workspace:workgroups/monitor-workspaces.adoc[] page. + +=== *Q: How can I improve the speed of my system?* + +A: Due to TigerGraph's massively parallel and hybrid in-memory database design, an instance with more vCPUs and more memory will usually run faster. +For a given hardware configuration, performance can be improved by optimizing graph schema, loading jobs, and queries. +In TigerGraph Distributed Cloud, you can also choose to provision a cluster with replication factor 2 to increase throughput. +Contact link:mailto:sales@tigergraph.com[sales@tigergraph.com] to discuss query optimization services. + + +=== *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[]. +// diff --git a/modules/cloud4/modules/resources/pages/gcp.adoc b/modules/cloud4/modules/resources/pages/gcp.adoc new file mode 100644 index 00000000..fe7b1728 --- /dev/null +++ b/modules/cloud4/modules/resources/pages/gcp.adoc @@ -0,0 +1,5 @@ += Google Cloud Platform (GCP) + +We do not support GCP at this time, we are actively working on it. Please check back soon. + +Please refer to xref:cloud4:resources:aws.adoc[AWS] for more information. \ No newline at end of file diff --git a/modules/cloudbeta/modules/resources/pages/glossary.adoc b/modules/cloud4/modules/resources/pages/glossary.adoc similarity index 82% rename from modules/cloudbeta/modules/resources/pages/glossary.adoc rename to modules/cloud4/modules/resources/pages/glossary.adoc index 83e5e402..f3816f58 100644 --- a/modules/cloudbeta/modules/resources/pages/glossary.adoc +++ b/modules/cloud4/modules/resources/pages/glossary.adoc @@ -29,6 +29,13 @@ One virtual machine or virtual server. An internal TigerGraph characteristic of a TigerGraph cluster that determines how the data in the database will be distributed +== read-only workspace + +A workspace where only read operations are allowed. It is optimized for read-intensive operations. + +== read-write workspace + +A workspace that allows read and write operations on the graph data. == replication factor @@ -75,6 +82,14 @@ A network between two VPCs allowing instances to communicate as if they are on t A browser-accessible command line for running GSQL commands on a TigerGraph Cloud cluster. +== workgroup + +A workgroup represents a project or a logical group within TigerGraph Cloud. It serves as a container that holds multiple workspaces and databases related to a specific use case, team, or application. + +== workspace + +A workspace is a compute unit within a TigerGraph database. + //== data topology size //data topology size check diff --git a/modules/cloud4/modules/resources/pages/index.adoc b/modules/cloud4/modules/resources/pages/index.adoc new file mode 100644 index 00000000..be376769 --- /dev/null +++ b/modules/cloud4/modules/resources/pages/index.adoc @@ -0,0 +1,36 @@ += Resources +:experimental: + +Resources provide other documents to help support your TigerGraph Cloud 4 journey. + +== xref:resources:glossary.adoc[] + +Here you can refer terms used in TigerGraph Cloud 4. + +== xref:resources:support.adoc[] + +Here you can learn how to get support. + +== xref:resources:faqs.adoc[] + +Here you can find answers to frequently asked questions. + +== xref:resources:aws.adoc[] + +Here you can learn about Amazon Web Services (AWS). + +== xref:resources:gcp.adoc[] + +Here you can learn about Google Cloud Platform (GCP). + +== xref:resources:azure.adoc[] + +Here you can learn about Microsoft Azure. + +== Policy Documents + +If you are a participating TigerGraph Cloud 4 user, please review our policy documents: + +* xref:quota_policy.adoc[TigerGraph Cloud 4 Subscription Plans and Quota Policy] + + diff --git a/modules/cloud4/modules/resources/pages/quota_policy.adoc b/modules/cloud4/modules/resources/pages/quota_policy.adoc new file mode 100644 index 00000000..98895fd7 --- /dev/null +++ b/modules/cloud4/modules/resources/pages/quota_policy.adoc @@ -0,0 +1,48 @@ += TigerGraph Cloud 4 Subscription Plans and Quota Policy + +== Objective +This document aims to provide customers with a clear understanding of the various subscription plans available, along with their associated resource allocations and limitations. It ensures customers can make informed decisions about their usage and upgrade options, enabling them to manage their resources and costs effectively while leveraging the full potential of TigerGraph Cloud. + +[IMPORTANT] +This policy is subject to review and adjustment at the discretion of TigerGraph's management based on feedback from the user community and evolving business needs. + +== Subscription Plans +TigerGraph Cloud offers four distinct subscription plans to cater to various customer needs: + +- **Free** +- **Paid** +- **Premium** +- **Enterprise** + +== Policy Details +The following table outlines the quotas and limits associated with each subscription plan: + +[cols="5", separator=| ] +|=== +| **Subscription Plan** | **Free** | **Paid** | **Premium** | **Enterprise** +| **Maximum Supported TGSize** | TG-4 | TG-16 | TG-32 | TG-64 (Customizable) +| **RW Workspace Quota (Per Account)** | 1 | 2 | 3 | 4 (Customizable) +| **RO Workspace Quota (Per Account)** | 2 | 3 | 5 | 7 (Customizable) +| **Maximum Memory Size (GiB)** | 768 | 5,120 | 16,384 | 32,768 (Customizable) +| **Manual Backup Quota (Per Read-Write Workspace)** | 1 | 1 | 3 | 5 (Customizable) +| **Auto Backup Quota (Per Read-Write Workspace)** | N/A | 3 | 7 | 7 (Customizable) +| **Suspend Grace Period (Days)** | 0 | 1 | 3 | 7 +| **Terminate Grace Period (Days)** | 7 | 7 | 14 | 28 +| **Support** | Business hour email support | Business hour email support | Premium support | Dedicated account manager, 24/7 premium support +|=== + +=== Explanation of Terms + +- **Monthly Usage Limit**: The maximum amount a customer can be charged for service usage within a month before additional actions are required. +- **Maximum Supported TGSize**: The largest TigerGraph workpace size supported. +- **RW Workspace Quota (Per Account)**: The number of Read-Write workspaces allowed per account. +- **RO Workspace Quota (Per Account)**: The number of Read-Only workspaces allowed per account. +- **Maximum Memory Size (GiB)**: The total memory allocation per subscription/orgnization. +- **Manual Backup Quota (Per Read-Write Workspace)**: The number of manual backups allowed per Read-Write workspace. +- **Auto Backup Quota (Per Read-Write Workspace)**: The number of automated backups allowed per Read-Write workspace. +- **Suspend Grace Period (Days)**: The number of days a workspace can be suspended before termination. +- **Terminate Grace Period (Days)**: The number of days before a suspended workspace is terminated. +- **Support**: The type of customer support provided. + +[NOTE] +Please contact us at sales@tigergraph.com if you have questions about the plan or need a custom plan. diff --git a/modules/cloudbeta/modules/resources/pages/support.adoc b/modules/cloud4/modules/resources/pages/support.adoc similarity index 52% rename from modules/cloudbeta/modules/resources/pages/support.adoc rename to modules/cloud4/modules/resources/pages/support.adoc index f2d98a30..fa31ad6d 100644 --- a/modules/cloudbeta/modules/resources/pages/support.adoc +++ b/modules/cloud4/modules/resources/pages/support.adoc @@ -1,9 +1,3 @@ -= Support -:experimental: - -== Contact Us -If you have any questions, please contact us at beta-support@tigergraph.com. - //Look to the terms and conditions //Email the address //Create a ticket @@ -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. -//// \ No newline at end of file +//// + += 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. \ No newline at end of file diff --git a/modules/cloud4/modules/resources/pages/terms_condition_beta.adoc b/modules/cloud4/modules/resources/pages/terms_condition_beta.adoc new file mode 100644 index 00000000..4d96bb9e --- /dev/null +++ b/modules/cloud4/modules/resources/pages/terms_condition_beta.adoc @@ -0,0 +1,84 @@ += Beta Program Terms and Conditions for TigerGraph Cloud 4 + + + +== Effective Date: Apr 23, 2024 + +These Terms and Conditions of the Beta Program for TigerGraph Cloud 4 ("Terms") constitute a legal agreement between *You* or the entity You are authorized to represent and bind to these terms (“You” or “Your”) and TigerGraph, Inc. ("TigerGraph", "We") and govern Your participation in the Beta Program for TigerGraph Cloud 4 ("Beta Program"). + +[IMPORTANT] +==== +Please read these Terms carefully. +==== + +=== 1) Beta Offering +The Beta Program provides You access to the TigerGraph Cloud 4 Beta software service ("Beta Offering"), a pre-production release, for testing and providing feedback to TigerGraph. +The Beta Offering is provided on an "as is" and "as available" basis for a limited time. +You may access the Beta Offering via a designated portal which is separate from TigerGraph's production and general commercial offerings. +You may not use the Beta Offering in production or for commercial purposes. + +=== 2) Acceptance of Terms +By accessing or using the Beta Offering, You confirm that You have read, understood, and agree to be bound by these Terms. +You also agree to use the Beta Offering in accordance with the TigerGraph Cloud Subscription Terms, which are available on our website at https://www.tigergraph.com/tigergraph-cloud-subscription-terms/ and are incorporated by reference. +The Terms control over any inconsistent provisions with the TigerGraph Cloud Subscription Terms. + +If You do not agree with these Terms or the TigerGraph Cloud Subscription Terms, You are not permitted to access or use the Beta Offering. + +=== 3) Participation + +* *Eligibility*: Participation in the Beta Program is voluntary and is open only to selected participants who agree to these Terms. +At our sole discretion, we reserve the right to reject access or revoke access for any participant at any time. + +* *Registration*: You may be required to register for an account and provide accurate and complete information. +You agree to keep Your account credentials confidential and not to share them with other parties. +The active use of computational resources for the use of the Beta Offering in TigerGraph Cloud 4 consumes TigerGraph Cloud credits. +TigerGraph will grant Your Beta Program account a number of no-charge credits. +If You use all the credits, contact TigerGraph, and You may receive more. + +=== 4) License and Restrictions +We grant You a limited, non-exclusive, non-transferable, sublicensable, or assignable license to use the Beta Offering solely for internal testing and evaluation. +You, directly or through any third party, agree not to disclose the Beta Offering to any third party, reverse engineer, reveal Your benchmarking, decompile, or disassemble the Beta Offering. +You agree You will not attempt to gain unauthorized access to the Beta Offering’s underlying code or infrastructure. + +=== 5) Feedback and Communications +You agree to provide feedback regarding Your experience with the Beta Offering, including but not limited to usability, bugs, improvements, suggestions, and performance issues (“Feedback”). +All Feedback will be considered non-proprietary to You. You acknowledge that TigerGraph owns all Feedback provided. +If we choose to publish Your Feedback, we will either do so in a way that does not identify You or obtain Your consent to identify You. +You acknowledge the importance of communication and feedback between You and TigerGraph during Your use of the Beta Offering and agree to receive related correspondence and updates from us with regard to the Beta Offering. + +=== 6) Data Collection and Protection + +* *Personal Data*: We may collect and use Your data on a limited basis under our Privacy Policy, which is available on our website at https://www.tigergraph.com/privacy-policy/. +We may also monitor how You use the Beta Offering and use that information, without limitation, to improve our products and services. + + +=== 7) No Warranty +The Beta Offering is provided "as is" without any warranties, express or implied. +We do not warrant that it will be error-free or uninterrupted. +We are not obligated to provide maintenance, technical, or other support for the Beta Offering. +You must separately backup all data used on the Beta Offering to avoid loss of data. + +=== 8) Limitation of Liability +We shall not be liable for any indirect, incidental, special, consequential, or punitive damages, including but not limited to loss of profits, data, use, goodwill, or other intangible losses resulting from Your access to, use of, or inability to access or use the Beta Offering. + +=== 9) Changes to Terms +We reserve the right to modify these Terms at any time. +We will provide notice of these changes by posting the revised Terms and updating the "Effective Date" above. +Your continued participation in the Beta Program will constitute Your consent to those changes. + +=== 10) Termination +We reserve the right to terminate the Beta Program or suspend Your access to the Beta Offering at any time, without prior notice or liability, for any reason whatsoever, including without limitation if You breach these Terms. +You may terminate Your participation in the Beta Program by canceling Your access to the Beta Program portal. + +We anticipate ending the Beta Program on July 20, 2024. +We intend to send a notice to the email address of Your Beta Program registration at least 48 hours before we end the Beta Program. +After the Beta Program ends, Your Beta Offering services and the data contained therein will be deleted. +We may retain Your registration information, feedback, and system monitoring data. +The restrictions in section 4 survive any termination in perpetuity. + +=== 11) Governing Law +These Terms shall be governed by and construed in accordance with the internal laws of the State of California without regard to its conflict of laws principles. +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-support@tigergraph.com. diff --git a/modules/cloudbeta/modules/resources/pages/terms_conditions.adoc b/modules/cloud4/modules/resources/pages/terms_conditions.adoc similarity index 91% rename from modules/cloudbeta/modules/resources/pages/terms_conditions.adoc rename to modules/cloud4/modules/resources/pages/terms_conditions.adoc index d124dd72..4d96bb9e 100644 --- a/modules/cloudbeta/modules/resources/pages/terms_conditions.adoc +++ b/modules/cloud4/modules/resources/pages/terms_conditions.adoc @@ -1,10 +1,10 @@ -= Beta Program Terms and Conditions for TigerGraph Cloud 4.0 += Beta Program Terms and Conditions for TigerGraph Cloud 4 == Effective Date: Apr 23, 2024 -These Terms and Conditions of the Beta Program for TigerGraph Cloud 4.0 ("Terms") constitute a legal agreement between *You* or the entity You are authorized to represent and bind to these terms (“You” or “Your”) and TigerGraph, Inc. ("TigerGraph", "We") and govern Your participation in the Beta Program for TigerGraph Cloud 4.0 ("Beta Program"). +These Terms and Conditions of the Beta Program for TigerGraph Cloud 4 ("Terms") constitute a legal agreement between *You* or the entity You are authorized to represent and bind to these terms (“You” or “Your”) and TigerGraph, Inc. ("TigerGraph", "We") and govern Your participation in the Beta Program for TigerGraph Cloud 4 ("Beta Program"). [IMPORTANT] ==== @@ -12,7 +12,7 @@ Please read these Terms carefully. ==== === 1) Beta Offering -The Beta Program provides You access to the TigerGraph Cloud 4.0 Beta software service ("Beta Offering"), a pre-production release, for testing and providing feedback to TigerGraph. +The Beta Program provides You access to the TigerGraph Cloud 4 Beta software service ("Beta Offering"), a pre-production release, for testing and providing feedback to TigerGraph. The Beta Offering is provided on an "as is" and "as available" basis for a limited time. You may access the Beta Offering via a designated portal which is separate from TigerGraph's production and general commercial offerings. You may not use the Beta Offering in production or for commercial purposes. diff --git a/modules/cloud4/modules/rest-api/nav.adoc b/modules/cloud4/modules/rest-api/nav.adoc new file mode 100644 index 00000000..59584724 --- /dev/null +++ b/modules/cloud4/modules/rest-api/nav.adoc @@ -0,0 +1,4 @@ +* xref:index.adoc[REST API (Preview)] +** xref:rest-api:authentication.adoc[Authentication] +** xref:rest-api:endpoints.adoc[Endpoints] +** xref:rest-api:definitions.adoc[Definitions] \ No newline at end of file diff --git a/modules/cloud4/modules/rest-api/pages/authentication.adoc b/modules/cloud4/modules/rest-api/pages/authentication.adoc new file mode 100644 index 00000000..f1af55c6 --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/authentication.adoc @@ -0,0 +1,23 @@ += Authentication + +To use the TigerGraph Cloud 4 REST APIs, you need to authenticate your requests. Authentication is typically done using API keys. + +[IMPORTANT] +==== +The TigerGraph Cloud 4 REST API is currently in preview version. Features and endpoints may change as the API evolves. +==== + +== Setup API Keys + +Before you can authenticate your API requests, you need to set up your API keys. Please refer to the xref:cloud4:administration:settings/how2-create-api-key.adoc[API Key Setup] page for detailed instructions on how to generate and manage your API keys. + +== Example Request + +Here’s an example of how to consume the APIs using your API key: + +```bash +curl -X GET "https://api.tgcloud.io/users" \ + -H 'accept: application/json' \ + -H "Authorization: Bearer " +``` + diff --git a/modules/cloud4/modules/rest-api/pages/definitions.adoc b/modules/cloud4/modules/rest-api/pages/definitions.adoc new file mode 100644 index 00000000..f8449a62 --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/definitions.adoc @@ -0,0 +1,885 @@ + +[[_definitions]] +== Definitions + +[[_agentconfig]] +=== AgentConfig + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**catalog_activity_update_interval_seconds** + +__optional__|integer +|**enable_topology_force_update** + +__optional__|boolean +|**heartbeat_interval_seconds** + +__optional__|integer +|**query_activity_update_interval_seconds** + +__optional__|integer +|**topology_update_interval_seconds** + +__optional__|integer +|=== + + +[[_allowedip]] +=== AllowedIP + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**cidr** + +__required__|string +|**id** + +__optional__|string +|**note** + +__optional__|string +|=== + + +[[_backup]] +=== Backup + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**id** + +__optional__|string +|**is_automatic** + +__optional__|boolean +|**size_bytes** + +__optional__|string +|**status** + +__optional__|string +|**tag** + +__optional__|string +|**time** + +__optional__|string +|**type** + +__optional__|string +|**version** + +__optional__|string +|=== + + +[[_backuprestorestatus]] +=== BackupRestoreStatus + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**created_at** + +__optional__|string +|**name** + +__optional__|string +|**output** + +__optional__|string +|**status** + +__optional__|string +|=== + + +[[_backupschedule]] +=== BackupSchedule + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**max_backup_files** + +__optional__|integer +|**max_reserved_days** + +__optional__|integer +|**max_retry** + +__optional__|integer +|**pause** + +__optional__|boolean +|**schedule** + +__required__|string +|=== + + +[[_createworkgrouprequest]] +=== CreateWorkgroupRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**cloud_provider_id** + +__required__|string +|**name** + +__optional__|string +|**platform** + +__optional__|<> +|**region** + +__optional__|string +|=== + + +[[_createworkspacerequest]] +=== CreateWorkspaceRequest +Create Workspace Request + + +[options="header", cols=".^3a,.^11a,.^4a"] +|=== +|Name|Description|Schema +|**addons** + +__optional__||< <> > array +|**auto_stop_minutes** + +__optional__||integer +|**enable_auto_start** + +__optional__||boolean +|**enable_ha** + +__optional__||boolean +|**is_rw** + +__optional__||boolean +|**name** + +__optional__||string +|**solution_install_request** + +__optional__||<> +|**tg_database_id** + +__optional__||string +|**tg_version** + +__optional__||string +|**workspace_type_name** + +__optional__|Workspace Type Name TG-0/TG-2|string +|=== + + +[[_deletebackuprequest]] +=== DeleteBackupRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**backup_id** + +__required__|string +|=== + + +[[_folderstatistics]] +=== FolderStatistics + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**backup_size** + +__optional__|integer +|**billed_size** + +__optional__|integer +|**log_size** + +__optional__|integer +|**milvus_size** + +__optional__|integer +|**total_size** + +__optional__|integer +|**workspaces** + +__optional__|< <> > array +|=== + + +[[_indatabaseuserrequest]] +=== InDatabaseUserRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**password** + +__optional__|string +|**username** + +__optional__|string +|=== + + +[[_region]] +=== Region + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**description** + +__optional__|string +|**name** + +__optional__|string +|=== + + +[[_restorebackuprequest]] +=== RestoreBackupRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**backup_id** + +__required__|string +|=== + + +[[_solutioninstallrequest]] +=== SolutionInstallRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**addons** + +__optional__|< <> > array +|**data_source_origin** + +__optional__|string +|**name** + +__optional__|string +|**solution_catalog_id** + +__optional__|string +|=== + + +[[_tgdatabase]] +=== TGDatabase + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**create_time** + +__optional__|string +|**database_id** + +__optional__|string +|**folder_statistics** + +__optional__|<> +|**name** + +__optional__|string +|**org_id** + +__optional__|string +|**org_name** + +__optional__|string +|**region** + +__optional__|string +|**tg_version** + +__optional__|string +|**workgroup_id** + +__optional__|string +|**workspaces** + +__optional__|< <> > array +|=== + + +[[_tgversion]] +=== TGVersion + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**image** + +__optional__|string +|**name** + +__optional__|string +|=== + + +[[_updatetgdatabaserequest]] +=== UpdateTGDatabaseRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**tg_database_name** + +__required__|string +|=== + + +[[_updateworkgrouprequest]] +=== UpdateWorkgroupRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**workgroup_name** + +__optional__|string +|=== + + +[[_updateworkspacerequest]] +=== UpdateWorkspaceRequest + +[options="header", cols=".^3a,.^11a,.^4a"] +|=== +|Name|Description|Schema +|**addons** + +__optional__||< <> > array +|**agent_config** + +__optional__||<> +|**auto_stop_minutes** + +__optional__|**Minimum value** : `0`|integer +|**enable_auto_start** + +__optional__||boolean +|**enable_ha** + +__optional__||boolean +|**pause** + +__optional__||boolean +|**workspace_name** + +__optional__||string +|**workspace_type_name** + +__optional__||string +|=== + + +[[_workgroup]] +=== Workgroup + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**cloud_provider_id** + +__optional__|string +|**creator** + +__optional__|string +|**enable_allow_list** + +__optional__|boolean +|**name** + +__optional__|string +|**org_id** + +__optional__|string +|**org_name** + +__optional__|string +|**platform** + +__optional__|<> +|**region** + +__optional__|string +|**tg_databases** + +__optional__|< <> > array +|**workgroup_id** + +__optional__|string +|**workspaces** + +__optional__|< <> > array +|=== + + +[[_workspace]] +=== Workspace + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**addons** + +__optional__|< <> > array +|**agent_config** + +__optional__|<> +|**auto_stop_minutes** + +__optional__|integer +|**cloud_provider_id** + +__optional__|string +|**condition_type** + +__optional__|string +|**created_at** + +__optional__|string +|**creator** + +__optional__|string +|**database_id** + +__optional__|string +|**edge_count** + +__optional__|integer +|**enable_auto_start** + +__optional__|boolean +|**enable_copilot** + +__optional__|boolean +|**enable_ha** + +__optional__|boolean +|**folder_statistics** + +__optional__|<> +|**graph_topology_size_bytes** + +__optional__|integer +|**is_rw** + +__optional__|boolean +|**last_modified_time** + +__optional__|string +|**name** + +__optional__|string +|**nginx_host** + +__optional__|string +|**org_id** + +__optional__|string +|**org_name** + +__optional__|string +|**refresh_message** + +__optional__|string +|**refresh_status** + +__optional__|string +|**region** + +__optional__|string +|**size** + +__optional__|integer +|**snapshot_time** + +__optional__|string +|**solution_catalog_id** + +__optional__|string +|**status** + +__optional__|string +|**tg_version** + +__optional__|string +|**version_number** + +__optional__|integer +|**vertex_count** + +__optional__|integer +|**workgroup_id** + +__optional__|string +|**workgroup_name** + +__optional__|string +|**workspace_id** + +__optional__|string +|**workspace_type** + +__optional__|<> +|=== + + +[[_workspaceschedule]] +=== WorkspaceSchedule + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**date** + +__optional__|string +|**id** + +__optional__|string +|**repeat** + +__required__|string +|**repeat_on** + +__optional__|string +|**time** + +__required__|string +|**timezone** + +__required__|string +|**workspace_id** + +__required__|string +|**workspace_type_name** + +__optional__|string +|=== + + +[[_workspacesize]] +=== WorkspaceSize + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**size** + +__optional__|integer +|**workspace_id** + +__optional__|string +|=== + + +[[_workspacetype]] +=== WorkspaceType + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**cpu** + +__optional__|string +|**ha** + +__optional__|integer +|**memory** + +__optional__|string +|**partition** + +__optional__|integer +|**typeName** + +__optional__|string +|=== + + +[[_middleware_error]] +=== middleware.Error + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**FieldName** + +__optional__|string +|**Reason** + +__optional__|string +|**Type** + +__optional__|<> +|=== + + +[[_middleware_errortype]] +=== middleware.ErrorType +__Type__ : enum (Internal-Error, Bad-Request, Not-Found, Forbidden, Unauthorized, API-Disabled, Quota-Exceed, Unknown) + + +[[_middleware_response]] +=== middleware.Response + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|object +|=== + + +[[_org_handler_orglistuserresponse]] +=== org_handler.OrgListUserResponse + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**auth0UserID** + +__optional__|string +|**authID** + +__optional__|string +|**created** + +__optional__|string +|**email** + +__optional__|string +|**enabled** + +__optional__|boolean +|**firstName** + +__optional__|string +|**id** + +__optional__|string +|**lastName** + +__optional__|string +|**metadata** + +__optional__|<> +|**path** + +__optional__|string +|**roles** + +__optional__|< <> > array +|**tenantID** + +__optional__|string +|**trn** + +__optional__|string +|**updated** + +__optional__|string +|**username** + +__optional__|string +|=== + + +[[_org_handler_orgmetadata]] +=== org_handler.OrgMetadata + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**attachedTo** + +__optional__|< string > array +|**lastLogin** + +__optional__|string +|=== + + +[[_org_handler_orgrole]] +=== org_handler.OrgRole + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**displayName** + +__optional__|string +|**id** + +__optional__|string +|**name** + +__optional__|string +|**path** + +__optional__|string +|**tenantID** + +__optional__|string +|**trn** + +__optional__|string +|=== + + +[[_org_handler_putorgusersroles]] +=== org_handler.PutOrgUsersRoles + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**roles** + +__optional__|< string > array +|=== + + +[[_pb_apikey]] +=== pb.APIKey + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**created_at** + +__optional__|string +|**creator** + +__optional__|string +|**description** + +__optional__|string +|**expires_at** + +__optional__|string +|**key_name** + +__optional__|string +|**org_id** + +__optional__|string +|**plaintext_key** + +__optional__|string +|**redacted_key** + +__optional__|string +|**user_id** + +__optional__|string +|=== + + +[[_pb_createapikeyrequest]] +=== pb.CreateAPIKeyRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**description** + +__optional__|string +|**life_time_in_seconds** + +__optional__|integer +|=== + + +[[_pb_customercreditcard]] +=== pb.CustomerCreditCard + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**brand** + +__optional__|string +|**card_id** + +__optional__|string +|**expire_month** + +__optional__|integer +|**expire_year** + +__optional__|integer +|**last_4_digits** + +__optional__|string +|**name_on_card** + +__optional__|string +|**org_id** + +__optional__|string +|=== + + +[[_pb_datastoragepricing]] +=== pb.DataStoragePricing + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**platform** + +__optional__|string +|**price_per_month** + +__optional__|number +|**region** + +__optional__|string +|=== + + +[[_pb_deleteapikeyrequest]] +=== pb.DeleteAPIKeyRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**key_name** + +__optional__|string +|=== + + +[[_pb_featureflag]] +=== pb.FeatureFlag + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**enabled** + +__optional__|boolean +|**feature_name** + +__optional__|string +|=== + + +[[_pb_getcustomercreditcardsresponse]] +=== pb.GetCustomerCreditCardsResponse + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**credit_cards** + +__optional__|< <> > array +|**default_card** + +__optional__|string +|=== + + +[[_pb_orgquota]] +=== pb.OrgQuota + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**max_workspace_memory** + +__optional__|string +|**max_workspace_type** + +__optional__|string +|**memory_limit** + +__optional__|string +|**memory_usage_in_bytes** + +__optional__|integer +|**org_id** + +__optional__|string +|**ro_workspace_count_limit** + +__optional__|integer +|**ro_workspace_count_usage** + +__optional__|integer +|**rw_workspace_count_limit** + +__optional__|integer +|**rw_workspace_count_usage** + +__optional__|integer +|**tier** + +__optional__|string +|**workspace_auto_backup_count_limit** + +__optional__|integer +|**workspace_auto_backup_retention_in_days** + +__optional__|integer +|**workspace_manual_backup_count_limit** + +__optional__|integer +|=== + + +[[_pb_organization]] +=== pb.Organization + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**create_time** + +__optional__|string +|**creator** + +__optional__|string +|**feature_flag** + +__optional__|< <> > array +|**logo_url** + +__optional__|string +|**org_display_name** + +__optional__|string +|**org_id** + +__optional__|string +|**org_name** + +__optional__|string +|=== + + +[[_pb_resourcepricing]] +=== pb.ResourcePricing + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**addon_pricing** + +__optional__|< <> > array +|**data_storage_pricing** + +__optional__|< <> > array +|**workspace_pricing** + +__optional__|< <> > array +|=== + + +[[_pb_workspacepricing]] +=== pb.WorkspacePricing + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**cloud_provider** + +__optional__|string +|**ha** + +__optional__|string +|**platform** + +__optional__|string +|**price_per_hour** + +__optional__|number +|**region** + +__optional__|string +|**workspace_type** + +__optional__|string +|=== + + +[[_resource_manager_handler_getmetadata_metadata]] +=== resource_manager_handler.GetMetadata.metadata + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**regions** + +__optional__|< <> > array +|**tgVersions** + +__optional__|< <> > array +|**workspaceTypes** + +__optional__|< <> > array +|=== + + +[[_tgiam_iamuser]] +=== tgIAM.IAMUser + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**auth0UserID** + +__optional__|string +|**created** + +__optional__|string +|**email** + +__optional__|string +|**enabled** + +__optional__|boolean +|**firstName** + +__optional__|string +|**id** + +__optional__|string +|**lastName** + +__optional__|string +|**path** + +__optional__|string +|**tenantID** + +__optional__|string +|**trn** + +__optional__|string +|**updated** + +__optional__|string +|**username** + +__optional__|string +|=== + + +[[_tgiam_orgrequest]] +=== tgIAM.OrgRequest + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**logoUrl** + +__optional__|string +|**orgDisplayName** + +__optional__|string +|**orgID** + +__optional__|string +|**orgName** + +__optional__|string +|=== + + + diff --git a/modules/cloud4/modules/rest-api/pages/endpoints.adoc b/modules/cloud4/modules/rest-api/pages/endpoints.adoc new file mode 100644 index 00000000..879a3a40 --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/endpoints.adoc @@ -0,0 +1,2496 @@ + +[[_paths]] +== Paths + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_post]] +=== Create workgroups in your org +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups +.... + + +==== Description +Create workgroups in your org + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Body**|**request** + +__required__|Create workgroup request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_post_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_post_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workgroup + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_get]] +=== Get workgroups for your org +.... +GET https://api.tgcloud.io/controller/v4/v2/workgroups +.... + + +==== Description +Get workgroups for your org + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_get_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|< <> > array +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workgroup + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_get]] +=== Get workgroup detail in your org +.... +GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID} +.... + + +==== Description +Get workgroup detail in your org + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_get_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workgroup + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_put]] +=== Update workgroups in your org +.... +PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID} +.... + + +==== Description +Update workgroups in your org + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Body**|**request** + +__required__|Update workgroup request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_put_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_put_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workgroup + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_delete]] +=== Delete workgroup detail in your org +.... +DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID} +.... + + +==== Description +Delete workgroup detail in your org + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_delete_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_delete_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workgroup + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_post]] +=== Add Allowed IP +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list +.... + + +==== Description +Add a new allowed IP to the workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Body**|**request** + +__required__|Allowed IP request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_post_response_200,Response 200>> +|**400**|Bad Request|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_post_response_400,Response 400>> +|**500**|Internal Server Error|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_post_response_500,Response 500>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_post_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_post_response_400]] +**Response 400** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_post_response_500]] +**Response 500** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* AllowedIP + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_get]] +=== List Allowed IPs +.... +GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list +.... + + +==== Description +List all allowed IPs in the workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_get_response_200,Response 200>> +|**500**|Internal Server Error|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_get_response_500,Response 500>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|< <> > array +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_get_response_500]] +**Response 500** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* AllowedIP + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_current_get]] +=== Get Current IP +.... +GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/current +.... + + +==== Description +Get the current IP and check if it is allowed in the workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_current_get_response_200,Response 200>> +|**500**|Internal Server Error|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_current_get_response_500,Response 500>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_current_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_current_get_result,Result>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_current_get_result]] +**Result** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|** IsAllowed** + +__optional__|boolean +|**CurrentIP** + +__optional__|string +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_current_get_response_500]] +**Response 500** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* AllowedIP + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_disable_put]] +=== Disable Allow List +.... +PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/disable +.... + + +==== Description +Disable the allow list for the workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_disable_put_response_200,Response 200>> +|**500**|Internal Server Error|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_disable_put_response_500,Response 500>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_disable_put_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_disable_put_response_500]] +**Response 500** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* AllowedIP + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_enable_put]] +=== Enable Allow List +.... +PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/enable +.... + + +==== Description +Enable the allow list for the workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_enable_put_response_200,Response 200>> +|**500**|Internal Server Error|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_enable_put_response_500,Response 500>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_enable_put_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_enable_put_response_500]] +**Response 500** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* AllowedIP + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_put]] +=== Update Allowed IP +.... +PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/{id} +.... + + +==== Description +Update an existing allowed IP in the workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**id** + +__required__|Allowed IP ID|string +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Body**|**request** + +__required__|Allowed IP request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_put_response_200,Response 200>> +|**400**|Bad Request|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_put_response_400,Response 400>> +|**500**|Internal Server Error|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_put_response_500,Response 500>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_put_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_put_response_400]] +**Response 400** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_put_response_500]] +**Response 500** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* AllowedIP + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_delete]] +=== Delete Allowed IP +.... +DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/{id} +.... + + +==== Description +Delete an existing allowed IP from the workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**id** + +__required__|Allowed IP ID|string +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_delete_response_200,Response 200>> +|**500**|Internal Server Error|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_delete_response_500,Response 500>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_delete_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_allow_list_id_delete_response_500]] +**Response 500** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* AllowedIP + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_databases_databaseid_get]] +=== Get database in workgroup +.... +GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/databases/{databaseID} +.... + + +==== Description +Get database in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**databaseID** + +__required__|Database ID|string +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_databases_databaseid_get_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_databases_databaseid_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Database + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_databases_databaseid_put]] +=== Update database in workgroup +.... +PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/databases/{databaseID} +.... + + +==== Description +Update database in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**databaseID** + +__required__|Database ID|string +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Body**|**request** + +__required__|Update database request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_databases_databaseid_put_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_databases_databaseid_put_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Database + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_databases_databaseid_delete]] +=== Delete database in workgroup +.... +DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/databases/{databaseID} +.... + + +==== Description +Delete database in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**databaseID** + +__required__|Database ID|string +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Database + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_post]] +=== Create workspace in workgroup +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces +.... + + +==== Description +Create workspace in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Body**|**request** + +__required__|Create workspace request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_post_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_post_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workspace + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_get]] +=== Get workspace in workgroup +.... +GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID} +.... + + +==== Description +Get workspace in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_get_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workspace + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_put]] +=== Update workspace in workgroup +.... +PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID} +.... + + +==== Description +Update workspace in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**request** + +__required__|Update workspace request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_put_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_put_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workspace + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_delete]] +=== Delete workspace in workgroup +.... +DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID} +.... + + +==== Description +Delete workspace in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workspace + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_backups_delete]] +=== Delete a backup +.... +DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups +.... + + +==== Description +Delete a backup for a workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**request** + +__required__|Delete Backup Request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully deleted the backup.|<> +|**400**|Bad request|<> +|**500**|Internal server error|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Backup + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_backups_restore_post]] +=== Restore a backup +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore +.... + + +==== Description +Restore a backup for a workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**request** + +__required__|Restore Backup Request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully restored the backup.|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_backups_restore_post_response_200,Response 200>> +|**400**|Bad request|<> +|**500**|Internal server error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_backups_restore_post_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Backup + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_backups_schedule_post]] +=== Set backup schedule +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule +.... + + +==== Description +Set a backup schedule for a workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**request** + +__required__|Backup Schedule|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully set the backup schedule.|<> +|**400**|Bad request|<> +|**500**|Internal server error|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Backup + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_dbuser_post]] +=== Create in-database GSQL user +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser +.... + + +==== Description +Create a new in-database GSQL user in the specified workspace and workgroup. + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**request** + +__required__|In-database user request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully created the in-database GSQL user.|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_dbuser_post_response_200,Response 200>> +|**400**|Bad request|<> +|**500**|Internal server error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_dbuser_post_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* DatabaseUser + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_dbuser_get]] +=== List in-database GSQL users +.... +GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser +.... + + +==== Description +List all in-database GSQL users in the specified workspace and workgroup. + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully listed the in-database GSQL users.|<<_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_dbuser_get_response_200,Response 200>> +|**500**|Internal server error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_dbuser_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|< <> > array +|=== + + +==== Produces + +* `application/json` + + +==== Tags + +* DatabaseUser + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_dbuser_put]] +=== Update in-database GSQL user password +.... +PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser +.... + + +==== Description +Update the password of an in-database GSQL user in the specified workspace and workgroup. + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**request** + +__required__|In-database user request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully updated the in-database GSQL password.|<> +|**400**|Bad request|<> +|**500**|Internal server error|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* DatabaseUser + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_dbuser_delete]] +=== Delete in-database GSQL user +.... +DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser +.... + + +==== Description +Delete an in-database GSQL user in the specified workspace and workgroup. + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**request** + +__required__|In-database user request|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully deleted the in-database GSQL user.|<> +|**400**|Bad request|<> +|**500**|Internal server error|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* DatabaseUser + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_pause_post]] +=== Pause workspace in workgroup +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/pause +.... + + +==== Description +Pause workspace in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workspace + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_refresh_post]] +=== Refresh workspace in workgroup +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/refresh +.... + + +==== Description +Refresh workspace in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workspace + + +[[_https_api_tgcloud_io_controller_v4_v2_workgroups_workgroupid_workspaces_workspaceid_resume_post]] +=== Resume workspace in workgroup +.... +POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/resume +.... + + +==== Description +Resume workspace in workgroup + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workgroupID** + +__required__|Workgroup ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Workspace + + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_meta_get]] +=== Get an metadata for your org +.... +GET https://api.tgcloud.io/controller/v4/v2/workspaces/meta +.... + + +==== Description +Get regions/tgVersions/workspaceTypes supported for your org + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workspaces_meta_get_response_200,Response 200>> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_meta_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Org + + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_get]] +=== List backups +.... +GET https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/backups +.... + + +==== Description +List all backups for a workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully listed the backups.|<<_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_get_response_200,Response 200>> +|**500**|Internal server error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|< <> > array +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Backup + + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_restore_job_status_get]] +=== Get backup restore status +.... +GET https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/backups/restore/{job}/status +.... + + +==== Description +Get the status of a backup restore job + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**job** + +__required__|Job ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully got the backup restore status.|<<_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_restore_job_status_get_response_200,Response 200>> +|**500**|Internal server error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_restore_job_status_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Backup + + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_schedule_post]] +=== Create a new workspace schedule +.... +POST https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/backups/schedule +.... + + +==== Description +Create a new workspace schedule for a given workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**body** + +__required__|Workspace Schedule|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_schedule_post_response_200,Response 200>> +|**400**|Bad Request|<> +|**500**|Internal Server Error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_schedule_post_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* WorkspaceSchedule + + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_schedule_get]] +=== Get backup schedule +.... +GET https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/backups/schedule +.... + + +==== Description +Get the backup schedule for a workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|Successfully got the backup schedule.|<<_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_schedule_get_response_200,Response 200>> +|**500**|Internal server error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_backups_schedule_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Backup + + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_get]] +=== Retrieve workspace schedule +.... +GET https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/schedules +.... + + +==== Description +Retrieve the schedule for a given workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_get_response_200,Response 200>> +|**500**|Internal Server Error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_get_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|< <> > array +|=== + + +==== Produces + +* `application/json` + + +==== Tags + +* WorkspaceSchedule + + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_schedule_id_put]] +=== Update an existing workspace schedule +.... +PUT https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/schedules/{schedule_id} +.... + + +==== Description +Update an existing workspace schedule for a given workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**schedule_id** + +__required__|Schedule ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|**Body**|**body** + +__required__|Workspace Schedule|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_schedule_id_put_response_200,Response 200>> +|**400**|Bad Request|<> +|**500**|Internal Server Error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_schedule_id_put_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* WorkspaceSchedule + + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_schedule_id_delete]] +=== Delete an existing workspace schedule +.... +DELETE https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/schedules/{schedule_id} +.... + + +==== Description +Delete an existing workspace schedule for a given workspace + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**schedule_id** + +__required__|Schedule ID|string +|**Path**|**workspaceID** + +__required__|Workspace ID|string +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<<_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_schedule_id_delete_response_200,Response 200>> +|**500**|Internal Server Error|<> +|=== + +[[_https_api_tgcloud_io_controller_v4_v2_workspaces_workspaceid_schedules_schedule_id_delete_response_200]] +**Response 200** + +[options="header", cols=".^3a,.^4a"] +|=== +|Name|Schema +|**Error** + +__optional__|boolean +|**ErrorDetails** + +__optional__|< <> > array +|**Message** + +__optional__|string +|**RequestID** + +__optional__|string +|**Result** + +__optional__|string +|=== + + +==== Produces + +* `application/json` + + +==== Tags + +* WorkspaceSchedule + + +[[_https_api_tgcloud_io_users_get]] +=== List of users in the org +.... +GET https://api.tgcloud.io/users +.... + + +==== Description +List of users in the org. Note: this endpoint is not APIKEY compatible + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**200**|OK|<> +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Org + + +[[_https_api_tgcloud_io_users_userid_roles_put]] +=== Update the role of an org user +.... +PUT https://api.tgcloud.io/users/{userId}/roles +.... + + +==== Description +Updates the role of an org user. Note: this endpoint is not APIKEY compatible + + +==== Parameters + +[options="header", cols=".^2a,.^3a,.^9a,.^4a"] +|=== +|Type|Name|Description|Schema +|**Path**|**userId** + +__required__|Id of the user|string +|**Body**|**body** + +__required__|Roles of the user|<> +|=== + + +==== Responses + +[options="header", cols=".^2a,.^14a,.^4a"] +|=== +|HTTP Code|Description|Schema +|**204**|No Content|No Content +|=== + + +==== Consumes + +* `application/json` + + +==== Produces + +* `application/json` + + +==== Tags + +* Org + + + diff --git a/modules/cloud4/modules/rest-api/pages/index.adoc b/modules/cloud4/modules/rest-api/pages/index.adoc new file mode 100644 index 00000000..eb8c60d0 --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/index.adoc @@ -0,0 +1,24 @@ += REST API (Preview) +:experimental: + +TigerGraph Cloud 4 REST API provides a set of endpoints that allow developers to interact programmatically with TigerGraph Cloud 4 services. Those APIs enable you to manage your graph databases and perform various administrative tasks. + +[IMPORTANT] +==== +The TigerGraph Cloud 4 REST API is currently in preview version. Features and endpoints may change as the API evolves. +==== + + +== xref:cloud4:rest-api:authentication.adoc[] + +Learn how to authenticate with the TigerGraph Cloud 4 REST API. + + +== xref:cloud4:rest-api:endpoints.adoc[] + +Explore the REST API endpoints available in TigerGraph Cloud 4. + +== xref:cloud4:rest-api:definitions.adoc[] + +Explore the REST API data model definitions in TigerGraph Cloud 4. + diff --git a/modules/cloud4/modules/rest-api/pages/overview.adoc b/modules/cloud4/modules/rest-api/pages/overview.adoc new file mode 100644 index 00000000..4b54fde4 --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/overview.adoc @@ -0,0 +1,19 @@ += Tigergraph Cloud Controller API + + +[[_overview]] +== Overview +This is a sample tigergraph cloud controller server api. + + +=== Version information +[%hardbreaks] +__Version__ : 2.0 + + +=== URI scheme +[%hardbreaks] +__BasePath__ : https://api.tgcloud.io + + + diff --git a/modules/cloud4/modules/rest-api/pages/security.adoc b/modules/cloud4/modules/rest-api/pages/security.adoc new file mode 100644 index 00000000..63e9501b --- /dev/null +++ b/modules/cloud4/modules/rest-api/pages/security.adoc @@ -0,0 +1,15 @@ + +[[_securityscheme]] +== Security + +[[_apikeyauth]] +=== ApiKeyAuth +Authorization for tigergraph cloud + +[%hardbreaks] +__Type__ : apiKey +__Name__ : Authorization +__In__ : HEADER + + + diff --git a/modules/cloudbeta/modules/schema-designer/nav.adoc b/modules/cloud4/modules/schema-designer/nav.adoc similarity index 100% rename from modules/cloudbeta/modules/schema-designer/nav.adoc rename to modules/cloud4/modules/schema-designer/nav.adoc diff --git a/modules/cloudbeta/modules/load-data/images/billing-homecard.png b/modules/cloud4/modules/security/images/billing-homecard.png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/billing-homecard.png rename to modules/cloud4/modules/security/images/billing-homecard.png diff --git a/modules/cloudbeta/modules/load-data/images/create-organization.png b/modules/cloud4/modules/security/images/create-organization.png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/create-organization.png rename to modules/cloud4/modules/security/images/create-organization.png diff --git a/modules/cloudbeta/modules/load-data/images/documentation-homecard.png b/modules/cloud4/modules/security/images/documentation-homecard.png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/documentation-homecard.png rename to modules/cloud4/modules/security/images/documentation-homecard.png diff --git a/modules/cloudbeta/modules/load-data/images/getstarted-homecard.png b/modules/cloud4/modules/security/images/getstarted-homecard.png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/getstarted-homecard.png rename to modules/cloud4/modules/security/images/getstarted-homecard.png diff --git a/modules/cloudbeta/modules/load-data/images/referece-homecard.png b/modules/cloud4/modules/security/images/referece-homecard.png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/referece-homecard.png rename to modules/cloud4/modules/security/images/referece-homecard.png diff --git a/modules/cloudbeta/modules/load-data/images/security-homecard.png b/modules/cloud4/modules/security/images/security-homecard.png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/security-homecard.png rename to modules/cloud4/modules/security/images/security-homecard.png diff --git a/modules/cloudbeta/modules/load-data/images/systemmanagment-homecard.png b/modules/cloud4/modules/security/images/systemmanagment-homecard.png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/systemmanagment-homecard.png rename to modules/cloud4/modules/security/images/systemmanagment-homecard.png diff --git a/modules/cloudbeta/modules/load-data/images/tools-page.png b/modules/cloud4/modules/security/images/tools-page.png similarity index 100% rename from modules/cloudbeta/modules/load-data/images/tools-page.png rename to modules/cloud4/modules/security/images/tools-page.png diff --git a/modules/cloudbeta/modules/security/nav.adoc b/modules/cloud4/modules/security/nav.adoc similarity index 100% rename from modules/cloudbeta/modules/security/nav.adoc rename to modules/cloud4/modules/security/nav.adoc diff --git a/modules/cloudbeta/modules/resource-manager/images/Add-onsimage.png b/modules/cloud4/modules/workgroup-workspace/images/Add-onsimage.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/Add-onsimage.png rename to modules/cloud4/modules/workgroup-workspace/images/Add-onsimage.png diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.38.09\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.38.09\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.38.09\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.38.09\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.38.52\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.38.52\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.38.52\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.38.52\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.39.34\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.39.34\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.39.34\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.39.34\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.40.16\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.40.16\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.40.16\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.40.16\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.41.55\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.41.55\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.41.55\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.41.55\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.42.36\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.42.36\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.42.36\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.42.36\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.43.22\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.43.22\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.43.22\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.43.22\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.45.15\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.45.15\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.45.15\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.45.15\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.45.39\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.45.39\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-17 at 5.45.39\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-17 at 5.45.39\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-24 at 8.18.30\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-24 at 8.18.30\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-24 at 8.18.30\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-24 at 8.18.30\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-28 at 9.36.29\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-28 at 9.36.29\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-28 at 9.36.29\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-28 at 9.36.29\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-28 at 9.36.44\342\200\257PM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-28 at 9.36.44\342\200\257PM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-28 at 9.36.44\342\200\257PM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-28 at 9.36.44\342\200\257PM.png" diff --git "a/modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-30 at 10.25.29\342\200\257AM.png" "b/modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-30 at 10.25.29\342\200\257AM.png" similarity index 100% rename from "modules/cloudbeta/modules/resource-manager/images/Screenshot 2024-04-30 at 10.25.29\342\200\257AM.png" rename to "modules/cloud4/modules/workgroup-workspace/images/Screenshot 2024-04-30 at 10.25.29\342\200\257AM.png" diff --git a/modules/cloud4/modules/workgroup-workspace/images/add-on.png b/modules/cloud4/modules/workgroup-workspace/images/add-on.png new file mode 100644 index 00000000..8de187af Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/add-on.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/advanced-settings-new.png b/modules/cloud4/modules/workgroup-workspace/images/advanced-settings-new.png new file mode 100644 index 00000000..c415dcac Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/advanced-settings-new.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/advnaced-settings-old.png b/modules/cloud4/modules/workgroup-workspace/images/advnaced-settings-old.png new file mode 100644 index 00000000..3b738812 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/advnaced-settings-old.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/advnaced-settings.png b/modules/cloud4/modules/workgroup-workspace/images/advnaced-settings.png new file mode 100644 index 00000000..c8af570b Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/advnaced-settings.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/alerts.png b/modules/cloud4/modules/workgroup-workspace/images/alerts.png new file mode 100644 index 00000000..1bb7f73f Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/alerts.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/auto-resume.png b/modules/cloud4/modules/workgroup-workspace/images/auto-resume.png new file mode 100644 index 00000000..952ff1e4 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/auto-resume.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/auto-suspend.png b/modules/cloud4/modules/workgroup-workspace/images/auto-suspend.png new file mode 100644 index 00000000..15bb386d Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/auto-suspend.png differ diff --git a/modules/cloudbeta/modules/resource-manager/images/autoSuspend.png b/modules/cloud4/modules/workgroup-workspace/images/autoSuspend.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/autoSuspend.png rename to modules/cloud4/modules/workgroup-workspace/images/autoSuspend.png diff --git a/modules/cloudbeta/modules/resource-manager/images/backupButton.png b/modules/cloud4/modules/workgroup-workspace/images/backupButton.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/backupButton.png rename to modules/cloud4/modules/workgroup-workspace/images/backupButton.png diff --git a/modules/cloudbeta/modules/resource-manager/images/backupButton3.png b/modules/cloud4/modules/workgroup-workspace/images/backupButton3.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/backupButton3.png rename to modules/cloud4/modules/workgroup-workspace/images/backupButton3.png diff --git a/modules/cloudbeta/modules/resource-manager/images/backupbutton2.png b/modules/cloud4/modules/workgroup-workspace/images/backupbutton2.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/backupbutton2.png rename to modules/cloud4/modules/workgroup-workspace/images/backupbutton2.png diff --git a/modules/cloudbeta/modules/resource-manager/images/backuprestore1.png b/modules/cloud4/modules/workgroup-workspace/images/backuprestore1.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/backuprestore1.png rename to modules/cloud4/modules/workgroup-workspace/images/backuprestore1.png diff --git a/modules/cloudbeta/modules/resource-manager/images/backuprestore2.png b/modules/cloud4/modules/workgroup-workspace/images/backuprestore2.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/backuprestore2.png rename to modules/cloud4/modules/workgroup-workspace/images/backuprestore2.png diff --git a/modules/cloudbeta/modules/resource-manager/images/backuprestore3.png b/modules/cloud4/modules/workgroup-workspace/images/backuprestore3.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/backuprestore3.png rename to modules/cloud4/modules/workgroup-workspace/images/backuprestore3.png diff --git a/modules/cloudbeta/modules/resource-manager/images/backuprestore4.png b/modules/cloud4/modules/workgroup-workspace/images/backuprestore4.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/backuprestore4.png rename to modules/cloud4/modules/workgroup-workspace/images/backuprestore4.png diff --git a/modules/cloudbeta/modules/resource-manager/images/backuprestore5.png b/modules/cloud4/modules/workgroup-workspace/images/backuprestore5.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/backuprestore5.png rename to modules/cloud4/modules/workgroup-workspace/images/backuprestore5.png diff --git a/modules/cloudbeta/modules/overview/images/billing-homecard.png b/modules/cloud4/modules/workgroup-workspace/images/billing-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/billing-homecard.png rename to modules/cloud4/modules/workgroup-workspace/images/billing-homecard.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/capacity-planning.png b/modules/cloud4/modules/workgroup-workspace/images/capacity-planning.png new file mode 100644 index 00000000..6615065a Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/capacity-planning.png differ diff --git a/modules/cloudbeta/modules/overview/images/create-organization.png b/modules/cloud4/modules/workgroup-workspace/images/create-organization.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/create-organization.png rename to modules/cloud4/modules/workgroup-workspace/images/create-organization.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/create-workgroup.png b/modules/cloud4/modules/workgroup-workspace/images/create-workgroup.png new file mode 100644 index 00000000..63582326 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/create-workgroup.png differ diff --git a/modules/cloudbeta/modules/resource-manager/images/createWorkspace.png b/modules/cloud4/modules/workgroup-workspace/images/createWorkspace.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/createWorkspace.png rename to modules/cloud4/modules/workgroup-workspace/images/createWorkspace.png diff --git a/modules/cloudbeta/modules/resource-manager/images/defineworkgroupvsworkspace.png b/modules/cloud4/modules/workgroup-workspace/images/defineworkgroupvsworkspace.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/defineworkgroupvsworkspace.png rename to modules/cloud4/modules/workgroup-workspace/images/defineworkgroupvsworkspace.png diff --git a/modules/cloudbeta/modules/resource-manager/images/defineworkgroupvsworkspace2.png b/modules/cloud4/modules/workgroup-workspace/images/defineworkgroupvsworkspace2.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/defineworkgroupvsworkspace2.png rename to modules/cloud4/modules/workgroup-workspace/images/defineworkgroupvsworkspace2.png diff --git a/modules/cloudbeta/modules/overview/images/documentation-homecard.png b/modules/cloud4/modules/workgroup-workspace/images/documentation-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/documentation-homecard.png rename to modules/cloud4/modules/workgroup-workspace/images/documentation-homecard.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/edit-ip-allowlist.png b/modules/cloud4/modules/workgroup-workspace/images/edit-ip-allowlist.png new file mode 100644 index 00000000..fbf21732 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/edit-ip-allowlist.png differ diff --git a/modules/cloudbeta/modules/resource-manager/images/expand2.png b/modules/cloud4/modules/workgroup-workspace/images/expand2.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/expand2.png rename to modules/cloud4/modules/workgroup-workspace/images/expand2.png diff --git a/modules/cloudbeta/modules/resource-manager/images/expandandshrink.png b/modules/cloud4/modules/workgroup-workspace/images/expandandshrink.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/expandandshrink.png rename to modules/cloud4/modules/workgroup-workspace/images/expandandshrink.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/general-settings.png b/modules/cloud4/modules/workgroup-workspace/images/general-settings.png new file mode 100644 index 00000000..f04bc896 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/general-settings.png differ diff --git a/modules/cloudbeta/modules/overview/images/getstarted-homecard.png b/modules/cloud4/modules/workgroup-workspace/images/getstarted-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/getstarted-homecard.png rename to modules/cloud4/modules/workgroup-workspace/images/getstarted-homecard.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/graph-admin.png b/modules/cloud4/modules/workgroup-workspace/images/graph-admin.png new file mode 100644 index 00000000..553bbd0d Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/graph-admin.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/ip-allowlist.png b/modules/cloud4/modules/workgroup-workspace/images/ip-allowlist.png new file mode 100644 index 00000000..437bc163 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/ip-allowlist.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/landing-page.png b/modules/cloud4/modules/workgroup-workspace/images/landing-page.png new file mode 100644 index 00000000..dde8580e Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/landing-page.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/loginPage.png b/modules/cloud4/modules/workgroup-workspace/images/loginPage.png new file mode 100644 index 00000000..d4c2a44b Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/loginPage.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/no-workgroup.png b/modules/cloud4/modules/workgroup-workspace/images/no-workgroup.png new file mode 100644 index 00000000..13b78ac1 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/no-workgroup.png differ diff --git a/modules/cloudbeta/modules/resource-manager/images/plusbutton.png b/modules/cloud4/modules/workgroup-workspace/images/plusbutton.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/plusbutton.png rename to modules/cloud4/modules/workgroup-workspace/images/plusbutton.png diff --git a/modules/cloudbeta/modules/overview/images/referece-homecard.png b/modules/cloud4/modules/workgroup-workspace/images/referece-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/referece-homecard.png rename to modules/cloud4/modules/workgroup-workspace/images/referece-homecard.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/schedule-1.png b/modules/cloud4/modules/workgroup-workspace/images/schedule-1.png new file mode 100644 index 00000000..8f513abb Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/schedule-1.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/schedule-2.png b/modules/cloud4/modules/workgroup-workspace/images/schedule-2.png new file mode 100644 index 00000000..7087717a Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/schedule-2.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/schedule-3.png b/modules/cloud4/modules/workgroup-workspace/images/schedule-3.png new file mode 100644 index 00000000..d943ee56 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/schedule-3.png differ diff --git a/modules/cloud4/modules/workgroup-workspace/images/schedule-4.png b/modules/cloud4/modules/workgroup-workspace/images/schedule-4.png new file mode 100644 index 00000000..82bcac38 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/schedule-4.png differ diff --git a/modules/cloudbeta/modules/overview/images/security-homecard.png b/modules/cloud4/modules/workgroup-workspace/images/security-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/security-homecard.png rename to modules/cloud4/modules/workgroup-workspace/images/security-homecard.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/signup.png b/modules/cloud4/modules/workgroup-workspace/images/signup.png new file mode 100644 index 00000000..5ad4b743 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/signup.png differ diff --git a/modules/cloudbeta/modules/resource-manager/images/choose-solution.png b/modules/cloud4/modules/workgroup-workspace/images/solution-add-on.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/choose-solution.png rename to modules/cloud4/modules/workgroup-workspace/images/solution-add-on.png diff --git a/modules/cloudbeta/modules/overview/images/systemmanagment-homecard.png b/modules/cloud4/modules/workgroup-workspace/images/systemmanagment-homecard.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/systemmanagment-homecard.png rename to modules/cloud4/modules/workgroup-workspace/images/systemmanagment-homecard.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/tabs.png b/modules/cloud4/modules/workgroup-workspace/images/tabs.png new file mode 100644 index 00000000..dd3e6d39 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/tabs.png differ diff --git a/modules/cloudbeta/modules/overview/images/tools-page.png b/modules/cloud4/modules/workgroup-workspace/images/tools-page.png similarity index 100% rename from modules/cloudbeta/modules/overview/images/tools-page.png rename to modules/cloud4/modules/workgroup-workspace/images/tools-page.png diff --git a/modules/cloudbeta/modules/resource-manager/images/workgroup1.png b/modules/cloud4/modules/workgroup-workspace/images/workgroup1.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/workgroup1.png rename to modules/cloud4/modules/workgroup-workspace/images/workgroup1.png diff --git a/modules/cloudbeta/modules/resource-manager/images/workgrouppage.png b/modules/cloud4/modules/workgroup-workspace/images/workgrouppage.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/workgrouppage.png rename to modules/cloud4/modules/workgroup-workspace/images/workgrouppage.png diff --git a/modules/cloudbeta/modules/resource-manager/images/workspace-database-tab.png b/modules/cloud4/modules/workgroup-workspace/images/workspace-database-tab.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/workspace-database-tab.png rename to modules/cloud4/modules/workgroup-workspace/images/workspace-database-tab.png diff --git a/modules/cloud4/modules/workgroup-workspace/images/workspace-general-tab.png b/modules/cloud4/modules/workgroup-workspace/images/workspace-general-tab.png new file mode 100644 index 00000000..60b495b2 Binary files /dev/null and b/modules/cloud4/modules/workgroup-workspace/images/workspace-general-tab.png differ diff --git a/modules/cloudbeta/modules/resource-manager/images/workspace-info-tab.png b/modules/cloud4/modules/workgroup-workspace/images/workspace-info-tab.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/workspace-info-tab.png rename to modules/cloud4/modules/workgroup-workspace/images/workspace-info-tab.png diff --git a/modules/cloudbeta/modules/resource-manager/images/workspace-monitor-tab.png b/modules/cloud4/modules/workgroup-workspace/images/workspace-monitor-tab.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/workspace-monitor-tab.png rename to modules/cloud4/modules/workgroup-workspace/images/workspace-monitor-tab.png diff --git a/modules/cloudbeta/modules/resource-manager/images/workspaceDetails.png b/modules/cloud4/modules/workgroup-workspace/images/workspaceDetails.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/workspaceDetails.png rename to modules/cloud4/modules/workgroup-workspace/images/workspaceDetails.png diff --git a/modules/cloudbeta/modules/resource-manager/images/workspacecreate.png b/modules/cloud4/modules/workgroup-workspace/images/workspacecreate.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/workspacecreate.png rename to modules/cloud4/modules/workgroup-workspace/images/workspacecreate.png diff --git a/modules/cloudbeta/modules/resource-manager/images/workspaceinfo.png b/modules/cloud4/modules/workgroup-workspace/images/workspaceinfo.png similarity index 100% rename from modules/cloudbeta/modules/resource-manager/images/workspaceinfo.png rename to modules/cloud4/modules/workgroup-workspace/images/workspaceinfo.png diff --git a/modules/cloud4/modules/workgroup-workspace/nav.adoc b/modules/cloud4/modules/workgroup-workspace/nav.adoc new file mode 100644 index 00000000..61a838d3 --- /dev/null +++ b/modules/cloud4/modules/workgroup-workspace/nav.adoc @@ -0,0 +1,16 @@ +* xref:index.adoc[] +** xref:cloud4:workgroup-workspace:workgroups/workgroup.adoc[Workgroups] +*** xref:cloud4:workgroup-workspace:workgroups/how2-create-a-workgroup.adoc[Create Workgroup] +*** xref:cloud4:workgroup-workspace:workgroups/how2-workgroup-access.adoc[Permissions] +*** xref:cloud4:workgroup-workspace:workgroups/monitor-workspaces.adoc[Monitor] +*** xref:cloud4:workgroup-workspace:workgroups/backup-and-restore.adoc[] +*** xref:cloud4:workgroup-workspace:workgroups/how2-config-network-access.adoc[Network Access] +** xref:workspaces/workspace.adoc[Workspaces] +*** xref:cloud4:workgroup-workspace:workspaces/how2-create-a-workspace.adoc[Create Workspace] +*** xref:cloud4:workgroup-workspace:workspaces/workspace-size.adoc[] +*** xref:cloud4:workgroup-workspace:workspaces/settings.adoc[Workspace Settings] +*** xref:cloud4:workgroup-workspace:workspaces/readwrite-readonly.adoc[RW/RO Workspaces] +*** xref:cloud4:workgroup-workspace:workspaces/expansion-shrink.adoc[Expand and Shrink] +*** xref:cloud4:workgroup-workspace:workspaces/schedule.adoc[Schedule] +*** xref:cloud4:workgroup-workspace:workspaces/connect-via-api.adoc[] + diff --git a/modules/cloud4/modules/workgroup-workspace/pages/index.adoc b/modules/cloud4/modules/workgroup-workspace/pages/index.adoc new file mode 100644 index 00000000..35902d18 --- /dev/null +++ b/modules/cloud4/modules/workgroup-workspace/pages/index.adoc @@ -0,0 +1,53 @@ += Workgroups and Workspaces +:experimental: + +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. + +== 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] +and learning xref:cloud4:workgroup-workspace:workgroups/how2-workgroup-access.adoc[]. + + +== xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Workspace and Database Overview] +Learn xref:cloud4:workgroup-workspace:workspaces/how2-create-a-workspace.adoc[] and unlock its many features. + +Such as: + +* xref:cloud4:workgroup-workspace:workspaces/settings.adoc[] +- +Learn how advanced settings in workspace allow users to customize and fine tune various aspects of their workspace configuration. + +* xref:cloud4:workgroup-workspace:workspaces/readwrite-readonly.adoc[] +- +Learn how Read-Write (RW) and Read-Only (RO) Workspaces will connect to a database. + +* xref:cloud4:workgroup-workspace:workspaces/workspace-size.adoc[] +- +Learn how to specify the size based on your data and performance requirements. + +* xref:cloud4:workgroup-workspace:workspaces/expansion-shrink.adoc[] +- +Learn how to adjust the capacity of your workspaces as your data grows or changes. + +* xref:cloud4:workgroup-workspace:workgroups/backup-and-restore.adoc[] +- +Learn how to create backup points and restore your workspace to a specific point in time. + +* xref:cloud4:workgroup-workspace:workspaces/connect-via-api.adoc[] +- +Learn how to connect to your graph database using REST APIs. + +* xref:cloud4:workgroup-workspace:workgroups/monitor-workspaces.adoc[] +- +Learn how TigerGraph Cloud 4 offers comprehensive monitoring capabilities that allow you to track the status and resource usage of your workspaces. + +== Next Steps + +Next, learn how to xref:cloud4:graph-development:load-data/index.adoc[Load Data] into TigerGraph Cloud 4. + +Or return to the xref:cloud4:overview:index.adoc[Overview] page for a different topic. + + + diff --git a/modules/cloudbeta/modules/resource-manager/pages/backup-and-restore.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/backup-and-restore.adoc similarity index 76% rename from modules/cloudbeta/modules/resource-manager/pages/backup-and-restore.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workgroups/backup-and-restore.adoc index 59be5106..43c42160 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/backup-and-restore.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/backup-and-restore.adoc @@ -14,7 +14,7 @@ Discover how to create backup points and restore your workspace to a specific po [IMPORTANT] ==== -Backup functionality is currently available only for xref:cloudBeta:resource-manager:workspaces/writeread_readonly.adoc#_read_write_rw_workspace[Read-Write (RW) workspaces]. +Backup functionality is currently available only for xref:cloud4:workgroup-workspace:workspaces/readwrite-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[] @@ -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 @@ -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 @@ -107,9 +105,9 @@ 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[]. +Next, learn more about how to xref:cloud4:workgroup-workspace:workspaces/connect-via-api.adoc[] a workspace, or xref:cloud4:workgroup-workspace:workgroups/monitor-workspaces.adoc[]. -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-config-network-access.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-config-network-access.adoc new file mode 100644 index 00000000..7bda3c8e --- /dev/null +++ b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-config-network-access.adoc @@ -0,0 +1,84 @@ += How to Configure Network Access +:experimental: + +The IP Allowlist feature in TigerGraph Cloud 4 is designed to enhance the security of your data by controlling which networks can access your resources. By specifying allowed IP addresses or ranges, you can safeguard your data from unauthorized access, data exfiltration, and insider threats. + +== Accessing the IP Allowlist Configuration + +To access the IP Allowlist configuration, navigate to the Network Access tab for your workgroup in TigerGraph Cloud 4. Here, you will find options to view, add, and manage the IP addresses that are permitted to access your data. + + +== Your IP Address + +Your current IP address is displayed at the top of the IP Allowlist configuration page. For example: + + Your IP: xxx.xxx.39.130 + +If your IP address is already included in the IP Allowlist, it will be explicitly mentioned: + + Your IP is included in the IP allowlist. + +== Managing the IP Allowlist + +=== Viewing the IP Allowlist + +The IP Allowlist table displays the current IP addresses and ranges that are allowed to access your data. The table includes the following columns: + +* IP Range: The IP address or range that is allowed. +* Note: A description or note for the IP address or range. +* Actions: Options to edit or remove the IP address or range. + +image::ip-allowlist.png[width=1200] + +=== Adding an IP Address or Range + +To add a new IP address or range to the allowlist, follow these steps: + +image::edit-ip-allowlist.png[] + +1. Click on btn:[Add IP]: This will open a form to add a new IP address or range. +2. Enter the IP Range: Specify the IP address or range in CIDR notation. For example, 192.168.1.0/24 for a range or 192.168.1.2/32 for a single IP address. +3. You can click on the btn:[Add My Current IP Address] button to automatically add your current IP address to the allowlist. +4. Add a Note: Provide a description or note for the IP address or range. This can help you remember why the IP was added. +5. Save: Click the btn:[Save] button to add the IP address or range to the allowlist. + +=== Editing an IP Address or Range +To edit an existing IP address or range: + +1. Click btn:[Edit] next to the IP address or range you want to modify. +2. Update the IP Range or Note: Make the necessary changes. +3. Save: Click btn:[Save] to apply the changes. + +=== Removing an IP Address or Range + +To remove an existing IP address or range: + +1. Click "Remove" next to the IP address or range you want to delete. +2. Confirm Removal: Confirm that you want to remove the IP address or range from the allowlist. + +=== Best Practices + +1. Use CIDR Notation: Specify IP ranges using CIDR notation to efficiently manage large groups of IP addresses. +2. Regularly Review the Allowlist: Periodically review the IP Allowlist to ensure that only necessary IP addresses have access. +3. Add Descriptive Notes: Use the Note field to add meaningful descriptions for each IP address or range, making it easier to manage and audit. + + +== Next Step + +Now, learn xref:cloud4:workgroup-workspace:workgroups/how2-workgroup-access.adoc[] or learn more about xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Workspaces and Databases]. + +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. + +//// +xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Workspaces and Databases, role=next-button] + +[.next-button] +xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Link Text] + +:next-button: pass:[xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Next]] +{next-button} + +++++ +Next +++++ +//// \ No newline at end of file diff --git a/modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-create-a-workgroup.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-create-a-workgroup.adoc new file mode 100644 index 00000000..187c9b87 --- /dev/null +++ b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-create-a-workgroup.adoc @@ -0,0 +1,59 @@ += How to Create a Workgroup +:experimental: + +To learn more about workgroups see xref:cloud4:workgroup-workspace:workgroups/workgroup.adoc[]. +To create a workgroup in TigerGraph Cloud 4, follow the steps below. + +== Create a Workgroup + +[Placeholder for create workgroup screenshot] + +. Log in to your TigerGraph Cloud account. ++ +image::signup.png[width=450] + +. Click on the btn:[Create Workspace] button on your landing page. ++ +image::landing-page.png[] + +. Alternatively, from the dashboard, navigate to the btn:[Workgroups] section and click on the btn:[Create Workgroup] or you can click on the image:plusbutton.png[width=50,height=50] button next to btn:[Workgroups]. ++ +image::no-workgroup.png[] + + +. Provide a name for the workgroup. ++ +[NOTE] +==== +Choose a name that reflects the purpose of your project or initiative. +==== ++ +image::create-workgroup.png[width=1500] +. Choose the cloud provider and the region ++ +[NOTE] +==== +TigerGraph Cloud 4 currently only operates on xref:cloud4:resources:aws.adoc[]. We are actively working on expanding to xref:cloud4:resources:gcp.adoc[] and xref:cloud4:resources:azure.adoc[]. Visit each platform's reference page to learn more about the available regions. +==== + +. Finally, click on the btn:[Next] button to create the workgroup. + +== Next Step + +Now, learn xref:cloud4:workgroup-workspace:workgroups/how2-workgroup-access.adoc[] or learn more about xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Workspaces and Databases]. + +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. + +//// +xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Workspaces and Databases, role=next-button] + +[.next-button] +xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Link Text] + +:next-button: pass:[xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Next]] +{next-button} + +++++ +Next +++++ +//// \ No newline at end of file diff --git a/modules/cloudbeta/modules/resource-manager/pages/how2-workgroup-access.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-workgroup-access.adoc similarity index 64% rename from modules/cloudbeta/modules/resource-manager/pages/how2-workgroup-access.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-workgroup-access.adoc index 8a215ec7..7cf55eff 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/how2-workgroup-access.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/how2-workgroup-access.adoc @@ -1,11 +1,11 @@ -= How to Manage Workgroup Access += How to Manage Workgroup and Workspace Permissions :experimental: In TigerGraph Cloud, access management allows you to configure permissions at both the user level and the resource level. == User Level Permission At the user level, you can define permissions that apply to individual users or groups of users. -User level permissions determine what actions a user can perform across the entire TigerGraph Cloud 4.0 organization. +User level permissions determine what actions a user can perform across the entire TigerGraph Cloud 4 organization. [TIP] @@ -13,7 +13,7 @@ User level permissions determine what actions a user can perform across the enti These permissions are typically related to administrative tasks and access to workgroups and workspaces. ==== -You can go to xref:cloudBeta:administration:how2-access-mgnt.adoc[] to manage access at the user level. +You can go to xref:cloud4:administration:how2-access-mgnt.adoc[] to manage access at the user level. == Resource Level @@ -41,24 +41,24 @@ Users added to the workgroup will be granted the workgroup admin role, which pro Workgroup admins have the authority to add users, assign roles, and configure permissions within the workgroup. ==== -For more information about workgroup admin please refer to xref:cloudBeta:administration:how2-access-mgnt.adoc#_permissions[Permissions]. +For more information about workgroup admin please refer to xref:cloud4:administration:how2-access-mgnt.adoc#_permissions[Permissions]. ==== Workspace Permissions When you configure permissions for a workspace, you can specify access rights for that specific workspace within a workgroup. The parent workgroup admins or organization admins automatically grant admin permissions for the workspace. -For more information about workspace admin role and workspace member role please refer to xref:cloudBeta:administration:how2-access-mgnt.adoc#_permissions[Permissions]. +For more information about workspace admin role and workspace member role please refer to xref:cloud4:administration:how2-access-mgnt.adoc#_permissions[Permissions]. [NOTE] ==== -For Organization Admins, Workgroup Admins, and Workspace Admins, the superuser database role is automatically granted. -This role provides extensive privileges and permissions within the graph database. -For more information about the superuser role and its capabilities, please refer to the TigerGraph documentation xref:gui:graphstudio:user-access-management.adoc#_role_and_graph_based_access_control[Role and Graph Based Access Control]. +* For Organization Admins, Workgroup Admins, and Workspace Admins, the Superuser database role is automatically granted. This role provides extensive privileges and permissions within the graph database. +* For Workspace Member, the Global Observer database role is automatically granted. This role provides minimum access to the graph database. +* For more information about the database roles and their capabilities, please refer to the TigerGraph documentation xref:gui:graphstudio:user-access-management.adoc#_role_and_graph_based_access_control[Role and Graph Based Access Control]. ==== == Next steps -Now, learn more about xref:cloudBeta:resource-manager:workspaces/workspace.adoc[Workspaces and Databases]. +Now, learn more about xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Workspaces and Databases]. -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/resource-manager/pages/monitor_workspaces.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/monitor-workspaces.adoc similarity index 59% rename from modules/cloudbeta/modules/resource-manager/pages/monitor_workspaces.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workgroups/monitor-workspaces.adoc index 3bcb1624..9c42da19 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/monitor_workspaces.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/monitor-workspaces.adoc @@ -2,13 +2,18 @@ :experimental: Monitoring the performance and health of your workspaces is essential for efficient operations. -TigerGraph Cloud offers comprehensive monitoring capabilities that allow you to track the status and resource usage of your workspaces. +TigerGraph Cloud 4 offers comprehensive monitoring capabilities that allow you to track the status and resource usage of your workspaces. You can monitor metrics such as CPU utilization, memory usage, and storage consumption, enabling you to optimize performance, identify bottlenecks, and ensure the smooth operation of TigerGraph databases using a Grafana dashboard. == How to Start Monitoring .To start monitoring, follow these steps: -. Go to the workspace btn:[...] menu. + +. Go to the `Monitor` tab on your workgroup dashboard. ++ +image::tabs.png[width="1600"] + +. Alternatively, go to the workspace btn:[...] menu. + image::Screenshot 2024-04-30 at 10.25.29 AM.png[width="300"] @@ -18,9 +23,9 @@ image::workspace-monitor-tab.png[] == Next Steps -Next, Learn how to xref:load-data:index.adoc[Load Data] into TigerGraph Cloud 4.0. +Next, Learn how to xref:graph-development:load-data/index.adoc[Load Data] into TigerGraph Cloud 4. -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/resource-manager/pages/workgroup.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/workgroup.adoc similarity index 51% rename from modules/cloudbeta/modules/resource-manager/pages/workgroup.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workgroups/workgroup.adoc index c9eccae1..b4ff3f39 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workgroup.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workgroups/workgroup.adoc @@ -1,7 +1,7 @@ = 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:cloudBeta:resource-manager:workspaces/workspace.adoc[Workspaces and Databases] related to a specific use case, team, or application. +A workgroup represents a project or a logical group within TigerGraph Cloud 4. +It serves as a container that holds multiple xref:cloud4:workgroup-workspace:workspaces/workspace.adoc[Workspaces and Databases] related to a specific use case, team, or application. //image::defineworkgroupvsworkspace2.png[] @@ -12,7 +12,7 @@ Workgroups provide a way to organize and manage resources, access controls, and == Next Step -See xref:how2-create-a-workgroup.adoc[] to get started. +See xref:cloud4:workgroup-workspace:workgroups/how2-create-a-workgroup.adoc[] to get started. -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/resource-manager/pages/connect_via_api.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/connect-via-api.adoc similarity index 88% rename from modules/cloudbeta/modules/resource-manager/pages/connect_via_api.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workspaces/connect-via-api.adoc index fee6cfa5..c1fac825 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/connect_via_api.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/connect-via-api.adoc @@ -22,7 +22,7 @@ image::Screenshot 2024-04-28 at 9.36.29 PM.png[] + [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. +You can go to xref:cloud4:graph-development:design-schema/index.adoc[Design Schema] 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"] @@ -64,6 +64,6 @@ If you need to connect using the database secret, please refer to xref:tigergrap == Next Steps -Next, learn more about how to xref:cloudBeta:resource-manager:monitor_workspaces.adoc[]. +Next, learn more about how to xref:cloud4:workgroup-workspace:workgroups/monitor-workspaces.adoc[]. -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/resource-manager/pages/expansion_shrink.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/expansion-shrink.adoc similarity index 77% rename from modules/cloudbeta/modules/resource-manager/pages/expansion_shrink.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workspaces/expansion-shrink.adoc index 12b17397..67a95f29 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/expansion_shrink.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/expansion-shrink.adoc @@ -50,9 +50,9 @@ It is recommended to schedule the expansion or shrink during a time when minimal == Next Steps -Next, learn more about how to xref:cloudBeta:resource-manager:backup-and-restore.adoc[], xref:cloudBeta:resource-manager:connect_via_api.adoc[], or xref:cloudBeta:resource-manager:monitor_workspaces.adoc[]. +Next, setup xref:cloud4:workgroup-workspace:workspaces/schedule.adoc[Schedule] or learn more about how to xref:cloud4:workgroup-workspace:workgroups/backup-and-restore.adoc[], xref:cloud4:workgroup-workspace:workspaces/connect-via-api.adoc[], or xref:cloud4:workgroup-workspace:workgroups/monitor-workspaces.adoc[]. -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/how2-create-a-workspace.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/how2-create-a-workspace.adoc similarity index 62% rename from modules/cloudbeta/modules/resource-manager/pages/workspaces/how2-create-a-workspace.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workspaces/how2-create-a-workspace.adoc index ff0336c3..2ea50eea 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/how2-create-a-workspace.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/how2-create-a-workspace.adoc @@ -2,48 +2,53 @@ :experimental: To learn more about workspaces see xref:workspaces/workspace.adoc[]. -To create a workspace in TigerGraph Cloud 4.0 follow the steps below: +To create a workspace in TigerGraph Cloud 4 follow the steps below: == Create a Workspace . Log in to your TigerGraph Cloud account. + -image::loginPage.png[width=250] +image::signup.png[width=450] + . From the dashboard, navigate to the btn:[Workgroups] section Click on the btn:[ Create Workspace ] button. + image::workspacecreate.png[] ++ . Provide a name for the workspace. ++ [NOTE] +==== Choose a name that reflects the purpose of your workspace. +==== + image::workspaceinfo.png[] -+ + . Select a TigerGraph workspace runtime. + + -//Please review the release notes in https://docs.tigergraph.com/tigergraph-server/current/release-notes/. . Specify workspace size and advanced settings. + image::workspaceDetails.png[] + -. For supported workspace sizes, please go to the Workspace Size page. +. For supported workspace sizes, please go to the xref:cloud4:workgroup-workspace:workspaces/workspace-size.adoc[] page. -. For advanced settings please refer to xref:cloudBeta:resource-manager:workspaces/advanced-settings/advanced-settings.adoc[] page. +. For advanced settings please refer to xref:cloud4:workgroup-workspace:workspaces/settings.adoc[] page. . Specify database name or attach to an existing database. .. This allows you to create Read-Write (RW) workspace or Read-Only (RO) workspace. -For more details, please refer to xref:cloudBeta:resource-manager:workspaces/writeread_readonly.adoc[]. +For more details, please refer to xref:cloud4:workgroup-workspace:workspaces/readwrite-readonly.adoc[]. + +. Specify Solutions for your workspace, for more details please visit xref:cloud4:integrations:solutions.adoc[] page. + -. Specify Add-ons to your workspace, for more details please visit xref:cloudBeta:integrations:add-ons.adoc[] page. +image::solution-add-on.png[] + +. Specify Add-ons to your workspace, for more details please visit xref:cloud4:integrations:add-ons.adoc[] page. + image::Add-onsimage.png[] -. Specify Solutions for your workspace, for more details please visit xref:cloudBeta:integrations:solutions.adoc[] page. -+ -image::choose-solution.png[] . Click on the btn:[ Create ] button to create the workspace. + [NOTE] @@ -71,6 +76,6 @@ image::workspace-database-tab.png[] == Next Steps -Now, that you have a workspace created see xref:cloudBeta:resource-manager:workspaces/advanced-settings/advanced-settings.adoc[] or learn more about xref:cloudBeta:resource-manager:workspaces/writeread_readonly.adoc[]. +Now, that you have a workspace created see xref:cloud4:workgroup-workspace:workspaces/settings.adoc[] or learn more about xref:cloud4:workgroup-workspace:workspaces/readwrite-readonly.adoc[]. -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/readwrite-readonly.adoc similarity index 82% rename from modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workspaces/readwrite-readonly.adoc index 887fe20b..cc8241bf 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/readwrite-readonly.adoc @@ -43,8 +43,8 @@ It is recommended to schedule the update during a time when minimal or no operat == Next Steps -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. +Next, about xref:cloud4:workgroup-workspace:workspaces/workspace-size.adoc[Workspace Sizes] or learn how to xref:cloud4:workgroup-workspace:workspaces/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. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/workgroup-workspace/pages/workspaces/schedule.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/schedule.adoc new file mode 100644 index 00000000..40710939 --- /dev/null +++ b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/schedule.adoc @@ -0,0 +1,53 @@ += Workspace Schedule +:experimental: + +TigerGraph Cloud 4 provides the ability to schedule workspace actions such as stopping, starting, expanding, and shrinking your workspace. This guide will walk you through the steps to configure and schedule these actions using the TigerGraph Cloud UI. + +== Steps to Schedule Workspace Actions + +=== 1) Open the Scheduler + +. Click on the btn:[Edit] button from the btn:[...] menu of your workspace, and navigate to the btn:[Advanced Settings] tab. + ++ +image:schedule-1.png[width=600] + +. In the schedule section, add new schedule by clicking the btn:[+] button or select edit option of an existing schedule. + ++ +image:schedule-2.png[width=600] + +=== 2) Configure the Scheduler + +. Choose your timezone from the dropdown menu. + +. Select the repeat option for your schedule: `Daily`, `Weekly`, `Weekdays`. If you do not want the action to repeat, select `No Repeat`. + +. Specify the time of day you want the action to occur. + +. Choose the desired workspace size from the Workspace Size dropdown menu. The sizes include vCPUs, RAM, and the associated cost per hour. Learn more at xref:workspaces/workspace-size.adoc[]. + ++ +image:schedule-3.png[width=150] + +. Click on the btn:[Save] button to save your schedule, then your schedule will be displayed in the schedule list. + ++ +image:schedule-4.png[width=600] + +[NOTE] +==== +An expansion or shrink is an offline operation. +If there are any other operations in progress on the workspace, they will be affected. +==== + +[TIP] +==== +Use this feature to automate workspace actions and optimize resource usage. +==== + + +== Next Steps +See xref:workspaces/how2-create-a-workspace.adoc[] to get started. + +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloud4/modules/workgroup-workspace/pages/workspaces/settings.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/settings.adoc new file mode 100644 index 00000000..c9c0a97d --- /dev/null +++ b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/settings.adoc @@ -0,0 +1,140 @@ += Workspace Settings +:experimental: + +The settings in workspace allow users to customize and fine tune various aspects of their workspace configuration. +These settings include options like *auto-suspend* and *auto-resume*, which automate the suspension and resumption of the workspace based on activity levels. + +[NOTE] +==== +Only users with the roles of *Workspace Admin*, *Workgroup Admin*, or *Org Admin* can access the workspace settings menu. +==== + +To access the workspace settings, click on the btn:[ ... ] button next to the btn:[Connect] button on your workspace, then select the *Edit* option from the dropdown menu + +image::workspace-general-tab.png[] + +A configuration panel will appear on the right side of your screen. + +== General Settings + +In the *General* tab, users can configure basic workspace options such as workspace size. + +image::general-settings.png[] + +=== Workspace Size Suggestion + +The *Size Suggestion* feature helps users select the appropriate workspace size by specifying the raw data size, compression ratio, and whether High Availability (HA) is enabled. + +image::capacity-planning.png[] + +How to Use Size Suggestion: + +* Raw Data Size: Enter the total size of your raw data in gigabytes (GB). +* Compression Ratio: Specify the expected compression ratio. This ratio helps estimate the actual memory required after data compression. +* Enable High Availability (HA): Indicate whether you want to enable High Availability for your workspace. Enabling HA ensures redundancy and improves fault tolerance. + +Based on these inputs, the we will recommend an optimal workspace size that balances performance and cost efficiency. + +[NOTE] +==== +The size suggestion is for guidance only. Actual requirements may vary based on specific use cases and data characteristics. +==== + +== Advanced Settings + +In the *Advanced Settings* tab, users can set the desired time intervals for auto-suspend and enable auto-resume to optimize resource usage and ensure a smooth user experience. + +image::advanced-settings-new.png[] + +=== Auto-Suspend + +Auto-suspend will automatically suspend your workspace after a specified period of inactivity. + +[TIP] +==== +This helps optimize resource utilization and cost when the workspace is not actively being used. +==== + +Choose an appropriate time interval for auto-suspend based on your typical usage patterns. + +image::auto-suspend.png[] + +For example, if your workspace is usually inactive for long periods, you can set a shorter interval for auto-suspend to conserve resources. + +[CAUTION] +Be mindful of any background processes or scheduled tasks that may require the workspace to remain active. +Adjust the auto-suspend interval accordingly to avoid interrupting critical processes. + +==== Auto-Suspend Limitations + +.The following operations are not treated as "active" and will not prevent the workspace from being auto-suspended: +* Consuming TigerGraph Cloud Controller APIs +* Configuring the workspace. +* Monitoring the workspace. +* Backuping/Restoring the workspace. + +=== Auto-Resume +Auto-resume will automatically resume your workspace when activity is detected. + +[TIP] +==== +This ensures a seamless user experience without the need for manual intervention. +==== +image::auto-resume.png[] + +When the Auto Resume is enabled, the workspace will become “Idle” state instead of “Stopped”. +Auto-resume will kick-in when users access tools and rest APIs. + +[NOTE] +==== +The first request that hits the Workspace when it is idle will trigger a start workspace request. The request itself is not buffered so you should keep retrying until it is successful. +==== + +==== Auto-Resume Limitations + +.The following endpoints will not trigger auto-resume: +* Consuming TigerGraph Cloud Controller APIs + +== Add-ons + +The *Add-ons* section allows users to enable and disable additional features and integrations based on their needs. This flexibility helps tailor the workspace to specific requirements and enhances functionality. + +image::add-on.png[] + +For the list of available add-ons and their capabilities, please refer to xref:cloud4:integrations:add-ons.adoc[]. + +[NOTE] +==== +Some add-ons may require additional configuration or incur extra costs. Review the documentation for each add-on to understand its capabilities and requirements. +==== + +== Alerts + +The *Alerts* section allows users to set up notifications for various workspace events. Alerts help monitor the health and performance of your workspace and ensure timely responses to critical events. + +image::alerts.png[] + +[NOTE] +==== +Alerts will be sent to the workspace creator email address. +==== + +== Graph Admin + +The *Graph Admin* section provides access to advanced administrative settings for your graph database. These settings allow you to manage TigerGraph Server settings. + +image::graph-admin.png[] + +[NOTE] +==== +Updating Graph Admin settings might result in the restart of certain TigerGraph services, which can cause temporary interruptions. +==== + +== Next Steps + +Next, learn about xref:cloud4:workgroup-workspace:workspaces/readwrite-readonly.adoc[] or learn more about xref:cloud4:workgroup-workspace:workspaces/workspace-size.adoc[]. + +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. + + + diff --git a/modules/cloud4/modules/workgroup-workspace/pages/workspaces/workspace-size.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/workspace-size.adoc new file mode 100644 index 00000000..9961233d --- /dev/null +++ b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/workspace-size.adoc @@ -0,0 +1,67 @@ += Workspace Size + +When creating a workspace, you can specify the size based on your data and performance requirements. +TigerGraph Cloud 4 offers multiple size options, allowing you to choose the appropriate capacity for your graph databases. + +[TIP] +The size determines the number of instances and the allocated resources for your workspace. + +== Workspace Size Table + +We provide the following workspace sizes on TigerGraph Cloud 4. + +[cols=6] +|=== +| Size | VCPU | Memory (GiB) | Pod Size | Maximum Topology Size(GiB) | Partition + +|TG-00|2|16|C2M16| 8 | 1 + +|TG-0|4|32|C4M32| 16 |1 + +|TG-1|8|64|C8M64| 32 |1 + +|TG-2|16|128|C16M128| 64 |1 + +|TG-4|32|256|C32M256| 128 | 1 + +|TG-6|48|384|C48M384| 192 |1 + +|TG-8|64|512|C64M512| 256 |1 + +|TG-16|128|1024|C64M512| 512 |2 + +|TG-24|192|1536|C64M512| 768 |3 + +|TG-32|256|2048|C64M512| 1024 |4 + +|TG-40|320|2560|C64M512| 1280 |5 + +|TG-48|384|3072|C64M512| 1536 |6 + +|TG-56|448|3584|C64M512| 1792 |7 + +|TG-64|512|4096|C64M512| 2048 |8 + +|TG-128|1024|8192|C64M512| 4096 |16 + +|=== + +Please contact support@tigergraph.com if you need a workspace size that is not listed in the table. + +//// +TigerGraph Size Capacity Planner (TBD) + +To help you determine the ideal workspace size for your graph databases, TigerGraph provides the TigerGraph Size Capacity Planner. This tool helps estimate the required resources based on factors such as data volume, query complexity, and expected workload. By using the TigerGraph Size Capacity Planner, you can make informed decisions about the size of your workspace, ensuring optimal performance and cost-effectiveness. + +[User input of estimated data size] + +Choosing the right workspace size is crucial for achieving optimal performance and cost efficiency. The TigerGraph Size Capacity Planner empowers you to make informed decisions and effectively manage the resources for your graph databases within TigerGraph Cloud. +//// +== Next Steps + +See xref:cloud4:workgroup-workspace:workspaces/expansion-shrink.adoc[] to learn how to change the size of a workspace or +return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. + +Or visit xref:cloud4:overview:pricing.adoc[] and xref:cloud4:overview:cost-estimation.adoc[] for detailed information on the costs associated with different workspace sizes. + + diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/workspace.adoc b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/workspace.adoc similarity index 78% rename from modules/cloudbeta/modules/resource-manager/pages/workspaces/workspace.adoc rename to modules/cloud4/modules/workgroup-workspace/pages/workspaces/workspace.adoc index 80e32ac3..7af80052 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/workspace.adoc +++ b/modules/cloud4/modules/workgroup-workspace/pages/workspaces/workspace.adoc @@ -2,7 +2,7 @@ A *Workspace* is a compute unit within a TigerGraph database. It is where the graph processing and analytics take place. -TigerGraph Cloud 4.0 supports two types of workspaces: read-write workspaces and read-only workspaces. +TigerGraph Cloud 4 supports two types of workspaces: read-write workspaces and read-only workspaces. ** *Read-Write Workspaces (RW)*: These workspaces allow read and write operations on the graph data. They are typically used for data ingestion, data updates, and running queries that modify the graph structure or properties. @@ -16,7 +16,7 @@ Read-only workspaces provide improved performance and scalability for read opera 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. +* The *database* in TigerGraph Cloud 4 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. + @@ -28,4 +28,4 @@ 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. -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. +Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/antora.yml b/modules/cloudbeta/antora.yml deleted file mode 100644 index dbea6c33..00000000 --- a/modules/cloudbeta/antora.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: cloudBeta -title: TigerGraph Cloud 4.0 -version: main -display_version: default -start_page: overview:index.adoc - -nav: - - modules/overview/nav.adoc - - modules/release-notes/nav.adoc - - modules/get-started/nav.adoc - - modules/resource-manager/nav.adoc - - modules/load-data/nav.adoc - - modules/schema-designer/nav.adoc - - modules/gsql-editor/nav.adoc - - modules/explore-graph/nav.adoc - - modules/integrations/nav.adoc - - modules/administration/nav.adoc - - modules/security/nav.adoc - - modules/billing-manager/nav.adoc - - modules/resources/nav.adoc diff --git a/modules/cloudbeta/modules/administration/nav.adoc b/modules/cloudbeta/modules/administration/nav.adoc deleted file mode 100644 index 7ae28dfc..00000000 --- a/modules/cloudbeta/modules/administration/nav.adoc +++ /dev/null @@ -1,10 +0,0 @@ -* xref:index.adoc[Administration] -** xref:administration:how2-invite-users.adoc[] -** xref:administration:how2-access-mgnt.adoc[] -** xref:administration:how2-use-organization-mgnt.adoc[] - -//// -** xref:cloudBeta:security:index.adoc[] -*** xref:cloudBeta:security:password-policy.adoc[] -*** xref:cloudBeta:security:idp.adoc[] -//// \ No newline at end of file diff --git a/modules/cloudbeta/modules/administration/pages/index.adoc b/modules/cloudbeta/modules/administration/pages/index.adoc deleted file mode 100644 index 9584e7d5..00000000 --- a/modules/cloudbeta/modules/administration/pages/index.adoc +++ /dev/null @@ -1,22 +0,0 @@ -= Administration Overview -:experimental: - -Here you can learn about the tools available for organizational administrators. - -== xref:cloudBeta:administration:how2-invite-users.adoc[] - -Learn how to invite new users to your organizations. - -== xref:cloudBeta:administration:how2-access-mgnt.adoc[] - -Learn how to manage access to workspaces and resources within TigerGraph Cloud 4.0. - -== xref:cloudBeta:administration:how2-use-organization-mgnt.adoc[] - -Learn about the organization management features that allow you to configure organization settings. - -== Next Steps - -Next, learn about xref:security:index.adoc[] or additional xref:cloudBeta:resources:index.adoc[] in TigerGraph Cloud 4.0. - -Return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/billing-manager/nav.adoc b/modules/cloudbeta/modules/billing-manager/nav.adoc deleted file mode 100644 index 8087d23e..00000000 --- a/modules/cloudbeta/modules/billing-manager/nav.adoc +++ /dev/null @@ -1,9 +0,0 @@ -* xref:index.adoc[Billing] -** xref:cloudBeta:billing-manager:payment-methods.adoc[] -** xref:cloudBeta:billing-manager:invoices.adoc[] -** xref:cloudBeta:billing-manager:pricing.adoc[] - - -//** xref:cloudBeta:billing-manager:compute_price.adoc[] -//** xref:cloudBeta:billing-manager:storage_price.adoc[] - diff --git a/modules/cloudbeta/modules/billing-manager/pages/compute_price.adoc b/modules/cloudbeta/modules/billing-manager/pages/compute_price.adoc deleted file mode 100644 index 971e5978..00000000 --- a/modules/cloudbeta/modules/billing-manager/pages/compute_price.adoc +++ /dev/null @@ -1 +0,0 @@ -= Compute Price \ No newline at end of file diff --git a/modules/cloudbeta/modules/billing-manager/pages/index.adoc b/modules/cloudbeta/modules/billing-manager/pages/index.adoc deleted file mode 100644 index 65d170a5..00000000 --- a/modules/cloudbeta/modules/billing-manager/pages/index.adoc +++ /dev/null @@ -1,28 +0,0 @@ -= Billing Overview -:experimental: - -Billing allows you to stay in control of your account, optimize resource usage, and manage costs effectively. -Understand the billing process and manage your subscription within TigerGraph Cloud 4.0 with the billing manager UI. - -image::Screenshot 2024-04-28 at 12.11.56 PM.png[] - -Check out the links below to explore more billing information to utilize. - -== xref:cloudBeta:billing-manager:payment-methods.adoc[] - -Learn how you can manage payment methods. - -== xref:billing-manager:invoices.adoc[] - -Learn how to view and export invoices. - -== xref:cloudBeta:billing-manager:pricing.adoc[] - -Here you can review pricing information in TIgerGraph Cloud 4.0. - -//== xref:cloudBeta:billing-manager:compute_price.adoc[] - -//== xref:cloudBeta:billing-manager:storage_price.adoc[] - - - diff --git a/modules/cloudbeta/modules/billing-manager/pages/pricing.adoc b/modules/cloudbeta/modules/billing-manager/pages/pricing.adoc deleted file mode 100644 index 3607c91c..00000000 --- a/modules/cloudbeta/modules/billing-manager/pages/pricing.adoc +++ /dev/null @@ -1,87 +0,0 @@ -= Pricing - -== Compute price - -[cols="4", separator=¦ ] -|=== -¦Size ¦VCPU ¦Memory (GB) ¦Price (TCR/hour) Price - -¦ TG-00 -¦ 2 -¦ 16 -¦ 0.25 - -¦ TG-0 -¦ 4 -¦ 32 -¦ 0.5 - -¦ TG-1 -¦ 8 -¦ 64 -¦ 1 - -¦ TG-2 -¦ 16 -¦ 128 -¦ 2 - -¦ TG-4 -¦ 32 -¦ 256 -¦ 4 - -¦ TG-6 -¦ 48 -¦ 384 -¦ 6 - -¦ TG-8 -¦ 64 -¦ 512 -¦ 8 - -¦ TG-12 -¦ 96 -¦ 768 -¦ 12 - -¦ TG-16 -¦ 128 -¦ 1024 -¦ 16 - -|=== - -== Add-on Prices - -[cols="3", separator=¦ ] -|=== -¦Add-On ¦Scope ¦Price - - -¦ CoPilot -¦ Workspace -¦ 30% of the workspace usage. - -¦ Insights -¦ Workspace -¦ 10% of the workspace usage. - -¦ GraphStudio -¦ Workspace -¦ Free - -¦ GraphQL -¦ Workspace -¦ Free - -|=== - -== 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. - -Return to the page to xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. - - diff --git a/modules/cloudbeta/modules/explore-graph/nav.adoc b/modules/cloudbeta/modules/explore-graph/nav.adoc deleted file mode 100644 index fa0abc8b..00000000 --- a/modules/cloudbeta/modules/explore-graph/nav.adoc +++ /dev/null @@ -1,3 +0,0 @@ -* xref:index.adoc[] -** xref:explore-graph:how2-use-pattern-search.adoc[] -** xref:cloudBeta:explore-graph:copilot-enablement.adoc[] \ No newline at end of file diff --git a/modules/cloudbeta/modules/explore-graph/pages/copilot-enablement.adoc b/modules/cloudbeta/modules/explore-graph/pages/copilot-enablement.adoc deleted file mode 100644 index 279c049f..00000000 --- a/modules/cloudbeta/modules/explore-graph/pages/copilot-enablement.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= CoPliot - - -CoPilot is meticulously designed to enhance productivity across various business functions, including analytics, development, and administration tasks. -The insights can then be presented as natural language, graph visualizations, and other perspectives. - -Its benefits are invaluable across a spectrum of domains, including customer service, marketing, sales, data science, DevOps, and engineering. - - -[TIP] -==== -With CoPilot, organizations can unlock the full potential of their data and drive informed decision-making like never before. -It empowers business analysts, data scientists, and developers to use natural language to run real-time queries against up-to-date data at scale. -==== - -See the xref:tg-copilot:getstarted:index.adoc[] and the TigerGraph CoPilot xref:tg-copilot:getstarted:oncloud.adoc[] documentations for more details. - -== Next Steps - -Once enabled, learn xref:tg-copilot:using-copilot:how2-use-on-cloud.adoc[] on our new TigerGraph CoPliot documentation. - -Or explore additional add-ons on the xref:integrations:index.adoc[] page or continue on to learn about the xref:administration:index.adoc[Administration] features or xref:security:index.adoc[] in TigerGraph Cloud 4.0. - -Return to xref:cloudBeta:integrations:index.adoc[Marketplace] or the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. - diff --git a/modules/cloudbeta/modules/get-started/pages/how2-signup.adoc b/modules/cloudbeta/modules/get-started/pages/how2-signup.adoc deleted file mode 100644 index 9d4ebd0b..00000000 --- a/modules/cloudbeta/modules/get-started/pages/how2-signup.adoc +++ /dev/null @@ -1,33 +0,0 @@ -= How to Sign Up -: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 -. Click btn:[Sign Up] https://beta.tgcloud.io[on the TigerGraph Cloud landing page]. -+ -image::loginPage.png[width=450] - -. 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. - -. When registering for a new TigerGraph Cloud 4.0 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:cloudBeta:administration:how2-use-organization-mgnt.adoc[] page. -==== - -== Next Steps - -The next step is to xref:how2-login.adoc[Log in] your new TigerGraph Cloud 4.0. - -Or return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. - - - diff --git a/modules/cloudbeta/modules/get-started/pages/index.adoc b/modules/cloudbeta/modules/get-started/pages/index.adoc deleted file mode 100644 index 129892e6..00000000 --- a/modules/cloudbeta/modules/get-started/pages/index.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= Get Started with TigerGraph 4.0 Cloud -: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[] - -Learn how to create a TigerGraph 4.0 Cloud account and get access to the platform. - -== xref:how2-login.adoc[] - -Learn how to log in to your TigerGraph 4.0 Cloud account. - -== Next Steps - -Once logged in, learn more about xref:cloudBeta:resource-manager:index.adoc[] or jump right into creating a xref:resource-manager:workgroup.adoc[Workgroup] and xref:resource-manager:workspaces/workspace.adoc[Workspaces]. - -Return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. - - - - - - diff --git "a/modules/cloudbeta/modules/gsql-editor/Screenshot 2024-04-18 at 10.06.56\342\200\257AM.png" "b/modules/cloudbeta/modules/gsql-editor/Screenshot 2024-04-18 at 10.06.56\342\200\257AM.png" deleted file mode 100644 index 57a73879..00000000 Binary files "a/modules/cloudbeta/modules/gsql-editor/Screenshot 2024-04-18 at 10.06.56\342\200\257AM.png" and /dev/null differ diff --git a/modules/cloudbeta/modules/gsql-editor/nav.adoc b/modules/cloudbeta/modules/gsql-editor/nav.adoc deleted file mode 100644 index 63aaa9c6..00000000 --- a/modules/cloudbeta/modules/gsql-editor/nav.adoc +++ /dev/null @@ -1,2 +0,0 @@ -* xref:index.adoc[GSQL Editor] -** xref:gsql-editor:how2-edit-gsql-query.adoc[Edit Query] \ No newline at end of file diff --git a/modules/cloudbeta/modules/integrations/pages/copilot.adoc b/modules/cloudbeta/modules/integrations/pages/copilot.adoc deleted file mode 100644 index 3ea8320f..00000000 --- a/modules/cloudbeta/modules/integrations/pages/copilot.adoc +++ /dev/null @@ -1,18 +0,0 @@ -= CoPilot -:experimental: - -CoPilot empowers business analysts, data scientists, and developers to use natural language to run real-time queries against up-to-date data at scale. -The insights can then be presented as natural language, graph visualizations, and other perspectives. - -image::Screenshot 2024-04-26 at 8.22.55 AM.png[] - -[TIP] -==== -With CoPilot, organizations can unlock the full potential of their data and drive informed decision-making in TigerGraph Cloud 4.0 like never before. -==== - -== Next Steps - -Learn xref:tg-copilot:using-copilot:how2-use-on-cloud.adoc[] on our new TigerGraph CoPliot documentation. - -Or return to xref:cloudBeta:integrations:index.adoc[Marketplace] or the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/integrations/pages/index.adoc b/modules/cloudbeta/modules/integrations/pages/index.adoc deleted file mode 100644 index d6fb70f2..00000000 --- a/modules/cloudbeta/modules/integrations/pages/index.adoc +++ /dev/null @@ -1,30 +0,0 @@ -= Marketplace Overview -:experimental: - -TigerGraph Cloud seamlessly integrates with various tools and services to enhance your graph database workflow. - -== xref:cloudBeta:integrations:add-ons.adoc[] - -Learn how to extend the capabilities of TigerGraph Cloud 4.0 with add-ons tailored to your needs. - -* xref:cloudBeta:explore-graph:copilot-enablement.adoc[CoPilot (Beta)] -+ -[NOTE] -==== -TigerGraph CoPilot (beta) is disabled by default in the Marketplace menu. -Contact beta-support@tigergraph.com to enable TigerGraph CoPilot as an option in the Marketplace. -==== -* xref:cloudBeta:integrations:insights.adoc[] -* xref:cloudBeta:integrations:graphstudio.adoc[] -* xref:cloudBeta:integrations:graphql.adoc[] - -== xref:cloudBeta:integrations:solutions.adoc[] - -Here you can learn about our array of industry standard prebuilt solutions for diverse industries and use cases. -Designed for users to swiftly adopt graph technology. - -== Next Steps - -Now learn about xref:administration:index.adoc[Administration] features or xref:security:index.adoc[] in TigerGraph Cloud 4.0. - -Or return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. diff --git a/modules/cloudbeta/modules/load-data/nav.adoc b/modules/cloudbeta/modules/load-data/nav.adoc deleted file mode 100644 index dbe2e063..00000000 --- a/modules/cloudbeta/modules/load-data/nav.adoc +++ /dev/null @@ -1,5 +0,0 @@ -* xref:index.adoc[Load Data] -** xref:load-data:load-from-local.adoc[] -** xref:load-data:load-from-cloud.adoc[] -** xref:load-data:load-from-other-sources.adoc[] -*** xref:load-data:jdbc.adoc[] \ No newline at end of file diff --git a/modules/cloudbeta/modules/load-data/pages/load-from-other-sources.adoc b/modules/cloudbeta/modules/load-data/pages/load-from-other-sources.adoc deleted file mode 100644 index 0164f6d8..00000000 --- a/modules/cloudbeta/modules/load-data/pages/load-from-other-sources.adoc +++ /dev/null @@ -1,14 +0,0 @@ -= Load from Other Sources - -TigerGraph Cloud 4.0 supports various data sources for ingestion, providing flexibility in integrating with your existing data infrastructure. -GSQL templates can be used for connectors that are not yet supported in the step-by-step loading guide. -See xref:tigergraph-server:data-loading:index.adoc[Data Loading in TigerGraph DB] for guides to loading data into TigerGraph. - -Additionally, data can also be loaded from a JDBC Connection as well, See xref:cloudBeta:load-data:jdbc.adoc[] for more details. - -== Next Steps - -Next, learn how to use the xref:cloudBeta:schema-designer:index.adoc[Schema Designer] in TigerGraph Cloud 4.0. - -Or return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. - diff --git a/modules/cloudbeta/modules/overview/nav.adoc b/modules/cloudbeta/modules/overview/nav.adoc deleted file mode 100644 index 72007a76..00000000 --- a/modules/cloudbeta/modules/overview/nav.adoc +++ /dev/null @@ -1,4 +0,0 @@ -* xref:index.adoc[Introduction] -** xref:overview:overview.adoc[Overview] -** xref:cloudBeta:overview:comparison_table.adoc[Compare 4.0] - diff --git a/modules/cloudbeta/modules/overview/pages/comparison_table.adoc b/modules/cloudbeta/modules/overview/pages/comparison_table.adoc deleted file mode 100644 index 1cb069bb..00000000 --- a/modules/cloudbeta/modules/overview/pages/comparison_table.adoc +++ /dev/null @@ -1,103 +0,0 @@ -= Compare with Other TigerGraph Offering - -Most of the documentation for TigerGraph Enterprise Server also applies to TigerGraph Cloud 4.0. -Here are some differences between the different TigerGraph offerings. -|=== -| Topic | TigerGraph Enterprise Server | TigerGraph Cloud Classic | TigerGraph Cloud 4.0 - -| GSQL Graph Algorithm Library -| Yes -| Yes -| Yes - -| Release Notes -| Yes -| TigerGraph Cloud provides database versions kept up to date with TigerGraph Server releases. -| TigerGraph Cloud 4.0 provides the latest TigerGraph Server 4.0. - -| GSQL 101 -| Yes -| Basic concepts still apply, most CREATE, INSTALL, LOAD, and RUN commands are replaced with the GraphStudio GUI-based approach. -| Fully supported using GSQL Editor. - -| GSQL 102 Pattern Matching -| Yes -| The same patterns can be used in queries. -| The same patterns can be used in queries. - -| MultiGraph Overview -| Yes -| Yes -| Yes - -| Hardware and Software Requirements -| Yes -| N/A -| N/A - -| Installation and Configuration -| Yes -| There are a few simple steps to install a Starter Kit. See the xref:cloud:support:faqs.adoc[]. -| Users can install solutions at any time. - -| User Access Management -| Yes -| Yes -| Yes - -| Data Encryption -| Yes -| TigerGraph Cloud is set up already for encrypted data at rest and at motion. -| TigerGraph Cloud is set up already for encrypted data at rest and at motion. - -| System Management -| Yes -| The Cloud Admin Portal is enhanced over the TigerGraph Server Admin Portal. Backup and Restore is done through the Cloud Admin Portal. -| The Cloud Admin Portal is enhanced over the TigerGraph Server Admin Portal. Backup and Restore is done through the Cloud Admin Portal. - -| GraphStudio UI Guide -| Yes -| Yes -| Yes - -| GSQL Demo Examples -| Yes -| Yes -| Yes - -| GSQL Language Reference, Part 1 Data Definition and Loading -| Yes -| Yes. GSQL Web Shell (Paid Tiers) supports Data Definition and Loading. Data files can be imported into the filesystem through GraphStudio, or submit support request to import into the filesystem. In addition, the operations can be performed through the GraphStudio user interface. -| Yes, GSQL Editor. - -| GSQL Language Reference, Part 2 Querying -| Yes -| Yes -| Yes - -| RESTPP API User Guide -| Yes -| Yes. Note the URL assigned to your cluster. -| Yes, Connect From APIs option on all workspaces. - -| Transaction Processing and ACID Support -| Yes -| Yes -| Yes - -| Data Loader User Guides -| Yes -| S3 Loader can be used through the GraphStudio interface. In addition, S3 Loader and Kafka Loader can be used in GSQL Web Shell (Paid Tiers). -| Yes. Step-by-step guide to load local and S3 files. Provide a GSQL template for all other connectors. - -| Schema Designer -| Yes, GraphStudio interface. -| Yes, GraphStudio. -| Yes, Schema Designer & GraphStudio. -|=== - -== Next Steps - -Next, see xref:cloudBeta:get-started:index.adoc[] to unlock its full potential. - -Return to xref:cloudBeta:overview:index.adoc[TigerGraph Cloud 4.0] for another topic. diff --git a/modules/cloudbeta/modules/overview/pages/index.adoc b/modules/cloudbeta/modules/overview/pages/index.adoc deleted file mode 100644 index 64edb370..00000000 --- a/modules/cloudbeta/modules/overview/pages/index.adoc +++ /dev/null @@ -1,136 +0,0 @@ -= TigerGraph Cloud 4.0 (beta version) -: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.0 (https://beta.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:[ToolTip Practice] - -//:tooltip: pass:[Hover over this text] - -//{tooltip} - -[CAUTION] -==== -TigerGraph Cloud 4.0 is still in beta release and the documentation is in progress. -==== - -[IMPORTANT] -==== -TigerGraph Cloud 4.0 beta is for personal or R&D use and not for production use. -Please see xref:cloudBeta:resources:terms_conditions.adoc[]. -==== - -== Get to Know Your TigerGraph Cloud - -[.home-card,cols="2",grid=none,frame=none, separator=¦] -|=== -¦ -image:getstarted-homecard.png[alt=getstarted,width=74,height=74] -*Get Started* - -xref:cloudBeta:get-started:index.adoc[Get Started] using TigerGraph Cloud 4.0 or explore key features in our xref:overview:overview.adoc[]. - -xref:get-started:how2-signup.adoc[How to Sign Up] | -xref:cloudBeta:get-started:how2-login.adoc[] -¦ -image:insights.png[alt=workspace,width=74,height=74] -*Workgroups and Workspaces* - -Learn how to dynamically allocate compute and storage resources. - -xref:resource-manager:index.adoc[Overview] | -xref:resource-manager:workgroup.adoc[Workgroup] | -xref:resource-manager:workspaces/workspace.adoc[Workspace] - -¦ -image:DataLoading-Homecard.png[alt=load data,width=74,height=74] -*Load Data* - -Learn how to Load Data into TigerGraph Cloud 4.0. - - - -xref:load-data:index.adoc[Overview] | -xref:load-data:load-from-local.adoc[Local] | -xref:load-data:load-from-cloud.adoc[Cloud] | -xref:load-data:load-from-other-sources.adoc[Other Sources] -¦ -image:TG_Icon_Library-135.png[alt=schemadesigner,width=74,height=74] -*Schema Designer* - -xref:cloudBeta:schema-designer:index.adoc[] teaches you how to you can easily modify and manage the schema of your graph databases using Schema Designer UI. - -¦ -image:schema-homecard.png[alt=gsqlEditor,width=74,height=74] -*GSQL Editor* - -The GSQL Editor is a powerful tool for developing and executing GSQL queries, allowing you to unlock insights from your graph databases. - -xref:gsql-editor:index.adoc[Overview] | xref:gsql-editor:how2-edit-gsql-query.adoc[] -¦ -image:TG_Icon_Library-218.png[alt=exploreGraph,width=74,height=74] -*Explore Graph* - -Visualize your data and navigate to understand complex connections and dependencies. - -xref:explore-graph:index.adoc[Overview] | -xref:explore-graph:how2-use-pattern-search.adoc[] - -¦ -image:ArchtectureOverview-homecard.png[alt=integration,width=74,height=74] -*Marketplace* - -TigerGraph Cloud 4.0 offers several powerful integration tools. - -xref:integrations:index.adoc[Overview] | -xref:cloudBeta:explore-graph:copilot-enablement.adoc[] | -xref:cloudBeta:integrations:insights.adoc[] | -xref:cloudBeta:integrations:graphstudio.adoc[] | -xref:cloudBeta:integrations:graphql.adoc[] -¦ -image:edtions-homecard.png[alt=billing,width=74,height=74] -*Administration* - -Here you can learn about the tools available for organizational administrators. - -xref:cloudBeta:administration:index.adoc[Overview] | -xref:cloudBeta:administration:how2-invite-users.adoc[] | -xref:cloudBeta:administration:how2-access-mgnt.adoc[] | -xref:cloudBeta:administration:how2-use-organization-mgnt.adoc[Org Management] -¦ -image:security-homecard.png[alt=security,width=74,height=74] -*Security* - -Learn about xref:security:index.adoc[] in TigerGraph Cloud 4.0. - -xref:cloudBeta:security:password-policy.adoc[] | -xref:cloudBeta:security:idp.adoc[] -¦ -image:billing-homecard.png[alt=billing,width=74,height=74] -*Billing* - -The xref:billing-manager:index.adoc[Billing] window allows users to pay only for their specific usage of storage, data access, and compute resources. - -xref:cloudBeta:billing-manager:payment-methods.adoc[] | -xref:cloudBeta:billing-manager:invoices.adoc[] | -xref:cloudBeta:billing-manager:pricing.adoc[] -¦ -image:referece-homecard.png[alt=support,width=74,height=74] -*Release Notes* - -View the xref:release-notes:index.adoc[] to get update information on features and releases. -¦ -image:documentation-homecard.png[alt=support,width=74,height=74] -*Resources* - -View any additional xref:resources:index.adoc[Resources] for TigerGraph Cloud 4.0. - -xref:cloudBeta:resources:glossary.adoc[] | -xref:cloudBeta:resources:terms_conditions.adoc[ Beta Terms and Conditions] | -xref:cloudBeta:resources:support.adoc[] - -|=== \ No newline at end of file diff --git a/modules/cloudbeta/modules/release-notes/images/billing-homecard.png b/modules/cloudbeta/modules/release-notes/images/billing-homecard.png deleted file mode 100644 index 245f8801..00000000 Binary files a/modules/cloudbeta/modules/release-notes/images/billing-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/release-notes/images/create-organization.png b/modules/cloudbeta/modules/release-notes/images/create-organization.png deleted file mode 100644 index 6d9dd0fa..00000000 Binary files a/modules/cloudbeta/modules/release-notes/images/create-organization.png and /dev/null differ diff --git a/modules/cloudbeta/modules/release-notes/images/documentation-homecard.png b/modules/cloudbeta/modules/release-notes/images/documentation-homecard.png deleted file mode 100644 index 3483ec46..00000000 Binary files a/modules/cloudbeta/modules/release-notes/images/documentation-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/release-notes/images/getstarted-homecard.png b/modules/cloudbeta/modules/release-notes/images/getstarted-homecard.png deleted file mode 100644 index cd45ceb9..00000000 Binary files a/modules/cloudbeta/modules/release-notes/images/getstarted-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/release-notes/images/referece-homecard.png b/modules/cloudbeta/modules/release-notes/images/referece-homecard.png deleted file mode 100644 index 9ece83db..00000000 Binary files a/modules/cloudbeta/modules/release-notes/images/referece-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/release-notes/images/security-homecard.png b/modules/cloudbeta/modules/release-notes/images/security-homecard.png deleted file mode 100644 index 2eb02629..00000000 Binary files a/modules/cloudbeta/modules/release-notes/images/security-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/release-notes/images/systemmanagment-homecard.png b/modules/cloudbeta/modules/release-notes/images/systemmanagment-homecard.png deleted file mode 100644 index 9054c265..00000000 Binary files a/modules/cloudbeta/modules/release-notes/images/systemmanagment-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/release-notes/images/tools-page.png b/modules/cloudbeta/modules/release-notes/images/tools-page.png deleted file mode 100644 index 9cfe3135..00000000 Binary files a/modules/cloudbeta/modules/release-notes/images/tools-page.png and /dev/null differ diff --git a/modules/cloudbeta/modules/release-notes/nav.adoc b/modules/cloudbeta/modules/release-notes/nav.adoc deleted file mode 100644 index f74eadce..00000000 --- a/modules/cloudbeta/modules/release-notes/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:index.adoc[] \ No newline at end of file diff --git a/modules/cloudbeta/modules/release-notes/pages/index.adoc b/modules/cloudbeta/modules/release-notes/pages/index.adoc deleted file mode 100644 index 7246a919..00000000 --- a/modules/cloudbeta/modules/release-notes/pages/index.adoc +++ /dev/null @@ -1,81 +0,0 @@ -= Cloud 4.0 (beta) Release Notes -:experimental: -//:page-aliases: change-log.adoc, release-notes.adoc -:toc: -:toclevels:2 - -TigerGraph Cloud 4.0 (Beta) was released on Monday, April 29th, 2024. - -== (Beta) Key Features -=== 4.0.0 - -//* xref:cloudBeta:get-started:index.adoc[Get Started] using TigerGraph Cloud with the 4.0. -* xref:cloudBeta:overview:overview.adoc#_separation_of_storage_and_compute[Separation of Storage and Compute] - Introduction of a unique architecture that separates storage and compute, allowing users to scale resources independently. - -* xref:resource-manager:workgroup.adoc[Workgroups] and xref:resource-manager:workspaces/workspace.adoc[Workspaces] give users control over resource management. - -* xref:load-data:index.adoc[] - Load Data into TigerGraph Cloud 4.0 and unlock its potential. - -* xref:cloudBeta:schema-designer:index.adoc[Schema Designer] - Easily modify and manage the schema of your graph databases using Schema Designer UI. - -* xref:gsql-editor:index.adoc[GSQL Editor] - The GSQL Editor is a powerful tool for developing and executing GSQL queries, allowing you to unlock insights from your graph databases by xref:gsql-editor:how2-edit-gsql-query.adoc[Editing, Running, and Sharing a GSQL Query.]. - -* xref:explore-graph:index.adoc[] and xref:explore-graph:how2-use-pattern-search.adoc[] - Visualize your data and navigate to understand complex connections and dependencies. - -* xref:integrations:index.adoc[] - TigerGraph Cloud 4.0 offers several powerful integration tools in our marketplace. -** xref:cloudBeta:integrations:solutions.adoc[] - Pre-built solution kits that address common use cases and industry-specific challenges. -** xref:cloudBeta:integrations:add-ons.adoc[] - Extend the capabilities of TigerGraph Cloud 4.0 with add-ons tailored to your needs. Add-ons provide additional functionalities and integrations that enhance your graph database workflow. -*** xref:cloudBeta:explore-graph:copilot-enablement.adoc[CoPilot Add-On] - CoPilot empowers business analysts, data scientists, and developers to use natural language to run real-time queries against up-to-date data at scale. -*** xref:cloudBeta:integrations:insights.adoc[Insights Add-On] - TigerGraph Insights is a no-code visual graph analyzer that makes building data analytics dashboards intuitive. -*** xref:cloudBeta:integrations:graphstudio.adoc[GraphStudio Add-On] - GraphStudio offers a range of features and tools to simplify the graph development process. -*** xref:cloudBeta:integrations:graphql.adoc[GraphQL Add-On] - TigerGraph GraphQL enables users to access and modify graph data in TigerGraph using GraphQL queries. - -* xref:cloudBeta:administration:index.adoc[] - The tools for organizational administrators to xref:cloudBeta:administration:how2-invite-users.adoc[] -, xref:cloudBeta:administration:how2-access-mgnt.adoc[Mange Access], xref:cloudBeta:administration:how2-use-organization-mgnt.adoc[Manage Organization]. - -* xref:billing-manager:index.adoc[Billing UI] - The new billing UI allows users to check and pay only for their specific usage of storage, data access, and compute resources -with an xref:cloudBeta:billing-manager:payment-methods.adoc[easy-to-use Payment Method manager], and the xref:cloudBeta:billing-manager:invoices.adoc[ability to check and export invoices]. - -//// -== Fixed issues -=== Fixed and Improved [v number] - -==== Functionality -* Description (Ticket Number) - -==== Crashes and Deadlocks - -* Description (Ticket Number) - -==== Improvements - -* Description (Ticket Number) - -== Known Issues and Limitations - -[cols="4", separator=¦ ] -|=== -¦ Description ¦ Found In ¦ Workaround ¦ Fixed In - -|=== - -=== Compatibility Issues - -[cols="2", separator=¦ ] -|=== -¦ Description ¦ Version Introduced - -|=== - -=== Deprecations - -[cols="3", separator=¦ ] -|=== -¦ Description ¦ Deprecated ¦ Removed - -|=== - -== Release notes for previous versions -* TBD -//// - diff --git a/modules/cloudbeta/modules/resource-manager/images/advanced-settings.png b/modules/cloudbeta/modules/resource-manager/images/advanced-settings.png deleted file mode 100644 index 8f8669fa..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/advanced-settings.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/auto-resume.png b/modules/cloudbeta/modules/resource-manager/images/auto-resume.png deleted file mode 100644 index 254a87a5..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/auto-resume.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/billing-homecard.png b/modules/cloudbeta/modules/resource-manager/images/billing-homecard.png deleted file mode 100644 index 245f8801..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/billing-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/create-organization.png b/modules/cloudbeta/modules/resource-manager/images/create-organization.png deleted file mode 100644 index 6d9dd0fa..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/create-organization.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/create-workgroup.png b/modules/cloudbeta/modules/resource-manager/images/create-workgroup.png deleted file mode 100644 index e2f5e4bb..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/create-workgroup.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/documentation-homecard.png b/modules/cloudbeta/modules/resource-manager/images/documentation-homecard.png deleted file mode 100644 index 3483ec46..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/documentation-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/getstarted-homecard.png b/modules/cloudbeta/modules/resource-manager/images/getstarted-homecard.png deleted file mode 100644 index cd45ceb9..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/getstarted-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/loginPage.png b/modules/cloudbeta/modules/resource-manager/images/loginPage.png deleted file mode 100644 index f14dd04c..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/loginPage.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/referece-homecard.png b/modules/cloudbeta/modules/resource-manager/images/referece-homecard.png deleted file mode 100644 index 9ece83db..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/referece-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/security-homecard.png b/modules/cloudbeta/modules/resource-manager/images/security-homecard.png deleted file mode 100644 index 2eb02629..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/security-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/systemmanagment-homecard.png b/modules/cloudbeta/modules/resource-manager/images/systemmanagment-homecard.png deleted file mode 100644 index 9054c265..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/systemmanagment-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/tools-page.png b/modules/cloudbeta/modules/resource-manager/images/tools-page.png deleted file mode 100644 index 9cfe3135..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/tools-page.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/images/workspace-general-tab.png b/modules/cloudbeta/modules/resource-manager/images/workspace-general-tab.png deleted file mode 100644 index ccb55062..00000000 Binary files a/modules/cloudbeta/modules/resource-manager/images/workspace-general-tab.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resource-manager/nav.adoc b/modules/cloudbeta/modules/resource-manager/nav.adoc deleted file mode 100644 index 749c66c8..00000000 --- a/modules/cloudbeta/modules/resource-manager/nav.adoc +++ /dev/null @@ -1,14 +0,0 @@ -* xref:index.adoc[] -** xref:workgroup.adoc[Workgroups] -*** xref:resource-manager:how2-create-a-workgroup.adoc[Create Workgroup] -*** xref:how2-workgroup-access.adoc[Workgroup Access] -** xref:workspaces/workspace.adoc[Workspaces] -*** xref:workspaces/how2-create-a-workspace.adoc[Create Workspace] -*** xref:workspaces/advanced-settings/advanced-settings.adoc[Advanced Settings] -*** xref:workspaces/writeread_readonly.adoc[RW/RO Workspaces] -*** xref:cloudBeta:resource-manager:workspaces/workspace-size.adoc[] -*** xref:expansion_shrink.adoc[Expand and Shrink] -*** xref:backup-and-restore.adoc[] -*** xref:resource-manager:connect_via_api.adoc[] -*** xref:monitor_workspaces.adoc[Monitor] - diff --git a/modules/cloudbeta/modules/resource-manager/pages/how2-create-a-workgroup.adoc b/modules/cloudbeta/modules/resource-manager/pages/how2-create-a-workgroup.adoc deleted file mode 100644 index 0c36f29c..00000000 --- a/modules/cloudbeta/modules/resource-manager/pages/how2-create-a-workgroup.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= 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 - -[Placeholder for create workgroup screenshot] - -. Log in to your TigerGraph Cloud account. -+ -image::loginPage.png[width=250] - -. 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::createWorkspace.png[] - -. Provide a name for the workgroup. -+ -[NOTE] -==== -Choose a name that reflects the purpose of your project or initiative. -==== -+ -//image::Screenshot 2024-04-24 at 8.18.30 PM.png[] -image::create-workgroup.png[] -. 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)`. -==== - -. Finally, click on the btn:[Next] button to create the workgroup. - -== Next Step - -Now, learn xref:cloudBeta:resource-manager:how2-workgroup-access.adoc[] or learn more about xref:cloudBeta:resource-manager:workspaces/workspace.adoc[Workspaces and Databases]. - -Return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. - -//// -xref:cloudBeta:resource-manager:workspaces/workspace.adoc[Workspaces and Databases, role=next-button] - -[.next-button] -xref:cloudBeta:resource-manager:workspaces/workspace.adoc[Link Text] - -:next-button: pass:[xref:cloudBeta:resource-manager:workspaces/workspace.adoc[Next]] -{next-button} - -++++ -Next -++++ -//// \ No newline at end of file diff --git a/modules/cloudbeta/modules/resource-manager/pages/index.adoc b/modules/cloudbeta/modules/resource-manager/pages/index.adoc deleted file mode 100644 index df481bdc..00000000 --- a/modules/cloudbeta/modules/resource-manager/pages/index.adoc +++ /dev/null @@ -1,67 +0,0 @@ -= Workgroups and Workspaces -:experimental: - -In TigerGraph Cloud 4.0, the concepts of workgroup, workspace, and database are used to organize and manage projects and data within the platform. -By utilizing xref:cloudBeta:resource-manager:workgroup.adoc[workgroups], xref:cloudBeta:resource-manager:workspaces/workspace.adoc[workspaces and databases], TigerGraph Cloud 4.0 provides a flexible and scalable environment for managing projects, allocating compute resources, and working with graph data effectively. - -//// -[CAUTION] -==== -TigerGraph Cloud 4.0 is still in beta release and the documentation is in progress. -==== - -[IMPORTANT] -==== -TigerGraph Cloud 4.0 beta is for personal or R&D use and not for production use. - -It is not covered by our xref:cloudBeta:resources:terms_conditions.adoc[]. -==== -//// - -== xref:resource-manager:workgroup.adoc[] - -Learn xref:how2-create-a-workgroup.adoc[] the first step before creating a xref:workspaces/workspace.adoc[Workspace] -and learning xref:how2-workgroup-access.adoc[]. - - -== xref:cloudBeta:resource-manager:workspaces/workspace.adoc[Workspace and Database Overview] -Learn xref:workspaces/how2-create-a-workspace.adoc[] and unlock its many features. - -Such as: - -* xref:cloudBeta:resource-manager:workspaces/advanced-settings/advanced-settings.adoc[] -- -Learn how advanced settings in workspace allow users to customize and fine-tune various aspects of their workspace configuration. - -* xref:workspaces/writeread_readonly.adoc[] -- -Learn how Read-Write (RW) and Read-Only (RO) Workspaces will connect to a database. - -* xref:workspaces/workspace-size.adoc[] -- -Learn how to specify the size based on your data and performance requirements. - -* xref:expansion_shrink.adoc[] -- -Learn how to adjust the capacity of your workspaces as your data grows or changes. - -* xref:backup-and-restore.adoc[] -- -Learn how to create backup points and restore your workspace to a specific point in time. - -* xref:resource-manager:connect_via_api.adoc[] -- -Learn how to connect to your graph database using REST APIs. - -* xref:resource-manager:monitor_workspaces.adoc[] -- -Learn how TigerGraph Cloud 4.0 offers comprehensive monitoring capabilities that allow you to track the status and resource usage of your workspaces. - -== Next Steps - -Next, learn how to xref:load-data:index.adoc[Load Data] into TigerGraph Cloud 4.0. - -Or return to the xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. - - - diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/advanced-settings/advanced-settings.adoc b/modules/cloudbeta/modules/resource-manager/pages/workspaces/advanced-settings/advanced-settings.adoc deleted file mode 100644 index d4cb9dea..00000000 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/advanced-settings/advanced-settings.adoc +++ /dev/null @@ -1,69 +0,0 @@ -= Advanced Workspace Settings -:experimental: - -The advanced settings in workspace allow users to customize and fine-tune various aspects of their workspace configuration. -These settings include options like *auto-suspend* and *auto-resume*, which automate the suspension and resumption of the workspace based on activity levels. - -Find them by clicking on the btn:[ ... ] button on your workspace next to the btn:[Connect] button. - -image::workspace-general-tab.png[] - -A workspace configuration panel will appear on the right of your screen. - -image::advanced-settings.png[] - -Users can choose the desired time intervals for auto-suspend and enable auto-resume to optimize resource usage and ensure a smooth user experience. - -== Auto-Suspend - -Auto-suspend will automatically suspend your workspace after a specified period of inactivity. - -[TIP] -==== -This helps optimize resource utilization and cost when the workspace is not actively being used. -==== - -Choose an appropriate time interval for auto-suspend based on your typical usage patterns. - -image::autoSuspend.png[] - -For example, if your workspace is usually inactive for long periods, you can set a shorter interval for auto-suspend to conserve resources. - -[CAUTION] -Be mindful of any background processes or scheduled tasks that may require the workspace to remain active. -Adjust the auto-suspend interval accordingly to avoid interrupting critical processes. - -=== Auto-Suspend Limitations - -.The following operations will not trigger an auto suspend: -* Any UI tools access. -* Running any GSQL query. -* Running loading job. -* Configuring an update. - - -== Auto-Resume -Auto-resume will automatically resume your workspace when activity is detected. - -[TIP] -==== -This ensures a seamless user experience without the need for manual intervention. -==== -image::auto-resume.png[] - -When the Auto Resume is enabled, the workspace will become “Idle” state instead of “Stopped”. -Auto-resume will kick-in when users access tools and rest APIs. - -=== Auto-Resume Limitations - -.The following endpoints will not trigger auto-resume: -* TigerGraph Cloud Controller APIs - -== Next Steps - -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. - - - diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/workspace-size.adoc b/modules/cloudbeta/modules/resource-manager/pages/workspaces/workspace-size.adoc deleted file mode 100644 index 155df4a2..00000000 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/workspace-size.adoc +++ /dev/null @@ -1,86 +0,0 @@ -= Workspace Size - -When creating a workspace, you can specify the size based on your data and performance requirements. -TigerGraph Cloud 4.0 offers multiple size options, allowing you to choose the appropriate capacity for your graph databases. - -[TIP] -The size determines the number of instances and the allocated resources for your workspace. - -== Workspace Size Table - -We provide the following workspace sizes on TigerGraph Cloud 4.0. - -[cols=5] -|=== -| Size | VCPU | Memory (GB) | Pod Size | Partition - -|TG-00 -|2 -|16 -|C2M16 -|1 - -|TG-0 -|4 -|32 -|C4M32 -|1 - -|TG-1 -|8 -|64 -|C8M64 -|1 - -|TG-2 -|16 -|128 -|C16M128 -|1 - -|TG-4 -|32 -|256 -|C32M256 -|1 - -|TG-6 -|48 -|384 -|C48M384 -|1 - -|TG-8 -|64 -|512 -|C64M512 -|1 - -|TG-12 -|96 -|768 -|C48M384 -|2 - -|TG-16 -|128 -|1024 -|C64M512 -|2 -|=== - -//// -TigerGraph Size Capacity Planner (TBD) - -To help you determine the ideal workspace size for your graph databases, TigerGraph provides the TigerGraph Size Capacity Planner. This tool helps estimate the required resources based on factors such as data volume, query complexity, and expected workload. By using the TigerGraph Size Capacity Planner, you can make informed decisions about the size of your workspace, ensuring optimal performance and cost-effectiveness. - -[User input of estimated data size] - -Choosing the right workspace size is crucial for achieving optimal performance and cost efficiency. The TigerGraph Size Capacity Planner empowers you to make informed decisions and effectively manage the resources for your graph databases within TigerGraph Cloud. -//// -== Next Steps - -See xref:cloudBeta:resource-manager:expansion_shrink.adoc[] to learn how to change the size of a workspace or -return to the xref:cloudBeta:resource-manager:index.adoc[] page or xref:cloudBeta:overview:index.adoc[Overview] page for a different topic. - - diff --git a/modules/cloudbeta/modules/resources/images/billing-homecard.png b/modules/cloudbeta/modules/resources/images/billing-homecard.png deleted file mode 100644 index 245f8801..00000000 Binary files a/modules/cloudbeta/modules/resources/images/billing-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resources/images/create-organization.png b/modules/cloudbeta/modules/resources/images/create-organization.png deleted file mode 100644 index 6d9dd0fa..00000000 Binary files a/modules/cloudbeta/modules/resources/images/create-organization.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resources/images/documentation-homecard.png b/modules/cloudbeta/modules/resources/images/documentation-homecard.png deleted file mode 100644 index 3483ec46..00000000 Binary files a/modules/cloudbeta/modules/resources/images/documentation-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resources/images/getstarted-homecard.png b/modules/cloudbeta/modules/resources/images/getstarted-homecard.png deleted file mode 100644 index cd45ceb9..00000000 Binary files a/modules/cloudbeta/modules/resources/images/getstarted-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resources/images/referece-homecard.png b/modules/cloudbeta/modules/resources/images/referece-homecard.png deleted file mode 100644 index 9ece83db..00000000 Binary files a/modules/cloudbeta/modules/resources/images/referece-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resources/images/security-homecard.png b/modules/cloudbeta/modules/resources/images/security-homecard.png deleted file mode 100644 index 2eb02629..00000000 Binary files a/modules/cloudbeta/modules/resources/images/security-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resources/images/systemmanagment-homecard.png b/modules/cloudbeta/modules/resources/images/systemmanagment-homecard.png deleted file mode 100644 index 9054c265..00000000 Binary files a/modules/cloudbeta/modules/resources/images/systemmanagment-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resources/images/tools-page.png b/modules/cloudbeta/modules/resources/images/tools-page.png deleted file mode 100644 index 9cfe3135..00000000 Binary files a/modules/cloudbeta/modules/resources/images/tools-page.png and /dev/null differ diff --git a/modules/cloudbeta/modules/resources/nav.adoc b/modules/cloudbeta/modules/resources/nav.adoc deleted file mode 100644 index 6085f882..00000000 --- a/modules/cloudbeta/modules/resources/nav.adoc +++ /dev/null @@ -1,6 +0,0 @@ -* xref:index.adoc[Resources] -** xref:resources:glossary.adoc[] -** xref:resources:support.adoc[] -** xref:resources:quota_policy.adoc[Restriction Policy] -** xref:resources:terms_conditions.adoc[Terms and Conditions] -// ** xref:resources:faqs.adoc[FAQs] diff --git a/modules/cloudbeta/modules/resources/pages/faqs.adoc b/modules/cloudbeta/modules/resources/pages/faqs.adoc deleted file mode 100644 index ee3e5ce4..00000000 --- a/modules/cloudbeta/modules/resources/pages/faqs.adoc +++ /dev/null @@ -1,593 +0,0 @@ -= TigerGraph Cloud FAQs -:pp: {plus}{plus} - -//// -*Feedback for TigerGraph Cloud is welcome at* tgcloud-feedback@tigergraph.com - -== Top FAQs - -=== 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. - -* 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. -* Check your junk/spam email folder or run a search for "TigerGraph" in case the email automatically got filtered to another inbox. -* Double-check the email address you entered to make sure it matches the one you signed up with. - -If you're still unable to log in or reset your password, contact TigerGraph Support at support@tigergraph.com for individualized help with your issue. - -=== *Q: How does TigerGraph Cloud compare with other DBaaS offerings?* - -A: TigerGraph Cloud gets you up and running with the fastest and best price-performance graph platform in just minutes. -TigerGraph's native parallel graph and deep link analytics give you both speed and scale, even on the most complex tasks. -The GraphStudio visual design interface enables everyone on your team to be a guru in graph. -And our starter kits for popular use cases mean you can have an example graph application working in minutes. -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?* - -A: New December 2020 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. -Please submit a support ticket for migration assistance. - -[#q-are-there-free-tier-instances-or-free-credits-for-the-system] -=== *Q: Are there Free Tier Instances or Free Credits for the System?* - -A: There are free-tier instances, but no free credits. - -When you select an instance type, you will see that one instance type is designated as the Free Tier. -Each registered account may provision one cluster at a time from the Free Tier. -Free Tier instances do not include backup and do not include support. If you want to start another Free Tier cluster, you will have to terminate your existing cluster. - -If no user activity is detected for more than one hour, TigerGraph may automatically stop a Free Tier instance. -Users can manually restart the Free Tier instances from their cloud portal. -TigerGraph may terminate Free Tier instances after 7 consecutive days of inactivity. -For additional information, see link:https://www.tigergraph.com/tigergraph-cloud-subscription-terms/[TigerGraph Cloud Terms]. - -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:sales@tigergraph.com[sales@tigergraph.com] to arrange a long-term contract for reserved TigerGraph instances. - - -=== *Q: In what cloud platforms and regions does TigerGraph 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)]. - -Visit each platform's reference page to learn more about the available regions. - -=== *Q: Can I choose different versions of TigerGraph on TigerGraph Cloud?* - -A: Yes. When you create a cluster, you can choose the database version you would like to use. -For security and stability reasons, only some legacy versions are available. -There is no difference in cost for using different versions of TigerGraph. - -=== *Q: Does TigerGraph Cloud support distributed databases?* - -A: Yes. -In the latest version of TigerGraph Cloud, you can provision a highly available TigerGraph cluster by entering 2 or 3 for the replication factor during the provisioning process. -Replication factors of 2 and 3 are supported for TigerGraph V3.0+. -For TigerGraph V2.6, only a replication factor of 2 is supported. -The configuration is active-active, meaning that all copies of the data are available to answer queries. - -NOTE: HA systems must have a minimum of 3 instances. -This means that the smallest supported cluster configuration for a replicated system for TigerGraph V3.0+ is one-way partitioning X three-way replication = three instances. -In comparison, the smallest supported cluster configuration for a replicated system for TigerGraph V2.6 is two-way partitioning X two-way replication = four instances. - - -=== *Q: What type of server should I use for my data size and workload?* - -A: Please see the section on pricing on our website at our link:https://www.tigergraph.com/cloud/[TigerGraph Cloud main page]. For further assistance, contact TigerGraph at link:mailto:sales@tigergraph.com[sales@tigergraph.com] - - -=== *Q: What kind of services do I get?* - -A: TigerGraph Cloud includes automatic scheduled backup, built-in encryption and other security features, patching, replication and distributed database option. In addition, you can now provision a distributed database as well as a replica cluster for high availability. -As a cloud service, many of the administrative and operational tasks - for monitoring, restoring, upgrading, for example - are just a click away. -In addition to operations and management for your TigerGraph databases, TigerGraph Cloud also offers Starter Kits to provide instant experience to various graph analytics use cases. -The list of Starter Kits can be found here: link:https://www.tigergraph.com/starterkits/[TigerGraph Cloud Starter Kits] - -[#q-is-there-a-quota-for-the-number-of-clusters-i-can-provision-in-a-single-account] -=== *Q: Is there a quota for the number of clusters I can provision in a single account?* - -A: Yes. -For basic accounts with credit card billing, there is a limit of 160 vCPUs and 20 instances. -A cluster is one logical database, which may include several instances due to a distribution database configuration and replication. -For accounts running exclusively on Free Credit and that have not yet entered a valid credit card, there is a limit of 16 vCPUs and two clusters. -For each registered account (with or without a valid credit card), you may only provision one cluster from the Free Tier. -To allow more vCPUs and clusters, please contact TigerGraph at link:mailto:sales@tigergraph.com[sales@tigergraph.com]. - -Total number of instances in a cluster = replication factor x partitioning factor - -[width="100%",cols="1,1,1",options="header",] -|=== -|Service |*Account With a Valid Credit Card* |*Account Without a Valid Credit -Card* -|*Free Tier Cluster Quota* |1 |1 - -|*Total Instance Quota* |20 |2 - -|*Total vCPU Quota* |160 |16 - -|*Cluster Size Limit* |10 instances |1 (distributed data is not -enabled) - -|*Replication Factor Limit* |2 |1 (HA is not enabled) - -|*Request Quota/Limit Increase* |Yes, Please contact -mailto:sales@tigergraph.com[]. a| -N/A - -Please upgrade your account by entering a valid credit card. - - -|=== - - -=== *Q: Can I run queries directly after sample starter kits are provisioned?* - -A: Data must be loaded and queries must be installed first. Please perform the following steps after the cluster is provisioned: - -. Connect to GraphStudio through "`Open Cluster Via Domain`" from the cloud portal. -. On the Load Data tab, click the Load button to load the sample dataset. -. On the Write Query tab, click the Install button to install the sample queries. - -Now you can run queries on the starter kit's sample data. Please visit our link:http://tigergraph.com/starterkits[TigerGraph Cloud Starter Kits] page to watch the overview video for each starter kit. - - -=== *Q: How can I monitor my TigerGraph Cloud service?* - -A: TigerGraph Cloud is instance-based and offers an administrator portal to monitor the performance and health of each machine instance. - -See TigerGraph's xref:gui:admin-portal:overview.adoc[Admin Portal Documentation] for more detailed information. - - -=== *Q: Is TigerGraph Cloud cloud-agnostic?* - -A: TigerGraph Cloud will provide teams with the flexibility to use the cloud vendor of their choice, so there will be no vendor lock-in. For the current version, TigerGraph Cloud offers instances on AWS, Azure and GCP platforms. If you require immediate assistance to manage TigerGraph on another cloud provider, please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com]. - - -=== *Q: Is the support for TigerGraph Cloud the same as the support for TigerGraph Enterprise?* - -A: Yes, TigerGraph supports TigerGraph cloud users using paid tiers. See the Support Policy terms at link:https://www.tigergraph.com/support-policy/[www.tigergraph.com/support-policy]. -Support is not included for free tier instances; therefore, support tickets for free tier clusters are answered when support staff bandwidth allows. -See Section 1.4 in link:https://www.tigergraph.com/tigergraph-cloud-subscription-terms/[www.tigergraph.com/tigergraph-cloud-subscription-terms]. -For additional developer resources for free tier users, join the TigerGraph developer community at link:https://community.tigergraph.com[community.tigergraph.com]. - - -=== *Q: What is the user interface for the TigerGraph Cloud instance?* - -A: The TigerGraph xref:gui:graphstudio:overview.adoc[GraphStudio™ UI (User Interface)] provides an intuitive, browser-based interface that helps users get started quickly with graph-based application development tasks: designing a graph schema, creating a schema mapping, loading data, exploring the graph, and writing GSQL queries. - -In addition, for TigerGraph paid tier clusters, users can use GSQL Web Shell to write GSQL commands in an interactive command line shell. Users can access GSQL Web Shell through the cluster panel from their Cloud Portal. This GSQL Web Shell opens up more data loading options such as S3 Loader (parquet format) and Kafka Loader. - - -=== *Q: What graph query language does TigerGraph support?* - -A: TigerGraph uses GSQL, the query language designed for fast and scalable graph operations and analytics. GSQL's similarity to SQL, high-level syntax, Turing completeness, and built-in parallelism brings faster performance, faster development and the ability to describe any algorithm. - -You can start learning GSQL from our xref:3.5@gsql-ref:tutorials:gsql-101/index.adoc[GSQL tutorials]. We also support a RESTful API and JSON output for easy integration with application languages like Python, Java, and C{pp}. - -Start learning GSQL and become a TigerGraph Certified Associate today with our link:https://www.tigergraph.com/certification/[Certification Program]. - - -=== *Q: Can I have multiple graphs in one TigerGraph Cloud instance?* - -A: Yes. If you use V3.0.5+ in TigerGraph Cloud, MultiGraph is supported through GraphStudio. Please refer to our xref:gui:graphstudio:design-schema.adoc[] page for the new MultiGraph Support through GraphStudio. - -=== *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] - -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. - -For complex loading jobs through GSQL Web Shell for paid tier clusters, please submit a support ticket from your cloud portal for more information. - -=== *Q: I can't find my registration activation email after registering for the first time. Where can I find it?* - -A: Please check your spam folder. If you can't find it in the spam folder, and still cannot receive the verification email in your mailbox after resending the verification email, please https://tigergraph.zendesk.com/hc/en-us/[open a support ticket] so that we can assist you with manual email verification process. - -*Q: How do I develop a customized application on top of TigerGraph Cloud?* - -A: Please see https://info.tigergraph.com/graph-gurus-24[Graph Gurus episode 24], where we presented "How to Build Innovative Applications with a Native Graph Database". - - -=== *Q: Can I upgrade from V2.6.x, V3.0.5, V3.0.6 to V3.1.1?* - -A: For free tier clusters, the upgrade is not supported unless you are migrating to paid tier clusters. If you want to change the database version in your free tier, you can terminate the existing free tier cluster, and create a new free tier with the new version. In each TigerGraph Cloud account, you can have one free tier. If you want to migrate to paid tier clusters, please send a support ticket through your cloud portal. - -For paid tier clusters, please submit a support ticket for upgrade assistance. Downtime is expected during this upgrade. It is recommended to create a new blank V3.1.1 cluster, import your data and copy the GSQL queries to test and experiment before upgrading your production instance from V2.6.x, V3.0.5, V3.0.6 to V3.1.1. - -== Pricing - -See https://www.tigergraph.com/cloud[the TigerGraph Cloud main page] for pricing information. - - -=== *Q: How do I migrate to the new December 2020 pricing to lower my bill?* - -A: New December 2020 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 TigerGraph Cloud accounts with valid credit cards are eligible for the paid tier migration. Please submit a support ticket for migration assistance. - - -=== *Q: Do you offer a discount for annual contracts/commitments?* - -A: Yes, there is a discount for contracting with TigerGraph for a one-year term. Please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com] to request your discount. - -=== *Q: Can I purchase TigerGraph Cloud Credits?* - -A: Yes. You can purchase cloud credits applied to TigerGraph Cloud usage. Please refer to https://www.tigergraph.com/cloud-credits/ - - -=== *Q: If I delete my instance before the end of the month, what will I have to pay?* - -A: If you are subscribed to our standard hourly service, you will be charged only for your hours of use. - - -=== *Q: If I add an instance mid-month, when do I start paying for it?* - -A: We bill you and charge your credit card at the end of each calendar month. - - -=== *Q: If I have a billing problem that I can't solve online, how do I contact you?* - -A: You can either open a support ticket from the cloud portal by clicking "`Support`" on the menu at the left of the page, or you can send an email to link:mailto:billing@tigergraph.com[billing@tigergraph.com]. - - -=== *Q: What happens if my monthly costs exceed the credit limit on my credit card?* - -A: If this happens you can contact link:mailto:sales@tigergraph.com[sales@tigergraph.com] and we will provide you with other payment options. - - -=== *Q: Where can I find TigerGraph's terms and conditions for its products and services?* - -A: You can find our terms and conditions here: http://www.tigergraph.com/terms[www.tigergraph.com/terms]. - - -=== *Q: How is TigerGraph Cloud priced for development, test, or QA environments?* - -A: With TigerGraph Cloud, you only pay for what you use. For long term contracts, please contact link:mailto:sales@tigergraph.com[sales@tigergraph.com]. - -== Sizing and Scaling - - -=== *Q: How do I determine the instance needed for my workload?* - -Check the individual pages under xref:reference:index.adoc[] to see what instance types are offered by each cloud provider in each region. -Larger graphs require more RAM. Higher performance calls for both more CPUs and more RAM. - -Our link:https://www.tigergraph.com/tigergraph-cloud-pricing/[pricing table] gives initial recommendations for which instance to start with, if you know how much data you will be loading into the graph. -We call the input data your "raw data". -TigerGraph reorganizes your data into a graph, encoding and compressing it. -We have assumed that your stored graph will be about 70% of the size of your raw data. -This is a conservative estimate; it's often smaller. - -You also need RAM for your graph querying and computation. -Different applications of TigerGraph can require very different amounts of RAM. -In the pricing table, we recommend that your total RAM be about 1.5 times the maximum amount of raw data you think you will load. - -If you see you need more space or more compute power, then just scale up. - -Please submit a support ticket from TigerGraph Cloud Portal or https://tigergraph.zendesk.com/hc/en-us/[from Zendesk] for more help. - - -=== *Q: How do I expand the disk size?* - -Please submit a support ticket from TigerGraph Cloud Portal for more help. - - -=== *Q: Can I migrate my database to a larger (or smaller) instance?* - -A: Contact TigerGraph Cloud Support for migrating between different instance types. Instance migration is not yet supported through one-click operation. - - -=== *Q: Can I deploy a distributed TigerGraph database across a cluster of instances?* - -A: Yes, you can provision a distributed database in TigerGraph Cloud. Simply provide the partition number and replication number you would like to have. -Please see the sections below on <<_provisioning_backup_and_restore>>. - -== Hardware - - -=== *Q: What type of disks are attached to the provisioned TigerGraph Instances?* - -A: A Root Disk (EBS based) is attached to TigerGraph Instances. - - -=== *Q: What does the provisioned disk include, and how should I approach disk sizing?* - -A: If you choose AWS as the backend, TigerGraph Cloud provisions persistent EBS volume as the disk attached to the EC2 machines to hold installation files and data files. -The disk holds the following: - -* OS installation -* TigerGraph database installation -* TigerGraph Graph storage -* Other data files uploaded to the instance -* Output files generated by querying the database -* System logs generated by the instance - -Hence, when you consider the size of the disk, please consider the size of the data for all the above installations and files. - - -=== *Q: What browsers are supported?* - -A: TigerGraph Cloud has been designed and tested for Chrome using React with the latest component libraries. Other browsers are not officially tested but are expected to work. - -== Provisioning, Backup and Restore - - -=== *Q: What is a Cluster?* - -A: A TigerGraph Cluster, formerly known as a Solution, is a graph database image which can be deployed on a virtual machine instance. Most clusters also come with a starter kit, a sample graph schema, sample data, and sample queries for a common use case, such as Recommendation Engine, Anti-Fraud, and Healthcare Analytics. - -In a newly provisioned cluster, the data files are ready to be loaded, and the queries are ready to be installed. - - -=== *Q: Is there a warm-up period for TigerGraph instances and clusters?* - -A: When you provision or restart a cluster, there will be a warm-up period for the machine instances and the disk attached to the instances. -The larger the data size and the greater the number of instances, the longer the warm-up period will be. - - -=== *Q: What is the difference between stopping and terminating a cluster?* - -A: When you stop a cluster, you shut down the virtual machine instance. -The TigerGraph database is frozen in its current state. -Billing for that machine instance also stops. -Scheduled backups also stop, but the backup copies are kept in EFS in AWS, Azure Files in Azure, and GCP Filestores in GCP. -You will still incur charges for disk storage and backups when a cluster is stopped. You can start the cluster again. -After a warmup period, the cluster will return to its previous state. - -When you terminate a cluster, you will deprovision the virtual machine and the attached disk space. -The cluster is deleted according to the cloud platform's policies and cannot be recovered. - -=== *Q: Do you offer backup in TigerGraph Cloud?* - -A: Yes. Please see our guide for using xref:solutions:backup-and-restore.adoc[] in the Admin Portal. - - -=== *Q: What backup options are available?* - -A: TigerGraph Cloud offers full backups on a scheduled or on-demand basis. -By default, backup is turned on when instances are running and will be done daily. -There are four backup schedules you can choose from: daily, weekly, monthly, and ad hoc. - -The default retention policy is to retain up to seven backups. -Therefore, daily backups are retained for a week, weekly backups for seven weeks, and monthly backups for seven months. -If you want to perform an ad hoc manual backup when there are already seven existing backups, you need to delete an older backup in order to save the most recent ad hoc copy. -The maximum number of manual backups is six, as the platform always reserves one spot for a scheduled backup. -When a cluster is stopped, backups in EFS, Azure Files and GCP Filestores will be charged for the time you have the clusters. -Please see pricing for backup costs while your instance is stopped. - -More options for longer retention policies are in development. - -=== *Q: Can I restore from a backup from another cluster in my account?* - -A: Contact TigerGraph Support to restore from another cluster backup. - - -=== *Q: What password do I use for backup and restore?* - -A: To perform an ad hoc backup, use the password of the `tigergraph` user of your cluster. -To restore from a previous backup, use the same password that was used to create the backup. -This rule applies to restoring from a different cluster in your account. All the backups of different clusters in your account can be found through the Admin Portal. - - -=== *Q: What happens to my automated backups if I terminate my cluster?* - -A: We will keep the latest backup for 15 days and then delete. -Within that 15 days, you may use your backup to restore into another similar cluster if it is a single server cluster. -To restore a cluster within 15 days, please submit a support ticket through the cloud portal. - - -=== *Q: How soon can I restore from a backup that I just made?* - -A: After you perform a backup, you should wait at least 15 minutes. - - -=== *Q: How can I delete my TigerGraph Cloud account?* - -A: Please submit a support ticket through the cloud portal. - -== High Availability and Replication - - -=== *Q: What kind of replicas does TigerGraph Cloud support?* - -A: TigerGraph Distributed Cloud offers active-active replication for increased availability and automatic failover. - -A TigerGraph system with High Availability (HA) is a cluster of server machines which uses replication to provide continuous service when one or more servers are not available or when some service components fail. -TigerGraph HA service provides loading balancing when all components are operational, as well as automatic failover in the event of a service disruption. - -[#q-what-is-the-replication-factor] -=== *Q: What is the replication factor?* - -A: Replication factor means how many copies of data are stored, each on a separate machine. -The default HA configuration has a replication factor of two, meaning that a fully-functioning system maintains two copies of the data, stored on separate machines. -TigerGraph Distributed Cloud currently supports your choice of replication factor of one (only one copy of the data, not recommended for critical systems), two, or three if you choose TigerGraph v3.0.6+. -If you choose TigerGraph v2.6.x, only replication factors of one or two are supported. - -*Limitation for TigerGraph v2.6.x:* In TigerGraph Distributed Cloud, if replication is used, the total number of instances must be at least 3. -For TigerGraph v2.6.x, if the replication factor is 2, then the partition factor must be at least 2, for a total of 2x2 = 4 instances. -TigerGraph v3.0.6+ supports configurations for a cluster with 1 partition and 3 replicas. - -*Limitation for TigerGraph v3.1.1:* This version only supports single server configuration. - -[#q-what-is-the-partition-factor] -=== *Q: What is the partition factor?* - -A: Partition factor means the number of parts or components your graph data is split into, which also equals the number of instances that collectively store one copy of the full graph. -For example, if you select a partition factor of 3, each instance will hold approximately 1/3 of your data. -Please read the xref:tigergraph-server:cluster-and-ha-management:ha-cluster.adoc[] documentation for additional details about partitions and replications. - - -=== *Q: How long do I need to wait for the cluster to be ready after provisioning process starts?* - -A: It currently takes about 4 minutes to provision a single instance. If you configure a 2x2 replicated and distributed graph database, it will take about 15 minutes. - -== Network, Security and User Management - - -=== *Q: Can I use TigerGraph in Amazon Virtual Private Cloud (Amazon VPC)?* - -A: By default, you will be given your own VPC(s) for your TigerGraph Cloud account resources in AWS and GCP, and your own Azure Virtual Networks for your TigerGraph Cloud account resources in Azure. Your instances are separated from other accounts by different VPCs or Virtual Networks. Within your own account, you have different VPCs or Virtual Networks for different regions. - - -=== *Q: Does TigerGraph Cloud support encrypting my data in transit and at rest?* - -A: Yes, TigerGraph Cloud encrypts all data in transit and at rest. - - -=== *Q: Am I sharing data storage with other customers? Is TigerGraph a multi-tenant cluster?* - -A: You are not sharing storage with other customers. Each TigerGraph cluster is provisioned as one or more virtual machine instances of the TigerGraph engine, used only for your account, and provisioned with its own disk space. No two accounts are sharing the same TigerGraph database. - -=== *Q: How do I access my TigerGraph Cloud account (e.g., username and password)?* - -A: When you register your account, you will select a username and password. You can then log in anytime at link:http://www.tgcloud.io/[www.tgcloud.io]. You will also be given a URL using a subdomain name that you select. - -=== *Q: How do I access my TigerGraph database and POST to TigerGraph?* - -A: You can access the database through TigerGraph's GraphStudio visual interface and through RESTful endpoints. Use RESTful endpoints to POST to TigerGraph clusters and develop applications. Please refer to the xref:tigergraph-server:API:index.adoc[RESTful API User Guide] for more information. To find the RESTful endpoints for queries created in GraphStudio, please read our documentation on xref:gui:graphstudio:write-queries.adoc[showing query endpoints]. There is also a recorded webinar which demos the process in detail: link:https://info.tigergraph.com/graph-gurus-24[Graph Gurus Episode 24] - -*Here is the step-by-step instructions:* - -TigerGraph cloud enables xref:tigergraph-server:API:authentication.adoc[REST{pp} Authentication] to securely connect TigerGraph Cloud clusters with your application through an endpoint on port 443 at `443/restpp/`. - -[NOTE] -TigerGraph Cloud clusters created before June 20, 2022 used port 9000 and 14240 for endpoints. See the xref:release-notes:index.adoc[] for details. - -*Step 1:* (First time only) Navigate to the TigerGraph cluster's Admin Portal, and generate a secret from User Management. - -For example, the URL for the cluster is: - -[source,text] ----- -https://SOLUTIONID.i.tgcloud.io:443/admin/#/user-management ----- - -and the generated secret is `abcd1234` from the Admin Portal. - -*Step 2:* (Need to renew every lifetime) Use the secret generated in step 1 to get a RESTPP token (for example, xyz789) using `curl`. Access RESTPP endpoints on port 443 using the syntax `443/restpp/`. - -Here is an example where you obtain a token with a lifetime of 1,000,000 seconds (11 days): - -[source,text] ----- -curl -X POST 'https://SOLUTIONID.i.tgcloud.io:443/restpp/requesttoken -d '{"secret"="abcd1234", "lifetime"="1000000"}' ----- - -[source,text] ----- -{ - "code":"REST-0000", - "expiration":1570727825, - "error":false, - "message":"Generate new token successfully.", - "token":"xyz789" -} ----- - -*Step 3:* Now in your application, use the token in the REST call as follows: - -[source,text] ----- -curl -X GET -H "Authorization: Bearer xyz789" 'https://SOLUTIONID.i.tgcloud.io:443/restpp/graph/MyGraph/vertices/Account?limit=3' ----- - - -=== *Q: Do free tier instances expose RESTful endpoints?* - -A: Yes. Free tier instances expose RESTful endpoints on port 443 to allow access to TigerGraph database, similar to paid tier instances. Clusters created before June 20, 2022 use port 9000. - - -=== *Q: Does TigerGraph Cloud offer Role Based Access Control?* - -A: TigerGraph's role-based access control with MultiGraph and User Management is available if you use TigerGraph V3.0.5+. - - -=== *Q: What happens to my data if I terminate an instance or if my account is closed?* - -A: When you terminate an instance in TigerGraph Distributed Cloud, the virtual machine instance and its associated storage volume are deleted according to the policies of the underlying cloud infrastructure vendor. - - -=== *Q: How does TigerGraph Cloud secure my data?* - -A: TigerGraph Cloud encrypts data at rest and in transit, and SSL is enabled for secure access. - - -=== *Q: Can I integrate TigerGraph Cloud into my single sign on system?* - -A: The ability to use cloud portal to integrate TigerGraph Cloud into an SSO system will be provided at a future date. -If you are using a paid tier instance, please submit a support ticket to request advanced service to integrate into an SSO system TigerGraph supports. -Please see more detailed pages on the xref:tigergraph-server:user-access:sso.adoc[Single Sign On (Server)] and xref:gui:admin-portal:security/sso.adoc[Single Sign On (GUI)] features. - -== Upgrade - - -=== Q: Can I upgrade TigerGraph version on my cluster? - -A: For free tier clusters, upgrading is not supported unless you are migrating to paid tier clusters. -If you want to change the database version in your free tier, you can terminate the existing free tier cluster, and create a new free tier with the new version. -In each TigerGraph Cloud account, you can have one free tier cluster. -If you want to migrate to paid tier clusters, please send a support ticket through your cloud portal. - -For paid tier clusters, please submit a support ticket for upgrade assistance. -Downtime is expected during this upgrade. -It is recommended to create a new blank cluster, import your data and copy the GSQL queries to test and experiment before upgrading your production instance. - -== TigerGraph Cloud Support - - -=== *Q: How do I submit a support ticket?* - -A: In your cloud portal, on the top bar, you can submit the support ticket by clicking on the support icon: image:support-icon.png[] - -This will generate a support ticket in TigerGraph's Zendesk support system. -You can track the ticket status in Zendesk. - - -=== *Q: How do I submit a support ticket if I cannot access the Cloud Portal?* - -A: If in rare cases, you cannot submit TigerGraph Cloud support tickets through the cloud portal for your account, you can also https://tigergraph.zendesk.com/hc/en-us/[open a support ticket] from Zendesk. -This action automatically generates a new Zendesk support ticket, and you can track the support ticket in the Freshdesk portal. - -== Performance - - -=== *Q: Is TigerGraph built on a NoSQL database or a relational database?* - -A: TigerGraph is a native parallel graph database built on C{pp}. It is not built on a NoSQL database or relational database. - - -=== *Q: How can I monitor the speed or throughput of queries and data loading?* - -A: The GraphStudio visual design tool provides several monitors. - -The xref:gui:graphstudio:load-data.adoc[] page includes a real time monitor and statistics. Query performance and many other measures are available on the xref:tigergraph-server:intro:index.adoc[Administrator Portal]. - - -=== *Q: How can I improve the speed of my system?* - -A: Due to TigerGraph's massively parallel and hybrid in-memory database design, an instance with more vCPUs and more memory will usually run faster. -For a given hardware configuration, performance can be improved by optimizing graph schema, loading jobs, and queries. -In TigerGraph Distributed Cloud, you can also choose to provision a cluster with replication factor 2 to increase throughput. -Contact link:mailto:sales@tigergraph.com[sales@tigergraph.com] to discuss query optimization services. - - -=== *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[]. -//// diff --git a/modules/cloudbeta/modules/resources/pages/index.adoc b/modules/cloudbeta/modules/resources/pages/index.adoc deleted file mode 100644 index c0211a02..00000000 --- a/modules/cloudbeta/modules/resources/pages/index.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= Resources -:experimental: - -Resources provide other documents to help support your TigerGraph Cloud 4.0 (beta) journey. - -== xref:resources:glossary.adoc[] - -Here you can refer terms used in TigerGraph Cloud and the 4.0 (beta). - -== xref:resources:support.adoc[] - -Here you can learn how to get support. - -//== xref:resources:faqs.adoc[Cloud 4.0 FAQs] - -//Here you can find Cloud 4.0 FAQs. - -== Policy Documents - -If you are a participating TigerGraph Cloud 4.0 (Beta) user, please review our policy documents: - -* xref:quota_policy.adoc[Beta Phase Quota Restriction Policy] -* xref:terms_conditions.adoc[Beta Program Terms and Conditions] - - diff --git a/modules/cloudbeta/modules/resources/pages/quota_policy.adoc b/modules/cloudbeta/modules/resources/pages/quota_policy.adoc deleted file mode 100644 index c07b0587..00000000 --- a/modules/cloudbeta/modules/resources/pages/quota_policy.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= 4.0 Beta Phase Quota Restriction Policy - -== Objective -To establish a fair-use policy that ensures equitable access to resources during the beta phase of TigerGraph Cloud 4.0 (Beta), while preventing abuse and over-utilization of shared infrastructure. - -[IMPORTANT] -This policy is subject to review and adjustment at the discretion of TigerGraph's management based on feedback from the user community and evolving business needs. - -This policy applies to all users participating in the beta phase of TigerGraph Cloud 4.0 (beta). - - -== Policy Details -=== Workspace Creation Limits: -Each user account is limited to creating a maximum of 3 workspace(s) during the beta phase. - -1. R/W Workspace. -2. R/O Workspaces. -3. Total 3 Workspaces allowed. - -The size of each workspace (in terms of allocated resources) will be capped to ensure equitable distribution among participants. - -[NOTE] -Max supported will be TG-16. - -=== Resource Allocation Quotas: -* A total number of 50 credits will be provided. -* Users requiring additional resources can apply for an exception by providing a valid justification. Requests will be reviewed on a case-by-case basis. -* Storage Quota: 100GB -* Backup Quota: Only 1 Backup is allowed. - -=== Monitoring and Enforcement: - -* Continuous monitoring will be implemented to detect and mitigate abusive behavior or anomalous usage patterns. - -* Users found to be violating the quota restrictions may face temporary suspension or reduction in allocated resources. - -=== Feedback and Adjustment Mechanism: -* Users are encouraged to provide feedback on resource limitations and usage experience. -* TigerGraph Cloud 4.0 reserves the right to adjust quota limits based on user feedback and observed usage patterns to serve the community's needs better. - -=== Communication: -* All participants will be informed of the quota restrictions and any subsequent adjustments via email and in-product notifications. - -=== End of Beta Phase: -* Upon conclusion of the beta phase, users will be transitioned to the standard pricing tier with revised quota restrictions. -Details will be communicated in advance. - -=== Exception Handling -* Users who legitimately need additional resources beyond the allocated quotas can submit a request through the Product Support/Feedback channel. -Each request will be evaluated based on its merits, considering the user's contribution to the beta testing process and the potential impact on the product's development. diff --git a/modules/cloudbeta/modules/schema-designer/images/billing-homecard.png b/modules/cloudbeta/modules/schema-designer/images/billing-homecard.png deleted file mode 100644 index 245f8801..00000000 Binary files a/modules/cloudbeta/modules/schema-designer/images/billing-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/schema-designer/images/create-organization.png b/modules/cloudbeta/modules/schema-designer/images/create-organization.png deleted file mode 100644 index 6d9dd0fa..00000000 Binary files a/modules/cloudbeta/modules/schema-designer/images/create-organization.png and /dev/null differ diff --git a/modules/cloudbeta/modules/schema-designer/images/documentation-homecard.png b/modules/cloudbeta/modules/schema-designer/images/documentation-homecard.png deleted file mode 100644 index 3483ec46..00000000 Binary files a/modules/cloudbeta/modules/schema-designer/images/documentation-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/schema-designer/images/getstarted-homecard.png b/modules/cloudbeta/modules/schema-designer/images/getstarted-homecard.png deleted file mode 100644 index cd45ceb9..00000000 Binary files a/modules/cloudbeta/modules/schema-designer/images/getstarted-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/schema-designer/images/referece-homecard.png b/modules/cloudbeta/modules/schema-designer/images/referece-homecard.png deleted file mode 100644 index 9ece83db..00000000 Binary files a/modules/cloudbeta/modules/schema-designer/images/referece-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/schema-designer/images/security-homecard.png b/modules/cloudbeta/modules/schema-designer/images/security-homecard.png deleted file mode 100644 index 2eb02629..00000000 Binary files a/modules/cloudbeta/modules/schema-designer/images/security-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/schema-designer/images/systemmanagment-homecard.png b/modules/cloudbeta/modules/schema-designer/images/systemmanagment-homecard.png deleted file mode 100644 index 9054c265..00000000 Binary files a/modules/cloudbeta/modules/schema-designer/images/systemmanagment-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/schema-designer/images/tools-page.png b/modules/cloudbeta/modules/schema-designer/images/tools-page.png deleted file mode 100644 index 9cfe3135..00000000 Binary files a/modules/cloudbeta/modules/schema-designer/images/tools-page.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/images/billing-homecard.png b/modules/cloudbeta/modules/security/images/billing-homecard.png deleted file mode 100644 index 245f8801..00000000 Binary files a/modules/cloudbeta/modules/security/images/billing-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/images/create-organization.png b/modules/cloudbeta/modules/security/images/create-organization.png deleted file mode 100644 index 6d9dd0fa..00000000 Binary files a/modules/cloudbeta/modules/security/images/create-organization.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/images/documentation-homecard.png b/modules/cloudbeta/modules/security/images/documentation-homecard.png deleted file mode 100644 index 3483ec46..00000000 Binary files a/modules/cloudbeta/modules/security/images/documentation-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/images/getstarted-homecard.png b/modules/cloudbeta/modules/security/images/getstarted-homecard.png deleted file mode 100644 index cd45ceb9..00000000 Binary files a/modules/cloudbeta/modules/security/images/getstarted-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/images/referece-homecard.png b/modules/cloudbeta/modules/security/images/referece-homecard.png deleted file mode 100644 index 9ece83db..00000000 Binary files a/modules/cloudbeta/modules/security/images/referece-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/images/security-homecard.png b/modules/cloudbeta/modules/security/images/security-homecard.png deleted file mode 100644 index 2eb02629..00000000 Binary files a/modules/cloudbeta/modules/security/images/security-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/images/systemmanagment-homecard.png b/modules/cloudbeta/modules/security/images/systemmanagment-homecard.png deleted file mode 100644 index 9054c265..00000000 Binary files a/modules/cloudbeta/modules/security/images/systemmanagment-homecard.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/images/tools-page.png b/modules/cloudbeta/modules/security/images/tools-page.png deleted file mode 100644 index 9cfe3135..00000000 Binary files a/modules/cloudbeta/modules/security/images/tools-page.png and /dev/null differ diff --git a/modules/cloudbeta/modules/security/pages/index.adoc b/modules/cloudbeta/modules/security/pages/index.adoc deleted file mode 100644 index 5064df2a..00000000 --- a/modules/cloudbeta/modules/security/pages/index.adoc +++ /dev/null @@ -1,22 +0,0 @@ -= Security -:experimental: - - -Here you can learn different security practices and policies in TigerGraph Cloud 4.0. - -[IMPORTANT] -==== -TigerGraph Cloud 4.0 beta is for personal or R&D use and not for production use. - -Please see xref:cloudBeta:resources:terms_conditions.adoc[]. -==== - - -== xref:cloudBeta:security:password-policy.adoc[] - -Learn and understand the password policy in TigerGraph Cloud 4.0. - - -== xref:cloudBeta:security:idp.adoc[] - -Learn and understand IDP intergration with SSO password policy in TigerGraph Cloud 4.0.