Connection Doc modifications - mysql, postgres & Mysql E2E fix (#12193)

* Fix Mysql E2E

* Fix Docs

* modify Security.md
This commit is contained in:
Ayush Shah 2023-06-28 13:48:10 +05:30 committed by GitHub
parent caa78a2310
commit b764641a97
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 10 deletions

View File

@ -7,8 +7,8 @@ currently being supported with security updates.
| Version | Supported |
| ------- | ------------------ |
| 0.13.x | :white_check_mark: |
| 0.12.x | :white_check_mark: |
| 1.1.x | :white_check_mark: |
| 1.0.x | :white_check_mark: |
## Reporting a Vulnerability

View File

@ -91,7 +91,7 @@ class MysqlCliTest(CliCommonDB.TestSuite, SQACommonMethods):
@staticmethod
def expected_filtered_table_includes() -> int:
return 48
return 50
@staticmethod
def expected_filtered_table_excludes() -> int:
@ -99,4 +99,4 @@ class MysqlCliTest(CliCommonDB.TestSuite, SQACommonMethods):
@staticmethod
def expected_filtered_mix() -> int:
return 48
return 50

View File

@ -41,6 +41,16 @@ $$section
Username to connect to MySQL. This user should have access to the `INFORMATION_SCHEMA` to extract metadata. Other workflows may require different permissions -- refer to the section above for more information.
$$
$$section
### Auth Config $(id="authType")
There are 2 types of auth configs:
- Basic Auth.
- IAM based Auth.
User can authenticate the Mysql Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services.
$$
## Basic Auth
$$section
@ -50,7 +60,9 @@ $$
## IAM Auth Config
### Note: If you are using IAM auth, add `"ssl": {"ssl-mode": "allow"} under Connection Arguments`
$$note
If you are using IAM auth, add <br />`"ssl": {"ssl-mode": "allow"}` under Connection Arguments
$$
$$section
### AWS Access Key ID $(id="awsAccessKeyId")
@ -180,5 +192,3 @@ $$
$$section
### Connection Arguments $(id="connectionArguments")
Additional connection arguments such as security or protocol configs that can be sent to the service during connection.
#### Note: If you are using IAM auth, add `"ssl": {"ssl-mode": "allow"} under Connection Arguments`
$$

View File

@ -45,6 +45,17 @@ $$section
Username to connect to Postgres. This user should have privileges to read all the metadata in Postgres.
$$
$$section
### Auth Config $(id="authType")
There are 2 types of auth configs:
- Basic Auth.
- IAM based Auth.
User can authenticate the Postgres Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services.
$$
## Basic Auth
$$section
### Password $(id="password")
@ -155,10 +166,11 @@ $$
$$section
### SSL Mode $(id="sslMode")
SSL Mode to connect to postgres database. E.g, `prefer`, `verify-ca` etc.
#### Note: if you are using `IAM auth`, select either `allow` (recommended) or other option based on your use case.
SSL Mode to connect to postgres database. E.g, `prefer`, `verify-ca`, `allow` etc.
$$
$$note
if you are using `IAM auth`, select either `allow` (recommended) or other option based on your use case.
$$
$$section
### Classification Name $(id="classificationName")