Repository navigation
docs: OS-specific commands and risk callouts - #277
Merged
Merged
Conversation
10 tasks
Bugs5382
marked this pull request as ready for review
September 30, 2026 02:09
This was referenced Sep 30, 2026
Bugs5382
force-pushed
the
docs/276-os-commands-callouts
branch
from
September 30, 2026 10:15
3189003 to
7e2b05c
Compare
…ed output into callouts Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
Contributor
Author
|
Closing summary: OS-specific commands in README, build/README and docs/ now show Windows (PowerShell) next to Linux / macOS, and risks and expected output sit in GitHub alert callouts. Rebased onto main with the DCO sign-off added. One conflict with #282 in docs/vmca-subordination.md: #282's CAUTION callout for TPM-held RSA keys replaces this PR's now-outdated "TPM-resident RSA not supported" note; every other hunk is unchanged. (While the branch was being rebased it was briefly pointed at main, which auto-closed this PR; it was restored and reopened.) CI green on d8caff5. Squash-merging with the owner's approval; closes #276. |
This was referenced Sep 30, 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.
What and why
The operator docs assumed a Unix shell for workstation commands, kept risks in paragraph text, and showed expected output in bare code blocks that read like commands. This PR:
bash) and Windows (PowerShell) (powershell): the ACME external account key and EST password generation, the EST/cacertsandsimpleenrollcalls, the openssl management-certificate fetch (</dev/nullhas no PowerShell form), and the VMCAgrep/catsteps. openssl, cryptosctl and task commands stay single, as do commands that only run on a Linux build host, a live Linux USB or a domain controller.simplereenrollstays single for now. On Windows,curl.exe(Schannel) takes a client certificate from the certificate store or a PFX file, not the PEM pair the example uses, and that path has not been checked on Windows.[!CAUTION]for key material, revocation, the maintenance-mode takeover window, the nodeid dev tier and PCR 7 changes;[!WARNING]for reboots, the vCenter import and untested hardware paths;[!IMPORTANT]for preconditions and easy mistakes;[!NOTE]for scope.[!TIP]alert that says what the output means and, where it matters, what to do when it differs.docs/image-upgrade.md, three items from "Limits worth knowing" (the pre-reseal TPM node, an image that does not boot, no production-hardware run yet) move, wording unchanged, into callouts at the steps they guard. Everything else keeps its order and wording.Closes #276
Verification
How this was verified
task ci(gofmt, golangci-lint, vet, test, build) andtask licensepass locally.> [!…]alert renders as an alert.Select-Stringfilters,Get-Content/Set-Contentand the'Q' | openssl s_clientfetch were also run in PowerShell 7. The EST password digest matchessha256sumfor the same password, and the generated key decodes withbase64.RawURLEncodingas the config loader does. The blocks avoid PowerShell 7-only syntax. Native-to-native pipes carry only PEM text, and binary data goes through files, because PowerShell 5.1 does not pipe bytes.Select-Stringtakes-CaseSensitiveto matchgrep: without it,CA:also matches hex bytes in the modulus.internal/revocation/store.go), the maintenance listener requiresNoClientCert, EST returns single-line base64 and reenrol requiresclientAuth, and ACME keys decode as unpadded base64url.