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

docs: document NodeFeature API #903

Merged
merged 1 commit into from
Dec 14, 2022
Merged

docs: document NodeFeature API #903

merged 1 commit into from
Dec 14, 2022

Conversation

marquiz
Copy link
Contributor

@marquiz marquiz commented Sep 29, 2022 •
edited
Loading

Document the usage of the NodeFeature CRD API. Also re-organize the
documentation a bit, moving the description of NodeFeatureRule
controller from customization guide to nfd-master usage page.

@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 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 Sep 29, 2022
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 29, 2022
This was referenced Oct 4, 2022
Merged
Merged
Merged
Merged
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 5, 2022
This was referenced Oct 6, 2022
Merged
Merged
Merged
@netlify
Copy link

netlify bot commented Oct 12, 2022 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-nfd ready!

Name Link
🔨 Latest commit 3209c14
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-nfd/deploys/639a331a149f7d000803693b
😎 Deploy Preview https://deploy-preview-903--kubernetes-sigs-nfd.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.

@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 12, 2022
@marquiz
Copy link
Contributor Author

marquiz commented Oct 12, 2022

Rebased. A big reduction in number of commits but still quite massive

@marquiz marquiz mentioned this pull request Oct 13, 2022
Merged
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 14, 2022
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 18, 2022
@marquiz marquiz mentioned this pull request Oct 18, 2022
Merged
@marquiz marquiz force-pushed the devel/nodefeature-crd branch 2 times, most recently from e64ea5e to 00591e8 Compare October 31, 2022 07:55
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 3, 2022
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 8, 2022
@ArangoGutierrez
Copy link
Contributor

/assign

@marquiz
Copy link
Contributor Author

marquiz commented Dec 14, 2022

Now that all the remaining bits have been split into separate PRs I rebased this and re-scoped to be only about the documentation (which was the last remaining piece).

Ready for review but depends on #991
/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 14, 2022
@marquiz
Copy link
Contributor Author

marquiz commented Dec 14, 2022

#991 was merged
/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 14, 2022
ArangoGutierrez
ArangoGutierrez approved these changes Dec 14, 2022
View reviewed changes
Copy link
Contributor

@ArangoGutierrez ArangoGutierrez left a comment

Choose a reason for hiding this comment

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

/lgtm

docs/usage/customization-guide.md
Note that RBAC rules must be created for each extension for them to be able to
create and manipulate NodeFeature objects in their namespace.

Support for NodeFeature CRD API is enabled with the `-enable-nodefeature-api`
Copy link
Contributor

Choose a reason for hiding this comment

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

Speaking of which, we should enable this via WorkerConfig, not to have to set the flag if it is already running

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I specifically didn't want to have that for now. I had some reasoning in the commit message:
2374944

We can add that later if needed, but after careful consideration, I'd say

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

LGTM label has been added.

Git tree hash: 8f34567e89e4e72e9ce9581e4debfcb6112b50b4

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ArangoGutierrez, marquiz

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

@marquiz
Copy link
Contributor Author

marquiz commented Dec 14, 2022

@fmuyassarov wanna take a look?
/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 14, 2022
@fmuyassarov
Copy link
Member

@fmuyassarov wanna take a look?

/hold

Yes, please. Will do it in few hours and if looks good will remove the hold.

fmuyassarov
fmuyassarov reviewed Dec 14, 2022
View reviewed changes
Copy link
Member

@fmuyassarov fmuyassarov left a comment

Choose a reason for hiding this comment

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

some nits, otherwise looks good!

docs/get-started/introduction.md Outdated Show resolved Hide resolved
docs/usage/nfd-master.md Outdated
Comment on lines 13 to 14
updating node objects. More specifically, it is able to modify node labels,
taints and extended resources.
Copy link
Member

Choose a reason for hiding this comment

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

shall we add annotations as well here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What I tried to say is that it modifies these attributes on client requests. I now changed the wording to

More specifically, it modifies node labels, taints and
extended resources based on requests from nfd-workers and 3rd party extensions.

Better? We could also talk about annotations but I don't know if that's something worth mentioning as it's not a "feature" available for users (not yet, at least)

Copy link
Member

Choose a reason for hiding this comment

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

+1

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 14, 2022
@marquiz
docs: document NodeFeature API
3209c14 
Document the usage of the NodeFeature CRD API. Also re-organize the
documentation a bit, moving the description of NodeFeatureRule
controller from customization guide to nfd-master usage page.
@marquiz
Copy link
Contributor Author

marquiz commented Dec 14, 2022

@fmuyassarov thanks for the review. Comments addressed, PTAL

@fmuyassarov
Copy link
Member

Looks good now.
/lgtm

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

LGTM label has been added.

Git tree hash: 884cdf69d4be14864bab3d84720245678c3fa699

@fmuyassarov
Copy link
Member

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 14, 2022
@k8s-ci-robot k8s-ci-robot merged commit a193098 into kubernetes-sigs:master Dec 14, 2022
@marquiz marquiz mentioned this pull request Dec 20, 2022
Closed
@marquiz marquiz deleted the devel/nodefeature-crd branch December 20, 2022 08:49
@marquiz marquiz mentioned this pull request Dec 20, 2022
Closed
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fmuyassarov fmuyassarov fmuyassarov left review comments

@kad kad Awaiting requested review from kad

@jjacobelli jjacobelli Awaiting requested review from jjacobelli

@ArangoGutierrez ArangoGutierrez Awaiting requested review from ArangoGutierrez

Assignees

@ArangoGutierrez ArangoGutierrez

@fmuyassarov fmuyassarov

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. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@marquiz @k8s-ci-robot @ArangoGutierrez @fmuyassarov