Skip to content

[docs] update self-hosted db guides#37606

Merged
GavinFrazar merged 13 commits intomasterfrom
gavinfrazar/update-db-docs
Feb 8, 2024
Merged

[docs] update self-hosted db guides#37606
GavinFrazar merged 13 commits intomasterfrom
gavinfrazar/update-db-docs

Conversation

@GavinFrazar
Copy link
Copy Markdown
Contributor

@GavinFrazar GavinFrazar commented Jan 31, 2024

This docs PR updates redis cluster, cockroachdb, and mongodb self-hosted guides.

The commits are well ordered and it's probably best to review commit by commit to understand what motivated each change set.

For Redis cluster, it was brought up during the testplan that the setup steps in the tls-cluster no tab didn't work with the rest of the guide for creating the Redis cluster. I added that section in #36260 - it sets redis cluster up such that Teleport's db CA is used to issues a cert for each node, yet still requires a custom CA to init the cluster + several additional steps. It's much simpler to just use the custom CA for each node's certs and only add trust for Teleport's db_client CA - if they want to use tls-cluster no they don't even need to change anything from the tls-cluster yes TLS setup.

For CockroachDB, I explained how to trust the Teleport db_client CA without changing the node.crt served by each node. Customers have asked about how they can do this and a few days ago it came up again. It's the default tab for that step because it's easier and simpler.
I also went into more detail about using cockroach cert.

For Mongo, I made some small improvements to indentation and only explain tctl auth sign setup for the config step that actually uses tctl auth sign.

@GavinFrazar GavinFrazar added documentation database-access Database access related issues and PRs db/mongo MongoDB related database access issues db/redis backport/branch/v13 no-changelog Indicates that a PR does not require a changelog entry labels Jan 31, 2024
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-om39gnqfv-goteleport.vercel.app/docs/ver/preview

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.

Thanks a lot for updating these!

Comment thread docs/pages/database-access/guides/cockroachdb-self-hosted.mdx Outdated
Comment thread docs/pages/database-access/guides/redis-cluster.mdx Outdated
Comment thread docs/pages/database-access/guides/redis-cluster.mdx Outdated
Comment thread docs/pages/database-access/guides/redis-cluster.mdx Outdated
Comment thread docs/pages/includes/database-access/custom-db-ca.mdx
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-cqncxgc26-goteleport.vercel.app/docs/ver/preview

@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-j9umw1arf-goteleport.vercel.app/docs/ver/preview

@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-nuk76lnza-goteleport.vercel.app/docs/ver/preview

@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-iw4fb28mg-goteleport.vercel.app/docs/ver/preview

@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-rd6gfze8j-goteleport.vercel.app/docs/ver/preview

Comment thread docs/pages/includes/database-access/split-db-ca-details.mdx Outdated
Comment thread docs/pages/includes/database-access/split-db-ca-details.mdx Outdated
Comment thread docs/pages/database-access/guides/cockroachdb-self-hosted.mdx Outdated
Comment thread docs/pages/database-access/guides/cockroachdb-self-hosted.mdx Outdated
Comment thread docs/pages/database-access/guides/cockroachdb-self-hosted.mdx Outdated
Comment thread docs/pages/database-access/guides/cockroachdb-self-hosted.mdx Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 7, 2024

🤖 Vercel preview here: https://docs-aiqzujumj-goteleport.vercel.app/docs/ver/preview

@GavinFrazar GavinFrazar force-pushed the gavinfrazar/update-db-docs branch from 28d58c6 to d8825fe Compare February 8, 2024 00:22
@GavinFrazar GavinFrazar added this pull request to the merge queue Feb 8, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 8, 2024

🤖 Vercel preview here: https://docs-ckh1241u3-goteleport.vercel.app/docs/ver/preview

Merged via the queue into master with commit e95f884 Feb 8, 2024
@GavinFrazar GavinFrazar deleted the gavinfrazar/update-db-docs branch February 8, 2024 00:39
@public-teleport-github-review-bot
Copy link
Copy Markdown

@GavinFrazar See the table below for backport results.

Branch Result
branch/v13 Failed
branch/v14 Failed
branch/v15 Create PR

GavinFrazar added a commit that referenced this pull request Feb 21, 2024
github-merge-queue Bot pushed a commit that referenced this pull request Feb 23, 2024
github-merge-queue Bot pushed a commit that referenced this pull request Feb 24, 2024
* backport #37606 to branch/v14.

* backport #38137 to branch/v14
GavinFrazar added a commit that referenced this pull request Feb 25, 2024
github-merge-queue Bot pushed a commit that referenced this pull request Feb 26, 2024
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/mongo MongoDB related database access issues db/redis documentation no-changelog Indicates that a PR does not require a changelog entry size/sm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants