Automatically configure and fail-over connections using DNS #2043

hessjcg · 2024-07-18T16:35:49Z

Feature Description

The java connector may be configured to connect to a Cloud SQL instance using a DNS name.

When the JDBC connection properties does not contain the cloudSqlInstance property, the connector will attempt to use the hostname from the JDBC URL to resolve name using DNS. The connector will query the local DNS for a TXT record. The TXT should contain an instance name matching that DNS name. The connector will use the instance name from the TXT record to connect to the Cloud SQL instance.

The connector will periodically query that DNS. If the instance name in the DNS record changes, the connector will terminate all open connections to the old instance. Then, it will reconfigure itself to open connections to the new instance.

This enables several DNS-related features by allowing configuration through DNS.

Users can configure their database clients using the domain name instead of the instance name.
Users can fail-over database clients when they change the DNS entry for the database instance.

This is the Java implementation of GoogleCloudPlatform/cloud-sql-go-connector#842

The text was updated successfully, but these errors were encountered:

…API. Part of #2043.

…2044) A connection may be configured to using a DNS name instead of an instance name. If the cloudSqlInstance property is set to be a domain name instead of an instance name, the connector will look up a SRV record for that name and connect to that instance. There should be exactly 1 SRV for the database instance. The connector will always use the SRV record with the highest priority. Part of #2043

…API. Part of #2043.

.

…2043. When connecting to a Cloud SQL database using a domain name like `db.example.com`, you may now set the domain name in the JDBC URL. For example, you can use a URL like "jdbc:mysql://db.example.com/my-schema?socketFactory=socketFactory=com.google.cloud.sql.mysql.SocketFactory" The socket factory will detect "db.example.com" and look up the TXT record to resolve the instance name. See #2043 for the whole feature definition.

jackwotherspoon · 2024-11-27T21:48:31Z

Hi All - Any updates on the implementation of this?

Since write endpoints are now in preview, I am eager to give this a try.

@derek-gfs Thanks for showing your interest here! We really appreciate it 😄

I believe @hessjcg will be picking back up this work in the coming week or two and getting these PRs across the line.

We are still waiting on a backend change to fully roll out before the full support of the feature in the Connectors will be possible.

See #2043 for the whole feature definition.

…2043. When connecting to a Cloud SQL database using a domain name like `db.example.com`, you may now set the domain name in the JDBC URL. For example, you can use a URL like "jdbc:mysql://db.example.com/my-schema?socketFactory=socketFactory=com.google.cloud.sql.mysql.SocketFactory" The socket factory will detect "db.example.com" and look up the TXT record to resolve the instance name. See #2043 for the whole feature definition.

…2043.

wip: fix validation in InternalConnectorRegistry wip: e2e postgres custom san test

Add DomainName to connection config, and an InstanceNameResolver function. This will allow the connector to be configured using a domain name referencing the instead of the instance name. This is part of the implementation of #2043.

…2043. (#2050) When connecting to a Cloud SQL database using a domain name like `db.example.com`, you may now set the domain name in the JDBC URL. For example, you can use a URL like "jdbc:mysql://db.example.com/my-schema?socketFactory=socketFactory=com.google.cloud.sql.mysql.SocketFactory" The socket factory will detect "db.example.com" and look up the TXT record to resolve the instance name. See #2043 for the whole feature definition.

…2043. (#2102) Adds documentation to describe how to use the hostname for JDBC and R2DBC.

…2101) Enables Sql Server users to set the domain name in the JDBC URL. Users simply replace the instance connection name with the domain name. Due to limitations of the SQL Server driver, users cannot use the JDBC URL's host field. Part of #2043

…2047) The dialer may be configured to use a DNS name to look up the instance name instead of configuring the connector with the instance name directly. Add a DNS TXT record for the Cloud SQL instance to a private DNS server or a private Google Cloud DNS Zone used by your application. For example: Record type: TXT Name: prod-db.mycompany.example.com – This is the domain name used by the application Value: my-project:region:my-instance – This is the instance connection name Configure the dialer with the cloudsqlconn.WithDNSResolver() option. Open a database connection using the DNS name: HOST: The domain name configured in your DNS TXT record. Base JDBC URL: jdbc:mysql://<HOST>/<DATABASE_NAME> SOCKET_FACTORY_CLASS: com.google.cloud.sql.mysql.SocketFactory The full JDBC URL for MySQL should look like this: String jdbcUrl = "jdbc:mysql://<HOST>/<DATABASE_NAME>?" + "&socketFactory=com.google.cloud.sql.mysql.SocketFactory" + "&user=<MYSQL_USER_NAME>" + "&password=<MYSQL_USER_PASSWORD>"; See also: the Cloud SQL Go Connector implementation Part of #2043

…nnector. (#2103) Now, the connector will detect if the R2DBC HOST connection property contains a domain name or a Cloud SQL instance name. If HOST has a domain name, the connector will look up the domain name to determine the instance name. For example, if the R2DBC url is set to r2dbc:gcp:mssql://<DB_USER>:<DB_PASS>@db.example.com/db, the connector will lookup the TXT record for db.example.com. The record should contain a valid Cloud SQL instance name. Part of #2043

hessjcg added priority: p1 Important issue which blocks shipping the next release. Will be fixed prior to next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Jul 18, 2024

hessjcg self-assigned this Jul 18, 2024

hessjcg added a commit that referenced this issue Jul 18, 2024

chore: Create a new DnsResolver class that wraps the clumsy Java DNS …

e7f0289

…API. Part of #2043.

hessjcg added a commit that referenced this issue Jul 18, 2024

feat: Automatically configure connections using DNS. Part of #2043.

11eec88

hessjcg added a commit that referenced this issue Jul 18, 2024

feat: Automatically configure connections using DNS. Part of #2043.

2665b01

This was referenced Jul 18, 2024

feat: Automatically configure connections using DNS. Part of #2043. #2044

Merged

chore: Create a new DnsResolver class that wraps the Java DNS API #2045

Merged

hessjcg added a commit that referenced this issue Jul 18, 2024

feat: Automatically configure connections using DNS. Part of #2043.

c41d806

hessjcg added a commit that referenced this issue Jul 19, 2024

chore: Create a new DnsResolver class that wraps the clumsy Java DNS …

cb75da8

…API. Part of #2043.

hessjcg added a commit that referenced this issue Jul 19, 2024

feat: Automatically configure connections using DNS. Part of #2043.

46e95c4

hessjcg added a commit that referenced this issue Aug 8, 2024

chore: Create a new DnsResolver class that wraps the clumsy Java DNS …

b5c6b97

…API. Part of #2043.

hessjcg mentioned this issue Aug 8, 2024

feat: Configure connections using DNS domain names #2047

Merged

hessjcg added a commit that referenced this issue Aug 8, 2024

feat: Automatically configure connections using DNS. Part of #2043.

9d71720

hessjcg added a commit that referenced this issue Aug 8, 2024

feat: Automatically configure connections using DNS. Part of #2043.

cc206b2

hessjcg added a commit that referenced this issue Aug 13, 2024

feat: Automatically configure connections using DNS. Part of #2043.

b57ca6c

hessjcg added a commit that referenced this issue Aug 13, 2024

feat: Automatically configure connections using DNS. Part of #2043.

01c0a38

hessjcg added a commit that referenced this issue Aug 13, 2024

feat: Automatically configure connections using DNS. Part of #2043.

1f3d6b7

hessjcg added a commit that referenced this issue Aug 13, 2024

wip: Use domain name from JDBC URL for Postgres and Mysql, Part of #2043

7901caf

.

hessjcg added a commit that referenced this issue Aug 13, 2024

feat: Automatically configure connections using DNS. Part of #2043.

49c7e38

hessjcg added a commit that referenced this issue Aug 13, 2024

feat: Automatically configure connections using DNS. Part of #2043.

f3f362e

hessjcg mentioned this issue Aug 13, 2024

chore: Use domain name from JDBC URL for Postgres and Mysql, Part of #2043 #2050

Merged

hessjcg added a commit that referenced this issue Aug 13, 2024

feat: Automatically configure connections using DNS. Part of #2043.

a0c1b4e

hessjcg mentioned this issue Aug 14, 2024

Provide support for loadBalanceHosts connection property #124

Open

hessjcg added a commit that referenced this issue Aug 15, 2024

feat: Automatically configure connections using DNS. Part of #2043.

8aaa907

hessjcg mentioned this issue Aug 15, 2024

feat: Automatically reset DNS-configured connections on DNS change. Part of #2043 #2056

Draft

hessjcg added a commit that referenced this issue Aug 15, 2024

feat: Automatically configure connections using DNS. Part of #2043.

cf7698a

sanmahapatra added a commit that referenced this issue Aug 26, 2024

Merge branch 'main' into gh-2043-java-dns-wrapper

b69274f

hessjcg added a commit that referenced this issue Jan 9, 2025

chore: Add domain name to the connector config.

43d160a

See #2043 for the whole feature definition.

hessjcg mentioned this issue Jan 9, 2025

chore: Add domain name to the connector config. #2098

Merged

hessjcg added a commit that referenced this issue Jan 10, 2025

chore: Use domain name from JDBC URL for SQL Server, Part of #2043.

df362e6

hessjcg added a commit that referenced this issue Jan 13, 2025

chore: Use domain name from JDBC URL for SQL Server, Part of #2043.

201dd71

hessjcg added a commit that referenced this issue Jan 13, 2025

docs: Add docs for connector configuration using DNS Names, Part of #…

8b651c0

…2043.

hessjcg added a commit that referenced this issue Jan 13, 2025

docs: Add docs for connector configuration using DNS Names, Part of #…

ccbddf3

…2043.

hessjcg mentioned this issue Jan 13, 2025

chore: Use domain name from R2DBC connections, Part of #2043. #2103

Merged

hessjcg added a commit that referenced this issue Jan 13, 2025

chore: Use domain name from JDBC URL for SQL Server, Part of #2043.

9efc407

hessjcg added a commit that referenced this issue Jan 13, 2025

chore: Use domain name from JDBC URL for SQL Server, Part of #2043.

51cd5f2

hessjcg added a commit that referenced this issue Jan 13, 2025

chore: Use domain name from JDBC URL for SQL Server, Part of #2043.

c4a6cfa

hessjcg added a commit that referenced this issue Jan 13, 2025

feat: Automatically configure connections using DNS. Part of #2043.

e885216

hessjcg added a commit that referenced this issue Jan 13, 2025

docs: Add docs for connector configuration using DNS Names, Part of #…

eee73af

…2043.

hessjcg added a commit that referenced this issue Jan 14, 2025

feat: Automatically configure connections using DNS. Part of #2043.

89c1f22

wip: fix validation in InternalConnectorRegistry wip: e2e postgres custom san test

hessjcg added a commit that referenced this issue Jan 14, 2025

feat: Automatically configure connections using DNS. Part of #2043.

a10e852

hessjcg added a commit that referenced this issue Jan 16, 2025

feat: Automatically configure connections using DNS. Part of #2043.

1930978

hessjcg added a commit that referenced this issue Jan 23, 2025

feat: Automatically configure connections using DNS. Part of #2043.

3cd89b1

hessjcg added a commit that referenced this issue Jan 23, 2025

feat: Automatically configure connections using DNS. Part of #2043.

595bfe3

hessjcg added a commit that referenced this issue Jan 23, 2025

feat: Automatically configure connections using DNS. Part of #2043.

e0bbb24

hessjcg added a commit that referenced this issue Jan 23, 2025

feat: Automatically configure connections using DNS. Part of #2043.

914dfdb

hessjcg added a commit that referenced this issue Jan 23, 2025

docs: Add docs for connector configuration using DNS Names, Part of #…

1860b76

…2043. (#2102) Adds documentation to describe how to use the hostname for JDBC and R2DBC.

hessjcg mentioned this issue Jan 23, 2025

chore: Use domain name from JDBC URL for SQL Server, Part of #2043. #2101

Merged

release-please bot mentioned this issue Jan 24, 2025

chore(main): release 1.23.0 #2108

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically configure and fail-over connections using DNS #2043

Automatically configure and fail-over connections using DNS #2043

hessjcg commented Jul 18, 2024 •

edited

Loading

jackwotherspoon commented Nov 27, 2024

Automatically configure and fail-over connections using DNS #2043

Automatically configure and fail-over connections using DNS #2043

Comments

hessjcg commented Jul 18, 2024 • edited Loading

Feature Description

jackwotherspoon commented Nov 27, 2024

hessjcg commented Jul 18, 2024 •

edited

Loading