Skip to content

dynamic resource allocation concepts#37766

Merged
k8s-ci-robot merged 1 commit into
kubernetes:dev-1.26from
pohly:dynamic-resource-allocation-concepts
Nov 28, 2022
Merged

dynamic resource allocation concepts#37766
k8s-ci-robot merged 1 commit into
kubernetes:dev-1.26from
pohly:dynamic-resource-allocation-concepts

Conversation

@pohly

@pohly pohly commented Nov 7, 2022

Copy link
Copy Markdown
Contributor

This will add a concept description for dynamic resource allocation.

@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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 7, 2022
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Nov 7, 2022
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Nov 7, 2022
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 7, 2022
@netlify

netlify Bot commented Nov 7, 2022

Copy link
Copy Markdown

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 1a5017a
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6369612cc37b4200080f03ea
😎 Deploy Preview https://deploy-preview-37766--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 site settings.

@krol3

krol3 commented Nov 21, 2022

Copy link
Copy Markdown
Contributor

Hey @pohly , 1.26 Docs Lead here 👋 !

The deadline (November 15th) for PRs ready to review has passed.

Please complete #37766 and request a review as soon as possible.

cc: @cathchu

@krol3

krol3 commented Nov 21, 2022

Copy link
Copy Markdown
Contributor

@pohly Please change the PR against dev-1.26 branch

@pohly pohly changed the base branch from main to dev-1.26 November 21, 2022 09:25
@leonardpahlke

Copy link
Copy Markdown
Contributor

Hey @pohly 🙂 what is the status on this? We need to start with the documentation & review process ASAP. We cannot add this feature without documentation! Thanks

@pohly pohly force-pushed the dynamic-resource-allocation-concepts branch from 1a5017a to 12f5290 Compare November 22, 2022 10:53
@netlify

netlify Bot commented Nov 22, 2022

Copy link
Copy Markdown

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit 197de4f
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/63849211c5777d00082e11a2
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 22, 2022
@pohly pohly changed the title WIP: dynamic resource allocation concepts Nov 22, 2022
@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 Nov 22, 2022
@pohly

pohly commented Nov 22, 2022

Copy link
Copy Markdown
Contributor Author

/assign @klueska

Please review.

The new `resource.k8s.io/v1alpha1` {{< glossary_tooltip text="API group"
term_id="api-group" >}} provides four new types:

- ResourceClass: defines which resource driver handles a certain kind of

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ideally these should link to the API documentation (similar to /docs/reference/kubernetes-api/config-and-storage-resources/csi-storage-capacity-v1/. But I don't know yet whether the new API group will have such generated documentation and where it will land.

Do we need to configure that?

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.

Maybe for now, link each of them to the section in the KEP that discusses them? Then we can update the links once they are they are available as above).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

There's no good anchor in the KEP for these. They would all link to the "API" section. I prefer to keep this as is until we have some generated API documentation.

@pohly pohly force-pushed the dynamic-resource-allocation-concepts branch from 12f5290 to 1185ea0 Compare November 23, 2022 08:49
@pohly

pohly commented Nov 23, 2022

Copy link
Copy Markdown
Contributor Author

The generated documentation looks good to me. I made some minor improvement (use description list) and one fix (list the new page in the index) since my first push.

@klueska klueska 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.

First pass

Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
@pohly pohly force-pushed the dynamic-resource-allocation-concepts branch from fe43be5 to ca5c83a Compare November 23, 2022 15:16

@klueska klueska 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.

Second pass.

Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
@krol3

krol3 commented Nov 28, 2022

Copy link
Copy Markdown
Contributor

Hi @pohly. This PR needs a doc review by Mon Nov 28th to get this into the release. Please reach out to required SIGs to get their review. Thank you!

@pohly pohly force-pushed the dynamic-resource-allocation-concepts branch from 5f42d49 to 895a012 Compare November 28, 2022 07:37
Comment thread content/en/docs/concepts/scheduling-eviction/dynamic-resource-allocation.md Outdated
@pohly pohly force-pushed the dynamic-resource-allocation-concepts branch from b75e21d to 0bd79fc Compare November 28, 2022 10:17
spec:
resourceClassName: resource.example.com
parametersRef:
apiGroup: cats.resource-driver.example.com

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.

This needs to be updated to match above.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

fixed

The documentation intentionally only gives an overview. The API documentation
and the KEP have more details. Specific examples will be provided by hardware
vendors that provide resource drivers.

The new page gets placed between "Scheduling Framework" (because that
introduces the concept of a scheduler plugin) and "Scheduler Performance
Tuning" (which seems like a more advanced topic).
@pohly pohly force-pushed the dynamic-resource-allocation-concepts branch from 0bd79fc to 197de4f Compare November 28, 2022 10:48
@klueska

klueska commented Nov 28, 2022

Copy link
Copy Markdown
Contributor

/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 Nov 28, 2022
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: b62c7926d75076016296d222b4f7ea5a57ec1c3b

@krol3 krol3 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.

/lgtm

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: klueska, krol3

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 28, 2022
@k8s-ci-robot k8s-ci-robot merged commit be09333 into kubernetes:dev-1.26 Nov 28, 2022
@k8s-ci-robot k8s-ci-robot added this to the 1.26 milestone Nov 28, 2022
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. 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/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

5 participants