Rename READMEs with .md extension, and fix links to them.

Commit edba2e97 renamed pageserver/README to pageserver/README.md, but
forgot to update links to it. Fix.

Rename libs/postgres_ffi/README and safekeeper/README files to also
have the the .md extension, so that github can render them nicely.

Quote ascii-diagram in safekeeper/README.md so that it renders
correctly.
This commit is contained in:
chaitanya sharma
2022-04-29 14:22:46 +03:00
committed by Heikki Linnakangas
parent 2911eb084a
commit 76388abeb6
4 changed files with 9 additions and 7 deletions

View File

@@ -7,8 +7,8 @@
- [glossary.md](glossary.md) — Glossary of all the terms used in codebase. - [glossary.md](glossary.md) — Glossary of all the terms used in codebase.
- [multitenancy.md](multitenancy.md) — how multitenancy is organized in the pageserver and Zenith CLI. - [multitenancy.md](multitenancy.md) — how multitenancy is organized in the pageserver and Zenith CLI.
- [sourcetree.md](sourcetree.md) — Overview of the source tree layeout. - [sourcetree.md](sourcetree.md) — Overview of the source tree layeout.
- [pageserver/README](/pageserver/README) — pageserver overview. - [pageserver/README.md](/pageserver/README.md) — pageserver overview.
- [postgres_ffi/README](/libs/postgres_ffi/README) — Postgres FFI overview. - [postgres_ffi/README.md](/libs/postgres_ffi/README.md) — Postgres FFI overview.
- [test_runner/README.md](/test_runner/README.md) — tests infrastructure overview. - [test_runner/README.md](/test_runner/README.md) — tests infrastructure overview.
- [safekeeper/README](/safekeeper/README) — WAL service overview. - [safekeeper/README.md](/safekeeper/README.md) — WAL service overview.
- [core_changes.md](core_changes.md) - Description of Zenith changes in Postgres core - [core_changes.md](core_changes.md) - Description of Zenith changes in Postgres core

View File

@@ -28,7 +28,7 @@ The pageserver has a few different duties:
- Receive WAL from the WAL service and decode it. - Receive WAL from the WAL service and decode it.
- Replay WAL that's applicable to the chunks that the Page Server maintains - Replay WAL that's applicable to the chunks that the Page Server maintains
For more detailed info, see `/pageserver/README` For more detailed info, see [/pageserver/README](/pageserver/README.md)
`/proxy`: `/proxy`:
@@ -57,7 +57,7 @@ PostgreSQL extension that contains functions needed for testing and debugging.
The zenith WAL service that receives WAL from a primary compute nodes and streams it to the pageserver. The zenith WAL service that receives WAL from a primary compute nodes and streams it to the pageserver.
It acts as a holding area and redistribution center for recently generated WAL. It acts as a holding area and redistribution center for recently generated WAL.
For more detailed info, see `/safekeeper/README` For more detailed info, see [/safekeeper/README](/safekeeper/README.md)
`/workspace_hack`: `/workspace_hack`:
The workspace_hack crate exists only to pin down some dependencies. The workspace_hack crate exists only to pin down some dependencies.

View File

@@ -7,6 +7,7 @@ replica. A replication slot is used in the primary to prevent the
primary from discarding WAL that hasn't been streamed to the WAL primary from discarding WAL that hasn't been streamed to the WAL
service yet. service yet.
```
+--------------+ +------------------+ +--------------+ +------------------+
| | WAL | | | | WAL | |
| Compute node | ----------> | WAL Service | | Compute node | ----------> | WAL Service |
@@ -23,7 +24,7 @@ service yet.
| Pageservers | | Pageservers |
| | | |
+--------------+ +--------------+
```
The WAL service consists of multiple WAL safekeepers that all store a The WAL service consists of multiple WAL safekeepers that all store a
@@ -31,6 +32,7 @@ copy of the WAL. A WAL record is considered durable when the majority
of safekeepers have received and stored the WAL to local disk. A of safekeepers have received and stored the WAL to local disk. A
consensus algorithm based on Paxos is used to manage the quorum. consensus algorithm based on Paxos is used to manage the quorum.
```
+-------------------------------------------+ +-------------------------------------------+
| WAL Service | | WAL Service |
| | | |
@@ -48,7 +50,7 @@ consensus algorithm based on Paxos is used to manage the quorum.
| +------------+ | | +------------+ |
| | | |
+-------------------------------------------+ +-------------------------------------------+
```
The primary connects to the WAL safekeepers, so it works in a "push" The primary connects to the WAL safekeepers, so it works in a "push"
fashion. That's different from how streaming replication usually fashion. That's different from how streaming replication usually