Skip to content

RS: Added S3 compatible storage info to REST API DB import/export sources references #1925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can back up or export a database's dataset to the following types of locatio

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

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.

To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.


### Google Cloud Storage

| Key name | Type | Description |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ You can import data to a database from the following location types:
- FTP
- SFTP
- Amazon S3
- Amazon S3 or S3-compatible storage
- Google Cloud Storage
- Microsoft Azure Storage
- NAS/Local Storage
Expand Down Expand Up @@ -66,6 +67,26 @@ Any additional required parameters may differ based on the import location type.
| secret_access_key | string | The AWS Secret Access that matches the Access Key ID |
| subdir | string | Path to the backup directory in the S3 bucket (optional) |

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.

To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

### Google Cloud Storage

| Key name | Type | Description |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can back up or export a database's dataset to the following types of locatio

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

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.

To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.8/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

### Google Cloud Storage

| Key name | Type | Description |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ You can import data to a database from the following location types:
- FTP
- SFTP
- Amazon S3
- Amazon S3 or S3-compatible storage
- Google Cloud Storage
- Microsoft Azure Storage
- NAS/Local Storage
Expand Down Expand Up @@ -67,6 +68,26 @@ Any additional required parameters may differ based on the import location type.
| secret_access_key | string | The AWS Secret Access that matches the Access Key ID |
| subdir | string | Path to the backup directory in the S3 bucket (optional) |

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.

To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/7.8/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

### Google Cloud Storage

| Key name | Type | Description |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ You can back up or export a database's dataset to the following types of locatio
- FTP/S
- SFTP
- Amazon S3
- Amazon S3 or S3-compatible storage
- Google Cloud Storage
- Microsoft Azure Storage
- NAS/Local Storage
Expand Down Expand Up @@ -60,6 +61,26 @@ Any additional required parameters may differ based on the backup/export locatio
| secret_access_key | string | The AWS Secret Access Key that matches the Access Key ID |
| subdir | string | Path to the backup directory in the S3 bucket (optional) |

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.

To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

### Google Cloud Storage

| Key name | Type | Description |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ You can import data to a database from the following location types:
- FTP
- SFTP
- Amazon S3
- Amazon S3 or S3-compatible storage
- Google Cloud Storage
- Microsoft Azure Storage
- NAS/Local Storage
Expand Down Expand Up @@ -66,6 +67,26 @@ Any additional required parameters may differ based on the import location type.
| secret_access_key | string | The AWS Secret Access that matches the Access Key ID |
| subdir | string | Path to the backup directory in the S3 bucket (optional) |

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.

To connect to an S3-compatible storage location:

1. Configure the S3 URL with [`rladmin cluster config`]({{<relref "/operate/rs/references/cli-utilities/rladmin/cluster/config">}}):

```sh
rladmin cluster config s3_url <URL>
```

Replace `<URL>` with the hostname or IP address of the S3-compatible storage location.

1. Configure the S3 CA certificate:

```sh
rladmin cluster config s3_ca_cert <filepath>
```

Replace `<filepath>` with the location of the S3 CA certificate `ca.pem`.

### Google Cloud Storage

| Key name | Type | Description |
Expand Down