Automatically configure and fail-over connections using DNS #842

hessjcg · 2024-07-16T18:51:38Z

Feature Description

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

When a connection is configured with a DNS name (instead of an instance name), the connector will query the local DNS for a SRV record. The SRV should contain an instance name matching that DNS name. The connector will use the instance name from the SRV 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.

Sample code

No response

Alternatives Considered

No response

Additional Details

No response

Part of #842

WIP: e2e test changes

Part of #842

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: ``` db, err := sql.Open( "cloudsql-mysql", "myuser:mypass@cloudsql-mysql(prod-db.mycompany.example.com)/mydb", ) ``` Part of #842

Part of #842

WIP: e2e test changes

Part of #842

Part of #842 chore: Add domain name to the cloudsql.ConnName struct feat: Check for DNS changes on connect. On change, close all connections and create a new dialer. feat: Automatially check for DNS changes periodically. On change, close all connections and create a new dialer. wip: eno changes wip: eno interface cleanup wip: convert monitoredInstance to *monitoredInstance

WIP: e2e test changes

Part of #842 chore: Add domain name to the cloudsql.ConnName struct feat: Check for DNS changes on connect. On change, close all connections and create a new dialer. feat: Automatially check for DNS changes periodically. On change, close all connections and create a new dialer. wip: eno changes wip: eno interface cleanup wip: convert monitoredInstance to *monitoredInstance

WIP: e2e test changes

…se all connections and create a new dialer. chore: Expose the refresh strategy UseIAMAuthN() value to the dialer. Part of #842 chore: Add domain name to the cloudsql.ConnName struct Feat: Check for DNS changes on connect. On change, close all connections and create a new dialer. feat: Automatially check for DNS changes periodically. On change, close all connections and create a new dialer. wip: eno changes wip: eno interface cleanup wip: convert monitoredInstance to *monitoredInstance

WIP: e2e test changes

…se all connections and create a new dialer. chore: Expose the refresh strategy UseIAMAuthN() value to the dialer. Part of #842 chore: Add domain name to the cloudsql.ConnName struct Feat: Check for DNS changes on connect. On change, close all connections and create a new dialer. feat: Automatially check for DNS changes periodically. On change, close all connections and create a new dialer. wip: eno changes wip: eno interface cleanup wip: convert monitoredInstance to *monitoredInstance

WIP: e2e test changes

…se all connections and create a new dialer. chore: Expose the refresh strategy UseIAMAuthN() value to the dialer. Part of #842 chore: Add domain name to the cloudsql.ConnName struct Feat: Check for DNS changes on connect. On change, close all connections and create a new dialer. feat: Automatially check for DNS changes periodically. On change, close all connections and create a new dialer. wip: eno changes wip: eno interface cleanup wip: convert monitoredInstance to *monitoredInstance

WIP: e2e test changes

…se all connections and create a new dialer. chore: Expose the refresh strategy UseIAMAuthN() value to the dialer. Part of #842 chore: Add domain name to the cloudsql.ConnName struct Feat: Check for DNS changes on connect. On change, close all connections and create a new dialer. feat: Automatially check for DNS changes periodically. On change, close all connections and create a new dialer. wip: eno changes wip: eno interface cleanup wip: convert monitoredInstance to *monitoredInstance

WIP: e2e test changes

When a connection is configured using a DNS domain name, the connector will poll the DNS TXT record every 30 seconds. If the value of the DNS record changes, the connector will close all connections to the old instance, and direct new connections to the updated instance. Fixes of #842

WIP: e2e test changes

(#871) Add e2e test to verify that connecting with a DNS name works correctly.

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

hessjcg self-assigned this Jul 16, 2024

hessjcg changed the title ~~Automatically configure and fail-over of client connections using DNS~~ Automatically configure and fail-over connections using DNS Jul 16, 2024

hessjcg mentioned this issue Jul 16, 2024

feat: Support configure connections using DNS #843

Merged

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

chore: Expose the refresh strategy UseIAMAuthN() value to the dialer.

cfd86cf

Part of #842

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

test: Add e2e test to access instance using DNS SRV record. part of #842

d870534

hessjcg mentioned this issue Jul 18, 2024

Automatically configure and fail-over connections using DNS GoogleCloudPlatform/cloud-sql-jdbc-socket-factory#2043

Open

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

test: Add e2e test to access instance using DNS SRV record. part of #842

1e0296b

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

test: Add e2e test to access instance using DNS SRV record. part of #842

1937892

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

test: Add e2e test to access instance using DNS SRV record. part of #842

8a39c92

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

chore: Expose the refresh strategy UseIAMAuthN() value to the dialer.

2724804

Part of #842

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

test: Add e2e test to access instance using DNS SRV record. part of #842

8f8263a

WIP: e2e test changes

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

chore: Expose the refresh strategy UseIAMAuthN() value to the dialer.

d725386

Part of #842

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

chore: Expose the refresh strategy UseIAMAuthN() value to the dialer.

2c56b58

Part of #842

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

chore: Expose the refresh strategy UseIAMAuthN() value to the dialer.

734da83

Part of #842

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

test: Add e2e test to access instance using DNS SRV record. part of #842

d5331cd

WIP: e2e test changes

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

chore: Expose the refresh strategy UseIAMAuthN() value to the dialer.

1b2fb7d

Part of #842

hessjcg added a commit that referenced this issue Sep 9, 2024

chore: Refactor dialer cache concurrency logic. Part of #842.

5bf1d21

hessjcg added a commit that referenced this issue Sep 10, 2024

chore: Refactor dialer cache concurrency logic. Part of #842.

10174c5

hessjcg added a commit that referenced this issue Sep 10, 2024

chore: Refactor dialer cache concurrency logic. Part of #842.

aab26be

hessjcg added a commit that referenced this issue Sep 10, 2024

chore: Refactor dialer cache concurrency logic. Part of #842.

090c568

hessjcg added a commit that referenced this issue Sep 10, 2024

test: Add e2e test to access instance using DNS SRV record. part of #842

5c3fdda

WIP: e2e test changes

hessjcg added a commit that referenced this issue Sep 17, 2024

chore: Refactor dialer cache concurrency logic. Part of #842.

0b5a40e

hessjcg added a commit that referenced this issue Sep 17, 2024

chore: Refactor dialer cache concurrency logic. Part of #842.

42b7170

hessjcg added a commit that referenced this issue Sep 17, 2024

test: Add e2e test to access instance using DNS SRV record. part of #842

c04cf6d

WIP: e2e test changes

hessjcg mentioned this issue Sep 17, 2024

feat: Automatically reset DNS-configured connections on DNS change #844

Closed

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

test: Add e2e test to access instance using DNS SRV record. part of #842

20f83d2

WIP: e2e test changes

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

test: Add e2e test to access instance using DNS SRV record. part of #842

bd731be

WIP: e2e test changes

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

test: Add e2e test to access instance using DNS SRV record. part of #842

530ed77

WIP: e2e test changes

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

test: Add e2e test to access instance using DNS SRV record. part of #842

7214664

WIP: e2e test changes

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

test: Add e2e test to access instance using DNS SRV record. part of #842

5db04fb

WIP: e2e test changes

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

test: Add e2e test to access instance using DNS SRV record. part of #842

d413f38

WIP: e2e test changes

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

test: Add e2e test to access instance using DNS SRV record. part of #842

7251c89

WIP: e2e test changes

hessjcg mentioned this issue Sep 18, 2024

feat: Automatically reset connection when the DNS record changes. #868

Merged

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

test: Add e2e test to access instance using DNS SRV record. part of #842

8325d7e

WIP: e2e test changes

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

test: Add e2e test to access instance using DNS SRV record. part of #842

9661e02

WIP: e2e test changes

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

test: Add e2e test to access instance using DNS SRV record. part of #842

4f7052a

WIP: e2e test changes

hessjcg added a commit that referenced this issue Sep 20, 2024

test: Add e2e test to access instance using DNS SRV record. part of #842

e887642

WIP: e2e test changes

hessjcg added a commit that referenced this issue Sep 20, 2024

test: Add e2e test to access instance using DNS SRV record. part of #842

620e5fe

WIP: e2e test changes

hessjcg added a commit that referenced this issue Sep 20, 2024

test: Add e2e test to access instance using DNS SRV record. part of #842

f8bf685

(#871) Add e2e test to verify that connecting with a DNS name works correctly.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically configure and fail-over connections using DNS #842

Automatically configure and fail-over connections using DNS #842

hessjcg commented Jul 16, 2024

Automatically configure and fail-over connections using DNS #842

Automatically configure and fail-over connections using DNS #842

Comments

hessjcg commented Jul 16, 2024

Feature Description

Sample code

Alternatives Considered

Additional Details