TSG: SBEHealth Test-Installed-SBE-Env-Vars (Environment Validator remediation guide)#315
Open
1008covingtonlane wants to merge 3 commits into
Open
Conversation
…ediation guide) New troubleshooting guide for the AzStackHci_SBEHealth_Test-Installed-SBE-Env-Vars pre-update SBE health check. Documents the Warning 'Inconsistent SBE ENV vars' state (a partial/interrupted SBE stage that leaves SBEInstalledContent/SBEInstalledMetadata mismatched), where it surfaces (portal Updates + EventID 17205 + the two machine env vars), and the remediation (re-run the Solution Builder Extension update to restore a consistent state). Adds the README index entry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new Environment Validator troubleshooting guide (TSG) for the pre-update SBE health check AzStackHci_SBEHealth_Test-Installed-SBE-Env-Vars, and indexes it in the Environment Validator README. The guide explains the three possible outcomes (installed / no SBE / inconsistent), where the warning surfaces (portal Updates view, Event ID 17205 on the AzStackHciEnvironmentChecker log, and the two machine env vars), and a read-only-safe remediation of re-running the Solution Builder Extension update to reconcile SBEInstalledContent / SBEInstalledMetadata. It fits the repo's community-driven supportability content used by CSS, engineering, and self-service users.
Changes:
- New 238-line TSG following the Environment Validator TSG format (H1 check name, metadata table, Overview, Requirements, Troubleshooting Steps, Related).
- Documents diagnosis (Event ID 17205 query, direct env-var inspection), remediation, verification, and escalation/ownership (SBE/update task + OEM).
- Adds a bullet link to the new guide in the Environment Validator
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
TSG/EnvironmentValidator/Troubleshooting-SBEHealth-Test-Installed-SBE-Env-Vars.md |
New TSG describing the SBE installed-env-vars consistency warning, diagnostics, and safe remediation. |
TSG/EnvironmentValidator/README.md |
Indexes the new guide as a bullet link (line 11) using the ./ relative path convention. |
…eck (PR review) Address the Copilot review comment: step 3 now uses 'Invoke-SolutionUpdatePrecheck -SystemHealth' (with a Get-SolutionUpdateEnvironment health-state verify), matching the repo convention in the two other pre-update readiness guides. A bare Invoke-SolutionUpdatePrecheck does not re-run the health checks; -SystemHealth is what actually re-evaluates SBE health. Also adds the HealthState check to step 4. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…17205 query (PR review parity) Same fix as the Endpoint-Matches-ModelSKU TSG (Copilot review on Azure#317), adapted for this WARNING-severity check: in the EventID 17205 JSON the top-level Status and Severity are numeric enums and Description is generic; there is no AdditionalData.Severity (verified on a live node: AdditionalData keys have Status + Detail but no Severity). This check keeps AdditionalData.Status = SUCCESS even when inconsistent and flags via the numeric Severity + the detail, so the reliable signal is AdditionalData.Detail reading 'Inconsistent SBE ENV vars'. The query now projects AdditionalData.Status + Severity + AdditionalData.Detail and the prose keys on the Detail text. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Adds a troubleshooting guide for the AzStackHci_SBEHealth_Test-Installed-SBE-Env-Vars pre-update SBE health check, and indexes it in the Environment Validator README.
This check reads the two machine environment variables that record the installed Solution Builder Extension (
SBEInstalledContent,SBEInstalledMetadata) plus the SBE version fromoemMetadata.xml, and reports the installed-SBE state. Its actionable state is a Warning, "Inconsistent SBE ENV vars", raised when those variables are in a mismatched combination (typically left by an interrupted or partial SBE stage). It does not block the operation, but the mismatch should be reconciled before the next update.The TSG covers:
AzStackHciEnvironmentChecker(with the-like '*Test-Installed-SBE-Env-Vars*'match), and reading the two machine env vars directly.Grounded on the
ASZ-EnvironmentValidatorAzStackHciSBEHealthsource (Test-AzStackHciSBEHealth).INTERNAL grade (tsg-forge): static lint A; 13-persona usability panel 5/5.