Document extended resources and OIR deprecation. #5399

ConnorDoyle · 2017-09-12T00:12:08Z

Implemented here: kubernetes/kubernetes#48922

Already included in v1.8 release notes:

/sig scheduling

cc @davidopp @vishh

This change is

k8sio-netlify-preview-bot · 2017-09-12T00:13:50Z

Deploy preview ready!

Built with commit d6ded8a

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

balajismaniam · 2017-09-12T02:36:58Z

For future reviewers: https://deploy-preview-5399--kubernetes-io-vnext-staging.netlify.com/docs/concepts/configuration/manage-compute-resources-container

balajismaniam

Minor comments. Otherwise LGTM.

balajismaniam · 2017-09-12T02:41:24Z

docs/concepts/configuration/manage-compute-resources-container.md

@@ -305,6 +305,15 @@ where `OOM` stands for Out Of Memory.

 ## Opaque integer resources (Alpha feature)

+{% include feature-state-deprecated.md %}
+
+**Note:** Opaque Integer Resources will be removed in version 1.9.


Move this note below https://github.com/kubernetes/kubernetes.github.io/pull/5399/files?diff=unified#diff-4c9401ed6b037e1adb958cbce20630c7L321.

balajismaniam · 2017-09-12T02:43:48Z

docs/concepts/configuration/manage-compute-resources-container.md

+{: .note}
+
+There are two steps required to use Extended Resources. First, the
+cluster operator must advertise a per-node opaque resource on one or more


s/opaque/extended or s/opaque//

tengqm · 2017-09-12T02:46:05Z

docs/concepts/configuration/manage-compute-resources-container.md

+curl --header "Content-Type: application/json-patch+json" \
+--request PATCH \
+--data '[{"op": "add", "path": "/status/capacity/example.com~1foo", "value": "5"}]' \
+http://k8s-master:8080/api/v1/nodes/k8s-node-1/status


the '/status' part should be removed?

@ConnorDoyle
I think at least 50% common user do not know how to config OIR or Extended Resouce by curl quickly. So remaining it is very necessary. I meet many users ask how to config OIR, so I add it in OIR docs. =)

@tengqm the URL shown is the correct way to patch the node status.

tengqm · 2017-09-12T03:00:30Z

docs/concepts/configuration/manage-compute-resources-container.md

+    "value": "5"
+  }
+]
+```


This http request detail is not strictly necessary because the following Shell command already covers all necessary information. So ... I'd suggest we remove it.

OK, should we remove the similar one from the OIR section above too?

If there is no meat in it, better throw it away IMO.

I suggest to remain it. It's very important for usual users.
I can help user to config this kind of resource though shell.

@zhangxiaoyu-zidif The snippet above is not a JSON or an YAML for you to create resource from Shell. It is an explanation of the HTTP request internals, and the information is duplicated with the command below.

Sorry to misunderstand your response. The command below is necessary. And the above one can be remove. It has no meaning to common users. But the below shell command is useful. =)

My historical note is that I first added the HTTP request, then reviewers asked for a curl equivalent. Guess the rationale is that the K8s API speaks HTTP and not curl. But I'm apparently in the minority here. Will remove both of them.

tengqm · 2017-09-12T03:12:49Z

docs/concepts/configuration/manage-compute-resources-container.md

+[IETF RFC 6901, section 3](https://tools.ietf.org/html/rfc6901#section-3).
+{: .note}
+
+To consume an Extended Resource in a Pod, include the resource name as a key


better be explicit here: .. include the resource name example.com/foo as a key ...

I meant this sentence to be more general than the specific resource from the example. Did that not come across? This is the second of two steps required to use ERs. The previous section began with "To advertise a new Extended Resource..."

Alright, if it is referring to general cases, i.e. "an Extended Resource", it is fine.
I was reading it as "the Extended Resource".

ConnorDoyle · 2017-09-12T05:24:41Z

docs/concepts/configuration/manage-compute-resources-container.md

@@ -316,6 +325,7 @@ available amount is simultaneously allocated to Pods.
 **Note:** Opaque integer resources are Alpha in Kubernetes version 1.5.


I think we can drop this note entirely now.

ConnorDoyle · 2017-09-12T14:31:34Z

cc @steveperry-53 (this should go in v1.8 docs)

ConnorDoyle · 2017-09-12T15:12:17Z

@tengqm updated, PTAL

vishh · 2017-09-12T18:23:33Z

/lgtm

zacharysarah · 2017-09-12T19:19:04Z

@ConnorDoyle 👋 Do you want to wait for a LGTM from @tengqm before merging?

EDIT: This looks good to me! 😄

ConnorDoyle · 2017-09-12T19:27:13Z

Not sure, what's the normal protocol? I think I changed all of the things mentioned by @tengqm, would be OK with making other changes in follow-ups if needed.

steveperry-53 · 2017-09-12T21:20:33Z

Added Tech Review LGTM based on lgtm by vish. Might want to wait a bit for @tengqm to chime in.
@zacharysarah, I'll leave that up to you.

zacharysarah · 2017-09-12T22:21:35Z

@steveperry-53 Agreed, let's give @tengqm a chance to respond. 👍

tengqm

Thanks.

ConnorDoyle · 2017-09-12T23:43:22Z

@tengqm thanks! let's land it 👍

@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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 12, 2017

k8s-github-robot assigned zacharysarah Sep 12, 2017

ConnorDoyle mentioned this pull request Sep 12, 2017

Opaque integer resources kubernetes/enhancements#76

Closed

22 tasks

Document extended resources and OIR deprecation.

31794d3

balajismaniam reviewed Sep 12, 2017

View reviewed changes

tengqm requested changes Sep 12, 2017

View reviewed changes

ConnorDoyle commented Sep 12, 2017

View reviewed changes

Updated extended resources doc per reviews.

d6ded8a

k8s-ci-robot assigned vishh Sep 12, 2017

k8s-ci-robot added the lgtm label Sep 12, 2017

zacharysarah added the Docs LGTM label Sep 12, 2017

steveperry-53 added the Tech Review LGTM label Sep 12, 2017

tengqm approved these changes Sep 12, 2017

View reviewed changes

steveperry-53 merged commit 6dcb9d4 into kubernetes:release-1.8 Sep 13, 2017

steveperry-53 added this to the 1.8 milestone Sep 13, 2017

ConnorDoyle deleted the extended-resources branch September 13, 2017 22:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document extended resources and OIR deprecation. #5399

Document extended resources and OIR deprecation. #5399

ConnorDoyle commented Sep 12, 2017 •

edited by k8s-reviewable

Loading

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

edited

Loading

balajismaniam commented Sep 12, 2017

balajismaniam left a comment

balajismaniam Sep 12, 2017

balajismaniam Sep 12, 2017

tengqm Sep 12, 2017

zhangxiaoyu-zidif Sep 12, 2017

ConnorDoyle Sep 12, 2017

tengqm Sep 12, 2017

ConnorDoyle Sep 12, 2017

tengqm Sep 12, 2017

zhangxiaoyu-zidif Sep 12, 2017

tengqm Sep 12, 2017

zhangxiaoyu-zidif Sep 12, 2017

ConnorDoyle Sep 12, 2017

tengqm Sep 12, 2017

ConnorDoyle Sep 12, 2017

tengqm Sep 12, 2017

ConnorDoyle Sep 12, 2017

tengqm Sep 12, 2017

ConnorDoyle commented Sep 12, 2017

ConnorDoyle commented Sep 12, 2017

vishh commented Sep 12, 2017

zacharysarah commented Sep 12, 2017 •

edited

Loading

ConnorDoyle commented Sep 12, 2017

steveperry-53 commented Sep 12, 2017

zacharysarah commented Sep 12, 2017

tengqm left a comment

ConnorDoyle commented Sep 12, 2017

		@@ -316,6 +325,7 @@ available amount is simultaneously allocated to Pods.
		Note: Opaque integer resources are Alpha in Kubernetes version 1.5.

Document extended resources and OIR deprecation. #5399

Document extended resources and OIR deprecation. #5399

Conversation

ConnorDoyle commented Sep 12, 2017 • edited by k8s-reviewable Loading

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

balajismaniam commented Sep 12, 2017

balajismaniam 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ConnorDoyle commented Sep 12, 2017

ConnorDoyle commented Sep 12, 2017

vishh commented Sep 12, 2017

zacharysarah commented Sep 12, 2017 • edited Loading

ConnorDoyle commented Sep 12, 2017

steveperry-53 commented Sep 12, 2017

zacharysarah commented Sep 12, 2017

tengqm left a comment

Choose a reason for hiding this comment

ConnorDoyle commented Sep 12, 2017

ConnorDoyle commented Sep 12, 2017 •

edited by k8s-reviewable

Loading

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

edited

Loading

zacharysarah commented Sep 12, 2017 •

edited

Loading