diff --git a/modules/backup-and-restore/pages/configurations.adoc b/modules/backup-and-restore/pages/configurations.adoc index 463691c4..1e8d2709 100644 --- a/modules/backup-and-restore/pages/configurations.adoc +++ b/modules/backup-and-restore/pages/configurations.adoc @@ -10,7 +10,7 @@ All commands must be run from the TigerGraph Linux user. The following is a list of configurations available for backup and restore. -[NOTE]: For `System.Backup.Local.Enable`, `System.Backup.S3.Enable`, `System.Backup.ABS.Enable`, and `System.Backup.GCS.Enable`, only one can be enabled at a time. +NOTE: For `System.Backup.Local.Enable`, `System.Backup.S3.Enable`, `System.Backup.ABS.Enable`, and `System.Backup.GCS.Enable`, only one can be enabled at a time. |=== |Configuration parameter |Description |Default @@ -23,18 +23,18 @@ Required if backup is to be stored locally. | `null` |System.Backup.S3.Enable |Enables or disables backup to AWS S3 or S3-compatible services such as Ceph S3.|`false` -|System.Backup.S3.AWSAccessKeyID |AWS Access Key ID for authentication (deprecated, use System.Backup.S3.AccessKeyID instead, which has a higher priority.) | `null` +|System.Backup.S3.AWSAccessKeyID |AWS Access Key ID for authentication (deprecated, use `System.Backup.S3.AccessKeyID` instead, which has a higher priority.) | `null` -|System.Backup.S3.AWSSecretAccessKey |AWS Secret Access Key for authentication (deprecated, use System.Backup.S3.SecretAccessKey instead, which has a higher priority.) +|System.Backup.S3.AWSSecretAccessKey |AWS Secret Access Key for authentication (deprecated, use `System.Backup.S3.SecretAccessKey` instead, which has a higher priority.) -[NOTE]: If setting this in interactive mode, store the key in a file and provide the path to the file, e.g., `@/tmp/test_secret`. +*NOTE*: If setting this in interactive mode, store the key in a file and provide the path to the file, e.g., `@/tmp/test_secret`. |`+null+` |System.Backup.S3.AccessKeyID |Access key ID for authentication for AWS S3 or S3-compatible services.| `nan` |System.Backup.S3.SecretAccessKey | Secret Access Key for authentication for AWS S3 or S3-compatible services. -[NOTE]: If setting this in interactive mode, store the key in a file and provide the path to the file, e.g., `@/tmp/test_secret`.|`nan` +*NOTE*: If setting this in interactive mode, store the key in a file and provide the path to the file, e.g., `@/tmp/test_secret`.|`nan` |System.Backup.S3.BucketName |Bucket for AWS S3 or S3-compatible services.|`nan` @@ -43,7 +43,7 @@ Secret Access Key for authentication for AWS S3 or S3-compatible services. |System.Backup.S3.RoleARN |The AWS role for accessing s3 buckets. S3 Role ARN takes priority over access keys. For more information, see link:https://docs.aws.amazon.com/IAM/latest/APIReference/API_Role.html[AWS role ARN documentation]. -[NOTE]: This is only for AWS S3, and TigerGraph assumes the credentials for using `sts:AssumeRole` have been set up. You can verify the credentials are ready by running link:https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html#examples[aws sts assume-role]. One way to set up credentials is to configure access key id, secret access key and region with AWS CLI `aws configure`. +*NOTE*: This is only for AWS S3, and TigerGraph assumes the credentials for using `sts:AssumeRole` have been set up. You can verify the credentials are ready by running link:https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html#examples[aws sts assume-role]. One way to set up credentials is to configure access key id, secret access key and region with AWS CLI `aws configure`. |`+nan+` @@ -52,7 +52,7 @@ S3 Role ARN takes priority over access keys. For more information, see link:http |System.Backup.ABS.AccountName |Azure storage account name for authentication.| `nan` |System.Backup.ABS.AccountKey |Account key for the Azure storage account. -[NOTE]: If setting this in interactive mode, store the key in a file and provide the path to the file, e.g., `@/tmp/test_key`. +*NOTE*: If setting this in interactive mode, store the key in a file and provide the path to the file, e.g., `@/tmp/test_key`. | `nan` |System.Backup.ABS.Endpoint|Optional Blob service endpoint; if not given, the default endpoint https://.blob.core.windows.net will be used.|`nan` |System.Backup.GCS.Enable |Enables or disables backup to Google Cloud Storage (GCS).|`false` @@ -60,7 +60,7 @@ S3 Role ARN takes priority over access keys. For more information, see link:http |System.Backup.GCS.AccessKeyID |Access Key for a GCS HMAC Key.| `nan` |System.Backup.GCS.Secret |Secret for a GCS HMAC Key. -[NOTE]: If setting this in interactive mode, store the key in a file and provide the path to the file, e.g., `@/tmp/test_secret`. +*NOTE*: If setting this in interactive mode, store the key in a file and provide the path to the file, e.g., `@/tmp/test_secret`. | `nan` |System.Backup.GCS.Endpoint|GCS Storage URI.|`https://storage.googleapis.com`