Skip to content

KEP-5547: Add docs for Workload APIs integration with Job controller#54489

Merged
k8s-ci-robot merged 2 commits intokubernetes:dev-1.36from
helayoty:helayoty/5547-integrate-job-workload
Apr 9, 2026
Merged

KEP-5547: Add docs for Workload APIs integration with Job controller#54489
k8s-ci-robot merged 2 commits intokubernetes:dev-1.36from
helayoty:helayoty/5547-integrate-job-workload

Conversation

@helayoty
Copy link
Copy Markdown
Member

@helayoty helayoty commented Feb 16, 2026

Description

  • Add new section in the Job controller for the Workload APIs integration. The documentation covers qualifying criteria, example YAML, opt-out mechanism for higher-level controllers, CronJob behavior, and alpha limitations
  • Added a note in the "Elastic Indexed Jobs" section that parallelism updates are rejected for gang-scheduled Jobs when EnableWorkloadWithJob is enabled
  • Added "Gang scheduling with Jobs" section in the scheduling doc explaining that the Job controller automatically creates Workload/PodGroup for qualifying parallel indexed Jobs

/sig apps
/sig scheduling
/area workload-aware

Issue

Closes: #

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. area/workload-aware Categorizes an issue or PR as relevant to Workload-aware and Topology-aware scheduling subprojects. labels Feb 16, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in SIG Scheduling Feb 16, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in SIG Apps Feb 16, 2026
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Feb 16, 2026
@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 16, 2026
@helayoty helayoty changed the base branch from main to dev-1.36 February 16, 2026 23:55
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 16, 2026
@helayoty helayoty moved this from Needs Triage to In Progress in SIG Apps Feb 16, 2026
@helayoty helayoty moved this from Needs Triage to In Progress in SIG Scheduling Feb 16, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 17, 2026

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 5ad50f0
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/69d7667831bece000839c702
😎 Deploy Preview https://deploy-preview-54489--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@helayoty helayoty force-pushed the helayoty/5547-integrate-job-workload branch from 012aa63 to 732ee6a Compare March 26, 2026 22:02
@k8s-ci-robot k8s-ci-robot added area/localization General issues or PRs related to localization area/release-eng Issues or PRs related to the Release Engineering subproject area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes language/fr Issues or PRs related to French language labels Mar 26, 2026
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Mar 26, 2026

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: helayoty / name: Heba Elayoty (63242e4)
  • ✅ login: helayoty / name: helayoty (5ad50f0)

@k8s-ci-robot k8s-ci-robot added the language/ja Issues or PRs related to Japanese language label Mar 26, 2026
@helayoty helayoty moved this from In Progress to Needs Review in SIG Scheduling Mar 27, 2026
@helayoty helayoty moved this from Backlog to Needs Review in Workload-aware & Topology-aware Workstream Mar 27, 2026
Copy link
Copy Markdown
Member

@andreyvelich andreyvelich left a comment

Choose a reason for hiding this comment

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

Thanks @helayoty, overall looks great!

Comment thread content/en/docs/concepts/workloads/controllers/job.md Outdated
Comment on lines +371 to +375
1. Creates a `Workload` object in the same namespace with a `podGroupTemplate`
containing a gang policy where `minCount` equals the Job's parallelism.
2. Creates a `PodGroup` object based on that template.
3. Creates Pods with `spec.schedulingGroup.podGroupName` set to the `PodGroup` name,
linking each Pod to its scheduling group.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we also explain naming for Workload, PodGroupTemplate, and PodGroup ?

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.

I guess this should link to changes that are also in review #54490

Comment thread content/en/docs/concepts/workloads/controllers/job.md
Comment thread content/en/docs/concepts/workloads/controllers/job.md
Comment thread content/en/docs/concepts/scheduling-eviction/gang-scheduling.md Outdated
@lmktfy
Copy link
Copy Markdown
Member

lmktfy commented Apr 3, 2026

/remove-area release-eng

@k8s-ci-robot k8s-ci-robot removed the area/release-eng Issues or PRs related to the Release Engineering subproject label Apr 3, 2026
@helayoty helayoty force-pushed the helayoty/5547-integrate-job-workload branch from 4696939 to 936f340 Compare April 6, 2026 11:22
@helayoty helayoty moved this from Needs Review to In Progress in SIG Scheduling Apr 6, 2026
@helayoty helayoty moved this from Needs Review to In Review in Workload-aware & Topology-aware Workstream Apr 6, 2026
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 7, 2026
Copy link
Copy Markdown
Contributor

@soltysh soltysh left a comment

Choose a reason for hiding this comment

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

Minor suggestions, but this lgtm from sig-apps pov


{{< feature-state feature_gate_name="EnableWorkloadWithJob" >}}

When the [`EnableWorkloadWithJob`](/docs/reference/command-line-tools-reference/feature-gates/) feature gate is enabled,
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.

If we land kubernetes/kubernetes#138210, this will need to get updated accordingly.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Can we update this in a follow-up PR?

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.

@helayoty yes, this will definitely need to be updated in a follow-up PR once the the other lands, thanks (you can also create an issue for this as well, recommended)

Comment thread content/en/docs/concepts/workloads/controllers/job.md Outdated
@reylejano
Copy link
Copy Markdown
Member

PR needs rebase

@reylejano
Copy link
Copy Markdown
Member

/milestone 1.36

@k8s-ci-robot k8s-ci-robot added this to the 1.36 milestone Apr 8, 2026
Comment thread content/en/docs/concepts/scheduling-eviction/gang-scheduling.md Outdated
@macsko
Copy link
Copy Markdown
Member

macsko commented Apr 9, 2026

/lgtm
From SIG Scheduling POV

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: 2891d613203060c374c47f7ca6317baf6e220437

@natalisucks
Copy link
Copy Markdown
Contributor

good from docs, thanks
/approve

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: natalisucks, soltysh

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

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

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/workload-aware Categorizes an issue or PR as relevant to Workload-aware and Topology-aware scheduling subprojects. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/release Categorizes an issue or PR as relevant to SIG Release. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

10 participants