Skip to content

docs: correct NX-OS Direct D2D credential env vars in PRD - #936

Merged
oboehmer merged 1 commit into
netascode:mainfrom
ChristopherJHart:docs/prd-nxos-env-vars
Sep 3, 2026
Merged

docs: correct NX-OS Direct D2D credential env vars in PRD#936
oboehmer merged 1 commit into
netascode:mainfrom
ChristopherJHart:docs/prd-nxos-env-vars

Conversation

@ChristopherJHart

@ChristopherJHart ChristopherJHart commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Summary

Corrects the NX-OS Direct row in the D2D credential environment variable table in dev-docs/PRD_AND_ARCHITECTURE.md. One line, documentation only.

Problem

The table listed NXOS_SSH_USERNAME / NXOS_SSH_PASSWORD for the NX-OS Direct architecture. Those names appear nowhere in the codebase — a repo-wide grep across .py, .yaml, and .j2 returns zero hits.

The NXOS entry added to CONTROLLER_REGISTRY in #895 uses the bare NXOS_ prefix, following the IOS-XE Direct precedent:

Architecture Username Env Var Password Env Var
IOS-XE Direct IOSXE_USERNAME IOSXE_PASSWORD
NX-OS Direct (before) NXOS_SSH_USERNAME NXOS_SSH_PASSWORD
NX-OS Direct (after) NXOS_USERNAME NXOS_PASSWORD

Deliberately left alone

The ACI and NDFC rows still show NXOS_SSH_* for leaf/spine SSH access. Those are equally unimplemented, but renaming them decides whether device credentials key off the device family or the controller context — a design question rather than a consistency fix. Happy to fold it in if reviewers would rather settle it here.

Test plan

  • Documentation-only change — no code paths touched
  • Confirmed NXOS_SSH_* has zero occurrences outside this document

Related


🤖 AI Generation Metadata

  • AI Generated: Yes
  • AI Tool: claude-code
  • AI Model: claude-opus-5
  • AI Contribution: ~100% (env var naming decision made by Christopher Hart)
  • AI Reason: documentation correction
  • Human Oversight: Reviewed by Christopher Hart

The D2D credential table listed `NXOS_SSH_USERNAME`/`NXOS_SSH_PASSWORD`
for the NX-OS Direct architecture. Those names appear nowhere in the
codebase, and the NXOS entry in CONTROLLER_REGISTRY uses the bare
`NXOS_` prefix, matching the IOS-XE Direct precedent
(`IOSXE_USERNAME`/`IOSXE_PASSWORD`).

The ACI and NDFC rows still show `NXOS_SSH_*` for leaf/spine SSH access.
Those are equally unimplemented, but renaming them is a separate design
decision about whether device credentials key off the device family or
the controller context, so they are left as-is here.

AI-Generated: yes
AI-Tool: claude-code
AI-Model: claude-opus-5
AI-Percent: 50
AI-Reason: documentation correction
@ChristopherJHart ChristopherJHart changed the title docs: correct controller registry example and NX-OS env vars in PRD docs: correct NX-OS Direct D2D credential env vars in PRD Sep 3, 2026
@oboehmer
oboehmer merged commit 45f7e45 into netascode:main Sep 3, 2026
13 checks passed
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