Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MultiKueue] Document MPI Operator managedBy field #3316

Merged
merged 3 commits into from
Oct 29, 2024
Merged

[MultiKueue] Document MPI Operator managedBy field #3316

merged 3 commits into from
Oct 29, 2024

Conversation

mszadkow
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Document how to use managedBy provided by the mpi-operator.

Which issue(s) this PR fixes:

Fixes #3313

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 25, 2024
@netlify Netlify
Copy link

netlify bot commented Oct 25, 2024 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit eba0457
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/6720ad27ddd8a5000863500e
😎 Deploy Preview https://deploy-preview-3316--kubernetes-sigs-kueue.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 site configuration.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 25, 2024
@mszadkow
Copy link
Contributor Author

/cc @mimowo @tenzen-y

@mszadkow mszadkow mentioned this pull request Oct 25, 2024
Merged
@mszadkow mszadkow marked this pull request as ready for review October 28, 2024 10:51
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 28, 2024
mimowo
mimowo reviewed Oct 28, 2024
View reviewed changes
Copy link
Contributor

@mimowo mimowo left a comment

Choose a reason for hiding this comment

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

LGTM overall, proposed rephrase to the section on managedBy,

site/content/en/docs/tasks/run/multikueue/mpijob.md Outdated Show resolved Hide resolved
@mszadkow mszadkow force-pushed the docs/mk-managed-by-mpi-operator branch from 21cbb2f to eba0457 Compare October 29, 2024 09:38
@mszadkow
Copy link
Contributor Author

/ok-to-test

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Oct 29, 2024
mimowo
mimowo reviewed Oct 29, 2024
View reviewed changes
Copy link
Contributor

@mimowo mimowo left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 29, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mimowo, mszadkow

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

The pull request process is described here

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

@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: ad71b55d3ef8eb3a2c6ecc817680ec6dc64049ea

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 29, 2024
@k8s-ci-robot k8s-ci-robot merged commit c6ccf98 into kubernetes-sigs:main Oct 29, 2024
7 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v0.9 milestone Oct 29, 2024
@mszadkow mszadkow deleted the docs/mk-managed-by-mpi-operator branch October 29, 2024 10:51
tenzen-y
tenzen-y reviewed Oct 29, 2024
View reviewed changes
Copy link
Member

@tenzen-y tenzen-y left a comment

Choose a reason for hiding this comment

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

@mszadkow Could you address these comments?

site/content/en/docs/tasks/run/multikueue/mpijob.md
@@ -0,0 +1,36 @@
---
title: "Run MPI Jobs in Multi-Cluster"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
title: "Run MPI Jobs in Multi-Cluster"
title: "Run MPIJobs in Multi-Cluster"

This is exactly MPIJob.

site/content/en/docs/tasks/run/multikueue/mpijob.md
weight: 3
date: 2024-10-25
description: >
Run a MultiKueue scheduled MPI Jobs.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Run a MultiKueue scheduled MPI Jobs.
Run a MultiKueue scheduled MPIJobs.

site/content/en/docs/tasks/run/multikueue/mpijob.md

## MultiKueue integration

Once the setup is complete you can test it by running a MPI Job [`sample-mpijob.yaml`](/docs/tasks/run/kubeflow/mpijobs/#sample-mpijob).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Once the setup is complete you can test it by running a MPI Job [`sample-mpijob.yaml`](/docs/tasks/run/kubeflow/mpijobs/#sample-mpijob).
Once the setup is complete you can test it by running a MPIJob [`sample-mpijob.yaml`](/docs/tasks/run/kubeflow/mpijobs/#sample-mpijob).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, will handle that

@tenzen-y tenzen-y mentioned this pull request Oct 29, 2024
Closed
3 tasks
PBundyra pushed a commit to PBundyra/kueue that referenced this pull request Nov 5, 2024
@mszadkow @PBundyra
[MultiKueue] Document MPI Operator managedBy field (kubernetes-sigs#3316
26ce7c5 
)

* Add MPIJob MultiCluster docs

* Include managedBy feature

* Update after code review
kannon92 pushed a commit to openshift-kannon92/kubernetes-sigs-kueue that referenced this pull request Nov 19, 2024
@mszadkow @kannon92
[MultiKueue] Document MPI Operator managedBy field (kubernetes-sigs#3316
6cad3b2 
)

* Add MPIJob MultiCluster docs

* Include managedBy feature

* Update after code review
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tenzen-y tenzen-y tenzen-y left review comments

@mimowo mimowo mimowo left review comments

@alculquicondor alculquicondor Awaiting requested review from alculquicondor

@denkensk denkensk Awaiting requested review from denkensk

Assignees

@mimowo mimowo

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v0.9
Development

Successfully merging this pull request may close these issues.

[MultiKueue] Document how to use mpi-operator with managedBy
4 participants
@mszadkow @k8s-ci-robot @mimowo @tenzen-y