Skip to content

Commit 2b19990

Browse files
doc(grpc): secure channels feature (#672)
* doc(grpc): secure channels * Update accept.txt --------- Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
1 parent a62e544 commit 2b19990

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

doc/source/how-to/grpc-api-packages.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,23 @@ underlying implementations.
276276
For each client library release, only a single gRPC API version should be wrapped
277277
to maintain a consistent API abstraction expectation for the supporting server instances.
278278

279+
Securing connections
280+
~~~~~~~~~~~~~~~~~~~~
281+
282+
It is possible to secure connections between the Python client library and the
283+
product servers.
284+
285+
For developers, use the `cyberchannel`_ module provided in the
286+
`ansys-tools-common`_ to implement secure connections. This ensures compliance
287+
with the latest security standards defined by PyAnsys.
288+
289+
For users, refer to the `certificates`_ section for creating and managing
290+
all necessary certificates for secure connections.
291+
292+
.. _cyberchannel: https://tools.docs.pyansys.com/version/stable/user_guide/secure_grpc.html#the-cyberchannel-module
293+
.. _ansys-tools-common: https://tools.docs.pyansys.com
294+
.. _certificates: https://tools.docs.pyansys.com/version/0.3/user_guide/secure_grpc.html#generating-certificates-for-mtls
295+
279296
Public versus private Python API package
280297
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
281298

doc/styles/config/vocabularies/ANSYS/accept.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Codespell
1717
[Cc]omponentization
1818
[Cc]omponentizing
1919
composability
20+
cyberchannel
2021
cybersecurity
2122
dataframes
2223
datagrams
@@ -134,4 +135,4 @@ Sphinx-Gallery
134135
snyk
135136
README
136137
CSV
137-
zizmor
138+
zizmor

0 commit comments

Comments
 (0)