Skip to content

Add upgrade decision, preflight and recovery walkthrough - #1225

Open
sylvesterkaczmarek wants to merge 1 commit into
cisagov:contributor-prsfrom
sylvesterkaczmarek:docs/353-upgrade-decision-and-recovery-20261011
Open

sylvesterkaczmarek wants to merge 1 commit into
cisagov:contributor-prsfrom
sylvesterkaczmarek:docs/353-upgrade-decision-and-recovery-20261011

Conversation

@sylvesterkaczmarek

@sylvesterkaczmarek sylvesterkaczmarek commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Maintenance update on 6 November 2026

Refreshed onto contributor-prs at 7046399b after the integration branch history changed. This PR now contains its 1-file topic change in one commit.

Validated 3 added Bash snippets, 9 local links/anchors and the current ISO step references. Git whitespace checks pass.

No operating-system upgrade, live Malcolm upgrade or restore was executed.

Earlier validation counts below record the original branch state. ChatGPT assisted with this refresh, corrections and validation.


Addresses #353 (written walkthrough option).

Summary

  • Add a decision matrix identifying the appropriate procedure for ISO/Hedgehog, release archive and Git installations.
  • Explain which Debian host-upgrade steps must be skipped for release archives on other Linux distributions.
  • Add a read-only preflight checkpoint for identifying the deployed version, recording state, free disk space and recovery access.
  • Explicitly separate configuration-directory backups from OpenSearch snapshots, PCAPs, logs and other persistent data.
  • Add a recovery matrix for failed host upgrades, Git conflicts, incompatible OpenSearch data and authentication/credential disruptions.

Verification

  • Validated relative documentation links.
  • All three new shell snippets pass Bash syntax checking.
  • git diff --check passed.

The guide does not attempt a destructive upgrade or claim live end-to-end restore testing.

Integration refresh (15 October 2026)

  • Rebases the changes onto upstream contributor-prs at a1da19b0, not the older main snapshot. Local dry-run integration of all 21 reviewed open PRs completed without merge conflicts.
  • Configuration syntax and relative documentation links were checked; there is no dedicated executable regression file in this PR.
  • Combined local Python integration suite: 776 passed, 6 skipped, 157 subtests passed; three Ruby suites: 24 tests, 97 assertions, all passed. Ten modified shell scripts passed ShellCheck (error severity), the NetFlow/TLS Docker Compose overlays parsed, and changed local Markdown links resolved.
  • This is offline/repository-level validation, not a live Malcolm, Zeek, Kubernetes, Azure or AWS deployment test, nor a complete Docker image build.

@sylvesterkaczmarek
sylvesterkaczmarek force-pushed the docs/353-upgrade-decision-and-recovery-20261011 branch from c65f949 to 404cfdf Compare October 15, 2026 20:58
@sylvesterkaczmarek
sylvesterkaczmarek changed the base branch from main to contributor-prs October 15, 2026 20:58
Refresh the focused change onto contributor-prs at 7046399.

Validated **3 added Bash snippets**, **9 local links/anchors** and the current ISO step references.

No operating-system upgrade, live Malcolm upgrade or restore was executed.
@sylvesterkaczmarek
sylvesterkaczmarek force-pushed the docs/353-upgrade-decision-and-recovery-20261011 branch from 404cfdf to 131289a Compare November 6, 2026 07:48
@mmguero mmguero added this to Malcolm Nov 9, 2026
@mmguero mmguero added this to the z.staging milestone Nov 9, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants