Skip to content

Add documentation for creating nitlsconfig gRPC channels - #2210

Open
alexdubois-ni wants to merge 1 commit into
ni:masterfrom
alexdubois-ni:users/adubois/createGRPCNITLSConfigPythonDocs
Open

Add documentation for creating nitlsconfig gRPC channels#2210
alexdubois-ni wants to merge 1 commit into
ni:masterfrom
alexdubois-ni:users/adubois/createGRPCNITLSConfigPythonDocs

Conversation

@alexdubois-ni

Copy link
Copy Markdown
Contributor

This change is just documentation.

  • I've added tests applicable for this pull request

Purely documentation. No tests required.

What does this Pull Request accomplish?

Add public-facing documentation for how to use our new Python nitlsconfig package to create mTLS encrypted gRPC channels.

Add initial documentation as well for creating gRPC channels as well, including how to even install gRPC. Ensure we link to and add tidbits for how to get this setup even working in the first place since it has a fair bit of nuance.

List issues fixed by this Pull Request below, if any.

N/A

What testing has been done?

Checked the produced documentation:

image

@alexdubois-ni
alexdubois-ni marked this pull request as ready for review August 27, 2026 20:49
@codecov-commenter

codecov-commenter commented Aug 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.34%. Comparing base (37a3bd1) to head (f2d0983).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2210      +/-   ##
==========================================
- Coverage   88.09%   87.34%   -0.75%     
==========================================
  Files          88       86       -2     
  Lines       22756    22461     -295     
==========================================
- Hits        20047    19619     -428     
- Misses       2709     2842     +133     
Flag Coverage Δ
codegenunittests 84.90% <ø> (ø)
nidcpowersystemtests 94.34% <ø> (ø)
nidcpowerunittests 89.53% <ø> (ø)
nidigitalsystemtests 92.02% <ø> (ø)
nidigitalunittests 68.44% <ø> (ø)
nidmmsystemtests 92.29% <ø> (ø)
nifakeunittests 86.01% <ø> (ø)
nifgensystemtests 94.32% <ø> (ø)
nimodinstsystemtests 73.85% <ø> (ø)
nimodinstunittests 94.20% <ø> (ø)
nirfsasystemtests 73.09% <ø> (-9.58%) ⬇️
nirfsaunittests 63.55% <ø> (ø)
nirfsgsystemtests 81.12% <ø> (ø)
niscopesystemtests 89.96% <ø> (ø)
niscopeunittests 43.20% <ø> (ø)
nisesystemtests 91.50% <ø> (ø)
niswitchsystemtests 81.56% <ø> (ø)
nitclksystemtests ?
nitclkunittests 98.26% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants