Skip to content

Commit

Permalink
Adapt RDS docs for v3 changes (#884)
Browse files Browse the repository at this point in the history
  • Loading branch information
steffyP authored and alexrashed committed Nov 9, 2023
1 parent d4e9edd commit 760ca7f
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 12 deletions.
4 changes: 2 additions & 2 deletions content/en/references/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,9 +219,9 @@ The old lambda provider is temporarily available in Localstack v2 using `PR

| Variable | Example Values | Description |
| - | - | - |
| `RDS_CLUSTER_ENDPOINT_HOST_ONLY` | `0` (default) / `1` | Whether the cluster endpoint returns the host only (which is AWS parity). If set to `0` it will return `<host>:<port>`. |
| `RDS_CLUSTER_ENDPOINT_HOST_ONLY` | `1` (default) / `0` | Whether the cluster endpoint returns the host only (which is AWS parity). If set to `0` it will return `<host>:<port>`. |
| `RDS_PG_CUSTOM_VERSIONS` | `0` / `1` (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 11). |
| `RDS_MYSQL_DOCKER` | `0` (default) / `1` | Whether to enable MySQL engines (instead of MariaDB). Will run the MySQL cluster/instances in a new docker container. |
| `RDS_MYSQL_DOCKER` | `1` (default) / `0` | Whether to disable MySQL engines (and use MariaDB instead). MySQL engine for cluster/instances will start in a new docker container. If you have troubles running MySQL in docker, you can disable the feature. |
| `MYSQL_IMAGE` | `mysql:8.0` | Defines a specific MySQL image that should be used when spinning up the MySQL engine. Only available if `RDS_MYSQL_DOCKER` is enabled. |
| `MSSQL_IMAGE` | `mcr.microsoft.com/mssql/server:2022-latest` | Defines a specific image that should be used when spinning up a SQL server engine. |

Expand Down
4 changes: 2 additions & 2 deletions content/en/user-guide/aws/docdb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ $ awslocal docdb create-db-cluster --db-cluster-identifier test-docdb-cluster --
"DBClusterIdentifier": "test-docdb-cluster",
"DBClusterParameterGroup": "default.docdb",
"Status": "available",
"Endpoint": "localhost:39045",
"Endpoint": "localhost",
"MultiAZ": false,
"Engine": "docdb",
"Port": 39045,
Expand Down Expand Up @@ -135,7 +135,7 @@ $ awslocal docdb describe-db-clusters --db-cluster-identifier test-docdb-cluster
"DBClusterIdentifier": "test-docdb-cluster",
"DBClusterParameterGroup": "default.docdb",
"Status": "available",
"Endpoint": "localhost:39045",
"Endpoint": "localhost",
"MultiAZ": false,
"Engine": "docdb",
"Port": 39045,
Expand Down
2 changes: 1 addition & 1 deletion content/en/user-guide/aws/neptune/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ You should see the following output:
{
"DBCluster": {
...
"Endpoint": "localhost:4510",
"Endpoint": "localhost",
"Port": 4510, # may vary
"DBClusterArn": "arn:aws:rds:us-east-1:000000000000:cluster:my-neptune-db",
...
Expand Down
9 changes: 2 additions & 7 deletions content/en/user-guide/aws/rds/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,6 @@ LocalStack's RDS implementation also supports the [RDS Data API](https://docs.aw

### Create an RDS cluster

{{< alert title="Note" >}}
The `Endpoint` for cluster on Localstack currently follows the pattern `<host>:<port>` for legacy reasons, which is not in parity in AWS.
To force the correct pattern (e.g. returning only the host for the `Endpoint`) you can use the configuration `RDS_CLUSTER_ENDPOINT_HOST_ONLY=1` to start LocalStack.
{{< /alert >}}

To create an RDS cluster, you can use the [`CreateDBCluster`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) API.
The following command creates a new cluster with the name `db1` and the engine `aurora-postgresql`.
Instances for the cluster must be added manually.
Expand All @@ -49,7 +44,7 @@ You should see the following output:
{
"DBCluster": {
...
"Endpoint": "localhost:4510",
"Endpoint": "localhost",
"Port": 4510, # may vary
"DBClusterArn": "arn:aws:rds:us-east-1:000000000000:cluster:db1",
...
Expand Down Expand Up @@ -179,7 +174,7 @@ MariaDB will be set up as an operating system package within LocalStack. However

### MySQL Engine

When choosing a MySQL engine type, the default installation will be MariaDB. If you prefer to utilize an actual MySQL version, you can achieve this by setting the environment variable `RDS_MYSQL_DOCKER=1`. When this feature is enabled, the MySQL community server will be launched in a new Docker container upon requesting the MySQL engine.
A MySQL community server will be launched in a new Docker container upon requesting the MySQL engine.

The `engine-version` will serve as the tag for the Docker image, allowing you to freely select the desired MySQL version from those available on the [official MySQL Docker Hub](https://hub.docker.com/_/mysql). If you have a specific image in mind, you can also use the environment variable `MYSQL_IMAGE=<my-image:tag>`.

Expand Down

0 comments on commit 760ca7f

Please sign in to comment.