docs: compatibility guide #1567
Conversation
sergiyvamz
force-pushed
the
docs-compatibility
branch
from
e1d0fb4 to
7a56d12
Compare
| | executionTime | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | logQuery | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | dataCache | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | customEndpoint | <span style="color:red;font-size:20px">✗</span> | |
There was a problem hiding this comment.
This table says you cannot use customEndpoint,efm,efm2 with a global endpoint, but the database type table says you can use those plugins against a global database. I'm assuming that's because you can technically use the plugins but not with the global endpoint URL. Can we change the DatabaseTypes table to clarify which endpoints are acceptable if a plugin is compatible with the database type only for certain URLs? That way we will avoid users seeing that the plugin is compatible with the database type and then assuming they can use any URL they want
There was a problem hiding this comment.
I believe that would make DatabaseTypes table messy and unreadable. We might need to prototype such changes in a simple excel file before rendering it to markdown.
There was a problem hiding this comment.
Yeah I was wondering about that. Hard to represent everything both clearly and concisely
| | [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | [failover](./using-plugins/UsingTheFailoverPlugin.md) | <span style="color:red;font-size:20px">✗</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | [failover2](./using-plugins/UsingTheFailover2Plugin.md) | <span style="color:red;font-size:20px">✗</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | |
There was a problem hiding this comment.
Should we mention that it requires special configuration like we do in the compatibility endpoints table?
There was a problem hiding this comment.
My idea is to let the user check particular plugin page and check necessary configuration parameters. This table is to summarize compatibility and raise a red flag if need. More details should be available on a plugin page.
| | [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | |
There was a problem hiding this comment.
should we clarify that efm and efm2 need the initial connection plugin if using aurora cluster like we do in the endpoint compatibility file?
There was a problem hiding this comment.
When user uses an Aurora Cluster it's also possible to use different endpoints to connect to it. If user decides to use instance endpoint then initialConnection plugin isn't required. Your suggestion is partially correct and depends on used endpoint.
| | [dev](./using-plugins/UsingTheDeveloperPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | fastestResponseStrategy | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:red;font-size:20px">✗</span> | <span style="color:red;font-size:20px">✗</span> | | ||
| | [limitless](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:red;font-size:20px">✗</span> | |
There was a problem hiding this comment.
don't have much insight into liimitless but does it make sense for limitless users to connect to these URLs instead of the limitless shard endpoint?
There was a problem hiding this comment.
These cluster endpoints resolves to a shard group endpoint so it's possible to use them to connect to database.
| | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | connectTime | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | [dev](./using-plugins/UsingTheDeveloperPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | fastestResponseStrategy | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:red;font-size:20px">✗</span> | |
There was a problem hiding this comment.
Double checking, do these plugins actually work with rds proxy? I wasn't sure since I don't think we've done much testing with rds proxy
- failover 1/2
- auroraConnectionTracker
- fastestResponse
- bg
There was a problem hiding this comment.
Failover 1/2, auroraConnectionTracker, fastestResponse should work fine since they don't depend on endpoint type. bg plugin requires additional testing.
There was a problem hiding this comment.
It might be worthwhile to note that after a failover event it will no longer be connected to the proxy endpoint? I believe the way we connect during a failover event doesn't use the proxy endpoint but connects to a reader/writer
| | [failover](./using-plugins/UsingTheFailoverPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:red;font-size:20px">✗</span> | | ||
| | [failover2](./using-plugins/UsingTheFailover2Plugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:red;font-size:20px">✗</span> | | ||
| | [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | | ||
| | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | <span style="color:yellow;font-size:15px">✓</span> | |
There was a problem hiding this comment.
I saw special configuration is required for iam with ip and cname, double checking it isn't required for secrets manager, federated auth, and okta though? Would've expected them to have similar requirements to IAM
There was a problem hiding this comment.
Added this note for secrets manager. It seems that federated auth and okta plugins already require all parameters.
docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraConnectionTrackerPlugin.md
Outdated
Show resolved
Hide resolved
sergiyvamz
force-pushed
the
docs-compatibility
branch
from
7a56d12 to
c0704fd
Compare
|
|
||
|
|
| - [RDS Multi-AZ DB Cluster Writer Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) - `<cluster-name>.cluster-<XYZ>.<region>.rds.amazonaws.com` | ||
| - [RDS Multi-AZ DB Cluster Reader Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) - `<cluster-name>.cluster-ro-<XYZ>.<region>.rds.amazonaws.com` | ||
| - [RDS Instance Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) - `<instance-name>.<XYZ>.<region>.rds.amazonaws.com` | ||
| - [RDS Proxy Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html) - `<proxy-name>.proxy-<XYZ>.<region>.rds.amazonaws.com`, `<endpoint-name>.endpoint.proxy-<XYZ>.<region>.rds.amazonaws.com` |
There was a problem hiding this comment.
| - [RDS Proxy Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html) - `<proxy-name>.proxy-<XYZ>.<region>.rds.amazonaws.com`, `<endpoint-name>.endpoint.proxy-<XYZ>.<region>.rds.amazonaws.com` | |
| - [RDS Proxy Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html) - `<proxy-name>.proxy-<XYZ>.<region>.rds.amazonaws.com`, `<endpoint-name>.endpoint.proxy-<XYZ>.<region>.rds.amazonaws.com`, | |
| `<endpoint-name>-read-only.endpoint.proxy-<XYZ>.<region>.rds.amazonaws.com` |
Wondering if it would be worthwhile to include either a mention or an example of the read only proxy endpoint?
sergiyvamz
force-pushed
the
docs-compatibility
branch
from
4ba7356 to
5153cc9
Compare
4 participants
Summary
Add compatibility guide
Additional Reviewers
@karenc-bq
@aaron-congo
@sophia-bq
@hsuamz
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.