diff --git a/modules/backup-and-restore/pages/configurations.adoc b/modules/backup-and-restore/pages/configurations.adoc index d6ef64c7..3cda1983 100644 --- a/modules/backup-and-restore/pages/configurations.adoc +++ b/modules/backup-and-restore/pages/configurations.adoc @@ -1,6 +1,6 @@ = Backup and Restore Configurations -This page walks you through the configurations available for backup and restore on TigerGraph and how to set them. +This page describes the configuration options available for backup and restore on TigerGraph and how to set them. == Prerequisites * You have access to the TigerGraph Linux user account on your cluster. @@ -8,7 +8,7 @@ All commands must be run from the TigerGraph Linux user. == Configuration parameters -The following is a list of configurations available for backup and restore. +The following is a list of configuration options available for backup and restore. |=== @@ -20,11 +20,11 @@ If this parameter is set to true, `System.Backup.S3.Enable` cannot be set to tru |`false` |System.Backup.Local.Path |Local path to store the backup files. -Required if backup is to be stored locally. |`nan` +Required if backup is to be stored locally. | null |System.Backup.S3.AWSAccessKeyID |AWS access key ID for s3 bucket of backup. -Required if backup is to be stored on S3. |`+nan+` +Required if backup is to be stored on S3. | null |System.Backup.S3.AWSSecretAccessKey |Secret access key for s3 bucket. @@ -34,7 +34,10 @@ Required if backup is to be stored on S3. |`+nan+` |System.Backup.S3.BucketName |Name of the S3 bucket to store backup files. -Required if backup is to be stored on S3.|`+nan+` +Required if backup is to be stored on S3.| null + +|System.Backup.S3.Endpoint | Endpoint to use instead of the S3 default endpoint. Must be a fully qualified URL. +Typically used when operating in a private network or with a non-AWS S3-compatible endpoint. | null |System.Backup.S3.Enable |Whether to store the database backup data to S3. Required if backup is to be stored on S3. diff --git a/modules/release-notes/pages/index.adoc b/modules/release-notes/pages/index.adoc index 49981f80..a0b10fdc 100644 --- a/modules/release-notes/pages/index.adoc +++ b/modules/release-notes/pages/index.adoc @@ -50,6 +50,11 @@ You can no longer specify an empty set using query strings in a GET request. NOTE: `TYPE` is a xref:3.8@gsql-ref:appendix:keywords-and-reserved-words.adoc [DDL reserved word]. In particular, you may not use `TYPE` as a vertex or attribute property name. +=== Backup + +* Added support and a configuration parameter for a +xref:3.8@tigergraph-server:backup-and-restore:configurations.adoc[user-supplied s3-compatible storage endpoint], typically used when operating in a private network of with a non-AWS S3-compatible service. + === Performance * Introduced the xref:gsql-ref:querying:query-optimizer/index.adoc[query optimizer], which performs cost-based optimization on queries based on pre-computed statistics.