add -tree option to images by justone · Pull Request #1794 · moby/moby

justone · 2013-09-04T19:40:56Z

This adds another option to images to print the image hierarchy in text form.

$ docker images -tree
|─27cf78414709
| └─b750fe79269d Tags: ubuntu:12.10,ubuntu:quantal
|   |─15fcc3627e79
|   | └─4b6446d47a37
|   |   └─0c074eec5f5c
|   |     └─3d546eda2db2
|   |       └─d660c80f5e1f
|   |         └─596fb3a686cf
|   |           └─61517a9129a2
|   |             └─3ad08d106530
|   |               └─64c0a2fd7c30
|   |                 └─1fde87bad242
|   |                   └─63b2b9368988
|   |                     └─fc4708bf64c3 Tags: ndj/mongodb:latest
|   |─3e11a97c3f82
|   | └─9dc7a7486e87
|   |   └─b179e38c4afd
|   |     └─b98d65ae00f7 Tags: shykes/znc:0.1,shykes/znc:git-eb9ffb538d1539c41efd03fa66c5ac1b8b91ca2a,shykes/znc:latest
|   └─8ee958cf9d12
|     └─adcb0fb35213
|       └─a6ddc80ec783
|         └─cc7feb9c3b51
|           └─b28ecfd506c6
|             └─37e7fb8b1be1
|               └─a22891c05c50
|                 └─cf9194b5b2b0
|                   └─564bac8b57aa
|                     └─e319e5b173bf
|                       └─c4551a6f0379
|                         └─b7bf889a949b
|                           └─ed37dbb60f27
|                             └─d210ec474616
|                               └─6311f2fa7ca9 Tags: ndj/redis:latest
|─8dbd9e392a96 Tags: ubuntu:12.04,ubuntu:latest,ubuntu:precise
| |─4df3eeb2c202
| | └─dd5498b6c712
| |   └─8d04c42f264e
| |     └─0c573a4b40cf
| |       └─a35fd99a7ea9
| |         └─dde68970d84b
| |           └─1822dc1f204e
| |             └─d45e5ba6dc2f
| |               └─d95940e2b97c
| |                 └─ee69859f33e8
| |                   └─29c4a226db51
| |                     └─df6178eb4c47
| |                       └─d809b136c558
| |                         └─0e19c79ffe35
| |                           └─86d4dd50dd90
| |                             └─aa6181c15178
| |                               └─c3fb316e3819
| |                                 └─f7ee6b773e3b
| |                                   └─c59ea12f6979
| |                                     └─e4e095dc03e5
| |                                       └─7e953d9b8602
| |                                         └─fb2759a6fbb5
| |                                           └─254835df9ccc
| |                                             └─e3fd1ccf8a1d
| |                                               └─115de9124bf2
| |                                                 └─3387c441027a
| |                                                   └─6bde376f8cc1 Tags: docker:latest
| └─d2d41694c20c
|   └─4cede2d58460
|     └─8d5d054f1376
|       └─5ade2d9ec9e0
|         └─76b0b1ab5fd5
|           └─ac3cca0eb14d
|             └─81acc6d83075
|               └─d31c015a3240
|                 └─c1c53577dc84
|                   └─2343dfdcc852
|                     └─95f9da0b614d
|                       └─2d6802031bf9
|                         └─b32035a894f2
|                           └─86858040aa36
|                             └─2ef244b028ac
|                               └─020b93c719a5 Tags: ndj/hipache:latest
└─e9aa60c60128 Tags: docker-ut:latest
$

This would (hopefully) solve #1776.

justone · 2013-09-04T19:41:47Z

The first commit is just the implementation. If the team likes it, I'll add tests and 'go fmt' it.

crosbymichael · 2013-09-04T21:22:52Z

@justone Looks awesome.

One thing that does not work is if I run
docker images -tree <imageid>
I expect only the current images graph to be displayed.

justone · 2013-09-04T22:31:58Z

Ah, ok. I'll add that and some tests. Thanks.

shykes · 2013-09-05T00:00:55Z

This looks very cool and I would love to use it :)

My first thought is that it would make more sense to move the display logic to the client. It can probably use the existing JSON api routes to get all the data it needs, no?

justone · 2013-09-05T00:08:55Z

@crosbymichael I added the ability to specify a starting image.

@shykes I originally thought to put the logic on the client side, but I found that the logic for -viz is on the server side, so I put -tree there to be consistent.

Also, the JSON api route doesn't include parentage, so that would have to be added. Would it be ok to finish this implementation where it is and then open another PR to move both -tree and -viz to the client?

vieux · 2013-09-05T21:57:57Z

@justone If it's not too much work, feel free to move, -viz client side among yours :)

justone · 2013-09-06T00:25:15Z

@vieux I think it won't be too much more work. If I add parentage to the JSON images API, would that require an API version bump?

vieux · 2013-09-11T00:29:01Z

Nope, as we just released 1.5 it's ok

srid · 2013-09-24T04:45:07Z

if you could also add a size column, showing the size of each image and also the virtual size including its ancestors, that'd be great.

justone · 2013-09-24T05:30:01Z

Good idea.

I do still plan on implementing this. Just had life get busy for a bit.

crosbymichael · 2013-10-03T22:19:13Z

@justone Any update on this? Do you need any help?

justone · 2013-10-03T22:23:00Z

No update as of yet. Been catching up with the latest code over the past couple days and hope to have something this weekend.

justone · 2013-10-06T06:17:43Z

Oops, accidental close.

justone · 2013-10-06T06:18:08Z

Todo list for the rest of the pull request:

rework /images/json to include parentage and consolidate repo/tag
move -viz code from server to client
re-implement -tree code on client
add size to tree info
make sure all existing tests run
add tests for new code
update any documentation

justone · 2013-10-28T04:42:20Z

Alright, @shykes, @crosbymichael, and @vieux, this pull request is ready for review. I just rebased to master. All tests pass, except for TestPrivilegedCanMount, which fails on master too.

Could you take a look and let me know if there's anything I need to fix?

Thanks.

vieux · 2013-10-31T02:38:12Z

@justone sorry, could you rebase this once again please ?

justone · 2013-10-31T13:59:26Z

@vieux No problem. Rebase done.

vieux · 2013-10-31T17:24:58Z

LGTM, ping @crosbymichael

vieux · 2013-11-05T19:32:16Z

ping @creack @crosbymichael

justone · 2013-11-06T04:40:24Z

Rebased again.

creack · 2013-11-06T16:28:31Z

LGTM, /cc @metalivedev could you take a look at the doc?

metalivedev · 2013-11-06T19:26:42Z

I don't think it is worth holding up the merge, but you removed viz from the API, so this sentence is incorrect.

I'll fix this up quick.

metalivedev · 2013-11-06T19:30:15Z

What happened to the requirement that the Content-type header should be set to "application/tar". Is that no longer a requirement?

Looks like it's on line 984, below.

You're right. Thanks.

metalivedev · 2013-11-06T19:47:48Z

Thanks for the quick fix on the images/viz!
The last tweak is to make the CLI documentation show -tree in the same way we show -viz:

.. _cli_images:

``images``
----------

::

    Usage: docker images [OPTIONS] [NAME]

    List images

      -a=false: show all images
      -q=false: only show numeric IDs
      -tree=false: output in text tree format
      -viz=false: output in graphviz format

justone · 2013-11-06T20:06:46Z

Ok, I fixed up the cli.rst doc. Thanks for your reviewing.

metalivedev · 2013-11-06T20:12:35Z

Docs LGTM. Thanks for the fixes!

add -tree option to images

justone · 2013-11-07T00:52:58Z

Awesome! Thank you to everyone who reviewed this PR.

justone closed this Oct 6, 2013

justone reopened this Oct 6, 2013

justone added 9 commits November 6, 2013 03:58

rework images JSON

15867ff

bump api version and ensure backward compat

d7928b9

fix "images -a"

dcf0279

move "images -viz" to client

2a5998b

bring back /images/viz, but 404 for latest

8f64759

implement "images -tree"

ec9a9a0

make existing tests pass

059bb7a

adding test for "images -viz"

d9fe064

adding test for "images -tree"

f1aeac3

justone added 3 commits November 6, 2013 04:23

add image size to -tree

b7d1d35

update "images" documentation

6d5b73c

fixup for rebase

22ef38e

metalivedev reviewed Nov 6, 2013
View reviewed changes

fix /images/json doc for 1.7

16eba6b

metalivedev reviewed Nov 6, 2013
View reviewed changes

updating cli help doc for images

363738b

metalivedev pushed a commit that referenced this pull request Nov 7, 2013

Merge pull request #1794 from justone/add-images-tree

807a305

add -tree option to images

metalivedev merged commit 807a305 into moby:master Nov 7, 2013

justone deleted the add-images-tree branch November 7, 2013 03:41

unclejack mentioned this pull request Nov 25, 2013

Feature Request: docker tree command #1776

Closed

Conversation

justone commented Sep 4, 2013

Uh oh!

justone commented Sep 4, 2013

Uh oh!

crosbymichael commented Sep 4, 2013

Uh oh!

justone commented Sep 4, 2013

Uh oh!

shykes commented Sep 5, 2013

Uh oh!

justone commented Sep 5, 2013

Uh oh!

vieux commented Sep 5, 2013

Uh oh!

justone commented Sep 6, 2013

Uh oh!

vieux commented Sep 11, 2013

Uh oh!

srid commented Sep 24, 2013

Uh oh!

justone commented Sep 24, 2013

Uh oh!

crosbymichael commented Oct 3, 2013

Uh oh!

justone commented Oct 3, 2013

Uh oh!

justone commented Oct 6, 2013

Uh oh!

justone commented Oct 6, 2013

Uh oh!

justone commented Oct 28, 2013

Uh oh!

vieux commented Oct 31, 2013

Uh oh!

justone commented Oct 31, 2013

Uh oh!

vieux commented Oct 31, 2013

Uh oh!

vieux commented Nov 5, 2013

Uh oh!

justone commented Nov 6, 2013

Uh oh!

creack commented Nov 6, 2013

Uh oh!

metalivedev Nov 6, 2013

Choose a reason for hiding this comment

Uh oh!

justone Nov 6, 2013

Choose a reason for hiding this comment

Uh oh!

metalivedev Nov 6, 2013

Choose a reason for hiding this comment

Uh oh!

justone Nov 6, 2013

Choose a reason for hiding this comment

Uh oh!

metalivedev Nov 6, 2013

Choose a reason for hiding this comment

Uh oh!

metalivedev commented Nov 6, 2013

Uh oh!

justone commented Nov 6, 2013

Uh oh!

metalivedev commented Nov 6, 2013

Uh oh!

justone commented Nov 7, 2013

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants