Add MariaDB to AWS RDS auto discovery #10333

jakule · 2022-02-13T05:14:51Z

This PR adds auto-discovery to MariaDB RDS including docs changes. The minimum supported version is MariaDB 10.6 as AWS doesn't support IAM on older versions: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html

lib/services/database.go

lib/services/database_test.go

docs/pages/database-access/guides/rds.mdx

ptgott · 2022-03-03T21:39:44Z

docs/pages/database-access/guides/rds.mdx

@@ -14,6 +14,11 @@ This guide will help you to:
  writing so it can't be used with Database Access.
 </Admonition>

+<Admonition type="note" title="MariaDB supported versions">


The two back-to-back Admonitions are kind of hard to follow. I think we should include a single Admonition that starts with a general statement like, "The following products are not compatible with Database Access," followed by a two-item list that includes the products mentioned in these Admonitions.

I merged and re-phrase the block. Let me know what do you think.

docs/pages/database-access/guides/rds.mdx

r0mant · 2022-03-03T21:43:06Z

docs/pages/database-access/guides/rds.mdx

@@ -14,6 +14,11 @@ This guide will help you to:
  writing so it can't be used with Database Access.
 </Admonition>

+<Admonition type="note" title="MariaDB supported versions">
+  The minimum supported version of MariaDB is 10.6. Older versions don't support


Nit: I would clarify that this is specifically for RDS MariaDB. Might be clear enough as it is given that this is RDS specific guide but I wonder if somebody might get confused by it anyway.

I was also thinking about it, but decided to skip as this is RDS only guide, but I don't see any harm with adding it.

r0mant · 2022-03-03T21:45:40Z

lib/services/database.go

+	// Min supported MariaDB version that supports IAM is 10.6
+	// https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
+	minIAMSupportedVer := semver.New("10.6.0")
+	return ver.Compare(*minIAMSupportedVer) >= 0


Nit: I think using LessThan is a bit more readable.

r0mant · 2022-03-03T21:47:24Z

lib/srv/db/cloud/watchers/rds.go

@@ -106,6 +106,14 @@ func (f *rdsDBInstancesFetcher) getRDSDatabases(ctx context.Context) (types.Data
 	}
 	databases := make(types.Databases, 0, len(instances))
 	for _, instance := range instances {
+		if !services.IsRDSInstanceSupported(instance) {


What about Aurora clusters? Does Aurora provide MariaDB engine?

I don't see MariaDB in Aurora (checked website + docs).

lib/services/database.go

jakule · 2022-03-04T23:13:07Z

Checking the updated docs page I noticed something. Here is a screenshot

So the page is targeting Teleport 9 release and everything described here (including support for RDS MariaDB) applies to v9, except Install Teleport 7.0.0. In my opinion is confusing. Any thoughts? @r0mant @ptgott

Co-authored-by: Paul Gottschling <[email protected]> Co-authored-by: Alan Parra <[email protected]>

greedy52 · 2022-03-07T14:29:32Z

So the page is targeting Teleport 9 release and everything described here (including support for RDS MariaDB) applies to v9, except Install Teleport 7.0.0

teleport/docs/config.json

Lines 814 to 823 in b8cae1a

    
           "teleport": { 
        
             "version": "7.0.0", 
        
             "golang": "1.16", 
        
             "plugin": { 
        
               "version": "7.0.0" 
        
             }, 
        
             "helm_repo_url": "https://charts.releases.teleport.dev", 
        
             "latest_oss_docker_image": "quay.io/gravitational/teleport:7", 
        
             "latest_ent_docker_image": "quay.io/gravitational/teleport-ent:7" 
        
           }

We haven't updated the version for docs?

ptgott · 2022-03-07T21:39:12Z

docs/pages/database-access/guides/rds.mdx

@@ -1,6 +1,6 @@
 ---
-title: Database Access with AWS RDS and Aurora for PostgreSQL and MySQL
-description: How to configure Teleport Database Access with AWS RDS and Aurora for PostgreSQL and MySQL.
+title: Database Access with AWS RDS and Aurora for PostgreSQL, MySQL and MariaDB


To prevent this title from being truncated in Google's search results, we should get this to around 55 chars or less, e.g., by making it "Database Access with AWS RDS and Aurora." We can then add an h1 attribute to the frontmatter that uses the original title, "Database Access with AWS RDS and Aurora for PostgreSQL, MySQL and MariaDB." The h1 attribute is not used to populate the page's title element, while title is.

Good tip. I'd never think about it. Changed.

docs/pages/database-access/guides/rds.mdx

Co-authored-by: Roman Tkachenko <[email protected]>

Add support for MariaDB AWS RDS with IAM authentication version 10.6+. Co-authored-by: Paul Gottschling <[email protected]> Co-authored-by: Alan Parra <[email protected]> Co-authored-by: Roman Tkachenko <[email protected]>

Add support for MariaDB AWS RDS with IAM authentication version 10.6+. Backport #10333 Co-authored-by: Paul Gottschling <[email protected]> Co-authored-by: Alan Parra <[email protected]> Co-authored-by: Roman Tkachenko <[email protected]>

jakule force-pushed the jakule/mariadb-rds-discovery branch 2 times, most recently from bc08bdc to 2ee9f83 Compare March 3, 2022 16:57

jakule marked this pull request as ready for review March 3, 2022 16:57

github-actions bot added database-access Database access related issues and PRs documentation labels Mar 3, 2022

github-actions bot requested review from codingllama, lxea, ptgott, r0mant, xinding33 and zmb3 March 3, 2022 16:58

codingllama approved these changes Mar 3, 2022

View reviewed changes

lib/services/database.go Outdated Show resolved Hide resolved

lib/services/database_test.go Outdated Show resolved Hide resolved

ptgott reviewed Mar 3, 2022

View reviewed changes

r0mant reviewed Mar 3, 2022

View reviewed changes

r0mant requested review from greedy52 and removed request for zmb3, lxea and xinding33 March 3, 2022 21:49

greedy52 reviewed Mar 4, 2022

View reviewed changes

lib/services/database.go Outdated Show resolved Hide resolved

lib/services/database.go Outdated Show resolved Hide resolved

jakule and others added 5 commits March 4, 2022 18:24

Add MariaDB AWS auto discovery

17f50fb

Add MariaDB AWS IAM version check

bd54ae5

Add MariaDB to RDS docs.

01bdefe

Apply suggestions from code review

c0faaf7

Co-authored-by: Paul Gottschling <[email protected]> Co-authored-by: Alan Parra <[email protected]>

Address code review comments.

426202d

jakule force-pushed the jakule/mariadb-rds-discovery branch from 80bdfa7 to 426202d Compare March 4, 2022 23:26

jakule requested review from ptgott, greedy52 and r0mant March 4, 2022 23:27

greedy52 approved these changes Mar 7, 2022

View reviewed changes

ptgott reviewed Mar 7, 2022

View reviewed changes

Address code review comments.

48facd5

jakule requested a review from ptgott March 8, 2022 03:30

Fix linter issue.

8a39782

ptgott approved these changes Mar 8, 2022

View reviewed changes

r0mant approved these changes Mar 9, 2022

View reviewed changes

docs/pages/database-access/guides/rds.mdx Outdated Show resolved Hide resolved

jakule and others added 2 commits March 9, 2022 11:09

Update docs/pages/database-access/guides/rds.mdx

9f40a3d

Co-authored-by: Roman Tkachenko <[email protected]>

Merge branch 'master' into jakule/mariadb-rds-discovery

6b4f7b3

jakule enabled auto-merge (squash) March 9, 2022 16:13

jakule merged commit 6eebe8d into master Mar 9, 2022

jakule deleted the jakule/mariadb-rds-discovery branch March 9, 2022 16:32

jakule mentioned this pull request Mar 9, 2022

[v9] Add MariaDB to AWS RDS auto discovery #10994

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MariaDB to AWS RDS auto discovery #10333

Add MariaDB to AWS RDS auto discovery #10333

jakule commented Feb 13, 2022 •

edited

Loading

ptgott Mar 3, 2022

jakule Mar 4, 2022

r0mant Mar 3, 2022

jakule Mar 4, 2022

r0mant Mar 3, 2022

r0mant Mar 3, 2022

jakule Mar 4, 2022

jakule commented Mar 4, 2022

greedy52 commented Mar 7, 2022 •

edited

Loading

ptgott Mar 7, 2022

jakule Mar 8, 2022

Add MariaDB to AWS RDS auto discovery #10333

Add MariaDB to AWS RDS auto discovery #10333

Conversation

jakule commented Feb 13, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakule commented Mar 4, 2022

greedy52 commented Mar 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jakule commented Feb 13, 2022 •

edited

Loading

greedy52 commented Mar 7, 2022 •

edited

Loading