Skip to content

Commit f57ba10

Browse files
chore: use rendered notices in README (#1088)
1 parent 6428cbe commit f57ba10

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,10 @@ To close the `Connector` object's background resources, call its `close()` metho
173173
connector.close()
174174
```
175175

176-
**Note**: For more examples of using SQLAlchemy to manage connection pooling with the connector, please see [Cloud SQL SQLAlchemy Samples](https://cloud.google.com/sql/docs/postgres/connect-connectors#python_1).
177-
178-
**Note for SQL Server users**: If your SQL Server instance requires SSL, you need to download the CA certificate for your instance and include `cafile={path to downloaded certificate}` and `validate_host=False`. This is a workaround for a [known issue](https://issuetracker.google.com/184867147).
176+
> [!NOTE]
177+
>
178+
> For more examples of using SQLAlchemy to manage connection pooling with the connector,
179+
> please see [Cloud SQL SQLAlchemy Samples](https://cloud.google.com/sql/docs/postgres/connect-connectors#python_1).
179180
180181
### Configuring the Connector
181182

@@ -275,9 +276,11 @@ conn = connector.connect(
275276
)
276277
```
277278

278-
Note: If specifying Private IP or Private Service Connect, your application must be
279-
attached to the proper VPC network to connect to your Cloud SQL instance. For most
280-
applications this will require the use of a [VPC Connector][vpc-connector].
279+
> [!IMPORTANT]
280+
>
281+
> If specifying Private IP or Private Service Connect (PSC), your application must be
282+
> attached to the proper VPC network to connect to your Cloud SQL instance. For most
283+
> applications this will require the use of a [VPC Connector][vpc-connector].
281284
282285
[psc]: https://cloud.google.com/vpc/docs/private-service-connect
283286
[vpc-connector]: https://cloud.google.com/vpc/docs/configure-serverless-vpc-access#create-connector
@@ -306,9 +309,20 @@ conn = connector.connect(
306309
)
307310
```
308311

309-
### SQL Server Active Directory Authentication
312+
### SQL Server (MSSQL)
313+
314+
> [!IMPORTANT]
315+
>
316+
> If your SQL Server instance is set to [enforce SSL connections](https://cloud.google.com/sql/docs/sqlserver/configure-ssl-instance#enforcing-ssl),
317+
> you need to download the CA certificate for your instance and include `cafile={path to downloaded certificate}`
318+
> and `validate_host=False`. This is a workaround for a [known issue](https://issuetracker.google.com/184867147).
319+
320+
#### Active Directory Authentication
310321

311-
Active Directory authentication for SQL Server instances is currently only supported on Windows. First, make sure to follow [these steps](https://cloud.google.com/blog/topics/developers-practitioners/creating-sql-server-instance-integrated-active-directory-using-google-cloud-sql) to set up a Managed AD domain and join your Cloud SQL instance to the domain. [See here for more info on Cloud SQL Active Directory integration](https://cloud.google.com/sql/docs/sqlserver/ad).
322+
Active Directory authentication for SQL Server instances is currently only supported on Windows.
323+
First, make sure to follow [these steps](https://cloud.google.com/blog/topics/developers-practitioners/creating-sql-server-instance-integrated-active-directory-using-google-cloud-sql)
324+
to set up a Managed AD domain and join your Cloud SQL instance to the domain.
325+
[See here for more info on Cloud SQL Active Directory integration](https://cloud.google.com/sql/docs/sqlserver/ad).
312326

313327
Once you have followed the steps linked above, you can run the following code to return a connection object:
314328

@@ -521,8 +535,10 @@ An alternative to using the `create_async_connector` function is initializing
521535
a `Connector` as an async context manager, removing the need for explicit
522536
calls to `connector.close_async()` to cleanup resources.
523537

524-
**Note:** This alternative requires that the running event loop be
525-
passed in as the `loop` argument to `Connector()`.
538+
> [!NOTE]
539+
>
540+
> This alternative requires that the running event loop be
541+
> passed in as the `loop` argument to `Connector()`.
526542
527543
```python
528544
import asyncio

0 commit comments

Comments
 (0)