Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that crdb can be used a a pg replacement for events #44704

Merged
merged 5 commits into from
Aug 5, 2024

Conversation

hugoShaka
Copy link
Contributor

@hugoShaka hugoShaka commented Jul 26, 2024

Backend doc reference update to mention that crdb can be used for audit.

Copy link

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

docs/pages/reference/backends.mdx Outdated Show resolved Hide resolved
@@ -13,7 +13,7 @@ read/write ratio, mutability, etc.).
| Data type | Description | Supported storage backends |
| - | - | - |
| core cluster state | Cluster configuration (e.g. users, roles, auth connectors) and identity (e.g. certificate authorities, registered nodes, trusted clusters). | Local directory (SQLite), etcd, PostgreSQL, Amazon DynamoDB, GCP Firestore, CockroachDB |
| audit events | JSON-encoded events from the audit log (e.g. user logins, RBAC changes) | Local directory, PostgreSQL, AWS DynamoDB, GCP Firestore |
| audit events | JSON-encoded events from the audit log (e.g. user logins, RBAC changes) | Local directory, PostgreSQL/CockroachDB, AWS DynamoDB, GCP Firestore |
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know that we should be equating the Postgres and CockroachDB backend like this.

Suggested change
| audit events | JSON-encoded events from the audit log (e.g. user logins, RBAC changes) | Local directory, PostgreSQL/CockroachDB, AWS DynamoDB, GCP Firestore |
| audit events | JSON-encoded events from the audit log (e.g. user logins, RBAC changes) | Local directory, PostgreSQL, CockroachDB, AWS DynamoDB, GCP Firestore |

Copy link
Contributor Author

@hugoShaka hugoShaka Jul 29, 2024

Choose a reason for hiding this comment

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

For audit events, we use the same backend for pg and crdb. For cluster state we use separate backends.

Copy link
Contributor

Choose a reason for hiding this comment

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

That seems more like an internal implementation detail than something that should be conveyed in our documentation though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure because in one case, the user needs enterprise + explicitly specify the cockroachDB backend. In the other, they configure a postgres audit backend that happens to be backed by crdb but it's transparent.

docs/pages/reference/backends.mdx Outdated Show resolved Hide resolved
Copy link

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

docs/pages/reference/backends.mdx Outdated Show resolved Hide resolved
docs/pages/reference/backends.mdx Outdated Show resolved Hide resolved
Copy link

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

docs/pages/reference/backends.mdx Show resolved Hide resolved
@@ -13,7 +13,7 @@ read/write ratio, mutability, etc.).
| Data type | Description | Supported storage backends |
| - | - | - |
| core cluster state | Cluster configuration (e.g. users, roles, auth connectors) and identity (e.g. certificate authorities, registered nodes, trusted clusters). | Local directory (SQLite), etcd, PostgreSQL, Amazon DynamoDB, GCP Firestore, CockroachDB |
| audit events | JSON-encoded events from the audit log (e.g. user logins, RBAC changes) | Local directory, PostgreSQL, AWS DynamoDB, GCP Firestore |
| audit events | JSON-encoded events from the audit log (e.g. user logins, RBAC changes) | Local directory, PostgreSQL/CockroachDB, AWS DynamoDB, GCP Firestore |
Copy link
Contributor

Choose a reason for hiding this comment

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

That seems more like an internal implementation detail than something that should be conveyed in our documentation though.

Copy link

github-actions bot commented Aug 2, 2024

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

docs/pages/reference/backends.mdx Outdated Show resolved Hide resolved
@public-teleport-github-review-bot public-teleport-github-review-bot bot removed the request for review from xinding33 August 5, 2024 13:34
Copy link

github-actions bot commented Aug 5, 2024

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

@hugoShaka hugoShaka added this pull request to the merge queue Aug 5, 2024
Merged via the queue into master with commit a2d87db Aug 5, 2024
36 checks passed
@hugoShaka hugoShaka deleted the hugo/mention-crdb-audit-event branch August 5, 2024 14:53
@public-teleport-github-review-bot

@hugoShaka See the table below for backport results.

Branch Result
branch/v15 Failed
branch/v16 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants