Skip to content

Commit 62ab6f2

Browse files
rrelledgerrelledge
authored
DOC-5373 RS: Added S3 compatible storage info to REST API DB import/export sources references (#1925)
1 parent 9ae05bf commit 62ab6f2

File tree

6 files changed

+127
-2
lines changed

6 files changed

+127
-2
lines changed

‎content/operate/rs/7.4/references/rest-api/objects/bdb/backup_location.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You can back up or export a database's dataset to the following types of locatio
1616

1717
- FTP/S
1818
- SFTP
19-
- Amazon S3
19+
- Amazon S3 or S3-compatible storage
2020
- Google Cloud Storage
2121
- Microsoft Azure Storage
2222
- NAS/Local Storage
@@ -61,6 +61,27 @@ Any additional required parameters may differ based on the backup/export locatio
6161
| secret_access_key | string | The AWS Secret Access Key that matches the Access Key ID |
6262
| subdir | string | Path to the backup directory in the S3 bucket (optional) |
6363

64+
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.
65+
66+
To connect to an S3-compatible storage location:
67+
68+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):
69+
70+
```sh
71+
rladmin cluster config s3_url <URL>
72+
```
73+
74+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
75+
76+
1. Configure the S3 CA certificate:
77+
78+
```sh
79+
rladmin cluster config s3_ca_cert <filepath>
80+
```
81+
82+
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.
83+
84+
6485
### Google Cloud Storage
6586

6687
| Key name | Type | Description |

‎content/operate/rs/7.4/references/rest-api/objects/bdb/dataset_import_sources.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ You can import data to a database from the following location types:
1818
- FTP
1919
- SFTP
2020
- Amazon S3
21+
- Amazon S3 or S3-compatible storage
2122
- Google Cloud Storage
2223
- Microsoft Azure Storage
2324
- NAS/Local Storage
@@ -66,6 +67,26 @@ Any additional required parameters may differ based on the import location type.
6667
| secret_access_key | string | The AWS Secret Access that matches the Access Key ID |
6768
| subdir | string | Path to the backup directory in the S3 bucket (optional) |
6869

70+
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.
71+
72+
To connect to an S3-compatible storage location:
73+
74+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):
75+
76+
```sh
77+
rladmin cluster config s3_url <URL>
78+
```
79+
80+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
81+
82+
1. Configure the S3 CA certificate:
83+
84+
```sh
85+
rladmin cluster config s3_ca_cert <filepath>
86+
```
87+
88+
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.
89+
6990
### Google Cloud Storage
7091

7192
| Key name | Type | Description |

‎content/operate/rs/7.8/references/rest-api/objects/bdb/backup_location.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You can back up or export a database's dataset to the following types of locatio
1616

1717
- FTP/S
1818
- SFTP
19-
- Amazon S3
19+
- Amazon S3 or S3-compatible storage
2020
- Google Cloud Storage
2121
- Microsoft Azure Storage
2222
- NAS/Local Storage
@@ -61,6 +61,26 @@ Any additional required parameters may differ based on the backup/export locatio
6161
| secret_access_key | string | The AWS Secret Access Key that matches the Access Key ID |
6262
| subdir | string | Path to the backup directory in the S3 bucket (optional) |
6363

64+
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.
65+
66+
To connect to an S3-compatible storage location:
67+
68+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.8/references/cli-utilities/rladmin/cluster/config">}}):
69+
70+
```sh
71+
rladmin cluster config s3_url <URL>
72+
```
73+
74+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
75+
76+
1. Configure the S3 CA certificate:
77+
78+
```sh
79+
rladmin cluster config s3_ca_cert <filepath>
80+
```
81+
82+
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.
83+
6484
### Google Cloud Storage
6585

6686
| Key name | Type | Description |

‎content/operate/rs/7.8/references/rest-api/objects/bdb/dataset_import_sources.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ You can import data to a database from the following location types:
1818
- FTP
1919
- SFTP
2020
- Amazon S3
21+
- Amazon S3 or S3-compatible storage
2122
- Google Cloud Storage
2223
- Microsoft Azure Storage
2324
- NAS/Local Storage
@@ -67,6 +68,26 @@ Any additional required parameters may differ based on the import location type.
6768
| secret_access_key | string | The AWS Secret Access that matches the Access Key ID |
6869
| subdir | string | Path to the backup directory in the S3 bucket (optional) |
6970

71+
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.
72+
73+
To connect to an S3-compatible storage location:
74+
75+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.8/references/cli-utilities/rladmin/cluster/config">}}):
76+
77+
```sh
78+
rladmin cluster config s3_url <URL>
79+
```
80+
81+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
82+
83+
1. Configure the S3 CA certificate:
84+
85+
```sh
86+
rladmin cluster config s3_ca_cert <filepath>
87+
```
88+
89+
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.
90+
7091
### Google Cloud Storage
7192

7293
| Key name | Type | Description |

‎content/operate/rs/references/rest-api/objects/bdb/backup_location.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ You can back up or export a database's dataset to the following types of locatio
1616
- FTP/S
1717
- SFTP
1818
- Amazon S3
19+
- Amazon S3 or S3-compatible storage
1920
- Google Cloud Storage
2021
- Microsoft Azure Storage
2122
- NAS/Local Storage
@@ -60,6 +61,26 @@ Any additional required parameters may differ based on the backup/export locatio
6061
| secret_access_key | string | The AWS Secret Access Key that matches the Access Key ID |
6162
| subdir | string | Path to the backup directory in the S3 bucket (optional) |
6263

64+
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.
65+
66+
To connect to an S3-compatible storage location:
67+
68+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/config">}}):
69+
70+
```sh
71+
rladmin cluster config s3_url <URL>
72+
```
73+
74+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
75+
76+
1. Configure the S3 CA certificate:
77+
78+
```sh
79+
rladmin cluster config s3_ca_cert <filepath>
80+
```
81+
82+
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.
83+
6384
### Google Cloud Storage
6485

6586
| Key name | Type | Description |

‎content/operate/rs/references/rest-api/objects/bdb/dataset_import_sources.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ You can import data to a database from the following location types:
1717
- FTP
1818
- SFTP
1919
- Amazon S3
20+
- Amazon S3 or S3-compatible storage
2021
- Google Cloud Storage
2122
- Microsoft Azure Storage
2223
- NAS/Local Storage
@@ -66,6 +67,26 @@ Any additional required parameters may differ based on the import location type.
6667
| secret_access_key | string | The AWS Secret Access that matches the Access Key ID |
6768
| subdir | string | Path to the backup directory in the S3 bucket (optional) |
6869

70+
You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate.
71+
72+
To connect to an S3-compatible storage location:
73+
74+
1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/config">}}):
75+
76+
```sh
77+
rladmin cluster config s3_url <URL>
78+
```
79+
80+
Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.
81+
82+
1. Configure the S3 CA certificate:
83+
84+
```sh
85+
rladmin cluster config s3_ca_cert <filepath>
86+
```
87+
88+
Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.
89+
6990
### Google Cloud Storage
7091

7192
| Key name | Type | Description |

0 commit comments

Comments
 (0)