Skip to content

docs: add docs for image signing#616

Merged
gilescope merged 11 commits into
mainfrom
SRE-1744/img-sign-documentation
Feb 21, 2026
Merged

docs: add docs for image signing#616
gilescope merged 11 commits into
mainfrom
SRE-1744/img-sign-documentation

Conversation

@KrisF-Midnight

Copy link
Copy Markdown
Contributor

Overview

Add documentation for the container image signing and SBOM/vulnerability scanning infrastructure implemented in PR #562 (SRE-1741). This fulfills the documentation requirements from JIRA ticket SRE-1744.

New documentation created:

  • docs/security/image-signing.md - Overview of signing architecture, keyless OIDC flow, SBOM generation, and vulnerability scanning
  • docs/security/verification-guide.md - Step-by-step commands for verifying signatures and SBOMs, including Kubernetes admission controller examples
  • docs/security/signing-runbook.md - Operational procedures, troubleshooting guides, CVE management, and emergency procedures
  • docs/operations/release-checklist.md - Pre/post-release verification steps including security gates

Updated:

  • README.md - Added links to the new security and operations documentation

🗹 TODO before merging

  • Ready

📌 Submission Checklist

  • Changes are backward-compatible (or flagged if breaking)
  • Pull request description explains why the change is needed
  • Self-reviewed the diff
  • I have included a change file, or skipped for this reason: Documentation-only changes, no product impact
  • If the changes introduce a new feature, I have bumped the node minor version
  • Update documentation (if relevant)
  • Updated AGENTS.md if build commands, architecture, or workflows changed - N/A, no changes to builds/architecture/workflows
  • No new todos introduced

🧪 Testing Evidence

Please describe any additional testing aside from CI:

  • Verified all internal links between documentation files are consistent

  • Verified verification commands match the implementation in .github/scripts/sbom-scan.sh and .github/workflows/sbom-scan-image.yml

  • Documentation references correct image registries (ghcr.io/midnightntwrk/*, midnightntwrk/*)

  • Additional tests are provided (if possible) - N/A for documentation

🔱 Fork Strategy

  • Node Runtime Update
  • Node Client Update
  • Other:
  • N/A

Links

JIRA: SRE-1744
Related: #562 (SRE-1741 implementation PR)

@KrisF-Midnight KrisF-Midnight requested a review from a team as a code owner February 5, 2026 14:35
@KrisF-Midnight KrisF-Midnight marked this pull request as draft February 5, 2026 14:35
@github-actions

github-actions Bot commented Feb 5, 2026

Copy link
Copy Markdown
Contributor

kics-logo

KICS version: v2.1.16

Category Results
CRITICAL CRITICAL 0
HIGH HIGH 0
MEDIUM MEDIUM 96
LOW LOW 12
INFO INFO 83
TRACE TRACE 0
TOTAL TOTAL 191
Metric Values
Files scanned placeholder 31
Files parsed placeholder 31
Files failed to scan placeholder 0
Total executed queries placeholder 73
Queries failed to execute placeholder 0
Execution time placeholder 9

@gilescope gilescope left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the release checklist please add in additional steps here:

https://github.com/midnightntwrk/midnight-node/blob/main/.github/ISSUE_TEMPLATE/node-release-checklist.md

(The other pages look good)

@KrisF-Midnight KrisF-Midnight self-assigned this Feb 5, 2026
@CLAassistant

CLAassistant commented Feb 5, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@KrisF-Midnight KrisF-Midnight force-pushed the SRE-1744/img-sign-documentation branch from 8281d8a to b3cae0c Compare February 9, 2026 11:31
@KrisF-Midnight KrisF-Midnight marked this pull request as ready for review February 9, 2026 11:31
@mladen-shielded mladen-shielded self-requested a review February 9, 2026 13:08
@KrisF-Midnight

Copy link
Copy Markdown
Contributor Author

For the release checklist please add in additional steps here:

https://github.com/midnightntwrk/midnight-node/blob/main/.github/ISSUE_TEMPLATE/node-release-checklist.md

(The other pages look good)

I've made the change. Can you please review.

@gilescope gilescope enabled auto-merge February 17, 2026 15:57
@gilescope gilescope added this pull request to the merge queue Feb 17, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch Feb 17, 2026
@gilescope gilescope added this pull request to the merge queue Feb 21, 2026
Merged via the queue into main with commit 08def79 Feb 21, 2026
38 checks passed
@gilescope gilescope deleted the SRE-1744/img-sign-documentation branch February 21, 2026 15:50
gilescope pushed a commit that referenced this pull request Apr 8, 2026
m2ux added a commit that referenced this pull request Apr 23, 2026
Signed-off-by: Mike Clay <mike.clay@shielded.io>
m2ux added a commit that referenced this pull request Apr 23, 2026
Signed-off-by: Mike Clay <mike.clay@shielded.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants