-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[WIP][docs] Documentation for logical replication with PG connector #23065
Conversation
✅ Deploy Preview for infallible-bardeen-164bc9 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I only reviewed the first few sections. It would be great if @ymahajan, @suranjan, and @asrinivasanyb can do a full review of the docs before we push the docs out.
docs/content/preview/explore/change-data-capture/debezium-connector-postgresql.md
Outdated
Show resolved
Hide resolved
docs/content/preview/explore/change-data-capture/debezium-connector-postgresql.md
Outdated
Show resolved
Hide resolved
docs/content/preview/explore/change-data-capture/debezium-connector-postgresql.md
Outdated
Show resolved
Hide resolved
docs/content/preview/explore/change-data-capture/debezium-connector-postgresql.md
Outdated
Show resolved
Hide resolved
docs/content/preview/explore/change-data-capture/debezium-connector-postgresql.md
Outdated
Show resolved
Hide resolved
|
||
## Guarantees | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs some intro text? Guanranteed by whom, for what?
This section looks like it belongs in the intro
|
||
## Highlights | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, highlights of what? This section looks like it belongs in the intro at the top.
CDC in YugabyteDB being based on the PostgreSQL Logical Replication model means: | ||
|
||
1. CDC user persona will be a 'PG Replication client'. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does this mean? Why is it secure?
docs/content/preview/explore/change-data-capture/using-logical-replication/_index.md
Outdated
Show resolved
Hide resolved
|
||
### Resilience | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need intro - what is it about YBDB replication that makes it resilient
--- | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some context would be useful.
To know more about how to monitor your CDC setup, see [Monitor](./monitor). | ||
{{</lead>}} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to be consistent, need sections to link to other topics - connector, best practices, advanced etc
## Overview | ||
|
||
YugabyteDB CDC captures changes made to data in the database and streams those changes to external processes, applications, or other databases. CDC allows you to track and propagate changes in a YugabyteDB database to downstream consumers based on its Write-Ahead Log (WAL). YugabyteDB CDC captures row-level changes resulting from INSERT, UPDATE, and DELETE operations in the configured database and publishes it further to be consumed by downstream applications. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Text isn't really about CDC logical replication
docs/content/preview/explore/change-data-capture/using-logical-replication/_index.md
Outdated
Show resolved
Hide resolved
docs/content/preview/explore/change-data-capture/using-logical-replication/_index.md
Outdated
Show resolved
Hide resolved
...tent/preview/explore/change-data-capture/using-logical-replication/advanced-configuration.md
Show resolved
Hide resolved
docs/content/preview/explore/change-data-capture/using-logical-replication/advanced-topic.md
Outdated
Show resolved
Hide resolved
docs/content/preview/explore/change-data-capture/using-logical-replication/best-practices.md
Show resolved
Hide resolved
...tent/preview/explore/change-data-capture/using-logical-replication/advanced-configuration.md
Show resolved
Hide resolved
...ent/preview/explore/change-data-capture/using-yugabytedb-grpc-replication/cdc-get-started.md
Show resolved
Hide resolved
...plore/change-data-capture/using-yugabytedb-grpc-replication/debezium-connector-yugabytedb.md
Outdated
Show resolved
Hide resolved
Summary: 944bd87 [#23308] DocDB: Do not show InvalidFlags in flags UI 3c5c40a [DOC-328] [2024.1.1] Change data capture (CDC) Observability in YugabyteDB Anywhere (#22733) eb39516 [DOC-397] [2024.1.1] Create provider validation (#23039) e948dee [#DOC-348] Documentation for Migration Assessment in yugabyted UI. (#23288) 80835a8 [#23230] [DB Clone][YSQL]: Fix Cloning to a time before drop table in case of colocated databases 57e930e [docs] 404 fixes for July 5-19 (#23277) e166cee [PLAT-13956]: Fix RBAC test failure 7e10e9f [WIP][docs] Documentation for logical replication with PG connector (#23065) 86c4e4c [doc][2024.1.1] yb shell client download (#23170) a03ccda [#23045] DocDB: Support for table locks using tserver local object lock manager 836345c [doc][yba][2024.1.1] Kubernetes Prometheus (#23097) c842e1d [PLAT-14750]: Add runtime config to show the Premium V2 Storage type in case of Azure during Create/Edit scenario b0392f3 [PLAT-14734]: Highlight Decommission node status to indicate node is in bad or unhealthy state 307e2fc Fix the UT pipeline for local provider e0ff600 [PLAT-14696] DDL atomicity check metric and alert1 f229cc6 [PLAT-14739]: Make xCluster sync lock per config uuid Test Plan: Jenkins: rebase: pg15-cherrypicks Reviewers: jason, tfoucher Tags: #jenkins-ready Differential Revision: https://phorge.dev.yugabyte.com/D36955
DOC-349