From c05f112d82e167ef2f8bb065c9b618f7392b8b63 Mon Sep 17 00:00:00 2001 From: Stefanie Plieschnegger Date: Wed, 11 Oct 2023 14:34:47 +0200 Subject: [PATCH] add docs for RDS_CLUSTER_ENDPOINT_HOST_ONLY configuration --- content/en/references/configuration.md | 9 +++++---- content/en/user-guide/aws/rds/index.md | 5 +++++ 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/content/en/references/configuration.md b/content/en/references/configuration.md index 17d758b478..608e9f70e7 100644 --- a/content/en/references/configuration.md +++ b/content/en/references/configuration.md @@ -219,10 +219,11 @@ The old lambda provider is temporarily available in Localstack v2 using `PR | Variable | Example Values | Description | | - | - | - | -| `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. | -| `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. | +| `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 `:`. | +| `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. | +| `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. | ### S3 diff --git a/content/en/user-guide/aws/rds/index.md b/content/en/user-guide/aws/rds/index.md index fb8b20dd1a..b876265d9b 100644 --- a/content/en/user-guide/aws/rds/index.md +++ b/content/en/user-guide/aws/rds/index.md @@ -25,6 +25,11 @@ 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 `:` 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.