Skip to content

docs: add AWS cross-account db access guide#25687

Merged
GavinFrazar merged 1 commit intomasterfrom
gavinfrazar/cross-account-aws-guide
May 17, 2023
Merged

docs: add AWS cross-account db access guide#25687
GavinFrazar merged 1 commit intomasterfrom
gavinfrazar/cross-account-aws-guide

Conversation

@GavinFrazar
Copy link
Copy Markdown
Contributor

Closes #21872

This is a docs only PR - it adds a guide for configuring a database agent to do discovery/access of AWS databases using assume_role_arn and optionally external_id to make the database agent assume that role arn before discovering/proxying the databases.

@GavinFrazar GavinFrazar added documentation aws Used for AWS Related Issues. database-access Database access related issues and PRs labels May 5, 2023
@github-actions github-actions Bot requested review from r0mant, xinding33 and zmb3 May 5, 2023 10:12
Comment thread docs/pages/database-access/guides/aws-cross-account.mdx Outdated
Comment thread docs/pages/database-access/guides/aws-cross-account.mdx Outdated
Comment thread docs/pages/database-access/guides/aws-cross-account.mdx Outdated
Comment thread docs/pages/database-access/guides/aws-cross-account.mdx
Comment thread docs/pages/includes/database-access/aws-bootstrap.mdx Outdated
Comment thread docs/pages/database-access/guides/aws-cross-account.mdx
@GavinFrazar
Copy link
Copy Markdown
Contributor Author

@ptgott @alexfornuto please take a look when you can, this guide is for a v13 release feature. sorry it's last minute! I was considering not even doing a guide, since I already updated the config file reference, hence I pushed this last minute. It's not super critical that the guide be available immediately with v13 release, but the sooner the better. Thanks!

@smallinsky smallinsky changed the title add AWS cross-account db access guide docs: add AWS cross-account db access guide May 11, 2023
@ptgott ptgott self-assigned this May 11, 2023
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we should expand the introduction a bit to add context and give the reader some idea of what the scope of enabling cross-account database access looks like.

In a couple of sentences, what are the major actions a Teleport operator would need to take to enable cross-account database access?

Also, I think the architecture of cross-account database access can be more explicit in the introduction. Is the Database Service using AWS IAM credentials for the target AWS account to enable access from Teleport users to a database in the target account? I.e., would the Database Service be managing multiple sets of AWS credentials?

I think a diagram would be really useful.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

expanded intro here: b5a2b4b

I've been struggling to make a diagram with mermaid, but I will try to add a lucid chart one instead. Conceptually, this is what it looks like (ignore the lack of good style/color please):
image

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like the extra detail, thanks! The diagram also makes sense to me. Eventually, I'd like to add some kind of standard stylesheet for Mermaid diagrams so authors don't need to worry about styling, but in the meantime, either Mermaid or LucidChart is fine.

Let me know if you'd like to make the diagram part of this PR or a separate one. I personally think the diagram above is clear and helpful (I'm ignoring all Mermaid style issues for now since I'm hoping we can get automated styling out at some point).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hmm, let's do a separate PR for the diagram

Comment thread docs/pages/database-access/guides/aws-cross-account.mdx Outdated
Comment thread docs/pages/database-access/guides/aws-cross-account.mdx Outdated
Comment thread docs/pages/database-access/guides/aws-cross-account.mdx Outdated
Comment thread docs/pages/database-access/guides/aws-cross-account.mdx Outdated
@GavinFrazar GavinFrazar force-pushed the gavinfrazar/cross-account-aws-guide branch from e345007 to 8e89fee Compare May 17, 2023 17:29
@GavinFrazar GavinFrazar enabled auto-merge May 17, 2023 17:29
@GavinFrazar GavinFrazar added this pull request to the merge queue May 17, 2023
Merged via the queue into master with commit 74569fc May 17, 2023
@GavinFrazar GavinFrazar deleted the gavinfrazar/cross-account-aws-guide branch May 17, 2023 17:50
@public-teleport-github-review-bot
Copy link
Copy Markdown

@GavinFrazar See the table below for backport results.

Branch Result
branch/v13 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

aws Used for AWS Related Issues. database-access Database access related issues and PRs documentation size/md

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Database Access multi AWS Accounts Support

3 participants