Add device plugin doc under concepts/cluster-administration. #5261

jiayingz · 2017-08-31T18:47:24Z

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For 1.8 Features: set Milestone to 1.8 and Base Branch to release-1.8
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

NOTE: Please check the “Allow edits from maintainers” box (see image below) to
allow reviewers to fix problems on your patch and speed up the review process.

Please delete this note before submitting the pull request.

This change is

jiayingz · 2017-08-31T18:47:45Z

/milestone 1.8

jiayingz · 2017-08-31T18:48:10Z

/assign @vishh

tengqm

looks good, just some nits

tengqm · 2017-09-01T01:17:52Z

docs/concepts/cluster-administration/device-plugins.md

+and reports two healthy devices on a node, the node status will be updated
+to advertise 2 `vendor-domain/foo`.
+Devices can then be selected using the same process as for OIRs in the pod spec.
+Currently, extended resources are only uspported as integer resources and expect


uspported -> supported

tengqm · 2017-09-01T01:18:21Z

docs/concepts/cluster-administration/device-plugins.md

+	rpc Register(RegisterRequest) returns (Empty) {}
+}
+```
+A device plugin can register itself to Kubelet through this gRPC service


add a period to this sentence

tengqm · 2017-09-01T01:20:15Z

docs/concepts/cluster-administration/device-plugins.md

+
+## Device Plugin Implementation
+
+The general workflow of a device plugin includes the following parts:


parts -> steps/phases?

tengqm · 2017-09-01T01:23:08Z

docs/concepts/cluster-administration/device-plugins.md

+## Device Plugin Implementation
+
+The general workflow of a device plugin includes the following parts:
+* Initialization. During this phase, a device plugin performs vendor specific initialization and setup to make sure their devices are in ready state.


a device plugin -> the device plugin

their devices -> the devices

tengqm · 2017-09-01T01:23:47Z

docs/concepts/cluster-administration/device-plugins.md

+
+The general workflow of a device plugin includes the following parts:
+* Initialization. During this phase, a device plugin performs vendor specific initialization and setup to make sure their devices are in ready state.
+* Starts a gRPC service with a unix socket under host path: `/var/lib/kubelet/device-plugins/` that implements the following interfaces:


The plugin starts a ...

tengqm · 2017-09-01T01:24:47Z

docs/concepts/cluster-administration/device-plugins.md

+        rpc Allocate(AllocateRequest) returns (AllocateResponse) {}
+}
+```
+* Register itself with Kubelet through unix socket at host path `/var/lib/kubelet/device-plugins/kubelet.sock`.


The plugin registers itself ...

tengqm · 2017-09-01T01:26:28Z

docs/concepts/cluster-administration/device-plugins.md

+* Register itself with Kubelet through unix socket at host path `/var/lib/kubelet/device-plugins/kubelet.sock`.
+* After successfully registering itself, the device plugin runs in serving mode during which it keeps
+monitoring device health and reports back to Kubelet upon any device state changes.
+It is also responsible for serving Allocate gRPC request. During Allocate, the device plugin may


request -> requests

tengqm · 2017-09-01T01:27:39Z

docs/concepts/cluster-administration/device-plugins.md

+monitoring device health and reports back to Kubelet upon any device state changes.
+It is also responsible for serving Allocate gRPC request. During Allocate, the device plugin may
+perform device specific preparing operations (e.g., gpu cleanup, QRNG initialization, and etc.).
+If the operations succeed, the device plugin will return AllocateResponse that contains container


return -> return an

jiayingz

Thanks a lot for the review!

jiayingz · 2017-09-01T19:10:09Z

docs/concepts/cluster-administration/device-plugins.md

+	rpc Register(RegisterRequest) returns (Empty) {}
+}
+```
+A device plugin can register itself to Kubelet through this gRPC service


jiayingz · 2017-09-01T19:10:16Z

docs/concepts/cluster-administration/device-plugins.md

+and reports two healthy devices on a node, the node status will be updated
+to advertise 2 `vendor-domain/foo`.
+Devices can then be selected using the same process as for OIRs in the pod spec.
+Currently, extended resources are only uspported as integer resources and expect


jiayingz · 2017-09-01T19:11:04Z

docs/concepts/cluster-administration/device-plugins.md

+## Device Plugin Implementation
+
+The general workflow of a device plugin includes the following parts:
+* Initialization. During this phase, a device plugin performs vendor specific initialization and setup to make sure their devices are in ready state.


jiayingz · 2017-09-01T19:11:05Z

docs/concepts/cluster-administration/device-plugins.md

+
+## Device Plugin Implementation
+
+The general workflow of a device plugin includes the following parts:


jiayingz · 2017-09-01T19:11:36Z

docs/concepts/cluster-administration/device-plugins.md

+
+The general workflow of a device plugin includes the following parts:
+* Initialization. During this phase, a device plugin performs vendor specific initialization and setup to make sure their devices are in ready state.
+* Starts a gRPC service with a unix socket under host path: `/var/lib/kubelet/device-plugins/` that implements the following interfaces:


jiayingz · 2017-09-01T19:12:23Z

docs/concepts/cluster-administration/device-plugins.md

+* Register itself with Kubelet through unix socket at host path `/var/lib/kubelet/device-plugins/kubelet.sock`.
+* After successfully registering itself, the device plugin runs in serving mode during which it keeps
+monitoring device health and reports back to Kubelet upon any device state changes.
+It is also responsible for serving Allocate gRPC request. During Allocate, the device plugin may


jiayingz · 2017-09-01T19:12:41Z

docs/concepts/cluster-administration/device-plugins.md

+monitoring device health and reports back to Kubelet upon any device state changes.
+It is also responsible for serving Allocate gRPC request. During Allocate, the device plugin may
+perform device specific preparing operations (e.g., gpu cleanup, QRNG initialization, and etc.).
+If the operations succeed, the device plugin will return AllocateResponse that contains container


k8sio-netlify-preview-bot · 2017-09-05T21:34:17Z

Deploy preview ready!

Built with commit 1561b17

https://deploy-preview-5261--kubernetes-io-vnext-staging.netlify.com

rohitagarwal003 · 2017-09-06T23:48:43Z

Who is the audience of this document? Device plugin vendors? Cluster administrators? Users?

rohitagarwal003 · 2017-09-06T23:49:16Z

Code is not rendered correctly: https://deploy-preview-5261--kubernetes-io-vnext-staging.netlify.com/docs/concepts/cluster-administration/device-plugins/

steveperry-53 · 2017-09-07T01:22:12Z

@jiayingz, It would be nice if I could do an edit pass on this topic. Is the Allow edits by maintainers checkbox available in the right column? If so, could you check it. Thanks.

steveperry-53 · 2017-09-07T20:43:23Z

@jiayingz, See f509e16 for suggested edits.

Next I need to adjust the Alpha notice to say 1.8 instead of 1.7.

steveperry-53 · 2017-09-07T20:51:50Z

@jiayingz, Is DaemonSet vs. Bare Metal the correct distinction? Here's how I see it: Regardless of whether you're on bare metal or a VM, you can deploy your device plugin as a DaemonSet (or not). Maybe we should say something like, "A device plugin can run as a DaemonSet or as a manually deployed component."

jiayingz · 2017-09-07T20:55:37Z

I am fine with changing "bare metal" to "as a manually deployed component". Agree it is more clear.

Add meta description. Fix typo. Change bare metal deployment to manual deployment.

Fix typo again.

steveperry-53 · 2017-09-07T21:46:22Z

@jiayingz, See cedc291 and 1561b17 for a few more edits.
After #5341 is merged, the alpha notice should change from 1.7 to 1.8.
Let me know when you're ready for me to merge this.

jiayingz · 2017-09-07T22:01:13Z

lgtm

@chenopis

* GC now supports non-core resources * Add two examples about how to analysis audits of kube-apiserver (#4264) * Deprecate system:nodes binding * [1.8] StatefulSet `initialized` annotation is now ignored. * inits the kubeadm upgrade docs addresses /issues/4689 * adds kubeadm upgrade cmd to ToC addresses /issues/4689 * add workload placement docs * ScaleIO - document udpate for 1.8 * Add documentation on storageClass.mountOptions and PV.mountOptions (#5254) * Add documentation on storageClass.mountOptions and PV.mountOptions * convert notes into callouts * Add docs for CustomResource validation add info about supported fields * advanced audit beta features (#5300) * Update job workload doc with backoff failure policy (#5319) Add to the Jobs documentation how to use the new backoffLimit field that limit the number of Pod failure before considering the Job as failed. * Documented additional AWS Service annotations (#4864) * Add device plugin doc under concepts/cluster-administration. (#5261) * Add device plugin doc under concepts/cluster-administration. * Update device-plugins.md * Update device-plugins.md Add meta description. Fix typo. Change bare metal deployment to manual deployment. * Update device-plugins.md Fix typo again. * Update page.version. (#5341) * Add documentation on storageClass.reclaimPolicy (#5171) * [Advanced audit] use new herf for audit-api (#5349) This tag contains all the changes in v1beta1 version. Update it now. * Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255) * Documentation for kubectl plugins (#5294) * Documentation for kubectl plugins * Update kubectl-plugins.md * Update kubectl-plugins.md * Updated CPU manager docs to match implementation. (#5332) * Noted limitation of alpha static cpumanager. * Updated CPU manager docs to match implementation. - Removed references to CPU pressure node condition and evictions. - Added note about new --cpu-manager-reconcile-period flag. - Added note about node allocatable requirements for static policy. - Noted limitation of alpha static cpumanager. * Move cpu-manager task link to rsc mgmt section. * init containers annotation removed in 1.8 (#5390) * Add documentation for TaintNodesByCondition (#5352) * Add documentation for TaintNodesByCondition * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Fix deployments (#5421) * Document extended resources and OIR deprecation. (#5399) * Document extended resources and OIR deprecation. * Updated extended resources doc per reviews. * reverts extra spacing in _data/tasks.yml * addresses `kubeadm upgrade` review comments Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit * HugePages documentation (#5419) * Update cpu-management-policies.md (#5407) Fixed the bad link. Modified "cpu" to "CPU". Added more 'yaml' as supplement. * Update RBAC docs for v1 (#5445) * Add user docs for pod priority and preemption (#5328) * Add user docs for pod priority and preemption * Update pod-priority-preemption.md * More updates * Update docs/admin/kubeadm.md for 1.8 (#5440) - Made a couple of minor wording changes (not strictly 1.8 related). - Did some reformatting (not strictly 1.8 related). - Updated references to the default token TTL (was infinite, now 24 hours). - Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`. - Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples. - Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes. - Documented the new `--groups` flag for `kubeadm token create`. - Added a note of caution under _Automating kubeadm_ that references the _Security model_ section. - Updated the component version table to drop 1.6 and add 1.8. - Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`. * Update StatefulSet Basics for 1.8 release (#5398) * addresses `kubeadm upgrade` review comments 2nd iteration review comments by @luxas * adds kubelet upgrade section to kubeadm upgrade * Fix a bulleted list on docs/admin/kubeadm.md. (#5458) I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow. This was introduced recently in #5440. * Clarify the API to check for device plugins * Moving Flexvolume to separate out-of-tree section * addresses `kubeadm upgrade` review comments CC: @luxas * fixes kubeadm upgrade index * Update Stackdriver Logging documentation (#5495) * Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526) * Update statefulset concepts doc to use apps/v1beta2 APIs (#5420) * add document on kubectl's behavior regarding initializers (#5505) * Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497) This is a new beta feature in 1.8. * Update kubectl patch doc to use apps/v1beta2 APIs (#5422) * [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525) * Update replicated stateful application task for 1.8. * Update single instance stateful app task for 1.8. * Update stateless app task for 1.8. * Update kubectl patch task for 1.8. * fix the link of persistent storage (#5515) * update the admission-controllers.md index.md what-is-kubernetes.md link * fix the link of persistent storage * Add quota support for local ephemeral storage (#5493) * Add quota support for local ephemeral storage update the doc to this alpha feature * Update resource-quotas.md * Updated Deployments concepts doc (#5491) * Updated Deployments concepts doc * Addressed comments * Addressed more comments * Modify allocatable storage to ephemeral-storage (#5490) Update the doc to use ephemeral-storage instead of storage * Revamped concepts doc for ReplicaSet (#5463) * Revamped concepts doc for ReplicaSet * Minor changes to call out specific versions for selector defaulting and immutability * Addressed doc review comments * Remove petset documentations (#5395) * Update docs to use batch/v1beta1 cronjobs (#5475) * add federation job doc (#5485) * add federation job doc * Update job.md Edits for clarity and consistency * Update job.md Fixed a typo * update DaemonSet concept for 1.8 release (#5397) * update DaemonSet concept for 1.8 release * Update daemonset.md Fix typo. than -> then * Update bootstrap tokens doc for 1.8. (#5479) * Update bootstrap tokens doc for 1.8. This has some changes I missed when I was updating the main kubeadm documention: - Bootstrap tokens are now beta, not alpha (kubernetes/enhancements#130) - The apiserver flag to enable the authenticator changedin 1.8 (kubernetes/kubernetes#51198) - Added `auth-extra-groups` documentaion (kubernetes/kubernetes#50933) - Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information. * Update bootstrap-tokens.md * Updated the Cassandra tutorial to use apps/v1beta2 (#5548) * add docs for AllowPrivilegeEscalation (#5448) Signed-off-by: Jess Frazelle <acidburn@microsoft.com> * Add local ephemeral storage alpha feature in managing compute resource (#5522) * Add local ephemeral storage alpha feature in managing compute resource Since 1.8, we add the local ephemeral storage alpha feature as one resource type to manage. Add this feature into the doc. * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Added documentation for Metrics Server (#5560) * authorization: improve authorization debugging docs (#5549) * Document mount propagation (#5544) * Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524) This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in kubernetes/kubernetes#49520 and some version bumps. * Add task doc for alpha dynamic kubelet configuration (#5523) * Fix input/output of selfsubjectaccess review (#5593) * Add docs for implementing resize (#5528) * Add docs for implementing resize * Update admission-controllers.md * Added link to PVC section * minor typo fixes * Update NetworkPolicy concept guide with egress and CIDR changes (#5529) * update zookeeper tutorial for 1.8 release * add doc for hostpath type (#5503) * Federated Hpa feature doc (#5487) * Federated Hpa feature doc * Federated Hpa feature doc review fixes * Update hpa.md * Update hpa.md * update cloud controller manager docs for v1.8 * Update cronjob with defaults information (#5556) * Kubernetes 1.8 reference docs (#5632) * Kubernetes 1.8 reference docs * Kubectl reference docs for 1.8 * Update side bar with 1.8 kubectl and api ref docs links * remove petset.md * update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644) * Fix cron job deletion section (#5655) * update imported docs (#5656) * Add documentation for certificate rotation. (#5639) * Link to using kubeadm page * fix the command output fix the command output * fix typo in api/resources reference: "Worloads" * Add documentation for certificate rotation. * Create TOC entry for cloud controller manager. (#5662) * Updates for new versions of API types * Followup 5655: fix link to garbage collection (#5666) * Temporarily redirect resources-reference to api-reference. (#5668) * Update config for 1.8 release. (#5661) * Update config for 1.8 release. * Address reviewer comments. * Switch references in HPA docs from alpha to beta (#5671) The HPA docs still referenced the alpha version. This switches them to talk about v2beta1, which is the appropriate version for Kubernetes 1.8 * Deprecate openstack heat (#5670) * Fix typo in pod preset conflict example Move container port definition to the correct line. * Highlight openstack-heat provider deprecation The openstack-heat provider for kube-up is being deprecated and will be removed in a future release. * Temporarily fix broken links by redirecting. (#5672) * Fix broken links. (#5675) * Fix render of code block (#5674) * Fix broken links. (#5677) * Add a small note about auto-bootstrapped CSR ClusterRoles (#5660) * Update kubeadm install doc for v1.8 (#5676) * add draft workloads api content for 1.8 (#5650) * add draft workloads api content for 1.8 * edits per review, add tables, for 1.8 workloads api doc * fix typo * Minor fixes to kubeadm 1.8 upgrade guide. (#5678) - The kubelet upgrade instructions should be done on every host, not just worker nodes. - We should just upgrade all packages, instead of calling out kubelet specifically. This will also upgrade kubectl, kubeadm, and kubernetes-cni, if installed. - Draining nodes should also ignore daemonsets, and master errors can be ignored. - Make sure that the new kubeadm download is chmoded correctly. - Add a step to run `kubeadm version` to verify after downloading. - Manually approve new kubelet CSRs if rotation is enabled (known issue). * Release 1.8 (#5680) * Fix versions for 1.8 API ref docs * Updates for 1.8 kubectl reference docs * Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681) * Update docs/admin/kubeadm.md (mostly 1.8 related). This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this). * A few of my own edits to clarify and clean up some Markdown.

k8s-ci-robot added 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 Aug 31, 2017

k8s-ci-robot assigned vishh Aug 31, 2017

tengqm reviewed Sep 1, 2017

View reviewed changes

jiayingz commented Sep 1, 2017

View reviewed changes

jiayingz force-pushed the device-plugin branch from 9c6f9dc to 7843780 Compare September 1, 2017 19:13

chenopis added this to the 1.8 milestone Sep 2, 2017

chenopis assigned steveperry-53 Sep 2, 2017

chenopis added Needs Docs Review labels Sep 2, 2017

Add device plugin doc under concepts/cluster-administration.

38e94ee

jiayingz force-pushed the device-plugin branch from 7843780 to 38e94ee Compare September 5, 2017 21:32

steveperry-53 added Docs Review: Open Issues and removed Needs Docs Review labels Sep 7, 2017

Update device-plugins.md

f509e16

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 7, 2017

steveperry-53 added 2 commits September 7, 2017 14:39

Update device-plugins.md

cedc291

Add meta description. Fix typo. Change bare metal deployment to manual deployment.

Update device-plugins.md

1561b17

Fix typo again.

steveperry-53 added the Docs LGTM label Sep 7, 2017

steveperry-53 removed the Docs Review: Open Issues label Sep 7, 2017

steveperry-53 merged commit f42118a into kubernetes:release-1.8 Sep 7, 2017


		## Device Plugin Implementation

		The general workflow of a device plugin includes the following parts:

Add device plugin doc under concepts/cluster-administration. #5261

Add device plugin doc under concepts/cluster-administration. #5261

Conversation

jiayingz commented Aug 31, 2017 • edited by k8s-reviewable Loading

jiayingz commented Aug 31, 2017

jiayingz commented Aug 31, 2017

tengqm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jiayingz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8sio-netlify-preview-bot commented Sep 5, 2017 • edited Loading

rohitagarwal003 commented Sep 6, 2017

rohitagarwal003 commented Sep 6, 2017

steveperry-53 commented Sep 7, 2017

steveperry-53 commented Sep 7, 2017

steveperry-53 commented Sep 7, 2017

jiayingz commented Sep 7, 2017

steveperry-53 commented Sep 7, 2017 • edited Loading

jiayingz commented Sep 7, 2017

jiayingz commented Aug 31, 2017 •

edited by k8s-reviewable

Loading

k8sio-netlify-preview-bot commented Sep 5, 2017 •

edited

Loading

steveperry-53 commented Sep 7, 2017 •

edited

Loading