Add documentation for creating nitlsconfig gRPC channels - #1022
Merged
alexdubois-ni merged 11 commits intoSep 18, 2026
Merged
Conversation
…gRPC documentation
alexdubois-ni
requested review from
bkeryan,
maxxboehme and
zhindes
as code owners
September 14, 2026 15:54
alexdubois-ni
changed the title
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Installation guidance must include nitlsconfig, and certificate-exchange requirements must be qualified for TLS-enabled channels.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Adds documentation for creating NI-DAQmx gRPC channels with nitlsconfig, including mTLS setup and lifecycle guidance.
Changes:
- Documents channel creation, TLS configuration, and custom options.
- Adds a
nitlsconfigintersphinx mapping.
File summaries
| File | Summary |
|---|---|
docs/grpc_session_options.rst |
Adds nitlsconfig usage and mTLS guidance; installation and TLS wording require updates. |
docs/conf.py |
Registers nitlsconfig documentation for cross-references. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
bkeryan
requested changes
Sep 14, 2026
…ers/adubois/updateDocsForNITLSConfigIntegration
zhindes
approved these changes
Sep 14, 2026
zhindes
left a comment
zhindes
left a comment
Collaborator
There was a problem hiding this comment.
Brad's on it; I trust y'all
… sections, and created formal sections altogether.
…se nitlsconfig in the local system case
bkeryan
requested changes
Sep 17, 2026
Co-authored-by: Brad Keryan <brad.keryan@ni.com>
Co-authored-by: Brad Keryan <brad.keryan@ni.com>
Co-authored-by: Brad Keryan <brad.keryan@ni.com>
Co-authored-by: Brad Keryan <brad.keryan@ni.com>
Co-authored-by: Brad Keryan <brad.keryan@ni.com>
bkeryan
approved these changes
Sep 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
- [ ] I've updated CHANGELOG.md if applicable.- [ ] I've added tests applicable for this pull requestWhat does this Pull Request accomplish?
Provides documentation for utilizing nitlsconfig with nidaqmx-python.
Why should this Pull Request be merged?
Since we're not opting to add examples, we should at the very least provide public documentation that highlights how to use nitlsconfig to produce mTLS encrypted channels using NI TLS, and walk customers through some of the required setup.
This matches the existing documentation that was added to nimi-python. However, the language did need to change because standard NI driver APIs ONLY have a session object with gRPC options, whereas NI-DAQmx has multitudes. I produced a short summary aligned with changelog mentions to at least make it clearer here.
What testing has been done?
N/A. This is documentation only. Full integration is done in this PR and ATS tests will soon follow: #1019