add server-side print docs #7671

juanvallejo · 2018-03-07T19:44:55Z

Add docs for kubernetes/enhancements#515

@smarterclayton
Is server-side print on by default? (i.e. no feature gate to document here https://kubernetes.io/docs/reference/feature-gates/ ?)

cc @smarterclayton @soltysh

k8sio-netlify-preview-bot · 2018-03-07T19:46:35Z

Deploy preview for kubernetes-io-vnext-staging ready!

Built with commit 8596fc7

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

juanvallejo · 2018-03-07T19:59:30Z

/milestone v1.10

bradtopol · 2018-03-07T20:11:02Z

I went ahead and marked this do-not-merge/work-in-progress. Thanks for your contributions!

juanvallejo · 2018-03-07T21:51:31Z

@smarterclayton @bradtopol this should be ready for review. Thanks

tengqm · 2018-03-08T09:11:36Z

docs/reference/api-concepts.md

+Accept: application/json;as=Table;v=meta.k8s.io;g=v1beta1, application/json
+```
+
+


Who are the audiences for this content? Client tool developers? Integration solution developers? kubectl users?

API consumers.

tengqm · 2018-03-08T09:15:00Z

docs/reference/kubectl/overview.md

@@ -192,6 +192,29 @@ NAME           RSRC
 submit-queue   610995
 ```

+#### Server-side columns
+
+`kubectl` supports receiving specific column information from the server about objects.


Why kubectl users need to care about this?

In the near future this will be the default and only way of interacting with the server. We're putting it here to gather feedback about the feature, especially the inconsistencies between the current behavior of kubectl.

soltysh · 2018-03-08T10:57:44Z

docs/reference/api-concepts.md

+
+For API resource types that do not have a custom Table definition on the server, a default Table response is returned by the server, consiting of the resource's NAME and AGE.
+
+        GET /apis/crd.example.com/v1alpha1/namespaces/default/resources


Change this to look similarly to the above example. Here we're discussing api concepts, so it's not good to show kubectl output.

soltysh · 2018-03-08T10:58:19Z

docs/reference/api-concepts.md

+        NAME          AGE
+        crd-object    1m
+
+Not all API resource types will support a Table response, specifically when using a client against older clusters. Clients that must work against all resource types, and can potentially deal with older clusters, should specify multiple content types in their `Accept` header to support fallback to non-Tabular JSON:


I'd explicitly mention this feature is 1.10+.

soltysh · 2018-03-08T11:00:37Z

docs/reference/kubectl/overview.md

+This allows for consistent human-readable output across clients used against the same cluster, by having the server encapsulate the details of printing.
+
+All functionality of the `get` command is unaffected by using this feature.
+Clients are still able to return sorted output, perform template printing, print custom-columns, etc.


This is too bold of a statement, we're actually discussing changing this so I'd drop both of these sentences.

soltysh · 2018-03-08T11:02:55Z

Is server-side print on by default? (i.e. no feature gate to document here https://kubernetes.io/docs/reference/feature-gates/ ?)

Yes, there's no knob, iirc.

Bradamant3 · 2018-03-08T14:51:11Z

/assign

juanvallejo · 2018-03-08T19:41:08Z

@soltysh thanks, review comments addressed

Bradamant3 · 2018-03-08T20:38:52Z

/approve
@soltysh if you could check changes and add an /lgtm, we can get this one merged. Thanks!

juanvallejo · 2018-03-09T16:43:23Z

@soltysh @smarterclayton friendly ping

soltysh · 2018-03-09T17:04:37Z

/lgtm

k8s-ci-robot · 2018-03-09T17:04:46Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bradamant3, soltysh

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:

~~docs/reference/api-concepts.md~~ [Bradamant3]
~~docs/reference/kubectl/overview.md~~ [Bradamant3]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* 1.10 update (#7151) * Fix partition value expected behaviour explanation (#7123) Fixes issue #7057 * Correct "On-Premise" to "On-Premises" * Updates the Calico installation page (#7094) * All files for Haufe Groups case study (#7051) * Fix typo (#7127) * fix typo of device-plugins.md (#7106) * fix broken links (#7136) * Updated configure-service-account (#7147) Error from server resolved by escaping kubectl patch serviceaccount default -p '{"imagePullSecrets": [{"name": "myregistrykey"}]}' JSON string by '\' * Remove docs related to 'require-kubeconfig' (#7138) With kubernetes/kubernetes#58367 merged, v1.10 will not use the "require-kubeconfig" flag. The flag has become a no-op solely to ensure existing deployments won't break. * Added Verification Scenario for a Pod that Uses a PVC in Terminating State (#7164) The below PR: kubernetes/kubernetes#55873 modified scheduler in such a way that scheduling of a pod that uses a PVC in Terminating state fails. That's why verification of such scenario was added to documentation. * fix LimitPodHardAntiAffinityTopology name (#7221) * Document the removal of the KubeletConfigFile feature gate (#7140) With kubernetes/kubernetes#58978 merged, the said feature gate is removed. This PR removes texts related to the gate and revises the Feature Gates reference to reflect this change. * deprecate three admission controller (#7363) * Document the removal of Accelerators feature gate (#7389) The `Accelerators` feature gate will be removed in 1.11. 1.10 will be its last mile. References: kubernetes/kubernetes#57384 * Update local storage docs for beta (#7473) * Document that HugePages feature gate is Beta (#7387) The `HugePages` feature gate has graduated to Beta in v1.10. This PR documents this fact. * Add HyperVContainer feature gates (#7502) * Remove the beta reference from Taints and Tolerations doc (#7493) * Kms provider doc (#7479) * Kms provider doc * issue# 7399, Create KMS-provider.md and update encrypt-data.md * address review comments * Document that Device Plugin feature is Beta (1.10) (#7512) * Add docs for CRD features for 1.10 (#7439) * Add docs for CRD features for 1.10 * Add CustomResourcesSubresources to list of feature gates * Add latest changes to custom resources doc * Add crds as abbreviated alias (#7437) * Bring PVC Protection Feature to Beta (#7165) * Bring PVC Protection Feature to Beta The PR: kubernetes/kubernetes#59052 brought PVC Protection feature to beta. That's why the documentation is updated accordingly. * The PVC Protection feature was renamed to Storage Protection. That's why the documentation is updated. * promote PodNodeSelector to stable; document detailed behavior (#7134) * promote PodNodeSelector to stable; document detailed behavior * respond to feedback * Update CPU manager feature enabling (#7390) With `CPUManager` feature graduating to beta. No explicit enabling is required starting v1.10. References: kubernetes/kubernetes#55977 * Adding block volumeMode documentation for local volumes. (#7531) Code review comments. Changed property to field. Address tech review comment. * remove description kubectl --show-all (#7574) --show-all has been deprecated and set to true by default. kubernetes/kubernetes#60210 * fix description about contribute style guide (#7592) * fix description about KUBECONFIG (#7589) s/envrionment/environment * fix description about cni (#7588) s/simultanously/simultaneously/ * fix description about MutatingAdmissionWebhook and ValidatingAdmissionWebhook (#7587) * fix description about persistent volume binding (#7590) s/slighty/slightly/ * Doc change for configurable pod resolv.conf Beta (#7611) * fix description about out of resource handling (#7597) s/threshhold/threshold * fix description about zookeeper (#7598) s/achive/achieve * fix description about kubeadm (#7594) s/compatability/compatibility/ * fix description about kubeadm (#7593) * fix description about kubeadm implementation details (#7595) * fix description about api concepts (#7596) * Storage Protection was renamed to Storage Object in Use Protection (#7576) * Storage Protection was renamed to Storage Object in Use Protection The K8s PR: kubernetes/kubernetes#59901 renamed Storage Protection to Storage Object in Use Protection. That's why the same is also renamed in the documentation. * Moved Storage Object in Use Protection admission plugin description down according to alphabetic order. * Use PSP from policy API group. (#7562) * update kubeletconfig docs for v1.10, beta (#7561) * Update port-forwarding docs (#7575) * add pv protection description (#7620) * fix description about client library (#7634) * Add docs on configuring NodePort IP (#7631) * Document that LocalStorageCapacityIsolation is beta (#7635) A follow-up to the kubernetes/kubernetes#60159 change which has promoted the `LocalStorageCapacityIsolation` feature gate to Beta. * Update CoreDNS docs for beta (#7638) * Update CoreDNS docs for beta * Review comments * Fix typo (#7640) * Update feature gates move to beta (#7662) * Added the inability to use colon ':' character as environment variable names and described workaround (#7657) * merge master to 1.10, with fixes (#7682) * Flag names changed (s/admission-control/enable-admission-plugins); disable-admissions-plugin entry added; removed reference to admission controller/plugins requiring set order (for v1.10), redundant example enabling specific plugin, and redundant version-specific info (#7449) * Documentation for MountPropagation beta (#7655) * Remove job's scale-related operations (#7684) * authentication: document client-go exec plugins (#7648) * authentication: document client-go exec plugins * Update authentication.md * Update local ephemeral storage feature to beta (#7685) Update local ephemeral storage feature to beta * Update docs for windows container resources (#7653) * add server-side print docs (#7671) * Create a task describing Pod process namespace sharing (#7489) * Add external metrics to HPA docs (#7664) * Add external metrics to HPA docs * Update horizontal-pod-autoscale-walkthrough.md * Apply review comments to HPA walkthrough * remove description about "scale jobs" (#7712) * CSI Docs for K8s v1.10 (#7698) * Add a warning about increased memory consumption for audit logging feature. (#7725) Signed-off-by: Mik Vyatskov <vmik@google.com> * Update Audit Logging documentation for 1.10 (#7679) Signed-off-by: Mik Vyatskov <vmik@google.com> * Fix stage names in audit logging documentation (#7746) Signed-off-by: Mik Vyatskov <vmik@google.com> * Feature gate update for release 1.10 (#7742) * State in the docs that the value of default Node labels are not reliable. (#7794) * Kill the reference to --admission-control option (#7755) The `--admission-control` option has been replaced by two new options in v1.10. This PR kills the last appearance of the old option in the doc. * Pvcprotection toc (#7807) * Refreshing installation instructions (#7495) * Refreshing installation instructions Added conjure-up. Updated displays and juju versions to current versions. * Updated anchors * Fixed image value version typo (#7768) Was inconsistent with other values * Update flocker reference to the github repo (#7784) * Fix typo in federation document (#7779) * an user -> a user (#7778) * Events are namespaced (#7767) * fix 'monitoring' link lose efficacy problem' (#7764) * docs/concepts/policy/pod-security-policy.md: minor fix. (#7659) * Update downward-api-volume-expose-pod-information.md (#7771) * Update downward-api-volume-expose-pod-information.md The pod spec puts the downward api files into /etc/podinfo, not directly in /etc. Updated docs to reflect this fact. * Update downward-api-volume-expose-pod-information.md One more spot needed fixing. * Update downward-api-volume-expose-pod-information.md Yet another fix, in the container example. * Add Amadeus Case Study (#7783) * Add Amadeus Case Study * add Amadeus logo * Fixed Cyrillic с in 'kube-proxy-cm' (#7787) There was a typo (wrong character) in kube-proxy-cm.yaml - Cyrillic с (UTF-8 0x0441) was used instead of Latin c. * install-kubectl: choose one installation method (#7705) The previous text layout suggested that all installations had to be done, one after another. * Update install-kubeadm.md (#7781) Add note to kubeadm install instruction to help install in other arch i.e. aarch64, ppc64le etc. * repair failure link (#7788) * repair failure link * repair failure link * do change as required * Update k8s201.md (#7777) * Update k8s201.md Change instructions to download yams files directly from the website (as used in other pages.) Added instructions to delete labeled pod to avoid warnings in the subsequent deployment step. * Update k8s201.md Added example of using the exposed host from the a node running Kubernetes. (This works on AWS with Weave; not able to test it on other variations...) * Gramatical fix to kompose introduction (#7792) The original wording didn't through very well. As much of the original sentence has been preserved as possible, primarily to ensure the kompose web address is see both in text and as a href link. * update amadeus.html (#7800) * Fix a missing word in endpoint reconciler section (#7804) * add toc entry for pvcprotection downgrade issue doc * Pvcprotection toc (#7809) * Refreshing installation instructions (#7495) * Refreshing installation instructions Added conjure-up. Updated displays and juju versions to current versions. * Updated anchors * Fixed image value version typo (#7768) Was inconsistent with other values * Update flocker reference to the github repo (#7784) * Fix typo in federation document (#7779) * an user -> a user (#7778) * Events are namespaced (#7767) * fix 'monitoring' link lose efficacy problem' (#7764) * docs/concepts/policy/pod-security-policy.md: minor fix. (#7659) * Update downward-api-volume-expose-pod-information.md (#7771) * Update downward-api-volume-expose-pod-information.md The pod spec puts the downward api files into /etc/podinfo, not directly in /etc. Updated docs to reflect this fact. * Update downward-api-volume-expose-pod-information.md One more spot needed fixing. * Update downward-api-volume-expose-pod-information.md Yet another fix, in the container example. * Add Amadeus Case Study (#7783) * Add Amadeus Case Study * add Amadeus logo * Fixed Cyrillic с in 'kube-proxy-cm' (#7787) There was a typo (wrong character) in kube-proxy-cm.yaml - Cyrillic с (UTF-8 0x0441) was used instead of Latin c. * install-kubectl: choose one installation method (#7705) The previous text layout suggested that all installations had to be done, one after another. * Update install-kubeadm.md (#7781) Add note to kubeadm install instruction to help install in other arch i.e. aarch64, ppc64le etc. * repair failure link (#7788) * repair failure link * repair failure link * do change as required * Update k8s201.md (#7777) * Update k8s201.md Change instructions to download yams files directly from the website (as used in other pages.) Added instructions to delete labeled pod to avoid warnings in the subsequent deployment step. * Update k8s201.md Added example of using the exposed host from the a node running Kubernetes. (This works on AWS with Weave; not able to test it on other variations...) * Gramatical fix to kompose introduction (#7792) The original wording didn't through very well. As much of the original sentence has been preserved as possible, primarily to ensure the kompose web address is see both in text and as a href link. * update amadeus.html (#7800) * Fix a missing word in endpoint reconciler section (#7804) * add toc entry for pvcprotection downgrade issue doc * revert TOC change * Release 1.10 (#7818) * Refreshing installation instructions (#7495) * Refreshing installation instructions Added conjure-up. Updated displays and juju versions to current versions. * Updated anchors * Fixed image value version typo (#7768) Was inconsistent with other values * Update flocker reference to the github repo (#7784) * Fix typo in federation document (#7779) * an user -> a user (#7778) * Events are namespaced (#7767) * fix 'monitoring' link lose efficacy problem' (#7764) * docs/concepts/policy/pod-security-policy.md: minor fix. (#7659) * Update downward-api-volume-expose-pod-information.md (#7771) * Update downward-api-volume-expose-pod-information.md The pod spec puts the downward api files into /etc/podinfo, not directly in /etc. Updated docs to reflect this fact. * Update downward-api-volume-expose-pod-information.md One more spot needed fixing. * Update downward-api-volume-expose-pod-information.md Yet another fix, in the container example. * Add Amadeus Case Study (#7783) * Add Amadeus Case Study * add Amadeus logo * Fixed Cyrillic с in 'kube-proxy-cm' (#7787) There was a typo (wrong character) in kube-proxy-cm.yaml - Cyrillic с (UTF-8 0x0441) was used instead of Latin c. * install-kubectl: choose one installation method (#7705) The previous text layout suggested that all installations had to be done, one after another. * Update install-kubeadm.md (#7781) Add note to kubeadm install instruction to help install in other arch i.e. aarch64, ppc64le etc. * repair failure link (#7788) * repair failure link * repair failure link * do change as required * Update k8s201.md (#7777) * Update k8s201.md Change instructions to download yams files directly from the website (as used in other pages.) Added instructions to delete labeled pod to avoid warnings in the subsequent deployment step. * Update k8s201.md Added example of using the exposed host from the a node running Kubernetes. (This works on AWS with Weave; not able to test it on other variations...) * Gramatical fix to kompose introduction (#7792) The original wording didn't through very well. As much of the original sentence has been preserved as possible, primarily to ensure the kompose web address is see both in text and as a href link. * update amadeus.html (#7800) * Fix a missing word in endpoint reconciler section (#7804) * Partners page updates (#7802) * Partners page updates * Update to ZTE link * Make using sysctls a task instead of a concept (#6808) Closes: #4505 * add a note when mount a configmap to pod (#7745) * adjust a note format (#7812) * Update docker-cli-to-kubectl.md (#7748) * Update docker-cli-to-kubectl.md Edited the document for adherence to the style guide and word usage. * Update docker-cli-to-kubectl.md * Incorporated the changes suggested. * Mount propagation update to include docker config (#7854) * update overridden config for 1.10 (#7847) * update overridden config for 1.10 * fix config file per comments * Update Extended Resource doc wrt cluster-level resources (#7759)

juanvallejo force-pushed the add-server-side-print-docs branch from a02eeb2 to e0a8f30 Compare March 7, 2018 19:44

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 7, 2018

k8s-ci-robot requested review from xiangpengzhao and zhangxiaoyu-zidif March 7, 2018 19:45

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 7, 2018

juanvallejo force-pushed the add-server-side-print-docs branch 2 times, most recently from 6bfce07 to 60637c3 Compare March 7, 2018 19:51

bradtopol self-requested a review March 7, 2018 20:09

bradtopol added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 7, 2018

bradtopol self-assigned this Mar 7, 2018

juanvallejo force-pushed the add-server-side-print-docs branch from 60637c3 to d243048 Compare March 7, 2018 21:44

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 7, 2018

juanvallejo force-pushed the add-server-side-print-docs branch from d243048 to 0ef1c0e Compare March 7, 2018 21:49

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 Mar 7, 2018

tengqm reviewed Mar 8, 2018

View reviewed changes

soltysh suggested changes Mar 8, 2018

View reviewed changes

Bradamant3 added this to the 1.10 milestone Mar 8, 2018

k8s-ci-robot assigned Bradamant3 Mar 8, 2018

add server-side print docs

8596fc7

juanvallejo force-pushed the add-server-side-print-docs branch from 0ef1c0e to 8596fc7 Compare March 8, 2018 19:40

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 8, 2018

k8s-ci-robot assigned soltysh Mar 9, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 9, 2018

soltysh approved these changes Mar 9, 2018

View reviewed changes

k8s-ci-robot merged commit 5ffc1e2 into kubernetes:release-1.10 Mar 9, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add server-side print docs #7671

add server-side print docs #7671

juanvallejo commented Mar 7, 2018 •

edited

Loading

k8sio-netlify-preview-bot commented Mar 7, 2018 •

edited

Loading

juanvallejo commented Mar 7, 2018

bradtopol commented Mar 7, 2018

juanvallejo commented Mar 7, 2018

tengqm Mar 8, 2018 •

edited

Loading

soltysh Mar 8, 2018

tengqm Mar 8, 2018

soltysh Mar 8, 2018

soltysh Mar 8, 2018

soltysh Mar 8, 2018

soltysh Mar 8, 2018

soltysh commented Mar 8, 2018

Bradamant3 commented Mar 8, 2018

juanvallejo commented Mar 8, 2018

Bradamant3 commented Mar 8, 2018

juanvallejo commented Mar 9, 2018

soltysh commented Mar 9, 2018

k8s-ci-robot commented Mar 9, 2018

		Accept: application/json;as=Table;v=meta.k8s.io;g=v1beta1, application/json
		```


		For API resource types that do not have a custom Table definition on the server, a default Table response is returned by the server, consiting of the resource's NAME and AGE.

		GET /apis/crd.example.com/v1alpha1/namespaces/default/resources

add server-side print docs #7671

add server-side print docs #7671

Conversation

juanvallejo commented Mar 7, 2018 • edited Loading

k8sio-netlify-preview-bot commented Mar 7, 2018 • edited Loading

juanvallejo commented Mar 7, 2018

bradtopol commented Mar 7, 2018

juanvallejo commented Mar 7, 2018

tengqm Mar 8, 2018 • edited Loading

Choose a reason for hiding this comment

soltysh Mar 8, 2018

Choose a reason for hiding this comment

tengqm Mar 8, 2018

Choose a reason for hiding this comment

soltysh Mar 8, 2018

Choose a reason for hiding this comment

soltysh Mar 8, 2018

Choose a reason for hiding this comment

soltysh Mar 8, 2018

Choose a reason for hiding this comment

soltysh Mar 8, 2018

Choose a reason for hiding this comment

soltysh commented Mar 8, 2018

Bradamant3 commented Mar 8, 2018

juanvallejo commented Mar 8, 2018

Bradamant3 commented Mar 8, 2018

juanvallejo commented Mar 9, 2018

soltysh commented Mar 9, 2018

k8s-ci-robot commented Mar 9, 2018

juanvallejo commented Mar 7, 2018 •

edited

Loading

k8sio-netlify-preview-bot commented Mar 7, 2018 •

edited

Loading

tengqm Mar 8, 2018 •

edited

Loading