feature(service describe): Output of service details by rhuss · Pull Request #252 · knative/client

rhuss · 2019-07-09T14:23:07Z

kn service describe mimics kubectl describe <sth> as that it output detail information in human-readable output. It also adds the possibility to print the service in machine-readable output e.g. via -o yaml. This is a difference to kubectl describe but necessary as kn list -o yaml will always print a list, not a single object. You can get the single object now with kn describe -o yaml, which also makes for a clear separation between list operations (multiple entities always) and single entity operation (one entity only). Hopefully, this is less confusing than kubectl get operation which has either list or single entity output depending on arguments.

This command shows information about the service itself, but also a summary of the associated revisions.

kn service describe has the following features:

Show basic info like
- name
- namespace
- external and internal URLs
- age
- annotations and labels of the service itself (shortened)
Shows the list of attached revisions which gets traffic
- name
- traffic split percentage
- image name
- configuration generation when created
- environment variables (shortened)
- scale (min ... max)
- concurrency options
- resource requests and limits
- age
With --details more information can be printed:
- annotation, labels, and envs are not shortened but all are printed
- image digest is shown for revisions
- all revisions are shown, not only those getting traffic
Machine-readable output with -o yaml|json|... or --template of this single service

This PR is a subset of and replacement for #75. There is no color option included nor any hipster stuff 🤓

Examle output

kn service describe hello

Name:         hello
Namespace:    default
URL:          http://hello.default.example.com
Address:      http://hello.default.svc.cluster.local
Annotations:  serving.knative.dev/creator=minikube-user, serving.knative.dev/lastModifier=minikube-user
Age:          1h

Revisions:
  100%  Name:   hello-tw5ds [3] (1h)
        Image:  gcr.io/knative-samples/helloworld-go
        Env:    hello=world, foo=bar
        Scale:  0 ... 10
        Memory: 50 Mb ... 100 Mb

Conditions:
  OK TYPE                   AGE REASON
  ++ ConfigurationsReady     1h
  ++ Ready                   1h
  ++ RoutesReady             1h

kn service describe hello --details

Name:         hello
Namespace:    default
URL:          http://hello.default.example.com
Address:      http://hello.default.svc.cluster.local
Annotations:  serving.knative.dev/creator=minikube-user
              serving.knative.dev/lastModifier=minikube-user
Age:          4m

Revisions:
  100%  Name:   hello-tw5ds [3] (16s)
        Image:  gcr.io/knative-samples/helloworld-go (5ea96ba4b872)
        Env:    hello=world
                foo=bar
        Scale:  0 ... 10
     -  Name:   hello-nc8xz [2] (3m)
        Image:  gcr.io/knative-samples/helloworld-go (5ea96ba4b872)
        Env:    hello=world
                foo=bar
     -  Name:   hello-fkl6l [1] (4m)
        Image:  gcr.io/knative-samples/helloworld-go (5ea96ba4b872)

Conditions:
  OK TYPE                   AGE REASON
  ++ ConfigurationsReady    13s
  ++ Ready                  13s
  ++ RoutesReady            13s

rhuss · 2019-07-25T07:28:38Z

@sixolet @cppforlife @maximilien All features are now implemented, please have a look at the updated issue description for all data that is shown. The focus was to show everything which also can be provided with kn service create as options.

What is missing is the unit test. However, because it really depends highly on the output to be shown I wanted to wait for first feedback if the current format is ok.

I would then also do the unit tests on then KnClient level, i.e. using a mock implementation of the KnClient interface (which needs to be introduced). Or is this something which we should leave for another PR? (this one is already huge). In that case, I would make a simplified test here (to keep the code coverage test happy), and work on another PR for the full coverage including mock support for KnClient.

`kn service show` mimics `kubectl describe <sth>` as that it output detail information in human readable output. A future extension should add machine readable output with `-o` to export a single object in json/yaml (that is missing from `kn service list`) This command shows information about the service itself, but also a summary about the associated revisions. It also knows about scaling and concurrency options. Options: `--details` : Print more information. By default only are shorter summary is shown

…be")

…) + machine readable output with -o

rhuss · 2019-08-07T06:01:20Z

/retest

rhuss · 2019-08-07T16:32:06Z

@sixolet @cppforlife @maximilien @navidshaikh Uff, finally I think the PR is ready for prime time. Some tests have been added (coverage 84%), please have another look at the PR. 'would be super awesome to get it merged until Friday before I head off to PTO and the PR would lie around for another three weeks.

navidshaikh

I think this is good to go.

navidshaikh · 2019-08-07T21:00:49Z


 	// Testing:
-	output, err := executeCommand(client, "create", "foo", "--image", "gcr.io/foo/bar:baz")
+	output, err := executeServiceCommand(client, "create", "foo", "--image", "gcr.io/foo/bar:baz")


navidshaikh · 2019-08-07T21:03:58Z

+	cmd.SetArgs(args)
+	cmd.SetOutput(output)
+	err := cmd.Execute()
+	return output.String(), err


I like this order. ❤️

navidshaikh · 2019-08-08T08:29:15Z

/lint

knative-prow-robot

@navidshaikh: 15 warnings.

Details

In response to this:

/lint

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.

knative-metrics-robot · 2019-08-08T09:37:46Z

The following is the coverage report on pkg/.
Say /test pull-knative-client-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/kn/commands/service/service_describe.go	78.3%	85.2%	6.9
pkg/serving/v1alpha1/client.go	86.0%	86.0%	-0.0
pkg/serving/v1alpha1/client_mock.go	96.0%	96.8%	0.8

rhuss · 2019-08-08T10:09:05Z

/lint

knative-prow-robot

@rhuss: 0 warnings.

Details

In response to this:

/lint

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.

navidshaikh

Looks good to me, thanks Roland for working on multiple rounds for this feature 👍

knative-prow-robot · 2019-08-08T10:33:21Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: navidshaikh, rhuss

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [navidshaikh,rhuss]

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

navidshaikh · 2019-08-08T15:23:35Z

/lgtm

googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Jul 9, 2019

knative-prow-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 9, 2019

knative-prow-robot requested review from evankanderson and mattmoor July 9, 2019 14:23

knative-prow-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 9, 2019

mattmoor removed their request for review July 10, 2019 00:57

rhuss changed the title ~~feature(service show): Output of service details~~ feature(service show): Output of service details [vanilla] Jul 10, 2019

navidshaikh reviewed Jul 15, 2019

View reviewed changes

Comment thread pkg/printers/prefixwriter.go Outdated

Comment thread pkg/kn/commands/service/service_show.go Outdated

Comment thread pkg/kn/commands/service/service_show.go Outdated

rhuss force-pushed the pr/svc-show-1 branch from ce28302 to 1a8e11b Compare July 16, 2019 15:27

rhuss added this to the v0.8.0 milestone Jul 16, 2019

cppforlife reviewed Jul 22, 2019

View reviewed changes

Comment thread test/e2e/service_options_test.go Outdated

cppforlife reviewed Jul 22, 2019

View reviewed changes

Comment thread go.sum Outdated

rhuss changed the title ~~feature(service show): Output of service details [vanilla]~~ feature(service describe): Output of service details Jul 24, 2019

rhuss force-pushed the pr/svc-show-1 branch from 8c2ec13 to 2f59e28 Compare July 24, 2019 14:08

knative-prow-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 24, 2019

toVersus reviewed Jul 25, 2019

View reviewed changes

Comment thread pkg/kn/commands/service/service_describe.go Outdated

Comment thread pkg/kn/commands/service/service_describe.go Outdated

Comment thread pkg/kn/commands/service/service_describe.go Outdated

rhuss force-pushed the pr/svc-show-1 branch 2 times, most recently from 8858eee to de38225 Compare July 26, 2019 20:21

toVersus reviewed Jul 27, 2019

View reviewed changes

Comment thread pkg/kn/commands/service/service_describe.go Outdated

rhuss force-pushed the pr/svc-show-1 branch from de38225 to f05c568 Compare July 28, 2019 09:04

rhuss mentioned this pull request Aug 6, 2019

Introduce --debug and --verbose as global options #333

Open

rhuss force-pushed the pr/svc-show-1 branch from f05c568 to 39f77a4 Compare August 6, 2019 14:36

rhuss added 6 commits August 6, 2019 22:32

chore: Cleanup up and refreshed dependencies

b549a3d

fix(service describe): Integration test fix (revert "show" to "descri…

f34b1ce

…be")

fix: go.sum

9547336

fix go.sum

2836e8e

feature(service describe): Add printing of resources (requests/limits…

19bd447

…) + machine readable output with -o

rhuss added 4 commits August 6, 2019 22:32

chore(service describe): Simplified digest handling

3baf77f

chore(service describe): Sort maps by key when printed

a88dc0d

chore: Adapt mock framework

abe30ba

chore(service describe): Test fixes

7aa5a59

rhuss force-pushed the pr/svc-show-1 branch from a95ce94 to 7aa5a59 Compare August 6, 2019 20:32

chore: Added some tests

4af24ec

rhuss force-pushed the pr/svc-show-1 branch from cfd7f88 to 4af24ec Compare August 7, 2019 11:21

rhuss added 2 commits August 7, 2019 16:18

more tests

bb08564

test: Moar tests

10e85c8

rhuss added 3 commits August 7, 2019 18:56

chore: Even moar tests

0fe9b2c

more, more tests

75934c8

changelog update

b3341d7

navidshaikh reviewed Aug 8, 2019

View reviewed changes

knative-prow-robot reviewed Aug 8, 2019

View reviewed changes

fix(service describe): golint fixes

03eaa6d

knative-prow-robot reviewed Aug 8, 2019

View reviewed changes

navidshaikh approved these changes Aug 8, 2019

View reviewed changes

knative-prow-robot assigned navidshaikh Aug 8, 2019

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 8, 2019

knative-prow-robot merged commit b4b254f into knative:master Aug 8, 2019

Conversation

rhuss commented Jul 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Examle output

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rhuss commented Jul 25, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rhuss commented Aug 7, 2019

Uh oh!

rhuss commented Aug 7, 2019

Uh oh!

navidshaikh left a comment

Choose a reason for hiding this comment

Uh oh!

navidshaikh Aug 7, 2019

Choose a reason for hiding this comment

Uh oh!

navidshaikh Aug 7, 2019

Choose a reason for hiding this comment

Uh oh!

navidshaikh commented Aug 8, 2019

Uh oh!

knative-prow-robot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

knative-metrics-robot commented Aug 8, 2019

Uh oh!

rhuss commented Aug 8, 2019

Uh oh!

knative-prow-robot left a comment

Choose a reason for hiding this comment

Uh oh!

navidshaikh left a comment

Choose a reason for hiding this comment

Uh oh!

knative-prow-robot commented Aug 8, 2019

Uh oh!

navidshaikh commented Aug 8, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

rhuss commented Jul 9, 2019 •

edited

Loading