docs: cockroachdb storage backend configuration #37880
Conversation
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-95kreh57y-goteleport.vercel.app/docs/ver/preview |
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
1 similar comment
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-c4v7480hw-goteleport.vercel.app/docs/ver/preview |
docs/pages/reference/backends.mdx
Outdated
|
|
||
| For more details on deploying CockroachDB see [CockroachDB's deployment options](https://www.cockroachlabs.com/docs/stable/choose-a-deployment-option). | ||
|
|
||
| For more details on configuring multi-region survival goals in CockroachDB see |
There was a problem hiding this comment.
"For more details" suggests that there are at least some details here, but I don't see anything about configuring multi-region survival goals.
I would rephrase this. Perhaps something along the lines of this:
There are several ways to configure multi-region deployments of CockroachDB,
the details of which are not in scope for this guide. To learn about how to
configure multi-region survival goals, see ...
There was a problem hiding this comment.
Makes sense I updated this for both the deployment and survival goals here b42399a
Co-authored-by: Zac Bergquist <[email protected]>
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-a7qfq88sb-goteleport.vercel.app/docs/ver/preview |
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
dboslee
added
the
no-changelog
|
🤖 Vercel preview here: https://docs-68perfkob-goteleport.vercel.app/docs/ver/preview |
|
@dboslee Is this PR ready for re-review? |
yep |
|
🤖 Vercel preview here: https://docs-7002fbyz1-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-eaaiyc1x2-goteleport.vercel.app/docs/ver/preview |
|
@zmb3 could you giving this a second look when you get a chance? |
|
🤖 Vercel preview here: https://docs-76y97k63g-goteleport.vercel.app/docs/ver/preview |
| type="warning" | ||
| title="IMPORTANT" | ||
| > | ||
| CockroachDB can currently only be used to store Teleport's cluster state. |
There was a problem hiding this comment.
Starting to feel like we should have a matrix on this page that lists each backend and each use case (cluster state, audit log, session recordings, etc) to indicate which backends support which types of data.
| `storage` section of `teleport.yaml` as shown below. | ||
| - Deploy several Auth Service instances connected to the CockroachDB storage backend. | ||
| - Deploy several Proxy Service instances. | ||
| - Make sure that the Proxy Service instances and all Teleport agent services that |
There was a problem hiding this comment.
This isn't specific to CockroachDB in any way, is it?
| # parameters may be specified using the URL. For a detailed list of available | ||
| # parameters see https://www.cockroachlabs.com/docs/stable/connection-parameter | ||
| # | ||
| # If your certificates are not stored at the default ~/.postgresql |
There was a problem hiding this comment.
Should we mention that we require mTLS? (Do we?)
Co-authored-by: Zac Bergquist <[email protected]>
Co-authored-by: Zac Bergquist <[email protected]>
|
🤖 Vercel preview here: https://docs-aa2q8uwzb-goteleport.vercel.app/docs/ver/preview |
|
🤖 Vercel preview here: https://docs-dnooauwag-goteleport.vercel.app/docs/ver/preview |
* docs: cockroachdb storage backend configuration * fix missing code block end quotes * Update docs/pages/reference/backends.mdx Co-authored-by: Zac Bergquist <[email protected]> * Update crdb deploy and config references * Update docs/pages/reference/backends.mdx Co-authored-by: Paul Gottschling <[email protected]> * Update docs/pages/reference/backends.mdx Co-authored-by: Paul Gottschling <[email protected]> * Update docs/pages/reference/backends.mdx Co-authored-by: Paul Gottschling <[email protected]> * Fix auth server lint * Fix spellcheck lint * Update docs/pages/reference/backends.mdx Co-authored-by: Zac Bergquist <[email protected]> * Update docs/pages/reference/backends.mdx Co-authored-by: Zac Bergquist <[email protected]> --------- Co-authored-by: Zac Bergquist <[email protected]> Co-authored-by: Paul Gottschling <[email protected]> Co-authored-by: Alexander Klizhentas <[email protected]>
* docs: cockroachdb storage backend configuration * fix missing code block end quotes * Update docs/pages/reference/backends.mdx * Update crdb deploy and config references * Update docs/pages/reference/backends.mdx * Update docs/pages/reference/backends.mdx * Update docs/pages/reference/backends.mdx * Fix auth server lint * Fix spellcheck lint * Update docs/pages/reference/backends.mdx * Update docs/pages/reference/backends.mdx --------- Co-authored-by: David Boslee <[email protected]> Co-authored-by: Zac Bergquist <[email protected]> Co-authored-by: Paul Gottschling <[email protected]>
Adds documentation for configuring cockroachdb as a storage backend.
This is the first enterprise only backend so I'm not certain what is the best way to indicate this is enterprise only.