-
Notifications
You must be signed in to change notification settings - Fork 38
Closed as duplicate of#230
Labels
documentationUser guides, tutorials, specificationsUser guides, tutorials, specifications
Description
Summary
With the upcoming 1.0.0 release, it is important that we clearly and instructively update our documentation to reference company-wide documentation with information about what TLS is and how TLS is set up in Exasol and in our UDFs. As part of this effort, the encryption.rst will be renamed to security.rst.
Documentation to link:
- (a) An introduction to TLS
- (b) TLS with Exasol
- (c) TLS in UDFs
Proposals from @tkilias : See IntRef
Use cases to cover:
- As an external client with CA certification pre-installed -> known CA or Admin
- External client but with non-privileged access
- Experimental works - tests
- Connection from in UDF to another Exasol
- (skip for now) Use your own CA from using an OS-specific trust store - complicated & we'd need to test our implementation first. Essentially, certifi was the default, and you can install truststore to handle.
If not using an OS-specific trust store, then we should show how to add the right arguments to the pyexasol.connect
Tasks
- Rename
encryption.rsttosecurity.rst - In (c), add article about CA certs for UDFs for Python, similar to the Java one.
- Re-order
security.rstto be in a clearer format, reference the Documentation (a-c) and their relevant parts with the use cases clearly highlighted so users just follow the subsection relevant to them. - (opt) In later PR, update the docstrings to point to the URL in the published documentation.
Metadata
Metadata
Assignees
Labels
documentationUser guides, tutorials, specificationsUser guides, tutorials, specifications