-
Notifications
You must be signed in to change notification settings - Fork 19
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
Docs #78
Conversation
Performance test results: |
documentation/docs/index.md
Outdated
In the MVP version of `pg_tde`, the following remains unencrypted: | ||
|
||
* Indexes | ||
* Logical replication |
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.
Logical replication just doesn't work.
Logical replication uses WAL. As WAL is encrypted, logical replication routines are unable to de/en_crypt it properly to communicate data. This is something to be done after the MVP.
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.
@nastena1606 could you add this is a "limitations" section or something similar?
|
||
```sh | ||
sudo systemctl restart postgresql-16 | ||
``` |
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.
At this point, the keyring configuration can be deleted too, and if keyring file is used, the datafile too.
Added flow diagram Added contributing doc
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.
LGTM
|
||
Before submitting code contributions, we ask you to complete the following prerequisites. | ||
|
||
### 1. Sign the CLA |
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.
We don't have CLA assistant set up for the tde ext. @capri1989 Do we want to?
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.
Yes we want to have one and comply with all other projects that we're having.
documentation/docs/index.md
Outdated
In the MVP version of `pg_tde`, the following remains unencrypted: | ||
|
||
* Indexes | ||
* Logical replication |
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.
@nastena1606 could you add this is a "limitations" section or something similar?
documentation/docs/install.md
Outdated
|
||
=== "Package manager" | ||
|
||
Currently only DEB packages are available. If you are running RPM-based operating system, consider [building the extension from source](#build-from-source) or [running it in Docker](#run-in-docker) |
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.
Deb packages are built for ubuntu 22.04, other distributions / versions might or might not work.
@@ -0,0 +1,165 @@ | |||
# Contributing guide |
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.
Should we add a link to the Make Build developers docs: https://github.com/Percona-Lab/postgres-tde-ext/wiki/Make-builds-for-developers somewhere? Or just mention the WIKI in general as it expected to get more pages in future.
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.
Plus we'd probably want to mention that the project should follow Postgres' coding conventions (https://www.postgresql.org/docs/current/source.html). Although we don't follow them on our own. But have such intention)
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.
Added. A question about tests - do we have them? Where to point contributors to?
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.
We do have tests. To run them:
./configure
make USE_PGXS=1 installcheck
modified: documentation/docs/contribute.md
No description provided.