Commit Graph

66 Commits

Author SHA1 Message Date
lowang-bh 124f6b8c6a
Fix: word spelling (#41003)
Signed-off-by: lowang_bh <lhui_wang@163.com>
2023-05-08 18:45:14 +08:00
Moshe Levi eaf9199d07 doc: extend PodResources API for Dynamic Resource Allocation
Signed-off-by: Moshe Levi <moshele@nvidia.com>
2023-04-04 10:17:03 +03:00
zhuzhenghao d08ae655fd Clean up page device-plugins 2023-02-18 01:07:55 +08:00
Swati Sehgal 88ecb0501c doc: capture device-plugin stricter workflow ordering explicitly
Based on kubelet device manager refactoring done in 1.25 release,
there is stricter ordering requirements where the device plugin
MUST start a gRPC service before registering itself to kubelet.
In case this ordering is not followed, the plugin registration
will fail.

Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
2023-01-16 11:47:45 +00:00
Swati Sehgal 35225fffe8 device-mgr-doc: Use a `note` shortcode instead of caution
Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
2022-12-12 14:11:26 +00:00
Swati Sehgal e3ed94f1d6 device-mgr-doc: Add caution closing tag
To enture that this page is rendered correctly on the Kubernetes
website, the caution tag needs to be closed.

This was missed during the doc write up and review process.

Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
2022-12-12 12:26:29 +00:00
carolina valencia 7cd85d1fc4 Merge remote-tracking branch 'upstream/main' into dev-1.26 2022-12-07 11:40:37 -03:00
Oscar Utbult 208af77e41 docs: fix spelling in device plugins (partilar -> particular) 2022-12-04 11:18:20 +01:00
Kubernetes Prow Robot b5aafaaac4
Merge pull request #37863 from krol3/merged-main-dev-1.26-02
Merge main branch into dev-1.26
2022-11-21 19:32:13 -08:00
Swati Sehgal 0a0fb70fc2 node: devicemgr: docs: Additional updates based on review comments
Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
2022-11-11 11:16:16 +00:00
Swati Sehgal 89fa301731 node: devicemgr: docs: Updates based on review comments
Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
2022-11-11 11:12:53 +00:00
Swati Sehgal 65f244bc3a node: devicemgr: docs: Kubelet Device Manager graduation to GA
Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
2022-11-11 11:09:04 +00:00
Kubernetes Prow Robot 9b62ccae9e
Merge pull request #37217 from tengqm/tweak-device-plugins
Tweak line wrappings in the device-plugin concepts page
2022-11-09 14:32:54 -08:00
Théo "Bob" Massard 70661324bd
fix(device-plugins): update FPGA device link 2022-10-18 14:07:48 +02:00
Qiming Teng 9ad91ebe41 Tweak line wrappings in the device-plugin concepts page
This PR fixes the long line problems found in the device-plugins.md page.
2022-10-08 16:51:35 +08:00
Mikko Ylinen 62980d931a clarify topologyinfo registration logic in device plugins
Signed-off-by: Mikko Ylinen <mikko.ylinen@intel.com>
2022-09-15 06:32:54 +03:00
Arnaud Meukam a180cd6853
Update docs to reference new container image registry
k8s.gcr.io is deprecated in favor of registry.k8s.io. The kubernetes
codebase have been updated with the new endpoint.

Ref: https://github.com/kubernetes/k8s.io/issues/3411

Signed-off-by: Arnaud Meukam <ameukam@gmail.com>
2022-08-18 16:35:26 +02:00
Sean Wei 34155fed0b Fix links for k/design-proposals-archive
The contributors/design-proposals in k/community was removed. It's only
available in k/design-proposals-archive repo now.

This commit also changes https://github.com/kubernetes/repo/blob/master/file.md
to https://git.k8s.io/repo/file.md for better consistency.
2022-06-10 22:49:04 +08:00
Nate W f85be125b9 Merge remote-tracking branch 'upstream/main' into dev-1.24 2022-03-31 15:18:13 -07:00
Tim Bannister 1c6009f29d Drop a device plugin that has an explicit Docker Engine dependency
Removal prompted by the removal of dockershim from Kubernetes.
2022-03-30 15:52:58 +01:00
Jakub Piotr Cłapa 26716d7326
Added a link to the SocketCAN device plugin 2022-03-30 13:18:11 +02:00
Ed Bartosh 2c6dcdde24 update list of Intel device plugins 2022-03-18 15:00:46 +02:00
Tim Bannister 2558306e58
Add third-party content disclaimer 2022-01-05 21:44:49 +00:00
Tim Bannister d67ac4dc95
Fix mismatched whitespace
Convert a tab to spaces to match other lines in snippet.
2022-01-05 21:44:48 +00:00
Tim Bannister fea1dc2801
Clean up front matter 2022-01-05 21:44:48 +00:00
Tim Bannister 7715646907
Tweak wording for Device Plugins concept 2022-01-05 21:44:44 +00:00
Swati Sehgal c7231c8d6d Explicitly state that GetCpuIds returns exclusive cpus
Based on the discussion here: https://github.com/kubernetes/kubernetes/pull/97415#discussion_r722548437
we explictly state that the GetCpuIds returned for a ContainerResource in the ListPodResourcesResponse
represent only exclusively allocated CPUs.

In order to evaluate the CPUs corresponding to the shared pool, List endpoint should be used in conjunction
with GetAllocatableResources endpoint. We highlight the steps that the client needs to take evaluate this.

Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
2021-11-17 15:16:57 +00:00
Swati Sehgal 8d6da01857 podresource-api: Graduate GetAllocatableResources to Beta
Also, explicitly clarify the behavior of GetAllocatableResources
The explanation that GetAllocatableResources can be used to obtain available resources
on the node can be misinterpretted as an API that is used to obtain free/unallocated
resources on a node.

This PR adds additional text to clarify that this API endpoint only returns
allocatable resources which are resources exposed to kubelet as defined here:
https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable.

Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
2021-11-17 15:16:57 +00:00
cezaryzukowski 11c8889e6d
The Memory Manager graduates to Beta (#28851)
* Update gRPC messages documentation

* Revisions + extend docs

* Update content/en/docs/tasks/administer-cluster/memory-manager.md

Co-authored-by: Tim Bannister <tim@scalefactory.com>

* Revisions

* Update content/en/docs/tasks/administer-cluster/memory-manager.md

Co-authored-by: Qiming Teng <tengqm@outlook.com>

* Revisions

Co-authored-by: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Qiming Teng <tengqm@outlook.com>
2021-07-27 02:12:45 -07:00
Jihoon Seo dfaefa54aa Nit: Fix hrefs of some links 2021-06-03 06:20:26 +09:00
Francesco Romani b4f485a6b0
Actualize podresources 1.21 (#27203)
* Actuallize podresources description

This commit updates description according to
https://github.com/kubernetes/enhancements/pull/1884

Update content/en/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins.md

Signed-off-by: Alexey Perevalov <alexey.perevalov@huawei.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>

* podresources: document the new feature gate

Signed-off-by: Francesco Romani <fromani@redhat.com>

* device plugins: add clarifications after review

- fix the AllocatableResourcesResponse comment
- describe the NUMA ID and explain the meaning of the field.

Signed-off-by: Francesco Romani <fromani@redhat.com>

Co-authored-by: Alexey Perevalov <alexey.perevalov@huawei.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2021-03-31 04:39:00 -07:00
XinYuan 41685331f3
Modify words that may cause ambiguity in device-plugins.md
The `/var/lib/kubelet/pod-resources/kubelet.sock` is required by device monitoring agent but not device plugin.
This word  `plugin` is ambiguous.

plugin -> device monitoring agent
2021-01-04 17:11:01 +08:00
Renaud Gaubert f2ef3d0e80 Graduate KubeletPodResources to GA
Signed-off-by: Renaud Gaubert <rgaubert@nvidia.com>
2020-10-29 18:55:33 -07:00
Qiming Teng 070023b24a Fix links in concepts section 2020-10-22 14:24:56 +08:00
h4ghhh 81a6a8e5bd modify device-plugins.md 2020-10-17 14:32:23 +08:00
Kubernetes Prow Robot 70b75e16f0
Merge pull request #22981 from shuuji3/en/replace-special-quote-with-normal-ones
Replace special quote characters with normal ones
2020-08-26 14:55:02 -07:00
TAKAHASHI Shuuji c6a96128c4
Replace special quote characters with normal ones. 2020-08-11 21:05:22 +09:00
Savitha Raghunathan 53c71ad3f9 Merge remote-tracking branch 'upstream/master' into dev-1.19 2020-08-03 16:09:39 -04:00
Qiming Teng c8f4704873 Fix links in concepts section (2) 2020-08-02 09:11:14 +08:00
Kubernetes Prow Robot 713603e146
Merge pull request #21607 from klueska/upstream-topology-manager-docs-update
Topology Manager docs update for 1.19
2020-07-14 10:45:21 -07:00
Kevin Klues 7b270b47bc Add updated documentation about the device plugin interface
Signed-off-by: Kevin Klues <kklues@nvidia.com>
2020-07-13 16:54:52 +02:00
TAKAHASHI Shuuji 6a22815738
Fix a broken link in concepts/extend-kubernetes/compute-storage-net/device-plugins.md 2020-06-29 10:53:48 +09:00
Kiyoshi Muranaka d8c8d6a881 [en] Fix broken link to Xilinx FPGA device plugins 2020-06-22 17:00:01 +09:00
Karen Bradshaw ecc27bbbe7 add en pages 2020-06-09 19:33:15 -04:00
Xiang Dai f21f4b2257 Fix en language misspell (#18201)
* fix misspell

Signed-off-by: Xiang Dai <764524258@qq.com>

* clean white noise

Signed-off-by: Xiang Dai <764524258@qq.com>
2019-12-20 06:49:32 -08:00
Damini Satya dff2f7b960 Official 1.17 Release Docs (#18011)
* feat: graduate TaintNodesByCondition to GA (#17073)

* Promote StartupProbe to beta (enabled by default). (#17164)

* Watch bookmarks to GA (#17026)

* feat: graduate ScheduleDaemonSetPods to GA (#17350)

* Update Docker installation instructions (#17405)

* Use exact version numbers for installing Docker in Ubuntu (#17428)

* Move CSIMigration and CSIMigrationGCE to Beta in Kubernetes v1.17 (#17478)

* Promote NodeLease feature to GA (#17189)

* Update docs for csi topology ga (#17408)

* Update RunAsUsername to beta (#17460)

* doc:Update RunAsUsername to beta

* doc: update samples - kubernetes.io/os is no longer beta

* Updating based on review feedback

* Promote Node-specific volume limits to GA (#17432)

* Promote PodShareProcessNamespace to stable (#17192)

* Promote PodShareProcessNamespace to stable

* Add for_k8s_version to feature-state label

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Readd version-check to shareProcessNamespace task

* Update service load balancer finalizer doc for GA (#17438)

* Update Topology Manager docs (#17451)

* Added information on how device plugins can take advantage
of Topology Manager
* Updated the Topology Manager documentation to include additionalinformation and update some out of date sections

* Fix broken Topology Manager link (#17746)

Part of What's Next Device Plugin section

* Update CRD defaulting docs for GA (#17450)

* Add documentation for VolumeSnapshot Beta (#17233)

* Updating EndpointSlice documentation for beta release in 1.17 (#17411)

* (docs/dualstack): v1.17 updates (#17457)

* Add placehold doc updates for dualstack in 1.17

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Add Downward API and /etc/hosts Pod IP validation

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* remove addressed known issue via k/k pr 85246

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Remove known issue and add flag as part of k/k 79993

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* remove follow up placeholders

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update verbiage

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Make IP addressing consistent throughout the task

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update to status.podIPs

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update content/en/docs/tasks/network/validate-dual-stack.md

Use set instead of env

Co-Authored-By: Khaled Henidak (Kal) <khnidk@outlook.com>

* add topology.kubernetes.io/zone, topology.kubernetes.io/region and node.kubernetes.io/instance-type labels to docs (#17498)

Signed-off-by: Andrew Sy Kim <kiman@vmware.com>

* Service topology alpha documentation (#17459)

* Update list of feature flags for in-tree plugins migrated to CSI (#17533)

Signed-off-by: Deep Debroy <ddebroy@docker.com>

* Update Node concept for TaintNodesByCondition going GA (#17577)

* feat: graduate ResourceQuotaScopeSelectors to GA in 1.17 (#17554)

* kubeadm: update the upgrade documentation for 1.17 (#17587)

* doc: Simplify Windows deployments with RuntimeClass (#16697)

* doc: Simplify Windows deployments with RuntimeClass

* Updating on review feedback

* doc: Adding windows-build label from enhancement 1301

* update doc for kubelet option --reserved-cpus (#17648)

* feat: update TaintNodesByCondition in feature gates table (#17377)

* Update docs for v1 resource quota configuration (#17547)

* AdmissionConfiguration v1 (#17548)

* Update WebhookAdmissionConfiguration examples (#17549)

* Update AWS EBS Migration Feature state (#16126)

* Add resource version section to api-concepts documentation (#16910)

* Add Resource Version semantics section to api concepts

* Clarify risks of going back in time, add details about compaction and watch cache sizes

* Apply suggestions from liggitt

Co-Authored-By: Jordan Liggitt <jordan@liggitt.net>

* remove pesudocode, apply feedback

* Fix typo

* Clarify equality rules

* Cleanup kubectl generators docs (#17609)

* Write ReplicationController without a space

* Drop mentioning unsupported cluster versions

* Fix capitalization for “API group”

* Tweak wording

* Avoid using deprecated generator in example

* add Antrea description in dev-1.17 (#17919)

* Promote VolumeSubpathEnvExpansion to GA

* Reference Documentation for the Kubernetes API for 1.17 (#18019)

* Update feature-gates.md (#18033)

* Reference Documentation for kubectl Commands for 1.17 (#18017)

* Update for v1.17 (#18034)

* Update config.toml(release-1.17) for 1.17 (#18031)
2019-12-09 16:11:29 -08:00
Luzhenxing 87c5bd56b1 fix error url (#17651) 2019-11-19 00:15:41 -08:00
Alexey Pyltsyn f120439575 Improve Concepts section (#17013)
Signed-off-by: Alexey Pyltsyn <lex61rus@gmail.com>
2019-10-27 18:49:25 -07:00
houjun 170161b10e Fix the status of feature podResource (#16560) 2019-10-07 20:43:10 -07:00
Tim Bannister 322e88de9a Update device plugin documentation + related pages (#14331)
* Update device plugin docs for Kubernetes 1.14

& related pages

This change is mainly about feature-state shortcodes & similar.

(if there's a way to get the short version string, eg "1.14" rather
than "v1.14", then that could go in place of the hard coded value
in this commit).

* Fix code block formatting

eg code blocks incorrectly marked as:
```shell

* Use glossary shortcodes where appropriate

* Hyperlink to Prometheus

* Tidy Markdown formatting

* Change example vendor domain name

Use a name inside ".example" to highlight that this is a DNS
domain name.

* Reword device plugins documentation

* Tweak headings for device plugins

* Add "what's next" to device plugins docs

* Tweak wording for device plugins docs

* Add KubeVirt device plugins
2019-08-06 16:00:52 -07:00