Skip to content

Commit e5fd4e6

Browse files
authored
docs: Update documentation to describe how to use Advanced DR write endpoint (#500)
1 parent 0a5f9fd commit e5fd4e6

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -444,14 +444,27 @@ variables. Here is a quick reference to supported values and their effect:
444444
- `GOOGLE_CLOUD_QUOTA_PROJECT`: Used to set a custom quota project to Cloud SQL
445445
APIs when defined.
446446

447-
## Using DNS domain names to identify instances
447+
## Using Advanced Disaster Recovery and DNS domain names to identify instances
448448

449-
The connector can be configured to use DNS to look up an instance. This would
450-
allow you to configure your application to connect to a database instance, and
451-
centrally configure which instance in your DNS zone.
449+
The connector can be configured to use DNS to look up an instance.
450+
Use a DNS name managed by Cloud SQL [Advanced Disaster Recovery](https://docs.cloud.google.com/sql/docs/mysql/use-advanced-disaster-recovery),
451+
or a domain name that you manage.
452+
453+
### Using Advanced Recovery Write Endpoint DNS Name
454+
455+
[Advanced Disaster Recovery](https://docs.cloud.google.com/sql/docs/mysql/use-advanced-disaster-recovery)
456+
creates geographically distributed replicas of your Cloud SQL database instance. When you perform
457+
switchover or failover on the database instance, the connector will gracefully disconnect from the
458+
old primary instance and reconnect to the new primary instance.
459+
460+
Follow the instructions in [Connect using Write Endpoint](https://docs.cloud.google.com/sql/docs/mysql/connect-to-instance-using-write-endpoint)
461+
to get the write endpoint DNS name for your primary instance. Then, use this write endpoint DNS
462+
name to configure the connector.
452463

453464
### Configure your DNS Records
454465

466+
The connector may be configured to use DNS that you define as well.
467+
455468
Add a DNS TXT record for the Cloud SQL instance to a **private** DNS server
456469
or a private Google Cloud DNS Zone used by your application.
457470

0 commit comments

Comments
 (0)