Skip to content

azure mysql postgres auto discovery docs#15986

Merged
GavinFrazar merged 17 commits into
masterfrom
gavinfrazar/azure_mysql_postgres_auto_discovery_docs
Sep 20, 2022
Merged

azure mysql postgres auto discovery docs#15986
GavinFrazar merged 17 commits into
masterfrom
gavinfrazar/azure_mysql_postgres_auto_discovery_docs

Conversation

@GavinFrazar
Copy link
Copy Markdown
Contributor

@GavinFrazar GavinFrazar commented Aug 30, 2022

This PR updates our Azure MySQL/Postgres docs to use database auto-discovery.

Branched off #15745 so github will retarget to master when that PR merges.

Changes:

  • use teleport db configure create command to make the db config using auto-discovery instead of static config
  • add new section for configuring permissions to enable database auto-discovery.
    • how to create a custom role definition with minimal permissions necessary
    • how to create a role assignment appropriate for the teleport db service principal
  • add screenshots for setting up Azure permissions.
  • add troubleshooting snippet
  • update teleport config yaml reference to include azure db matcher and explanation of options.

This is part of the larger issue: #14688

Next steps will be to add bootstrap configurators to remove the manual IAM setup steps, although this will require significantly more work so for now the docs will just explain how to setup Azure IAM permissions manually.

@GavinFrazar GavinFrazar added database-access Database access related issues and PRs db/postgres PostgreSQL related database access issues db/mysql MySQL related database access issues labels Aug 30, 2022
@GavinFrazar GavinFrazar marked this pull request as ready for review August 30, 2022 23:14
Base automatically changed from gavinfrazar/azure_mysql_postgres_auto_discovery_watchers to master August 30, 2022 23:42
@GavinFrazar GavinFrazar changed the title Gavinfrazar/azure mysql postgres auto discovery docs azure mysql postgres auto discovery docs Aug 31, 2022
@GavinFrazar GavinFrazar force-pushed the gavinfrazar/azure_mysql_postgres_auto_discovery_docs branch from fe61996 to a2eb122 Compare August 31, 2022 00:37
@GavinFrazar GavinFrazar force-pushed the gavinfrazar/azure_mysql_postgres_auto_discovery_docs branch from 13161aa to 81f5d60 Compare August 31, 2022 16:14
@GavinFrazar GavinFrazar force-pushed the gavinfrazar/azure_mysql_postgres_auto_discovery_docs branch 5 times, most recently from e0cebb9 to 4aec549 Compare August 31, 2022 16:46
Copy link
Copy Markdown
Contributor

@greedy52 greedy52 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably should blur or cross out real IDs (subscription ID, object ID) in the screenshot.

Comment thread docs/pages/database-access/guides/azure-postgres-mysql.mdx Outdated
Comment thread docs/pages/database-access/guides/azure-postgres-mysql.mdx Outdated
Comment thread docs/pages/database-access/guides/azure-postgres-mysql.mdx
Comment thread docs/pages/includes/database-access/azure-troubleshooting.mdx
Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Comment thread docs/pages/database-access/guides/azure-postgres-mysql.mdx Outdated
Comment thread docs/pages/database-access/guides/azure-postgres-mysql.mdx Outdated
Comment thread docs/pages/database-access/guides/azure-postgres-mysql.mdx Outdated
GavinFrazar and others added 3 commits September 19, 2022 09:46
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
Copy link
Copy Markdown
Contributor

@alexfornuto alexfornuto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tested the changes here, but the writing is 👍.

@GavinFrazar GavinFrazar enabled auto-merge (squash) September 19, 2022 17:05
@GavinFrazar GavinFrazar enabled auto-merge (squash) September 20, 2022 05:16
@GavinFrazar GavinFrazar merged commit a90334f into master Sep 20, 2022
@github-actions
Copy link
Copy Markdown
Contributor

@GavinFrazar See the table below for backport results.

Branch Result
branch/v10 Create PR

@GavinFrazar GavinFrazar deleted the gavinfrazar/azure_mysql_postgres_auto_discovery_docs branch September 20, 2022 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

database-access Database access related issues and PRs db/mysql MySQL related database access issues db/postgres PostgreSQL related database access issues documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants