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

[WIP][docs] Documentation for logical replication with PG connector #23065

Merged
merged 111 commits into from
Jul 30, 2024

Conversation

vaibhav-yb
Copy link
Contributor

@vaibhav-yb vaibhav-yb commented Jul 1, 2024

DOC-349

@vaibhav-yb vaibhav-yb added the area/documentation Documentation needed label Jul 1, 2024
@vaibhav-yb vaibhav-yb self-assigned this Jul 1, 2024
Copy link

netlify bot commented Jul 1, 2024

Deploy Preview for infallible-bardeen-164bc9 ready!

Name Link
🔨 Latest commit 0ab5c65
🔍 Latest deploy log https://app.netlify.com/sites/infallible-bardeen-164bc9/deploys/66a938370145b20008ec4b23
😎 Deploy Preview https://deploy-preview-23065--infallible-bardeen-164bc9.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@streddy-yb streddy-yb left a 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.


## Guarantees

Copy link
Contributor

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

Copy link
Contributor

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'.
Copy link
Contributor

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?


### Resilience

Copy link
Contributor

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

---

Copy link
Contributor

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>}}

Copy link
Contributor

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.
Copy link
Contributor

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

@ddhodge ddhodge merged commit 7e10e9f into yugabyte:master Jul 30, 2024
2 checks passed
jasonyb pushed a commit that referenced this pull request Aug 1, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet