docs: refresh CONTROLLER_REGISTRY example in PRD after #896 - #937
Merged
oboehmer merged 1 commit intoSep 3, 2026
Merged
Conversation
The CONTROLLER_REGISTRY example in the architecture document still showed the pre-refactor API that PR netascode#896 replaced: - `CredentialSet(env_vars=[...])` positional tuple, replaced by the `fields={kind: ENV_VAR}` mapping - `auth_method="token"` string, replaced by the AuthMethod enum - `insecure_env_var` missing entirely, added by netascode#896 to back should_verify_ssl() - the IOS-XE credential sets omitted the device username/password that the real registry entry has always carried - `list` literals where ControllerConfig.credential_sets is a tuple Updated the SDWAN and IOS-XE entries to match nac_test/core/controller.py. Documentation only. AI-Generated: yes AI-Tool: claude-code AI-Model: claude-opus-5 AI-Percent: 66 AI-Reason: documentation correction
3 tasks
oboehmer
approved these changes
Sep 3, 2026
oboehmer
left a comment
Collaborator
There was a problem hiding this comment.
Thanks! We should really drop code examples from this doc ;-)
2 tasks
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.
Summary
Refreshes the
CONTROLLER_REGISTRYexample indev-docs/PRD_AND_ARCHITECTURE.mdso it matches the API that #896 shipped. Documentation only — no code paths touched.Split out of #936, where it was originally bundled with an unrelated env var correction.
Problem
The example still documents the pre-refactor API:
CredentialSet(env_vars=[...])positional tuplefields={kind: ENV_VAR}mappingauth_method="token"stringAuthMethod.TOKENenum memberinsecure_env_varabsentshould_verify_ssl()credential_sets=[...]listControllerConfig.credential_setsis atupleAnyone following the example to add a controller would write code that fails to construct.
Changes
Updated the SDWAN and IOS-XE entries in that code block to match
nac_test/core/controller.pyonmain, and carried over the comment explaining thatIOSXE_URLandIOSXE_HOSTboth map tokind="url"because the former is being phased out.Not included
I did not add an NXOS entry to the example. The block already ends with
# CC, MERAKI, FMC, ISE follow the same pattern...and has never enumerated every controller, so adding NXOS would gain little while making this PR depend on #895 merging first. Keeping it out leaves this as pure mechanical cleanup that can merge in any order.Test plan
nac_test/core/controller.pyonmainControllerConfigandCredentialSetdataclass definitionsRelated
🤖 AI Generation Metadata