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.

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

Expand documentation for adding an custom Job type to Kueue via external controller #2082

Closed
2 tasks
dgrove-oss opened this issue Apr 26, 2024 · 3 comments · Fixed by #2186
Closed
2 tasks
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@dgrove-oss
Copy link
Contributor

What would you like to be added:

Rework the page on adding a custom job type to Kueue to equally describe adding an external extension.

Why is this needed:

Kueue actually supports external extension fairly well and documenting it would help grow the community.

Completion requirements:

This enhancement requires the following artifacts:

  • Design doc
  • API change
  • [ x ] Docs update

The artifacts should be linked in subsequent comments.

@dgrove-oss dgrove-oss added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 26, 2024
@dgrove-oss
Copy link
Contributor Author

I'm planning to do this based on our experience with building the AppWrapper controller. The main question I had was whether you would prefer the final doc to be one page with 2 sections or a short summary page with two child pages each giving the details of internal and external.

@tenzen-y
Copy link
Member

tenzen-y commented May 1, 2024

I'm planning to do this based on our experience with building the AppWrapper controller. The main question I had was whether you would prefer the final doc to be one page with 2 sections or a short summary page with two child pages each giving the details of internal and external.

@dgrove-oss IMO, we depend on the amount of differences between the existing integration approach (https://kueue.sigs.k8s.io/docs/tasks/dev/integrate_a_custom_job/) and new external integration.

@alculquicondor @mimowo Any thought?

@alculquicondor
Copy link
Contributor

The existing page looks small enough, so maybe it would be fine to add it there. But don't stress about it and open a new page if it feels right.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants