Architecture/Technical documentation available for users

Description

When going live we need to have available and easy to find documentation addressing the needs of a technical persona who wants to understand how does the solution work. Example user stories are as follows:

  • As a DBA who is considering using pg_tde I want to understand how it works so that I am more confident about the security of the presented solution.

  • As a PostgreSQL Community contributor I want to understand how does the solution work without having to go over the code so that I see whether I want to spend time reviewing the patches related to this work

  • As a researcher I want to understand the details of the solution so that I can write meaningful information about it in any reviews or comparisons and not make mistakes

  • As Percona Sales Engineer I want to make sure I know all ins and outs of the solution so that do not misrepresent it to a customer

 

I’ve been looking for a more technical write up that could answer questions like:

  • what’s the key granularity and why?

  • what is not currently encrypted and what are the potential risks that go with this?

  • why extension, what limitations were there?

Also should include any write up covering:

  • impact on replication (physical, logical) and clustering (e.g. how to encrypt a whole Patroni cluster)

  • impact on backup and restores (different types)

  • encrypting existing tables

  • enforcing encryption as an admin/permissions etc.

How to document

None

How to test

None

Activity

Show:

Zsolt Parragi February 12, 2025 at 10:43 AM

Didnt we create the high level overview document for this purpose, so that we can share it to explain things?

Details

Assignee

Reporter

Labels

Components

Priority

Smart Checklist

Created February 12, 2025 at 10:41 AM
Updated 4 days ago

Flag notifications