Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
117 commits
Select commit Hold shift + click to select a range
482c205
DOC-2746-Log Files page updated
Tushar-TG-14 Jun 26, 2025
f7a6101
DOC-2847-added `System.Backup.StagingPath` in 4.2
Tushar-TG-14 Jul 4, 2025
8bd5295
DOC-2913-updated example of "Run an interpreted query" [4.2]
Tushar-TG-14 Jul 4, 2025
b62aefc
DOC-2924-updated "GET WORKLOAD QUEUE" command [4.2]
Tushar-TG-14 Jul 8, 2025
b323286
DOC-2746-Final Updates
Tushar-TG-14 Jul 9, 2025
c3314a8
DOC-2897-drop-ACL
Jul 11, 2025
4ac8ecd
DOC-2897-drop-ACL-release-notes
Jul 11, 2025
8a8f974
DOC-2897-proofread fix menu
Jul 11, 2025
b152f76
DOC-2242-known-issus-4.2
Jul 9, 2025
84dd4f0
DOC-2920-Added fixed CVEs for 4.2
Tushar-TG-14 Jul 11, 2025
bd71c29
DOC-2746-Final changes
Tushar-TG-14 Jul 11, 2025
9555478
DOC-2746-Update log-files.adoc
Tushar-TG-14 Jul 11, 2025
92f6408
Merge pull request #843 from tigergraph/DOC-2746-log-files-page-updat…
Tushar-TG-14 Jul 11, 2025
b80d641
DOC-2916-GBAR-dropped 4.2
Jul 15, 2025
27b2e5b
DOC-2916-proofread-remove-gbar-4.2
Jul 15, 2025
313610f
DOC-2746-Log Files page updated [4.2]
Tushar-TG-14 Jul 15, 2025
d16e2d1
DOC-2930-Updated endpoint for expired tokens [4.2]
Tushar-TG-14 Jul 29, 2025
a9dcab7
DOC-2590-Added a NOTE on CRR upgrade [4.2]
Tushar-TG-14 Jul 30, 2025
dbc2339
Moved image to github for "Troubleshooting Guide" [4.2]
Tushar-TG-14 Aug 14, 2025
24d7a11
DOC-2947: Fixed images to Troubleshooting Guide [4.2]
Tushar-TG-14 Aug 18, 2025
22c5f14
Add files via upload
Tushar-TG-14 Aug 18, 2025
5e2f082
DOC-2947 - Fixed image on Log Files [4.2]
Tushar-TG-14 Aug 18, 2025
df6779d
DOC-2596: Data CRUD privileges [4.2]
Tushar-TG-14 Aug 21, 2025
71510ed
DOC-2894: fixed reference format while running docker image as daemon
Tushar-TG-14 Aug 22, 2025
2bf3a42
DOC-2894: fixed reference format while running docker image as daemon…
Tushar-TG-14 Aug 22, 2025
5fea93e
Merge pull request #857 from tigergraph/DOC-2894-fixed-command-format…
Tushar-TG-14 Aug 22, 2025
486ec62
Merge branch '4.2' into 4.2.1-dev
Tushar-TG-14 Sep 5, 2025
0110c88
Merge pull request #859 from tigergraph/4.2.1-dev
Tushar-TG-14 Sep 5, 2025
2014a7b
Added 4.2.1 release date on 4.2 release notes page
Tushar-TG-14 Sep 5, 2025
0c24b1c
Fixed security vulnerability fixes
Tushar-TG-14 Sep 5, 2025
c9efa12
DOC-2902-Added in Compatibility Issues [4.2.1]
Tushar-TG-14 Sep 9, 2025
b6e7308
DOC-2968-Fixed RESTPP APIs reference on workload management [4.2]
Tushar-TG-14 Sep 9, 2025
b0b012d
DOC-2968: NOTE updated [4.2]
Tushar-TG-14 Sep 10, 2025
70b5703
DOC-3006: Modified Create a secret statement [4.2]
Tushar-TG-14 Sep 10, 2025
d45da62
DOC-2982: Correction-BasicConfig.Env config param [4.2]
AyeshaFirdausTG Sep 10, 2025
15a06a9
Merge pull request #861 from tigergraph/DOC-2982-Correction-BasicConf…
AyeshaFirdausTG Sep 10, 2025
c103164
DOC-2983-updated CRR steps on upgrade page [4.2]
AyeshaFirdausTG Sep 10, 2025
388a209
DOC-2983-updated CRR steps on set up page [4.2]
AyeshaFirdausTG Sep 10, 2025
953a2d7
Version updated for ACL feature in Deprecations and Removals section …
Tushar-TG-14 Sep 11, 2025
7ead2b7
DOC-2628: Updated Compatibility Issues section [4.2]
Tushar-TG-14 Sep 16, 2025
063433e
DOC-2948-fixed typo
Tushar-TG-14 Sep 16, 2025
d8be8d5
DOC-3014: Updated endpoint for running an existing schema change job …
Tushar-TG-14 Sep 17, 2025
3898eea
Add files via upload
AyeshaFirdausTG Sep 18, 2025
766d749
Add files via upload
AyeshaFirdausTG Sep 18, 2025
825265c
DOC-2759 Update load balancer [4.2]
AyeshaFirdausTG Sep 19, 2025
c79d436
DOC-3018: OS upgrade from RHEL 9.0 to 9.2/9.5 [4.2]
Tushar-TG-14 Sep 19, 2025
49c18a3
DOC-3007: Added feature to the Compatibility Issues [4.2.1]
Tushar-TG-14 Sep 19, 2025
f226508
Update index.adoc
Tushar-TG-14 Sep 19, 2025
a46bef0
DOC-3009-remove-kb.tigergraph.com
Sep 23, 2025
85ccfc0
Merge pull request #866 from tigergraph/DOC-3009-remove-kb.tigergraph…
victorleeTG Sep 23, 2025
e62f893
Merge pull request #862 from tigergraph/DOC-2759-Update-load-balancer…
AyeshaFirdausTG Sep 24, 2025
2ef2ba5
DOC-3021: 4.2.2 - Bug fixes
Tushar-TG-14 Sep 29, 2025
69cf8e6
Update index.adoc
Tushar-TG-14 Sep 29, 2025
7793a1f
DOC-2985 ACL read privilege upgrade block [4.2.1]
AyeshaFirdausTG Sep 29, 2025
ef7bbeb
Update index.adoc
Tushar-TG-14 Sep 30, 2025
ca9e22f
Update index.adoc
Tushar-TG-14 Sep 30, 2025
38361f3
Merge pull request #871 from tigergraph/DOC-3021-added-bug-fixes-to-r…
Tushar-TG-14 Sep 30, 2025
130b533
Update index.adoc
Tushar-TG-14 Oct 1, 2025
dee8a99
Update index.adoc
Tushar-TG-14 Oct 3, 2025
250c792
ACL privilege migrations [4.2.1]
AyeshaFirdausTG Oct 6, 2025
21241c5
Merge pull request #873 from tigergraph/ACL-privilege-migration-[4.2.1]
AyeshaFirdausTG Oct 6, 2025
815d469
Update change-port.adoc [4.2]
Tushar-TG-14 Oct 8, 2025
60a6be8
DOC-2921 Removed local file-[4.2]
AyeshaFirdausTG Oct 8, 2025
d36bd2a
DOC-2883: Added note about increasing load balancer idle timeout
Tushar-TG-14 Oct 14, 2025
afc431a
Merge pull request #876 from tigergraph/DOC-2883-add-note-idle-timeou…
Tushar-TG-14 Oct 27, 2025
940972f
DOC-3036: Document automatic service restart on Command Glossary page…
Tushar-TG-14 Oct 27, 2025
0df0fde
DOC-3036: Added Controller.ServiceManager.AutoRestart to configuratio…
Tushar-TG-14 Oct 27, 2025
9d1607f
DOC-2787: Updated "How to Enable Avro Data Validation" section [4.2]
Tushar-TG-14 Oct 27, 2025
b945528
DOC-2787: Added "Avro Data Validation" [4.2]
Tushar-TG-14 Oct 27, 2025
916dea5
Clarify Avro data loading error description
Tushar-TG-14 Oct 27, 2025
4618b66
DOC-3048: Updated 9000 port internal [4.2]
Tushar-TG-14 Nov 3, 2025
ca86bcb
DOC-2939: Updated API to query the LastSeqID [4.2]
Tushar-TG-14 Nov 11, 2025
7a533ee
DOC-2081: Added ProxyGroup [4.2]
Tushar-TG-14 Nov 13, 2025
7e1e547
DOC-3054: Updated "purged_deletedvid_curr_tid" field [4.2]
Tushar-TG-14 Nov 17, 2025
be306ab
DOC-2214 clarify array handling for gadmin config set and add guidanc…
Tushar-TG-14 Nov 21, 2025
9de7210
DOC-2214: Improve description of gadmin config entry usage
Tushar-TG-14 Nov 24, 2025
85f0a8a
Merge pull request #886 from tigergraph/DOC-2214-update-gadmin-config…
Tushar-TG-14 Nov 24, 2025
059e7b1
Improve formatting of gadmin config command example
Tushar-TG-14 Nov 24, 2025
edf6bfa
Fix formatting of gadmin config command example
Tushar-TG-14 Nov 24, 2025
254625d
Updated security vulnerabilities in release notes [4.2]
Tushar-TG-14 Nov 24, 2025
6abda0a
Clean up CVE entries in release notes
Tushar-TG-14 Nov 24, 2025
3a5394b
Update index.adoc
Tushar-TG-14 Nov 24, 2025
5383090
DOC-3057-server-docs-error
AyeshaFirdausTG Nov 24, 2025
d77d923
Merge pull request #887 from tigergraph/DOC-3057-server-docs-error
AyeshaFirdausTG Nov 27, 2025
f359832
DOC-3072: Fix stagingPath option for Expansion [4.2]
Tushar-TG-14 Dec 3, 2025
94594b1
DOC-3072: Fix stagingPath option for Shrink[4.2]
Tushar-TG-14 Dec 3, 2025
382402e
Add files via upload
Tushar-TG-14 Dec 4, 2025
a1a2531
DOC-3070: Add new documentation page for Node Replacement V2 [4.2]
Tushar-TG-14 Dec 4, 2025
1ddfa2e
DOC-3070: Updated nav.adoc for Node Replacement V2 [4.2]
Tushar-TG-14 Dec 4, 2025
78cd63f
DOC-3070: Add Node Replacement (V2) link to navigation [4.2]
Tushar-TG-14 Dec 4, 2025
d9f6e86
Update nav.adoc
Tushar-TG-14 Dec 4, 2025
c09cbbd
DOC-3070: Add Node Replacement (V2) nav entries for 4.2
Tushar-TG-14 Dec 4, 2025
38667b2
DOC-3079: Add gadmin config for GSE and GPE
Tushar-TG-14 Dec 5, 2025
b3875ad
Merge pull request #890 from tigergraph/DOC-3079-add-gpe-gse-retentio…
Tushar-TG-14 Dec 8, 2025
d3d5354
DOC-3071: Update staging path requirements in cluster expansion [4.2]
Tushar-TG-14 Dec 8, 2025
13c7d36
DOC-3093-using-MinIO-4.2
AyeshaFirdausTG Jan 5, 2026
7efdfa8
DOC-3093-using-MinIO-4.2.2
AyeshaFirdausTG Jan 6, 2026
8014213
DOC-3096-patent-list-doc-site
Jan 7, 2026
d1c79e8
Merge pull request #893 from tigergraph/DOC-3096-patent-list-doc-site
victorleeTG Jan 7, 2026
0904f72
Default response size limit
AyeshaFirdausTG Jan 16, 2026
dd0b3ab
Merge pull request #895 from tigergraph/DOC-3101-default-size-limit
AyeshaFirdausTG Jan 19, 2026
0ab0913
DOC-3100-update-spark-connector-4.2
AyeshaFirdausTG Jan 21, 2026
ae9d4e5
Merge pull request #897 from tigergraph/DOC-3100-update-spark-connect…
AyeshaFirdausTG Jan 21, 2026
dfbb109
DOC-3102: Document memory usage differences for deployments [4.2]
Tushar-TG-14 Jan 21, 2026
742abd2
Merge pull request #898 from tigergraph/DOC-3102-memory-usage-between…
Tushar-TG-14 Jan 22, 2026
1125ef3
DOC-2537: Document GUI CORS configuration parameters
Tushar-TG-14 Jan 27, 2026
47a3880
DOC-2537: Changes Updated
Tushar-TG-14 Jan 29, 2026
d327dea
Merge pull request #899 from tigergraph/DOC-2537-configure-cors-policy
Tushar-TG-14 Jan 29, 2026
742a743
DOC-3107-command-responses-4.2
AyeshaFirdausTG Jan 29, 2026
b99eca5
Update system-administration-faqs.adoc
AyeshaFirdausTG Feb 4, 2026
b481570
Merge pull request #900 from tigergraph/DOC-3107-command-responses-4.2
AyeshaFirdausTG Feb 4, 2026
690889f
Update workload-management.adoc
AyeshaFirdausTG Feb 5, 2026
b2432d4
DOC-3112: Update documentation for loading job status endpoint
Tushar-TG-14 Feb 9, 2026
b2c4ecf
Update gsql-endpoints.adoc
Tushar-TG-14 Feb 9, 2026
5b776d2
DOC-3112: Update documentation for loading job (one) status endpoint …
Tushar-TG-14 Feb 10, 2026
c17f90e
Merge pull request #901 from tigergraph/DOC-3112-update-graph-paramet…
Tushar-TG-14 Feb 10, 2026
7132ba7
DOC-2978-internal-kafka-tls-4.3
AyeshaFirdausTG Feb 10, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 34 additions & 7 deletions modules/API/pages/built-in-endpoints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -955,7 +955,7 @@ This request requires the privilege `WRITE_USER`:

[.wrap,console]
----
curl -X DELETE "https://localhost:14240/expiredtoken"
curl --user example_username:example_password -X DELETE https://localhost:14240/gsqlserver/gsql/expiredtoken
----

The following request deletes all expired tokens that belong to users `u1` and `u2` as well as all tokens created with secrets `s1` and `s2`.
Expand Down Expand Up @@ -2873,7 +2873,7 @@ The xref:built-in-endpoints.adoc#_check_query_status_detached_mode[results] and

`POST /gsql/v1/queries/interpret`

This endpoint runs a GSQL query in Interpreted Mode. The query body should be supplied at the data payload, and the query's parameters are supplied as the URL's query string. *This endpoint exists on the GSQL server on port 14240.*
This endpoint runs a GSQL query in Interpreted Mode. The query body should be supplied as the data payload, and the query parameters are supplied as the URL's query string. *This endpoint exists on the GSQL server on port 14240.*

This request goes directly to the GSQL server (port 14240) instead of the RESTPP server, so the username and password must be specified in the header. If you are using curl, you can use the `-u` option as shown below.

Expand All @@ -2886,20 +2886,47 @@ The request body for this endpoint should be the entire `INTERPRET QUERY` statem
When running an interpreted query through this endpoint, the query parameters should be xref:index.adoc#_query_string_parameters[passed in through the URL query string].

==== Sample request:

[tabs]
====
Request::
+
--
[source.wrap,bash]
----
curl --fail -u <my_username>:<my_password> -X POST "http://localhost:14240/gsql/v1/queries/interpret?a=10" -d 'INTERPRET QUERY (INT a) FOR GRAPH gsql_demo {
curl -u <my_username>:<my_password> -H "Content-Type: text/plain" -X POST "http://localhost:14240/gsql/v1/queries/interpret?a=10" -d 'INTERPRET QUERY (INT a) FOR GRAPH gsql_demo {
PRINT a;
}'
}'
----
--
Response::
+
--
[source,json]
----
{
"error": false,
"message": "",
"version": {
"schema": 3,
"edition": "enterprise",
"api": "v2"
},
"results": [
{
"a": 10
}
]
}
----
--
====

=== List running queries of a graph

`GET /restpp/showprocesslist/{graph_name}`

This endpoint reports statistics of running queries of a graph: the query's request ID, start time, expiration time, and the REST endpoint's URL.
This includes installed queries. interpreted queries, as well as built-in queries.
This includes installed queries, interpreted queries, as well as built-in queries.

As of 4.2.1, this endpoint reports on the activity on all server nodes in a distributed cluster, not just for the node being addressed.

Expand Down Expand Up @@ -2964,7 +2991,7 @@ If set to `true`, the response will only include the status of queries on the cu
`GET /restpp/showprocesslistall`

This endpoint reports the statistics of all running queries across all graphs on a TigerGraph instance: the query's request ID, start time, expiration time, and the REST endpoint's URL.
This includes installed queries. interpreted queries, as well as built-in queries.
This includes installed queries, interpreted queries, as well as built-in queries.

As of 4.2.1, this endpoint reports on the activity on all server nodes in a distributed cluster, not just for the node being addressed.

Expand Down
33 changes: 22 additions & 11 deletions modules/API/pages/gsql-endpoints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1727,7 +1727,7 @@ Sample Response::
'''
=== run an existing schema change job

`POST /gsql/v1/schema/jobs/{jobName}`
`PUT /gsql/v1/schema/jobs/{jobName}`

Run an existing schema change job.

Expand Down Expand Up @@ -2055,7 +2055,7 @@ Sample Response::
====

'''

[#_run_a_loading_job]
=== Run a loading job

`POST /gsql/v1/loading-jobs/run`
Expand Down Expand Up @@ -2185,19 +2185,26 @@ Sample Response::

`GET /gsql/v1/loading-jobs/status`

Get the status of one or more loading jobs that have been started, equivalent to GSQL
Get the status of one or more loading jobs that have been started. This endpoint is equivalent to the GSQL command.
xref:{page-component-version}@gsql-ref:ddl-and-loading:managing-loading-job.adoc#_show_loading_status[SHOW LOADING STATUS].

The `graph` parameter is required because loading job run IDs are scoped to a specific graph.
If the `graph` parameter is missing, the request will fail even if valid `jobIds` are provided.

==== Parameters:

//[width="100%",cols="25%,25%,50%",options="header",]
[%autowidth]
|===
| Name | Required | Description

| `graph`
| Yes
| Name of the graph on which the loading jobs were executed.

| `jobIds`
| yes
| ID of the loading job
| Yes
| One or more loading job run IDs, separated by commas.
|===

==== Example
Expand All @@ -2210,7 +2217,7 @@ Sample Request::
[source,bash]
----
curl -H 'Content-Type: application/json' -X GET
'http://localhost:14240/gsql/v1/loading-jobs/status/jobIds=financialGraph.load_ldbc_snb.jdbc.all.1111111111121'
'http://localhost:14240/gsql/v1/loading-jobs/status?graph=financialGraph&jobIds=financialGraph.load_ldbc_snb.jdbc.all.1111111111121'
----
--
Sample Response::
Expand Down Expand Up @@ -2239,9 +2246,13 @@ The behavior of this endpoint is the same as that of `GET /gsql/v1/loading-jobs/
|===
| Name | Required | Description

| `graph`
| Yes
| Name of the graph on which the loading job was executed.

| `jobId`
| yes
| ID of the loading job
| Yes
| ID of the loading job run.
|===

==== Example
Expand All @@ -2254,7 +2265,7 @@ Sample Request::
[source,bash]
----
curl -H 'Content-Type: application/json' -X GET
'http://localhost:14240/gsql/v1/loading-jobs/status/financialGraph.load_ldbc_snb.jdbc.all.1111111111121'
'http://localhost:14240/gsql/v1/loading-jobs/status/financialGraph.load_ldbc_snb.jdbc.all.1111111111121?graph=financialGraph'
----
--
Sample Response::
Expand Down Expand Up @@ -2708,11 +2719,11 @@ Sample Response::
====

'''
=== get the sample data of S3 file.uris or local files
=== get sample data from an S3 object

`POST /gsql/v1/sample-data`

Get the sample data of S3 file.uris or local files.
Get the first N lines from an S3 object

==== Parameters:

Expand Down
4 changes: 2 additions & 2 deletions modules/API/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -324,8 +324,8 @@ You can specify the response size limit of an HTTP request with the following he
----
curl -X <GET/POST> -H "RESPONSE-LIMIT: <size limit in byte>" '<request_URL>'
----

If the response size is larger than the given limit, an error message will be returned instead of the actual query result:
* If the `RESPONSE-LIMIT` header is not set, TigerGraph uses the value configured in `GSQL.QueryResponseMaxSizeByte` as the default response size limit.
* If the response size is larger than the given limit, an error message will be returned instead of the actual query result:

[source,bash]
----
Expand Down
28 changes: 5 additions & 23 deletions modules/additional-resources/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,24 +1,6 @@
* Additional Resources
** xref:best-practice-guides/best-practices-overview.adoc[]
*** xref:best-practice-guides/best-prac-scaling-clusters.adoc[Scaling Guide]
** Troubleshooting and FAQs
*** link:https://kb.tigergraph.com/[Knowledge base and FAQs]
*** xref:troubleshooting:troubleshooting-guide.adoc[]
*** xref:troubleshooting:system-administration-faqs.adoc[]
*** xref:troubleshooting:log-files.adoc[]
**** xref:troubleshooting:audit-log.adoc[]
**** xref:troubleshooting:gcollect.adoc[]
**** xref:troubleshooting:elk-filebeat.adoc[]
** References
*** xref:reference:configuration-parameters.adoc[]
*** xref:reference:return-codes.adoc[]
*** xref:user-access:rbac-row-policy/row-policy-privileges-table.adoc[]
*** xref:reference:list-of-privileges-legacy.adoc[]
*** xref:reference:ports.adoc[]
*** xref:reference:glossary.adoc[]
*** xref:reference:patents-and-third-party-software.adoc[]
*** xref:additional-resources:legacy-tg-versions.adoc[]
*** xref:intro:comparison-of-editions.adoc[]
*** xref:intro:release-process.adoc[Release and Patch Process]
*** xref:user-access:rbac-row-policy/row-policy-ebnf.adoc[]
// NOTE: /additional-resources/nav.adoc is not used; its content is covered by /reference/nav.adoc.
//* Additional Resources
//** xref:best-practice-guides/best-practices-overview.adoc[]
//*** xref:best-practice-guides/best-prac-scaling-clusters.adoc[Scaling Guide]
//** xref:additional-resources:legacy-tg-versions.adoc[]

2 changes: 0 additions & 2 deletions modules/additional-resources/pages/legacy-tg-versions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ This page lists all LTS (Long-Term Support) and previous versions of TigerGraph
* xref:4.1@tigergraph-server:intro:index.adoc[4.1]
* xref:3.11@tigergraph-server:intro:index.adoc[3.11]
* xref:3.10@tigergraph-server:intro:index.adoc[3.10]
* xref:3.9@tigergraph-server:intro:index.adoc[3.9] (no updates planned)
* xref:3.6@tigergraph-server:intro:index.adoc[3.6] (no updates planned)

== Other Versions

Expand Down
1 change: 1 addition & 0 deletions modules/advanced-topics/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
//HA
*** xref:cluster-and-ha-management:ha-overview.adoc[High Availability (HA)]
**** xref:cluster-and-ha-management:ha-cluster.adoc[Cluster Configuration]
**** xref:cluster-and-ha-management:node-replacement-v2.adoc[Node Replacement (V2)]
**** xref:cluster-and-ha-management:region-aware.adoc[Region Aware Cluster Configuration]
**** xref:cluster-and-ha-management:ha-for-gsql-server.adoc[GSQL Server HA]
**** xref:cluster-and-ha-management:ha-for-application-server.adoc[Application Server HA]
Expand Down
6 changes: 6 additions & 0 deletions modules/backup-and-restore/pages/configurations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,12 @@ S3 Role ARN takes priority over access keys. For more information, see link:http
|System.Backup.CompressionLevel |The backup compression level strikes a balance between size and speed. The better compression, the longer it takes.
("BestSpeed", "DefaultCompression", "BestCompression")
| "DefaultCompression"

|System.Backup.StagingPath | Specifies the root directory for storing intermediate (staging) files during backup and restore operations. If left empty, a default `backup` folder under the TigerGraph data root is used.
You can override this configuration by providing the `--staging-path` option when running the `gadmin backup create` or `gadmin backup restore` commands. The command-line option takes precedence over the system configuration.
Since these operations are I/O-intensive, we recommend setting this path to a dedicated disk separate from the TigerGraph data root directory. This helps minimize potential impact on business operations, especially during backups.
| `"" (empty string)`

|===

== Backup to AWS S3
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions modules/cluster-and-ha-management/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
// HA
** xref:ha-overview.adoc[High Availability]
*** xref:ha-cluster.adoc[]
*** xref:cluster-and-ha-management:node-replacement-v2.adoc[Node Replacement (V2)]
*** xref:region-aware.adoc[Region Aware Cluster Configuration (Preview)]
*** xref:ha-for-gsql-server.adoc[GSQL Server HA]
*** xref:ha-for-application-server.adoc[Application Server HA]
Expand Down
29 changes: 23 additions & 6 deletions modules/cluster-and-ha-management/pages/expand-a-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -81,18 +81,35 @@ We suggest naming the new nodes following the convention of `m<count>`, such as

==== Supply a staging location

Extra disk space is required during cluster expansion. If more space is not available on the same disk, you can supply a staging location on a different disk to hold temporary data:
Extra disk space is required during cluster expansion. If more space is not available on the existing disk, you can supply a staging location on a different disk to hold temporary data:

[source,console]
----
$ gadmin cluster expand m3:192.168.1.3,m4:192.168.1.4 --stagingPath /tmp/
$ gadmin cluster expand m3:192.168.1.3,m4:192.168.1.4 --staging-path /tmp/
----

If you choose to supply a staging location, make sure that the TigerGraph Linux user has write permission to the path you provide. The overall amount of space required for expansion on each node is `(1 + ceiling(oldPartition/newPartition) ) * dataRootSize`.
`oldPartition` and `newPartition` stand for the partitioning factors of the cluster before and after expansion, respectively; `dataRootSize` stands for the size of the data root folder on the node.
When you specify `--staging-path`, the path must:

For example, assume you are expanding from a 6-node cluster with a replication factor of 2 and a partitioning factor of 3, to a 10-node cluster with a replication factor of 2 and a partitioning factor of 5, and the size of the data root folder on a node is 50GB.
You would need more than `(1 + ceiling(3/5)) * 50) = 100 GB` of free space on the staging path.
* Exist on *every node* in the cluster (both existing nodes and newly added nodes).
* Be accessible and writable by the TigerGraph Linux user on all nodes.

TigerGraph uses the staging path on each node during expansion, so the operation will fail if the path is missing or not writable on any node.

The overall amount of space required on each node is:

`(1 + ceiling(oldPartition / newPartition)) * dataRootSize`

where:

* `oldPartition` = partitioning factor before expansion
* `newPartition` = partitioning factor after expansion
* `dataRootSize` = size of the data root folder on that node

For example, expanding from a 6-node cluster with replication factor 2 and partitioning factor 3 to a 10-node cluster with replication factor 2 and partitioning factor 5, with a 50 GB data root folder, requires more than:

`(1 + ceiling(3 / 5)) * 50 = 100 GB`

of free space on the staging path of *each node*.

==== Configure region awareness

Expand Down
Loading