Update get.go to use server-side printing #55637

juanvallejo · 2017-11-13T21:37:42Z

Addresses part of #58536
Adds support for server-side changes implemented in #40848 and updated in #59059

@deads2k per our discussion, opening this as a separate PR.
This wires through a per-request use of as=Table;... header parameters
using the resource builder from the kube get command.

Items to consider going forward:

Figure out how to handle sorting when dealing with multiple Table objects from the server
Figure out sorting when dealing with a mixed response from the server consisting of Tables and normal resources (--sort-by is handled in this PR by falling back to old behavior)
Filtering: How should we filter Table objects? Separate filter for rows? Filter on jsonpath? We have access to partial object metadata for each table row - not enough to know how to filter pods, for example but we could request that the original object be included along with each Table.Row by adding an includeObject param in the client request.

Resources that do not yet support Table output

Namespaces
Services
Service catalog resources: https://github.com/kubernetes-incubator/service-catalog/blob/master/pkg/apis/servicecatalog/v1beta1/types.go

Release note:

NONE

juanvallejo · 2017-11-13T21:40:50Z

pkg/kubectl/resource/helper.go

+		table := &metav1alpha1.Table{}
+		err := req.
+			AsTable(metav1.GroupVersion{}).
+			Do().Into(table)


@deads2k I'm thinking it'd be best to just have a codec that handles this, however I'm not too familiar with this part of the codebase: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/runtime/serializer/negotiated_codec.go#L34

deads2k · 2017-11-14T13:19:22Z

staging/src/k8s.io/client-go/rest/request.go

@@ -162,6 +163,26 @@ func (r *Request) Suffix(segments ...string) *Request {
 	return r
 }

+// AsTable adds the "as=Table;v=v1alpha1;g=meta.k8s.io" parameter to the Accept header


Note that this method is simply a pretty skin for SetHeader

deads2k · 2017-11-14T13:22:28Z

staging/src/k8s.io/client-go/rest/request.go

+	tableParam := fmt.Sprintf(";as=Table;v=%s;g=%s", gv.Version, gv.Group)
+
+	if len(r.content.AcceptContentTypes) > 0 {
+		r.SetHeader("Accept", r.content.AcceptContentTypes+tableParam)


Ah, it's not. It seems like we'll eventually want a way to add or set content types, but this could hold for a while.

deads2k · 2017-11-14T13:23:16Z

pkg/kubectl/resource/helper.go

@@ -63,7 +64,7 @@ func (m *Helper) Get(namespace, name string, export bool) (runtime.Object, error
 	return req.Do().Get()
 }

-func (m *Helper) List(namespace, apiVersion string, export bool, options *metav1.ListOptions) (runtime.Object, error) {
+func (m *Helper) List(namespace, apiVersion string, export, requestTable bool, options *metav1.ListOptions) (runtime.Object, error) {


You'll need this for Get too.

Thanks, wired it through to Get as well

No. Yuck. This should be a separate flag on Helper that changes the request type. We'll have other things we change to, like PartialObjectMetadata.

You also shouldn't have to be parsing into things, you just need to add the table type to the scheme

See c672a85#diff-92d4543eda898d1cb24544d3399bebb3R41 and c672a85#diff-1bc8485222e19c02f9aac7ecbc1cdfd6R50 for adding to the scheme

Regarding setting this, we should be transforming request like c672a85#diff-b5780bd984478baab9841efd2c817719R267

And then handling the presence of a Table gracefully in the returned get.go code.

deads2k · 2017-11-14T13:26:41Z

staging/src/k8s.io/client-go/rest/request.go

@@ -162,6 +163,26 @@ func (r *Request) Suffix(segments ...string) *Request {
 	return r
 }

+// AsTable adds the "as=Table;v=v1alpha1;g=meta.k8s.io" parameter to the Accept header
+func (r *Request) AsTable(gv metav1.GroupVersion) *Request {


@smarterclayton this looks like the correct spot to set the options, since I wouldn't want an entirely new client for one request. The rest of the pull seems to flow from here. In the builder, we could argue things like enum over bool and the like, but given how get.go works, we need to set the value from pkg/kubectl/resource/helper.go

I don't think request should know anything about Table. This should just be SetHeader, only higher levels know about Tables. PartialObjectMetadata will also come through this path and I don't want AsPartialObjectMetadata

fabianofranz · 2017-12-21T16:58:47Z

/unassign

soltysh · 2018-01-22T15:48:19Z

/assign

juanvallejo · 2018-01-30T15:54:40Z

@soltysh this has been rebased.
Intend to use it to implement client-side items from: #58536

soltysh · 2018-02-22T15:09:58Z

With a simple check like this (you'd need to add nice error handling):

   b := f.NewBuilder()....Flatten()

    clientset, _ := f.ClientSet()
    version, _ := clientset.Discovery().ServerVersion()
    minor, _ := strconv.Atoi(version.Minor)
    if minor > 10 {
        b = b.TransformRequests(func(req *rest.Request) {...}
    }
    r := b.Do()
...

this will work nicely with 1.8 and 1.7.

smarterclayton · 2018-02-22T16:10:06Z

Please don't do version checking like that.

If this is something we can backport to 1.8 (it's probably the fall through version checking) that's better.

soltysh · 2018-02-22T16:22:34Z

@smarterclayton we've discussed this in length during scrum, the 2 requests I've proposed is the way to go.

This patch adds support for the "server-side GET operation" introduced by pull/40848 and proposed by kubernetes/community#363.

soltysh

/lgtm

k8s-ci-robot · 2018-02-23T16:05:16Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: deads2k, juanvallejo, 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:

~~pkg/kubectl/OWNERS~~ [deads2k]
~~pkg/printers/OWNERS~~ [deads2k]

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

k8s-github-robot · 2018-02-23T17:45:26Z

/test all [submit-queue is verifying that this PR is safe to merge]

k8s-github-robot · 2018-02-23T17:49:34Z

Automatic merge from submit-queue (batch tested with PRs 55637, 57461, 60268, 60290, 60210). If you want to cherry-pick this change to another branch, please follow the instructions here.

k8s-ci-robot · 2018-02-23T18:14:19Z

@juanvallejo: The following test failed, say /retest to rerun them all:

Test name	Commit	Details	Rerun command
pull-kubernetes-unit	`9946374`	link	`/test pull-kubernetes-unit`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

smarterclayton · 2018-02-25T21:22:47Z

Sorting and printing should be using the table but with full objects returned via the print API (?includeObject=Object) and then doing the sort on nested, as should custom columns.

@soltysh

…nt-in-get Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. enable server-printing in tests **Release note**: ```release-note NONE ``` Depends on #55637 Separate pull to test the `--experimental-server-print` flag in test-cmd-util tests introduced in #55637 cc @soltysh

soltysh · 2018-02-26T12:07:31Z

@smarterclayton I've added a point about that to the general server side printing issue.

@smarterclayton

Automatic merge from submit-queue (batch tested with PRs 61842, 61477, 61777). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Turn server-print on by default in kubectl **What this PR does / why we need it**: #55637 introduced `-experimental-server-print` that enabled users to opt-in to user server-side printing. This is a followup which enables this functionality by default, with the ability to fallback not to do it with `--server-print=false`. /assign @smarterclayton @juanvallejo **Release note**: ```release-note Enable server-side print in kubectl by default, with the ability to turn it off with --server-print=false ```

juanvallejo changed the title ~~prototype use of tabular json response~~ [WIP] prototype use of tabular json response Nov 13, 2017

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 13, 2017

k8s-github-robot assigned sttts and wojtek-t Nov 13, 2017

juanvallejo commented Nov 13, 2017

View reviewed changes

sttts assigned fabianofranz, smarterclayton and deads2k and unassigned sttts Nov 14, 2017

deads2k reviewed Nov 14, 2017

View reviewed changes

k8s-github-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 19, 2017

juanvallejo mentioned this pull request Dec 5, 2017

ensure PrinterForCommand is consumed through cmdutil.Factory #54881

Merged

k8s-ci-robot unassigned fabianofranz Dec 21, 2017

k8s-ci-robot assigned soltysh Jan 22, 2018

juanvallejo mentioned this pull request Jan 22, 2018

Bringing server-side printing to beta summary #58536

Closed

16 tasks

juanvallejo force-pushed the jvallejo/kubectl-get-table-response-proto-v2 branch from cee04e7 to c6c4b79 Compare January 30, 2018 15:44

kubernetes deleted a comment from k8s-github-robot Jan 30, 2018

k8s-github-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 30, 2018

juanvallejo changed the title ~~[WIP] prototype use of tabular json response~~ prototype use of tabular json response Jan 30, 2018

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 Jan 30, 2018

juanvallejo force-pushed the jvallejo/kubectl-get-table-response-proto-v2 branch from 4879c87 to 55deab7 Compare February 22, 2018 15:13

juanvallejo force-pushed the jvallejo/kubectl-get-table-response-proto-v2 branch 3 times, most recently from 012804e to 50c30cd Compare February 22, 2018 16:55

smarterclayton mentioned this pull request Feb 23, 2018

Implement a stub server printer for CRDs #60269

Merged

juanvallejo force-pushed the jvallejo/kubectl-get-table-response-proto-v2 branch from 50c30cd to fc14bb8 Compare February 23, 2018 15:21

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 23, 2018

juanvallejo force-pushed the jvallejo/kubectl-get-table-response-proto-v2 branch 2 times, most recently from f9db9c1 to a21bb3f Compare February 23, 2018 15:32

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 23, 2018

juanvallejo mentioned this pull request Feb 23, 2018

enable server-printing in tests #60310

Merged

handle Table response in client

9946374

This patch adds support for the "server-side GET operation" introduced by pull/40848 and proposed by kubernetes/community#363.

juanvallejo force-pushed the jvallejo/kubectl-get-table-response-proto-v2 branch from a21bb3f to 9946374 Compare February 23, 2018 15:41

soltysh approved these changes Feb 23, 2018

View reviewed changes

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

k8s-github-robot merged commit 9116cb8 into kubernetes:master Feb 23, 2018

juanvallejo deleted the jvallejo/kubectl-get-table-response-proto-v2 branch February 23, 2018 19:04

juanvallejo mentioned this pull request Feb 28, 2018

Add missing table converters for server side printing #60580

Merged

soltysh mentioned this pull request Mar 21, 2018

Turn server-print on by default in kubectl #61477

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update get.go to use server-side printing #55637

Update get.go to use server-side printing #55637

juanvallejo commented Nov 13, 2017 •

edited

juanvallejo Nov 13, 2017

deads2k Nov 14, 2017

deads2k Nov 14, 2017

deads2k Nov 14, 2017

juanvallejo Nov 14, 2017

smarterclayton Jan 30, 2018

smarterclayton Jan 30, 2018

smarterclayton Jan 30, 2018

deads2k Nov 14, 2017

smarterclayton Jan 30, 2018

fabianofranz commented Dec 21, 2017

soltysh commented Jan 22, 2018

juanvallejo commented Jan 30, 2018

soltysh commented Feb 22, 2018 •

edited

smarterclayton commented Feb 22, 2018

soltysh commented Feb 22, 2018

soltysh left a comment

k8s-ci-robot commented Feb 23, 2018

k8s-github-robot commented Feb 23, 2018

k8s-github-robot commented Feb 23, 2018

k8s-ci-robot commented Feb 23, 2018 •

edited

smarterclayton commented Feb 25, 2018

soltysh commented Feb 26, 2018

Update get.go to use server-side printing #55637

Update get.go to use server-side printing #55637

Conversation

juanvallejo commented Nov 13, 2017 • edited

Items to consider going forward:

Resources that do not yet support Table output

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

fabianofranz commented Dec 21, 2017

soltysh commented Jan 22, 2018

juanvallejo commented Jan 30, 2018

soltysh commented Feb 22, 2018 • edited

smarterclayton commented Feb 22, 2018

soltysh commented Feb 22, 2018

soltysh left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 23, 2018

k8s-github-robot commented Feb 23, 2018

k8s-github-robot commented Feb 23, 2018

k8s-ci-robot commented Feb 23, 2018 • edited

smarterclayton commented Feb 25, 2018

soltysh commented Feb 26, 2018

juanvallejo commented Nov 13, 2017 •

edited

soltysh commented Feb 22, 2018 •

edited

k8s-ci-robot commented Feb 23, 2018 •

edited