Skip to content

docs: clarify workload owner kinds supported by WorkloadScan#1181

Open
fabriziosestito wants to merge 1 commit into
kubewarden:mainfrom
fabriziosestito:docs/clarify-workload-types
Open

docs: clarify workload owner kinds supported by WorkloadScan#1181
fabriziosestito wants to merge 1 commit into
kubewarden:mainfrom
fabriziosestito:docs/clarify-workload-types

Conversation

@fabriziosestito
Copy link
Copy Markdown
Collaborator

Description

clarify workload owner kinds supported by WorkloadScan

Fixes #938

@fabriziosestito fabriziosestito self-assigned this May 28, 2026
Copilot AI review requested due to automatic review settings May 28, 2026 09:17
@fabriziosestito fabriziosestito requested a review from a team as a code owner May 28, 2026 09:17
@fabriziosestito fabriziosestito added the documentation Improvements or additions to documentation label May 28, 2026
@github-project-automation github-project-automation Bot moved this to Pending Review in SBOMscanner May 28, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 53.47%. Comparing base (4395da6) to head (084f2dd).
⚠️ Report is 29 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1181      +/-   ##
==========================================
+ Coverage   53.41%   53.47%   +0.05%     
==========================================
  Files          61       61              
  Lines        5328     5328              
==========================================
+ Hits         2846     2849       +3     
+ Misses       2086     2083       -3     
  Partials      396      396              
Flag Coverage Δ
unit-tests 53.47% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Clarifies how WorkloadScan determines the “workload” for a Pod by describing which ownerReference chains are walked and how WorkloadScanReport names are derived from the resolved owner kind/UID (including mirror/static Pods owned by Node).

Changes:

  • Rewords “Supported workload types” to describe report creation per resolved top-level owner rather than a fixed whitelist.
  • Documents the two special ownerReference chains that are walked (ReplicaSet → Deployment, Job → CronJob).
  • Explicitly notes that other controller owner kinds (e.g., Node, custom CRDs) produce reports named <kind>-<uid>.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/user-guide/scanning-workloads.md Outdated
@fabriziosestito fabriziosestito force-pushed the docs/clarify-workload-types branch from 4153faa to 35c961e Compare May 28, 2026 09:22
Signed-off-by: Fabrizio Sestito <fabrizio.sestito@suse.com>
@fabriziosestito fabriziosestito force-pushed the docs/clarify-workload-types branch from 35c961e to 084f2dd Compare May 28, 2026 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Pending Review

Development

Successfully merging this pull request may close these issues.

Bug: mirror pod (whose ownerReferences.kind = Node) will fail to have correct workloadScanReport

2 participants