Skip to content

doc(grpc): secure channels feature #672

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.

Sign up for GitHub

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

Merged
RobPasMue merged 3 commits into from
Nov 25, 2025
Merged

doc(grpc): secure channels feature #672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5485e4
doc(grpc): secure channels
jorgepiloto Nov 24, 2025
4840751
Update accept.txt
RobPasMue Nov 25, 2025
7af6da7
Merge branch 'main' into feat/grpc
RobPasMue Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions doc/source/how-to/grpc-api-packages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,23 @@ underlying implementations.
For each client library release, only a single gRPC API version should be wrapped
to maintain a consistent API abstraction expectation for the supporting server instances.

Securing connections
~~~~~~~~~~~~~~~~~~~~

It is possible to secure connections between the Python client library and the
product servers.

For developers, use the `cyberchannel`_ module provided in the
`ansys-tools-common`_ to implement secure connections. This ensures compliance
with the latest security standards defined by PyAnsys.

For users, refer to the `certificates`_ section for creating and managing
all necessary certificates for secure connections.

.. _cyberchannel: https://tools.docs.pyansys.com/version/stable/user_guide/secure_grpc.html#the-cyberchannel-module
.. _ansys-tools-common: https://tools.docs.pyansys.com
.. _certificates: https://tools.docs.pyansys.com/version/0.3/user_guide/secure_grpc.html#generating-certificates-for-mtls

Public versus private Python API package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
3 changes: 2 additions & 1 deletion doc/styles/config/vocabularies/ANSYS/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Codespell
[Cc]omponentization
[Cc]omponentizing
composability
cyberchannel
cybersecurity
dataframes
datagrams
Expand Down Expand Up @@ -134,4 +135,4 @@ Sphinx-Gallery
snyk
README
CSV
zizmor
zizmor
Loading