You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/02/26 01:57:17 UTC

[GitHub] [pulsar] Jennifer88huang commented on a change in pull request #9707: [Doc] Add descriptions of end-to-end encryption for Python client

Jennifer88huang commented on a change in pull request #9707:
URL: https://github.com/apache/pulsar/pull/9707#discussion_r583331134



##########
File path: site2/docs/client-libraries-python.md
##########
@@ -288,3 +288,103 @@ class Example(Record):
     a = String()
     sub = MySubRecord()
 ```
+
+## End-to-end encryption
+
+[End-to-end encryption](https://pulsar.apache.org/docs/en/next/cookbooks-encryption/#docsNav) allows applications to encrypt messages at producers and decrypt at consumers.
+
+### Configuration
+
+If you want to use the end-to-end encryption feature in the Python client, you need to configure `publicKeyPath` and `privateKeyPath` for both producer and consumer.
+
+```
+publicKeyPath: "./public.pem"
+privateKeyPath: "./private.pem"
+```
+
+### Tutorial
+
+This section provides step-by-step instructions on how to use the end-to-end encryption feature in the Python client.
+
+#### Prerequisite

Review comment:
       Heading is used to make the structure clear, in this case, I don't think we need a heading 4 for the prerequisite. I suggest that we use a "bold font" for prerequisite or a sentence for explain it.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org