Make `tctl <resource> ls` command outputs consistent #9519

lxea · 2021-12-21T16:29:02Z

This makes tctl commands consistent between different outputs as described in #9379. This adds a kube ls command.

lxea

In order to get Teleport version and host, GetWindowsDesktopServices must be used however I'm not sure how to associate a windows desktop with a windows desktop service. Any ideas @russjones ?

russjones · 2021-12-22T17:11:52Z

@lxea @zmb3 should be able to help you out on the Windows Desktop questions.

zmb3 · 2021-12-22T21:10:43Z

@lxea there currently isn't an association between a Windows Desktop and the Windows Desktop Service (or services) that can connect to it.

We'll be adding this soon (feel free to follow #9277 for progress).

If there's anything in particular you need in the implementation to make this work easier let me know, but the plan is basically do make it work exactly like database access.

tool/tctl/common/collection.go

tool/tctl/common/desktop_command.go

russjones · 2021-12-22T22:45:49Z

@lxea Can we use a similar approach to what we did with tsh where we size the output to the size of the terminal? I think that will let us show more labels whenever we can.

tool/tctl/common/collection.go

r0mant · 2022-03-01T17:16:16Z

@Tener @zmb3 Since you guys looked at this before, mind re-reviewing?

tool/tctl/common/collection.go

tool/tctl/common/desktop_command.go

tool/tctl/main.go

tool/tctl/common/kube_command.go

tool/tctl/common/desktop_command.go

Tener · 2022-03-04T08:43:41Z

@r0mant @lxea sorry for the delay. I have reviewed everything now, including the code I didn't look at close enough on the first pass. Sorry for pointing out stuff I could have found already in the past but missed...

Tener

LGTM

Tener · 2022-03-08T09:42:28Z

@r0mant @zmb3 I've approved, but scripts require your approval too.

r0mant

Have a couple suggestions.

api/types/app.go

tool/tctl/common/collection.go

r0mant

Approving but please address suggestions I left before merging.

api/types/constants.go

lib/asciitable/table.go

tool/tctl/common/collection.go

tool/tctl/common/node_command.go

New format: ``` Host UUID Public Address Labels Version ---- ------------------------------------ -------------- ------------------------- ------------- corn 7b3ca8d8-710c-4305-aa29-e73628ac572c 127.0.0.1:3022 env=example,hostname=corn 8.0.0-alpha.1 ``` With `--yaml` ```yaml kind: node metadata: expires: "2021-12-16T15:26:44.887862347Z" id: 1639667804888460055 labels: env: example name: 7b3ca8d8-710c-4305-aa29-e73628ac572c spec: addr: 127.0.0.1:3022 cmd_labels: hostname: command: - hostname period: 1m0s result: corn hostname: corn public_addr: corn.lan:8443 rotation: current_id: "" last_rotated: "0001-01-01T00:00:00Z" schedule: standby: "0001-01-01T00:00:00Z" update_clients: "0001-01-01T00:00:00Z" update_servers: "0001-01-01T00:00:00Z" started: "0001-01-01T00:00:00Z" version: 8.0.0-alpha.1 version: v2 ```

``` Host Name Public Address URI Labels Version ---- ----------- -------------------- ------------------- ------------------------------- ------------- corn example-app example-app.corn.lan http://0.0.0.0:8000 teleport.dev/origin=config-file 8.0.0-alpha.1 ```

``` Host Name Protocol URI Labels Version ---- -------- -------- ------------ ------------------------------- ------------- corn postgres postgres 0.0.0.0:5432 teleport.dev/origin=config-file 8.0.0-alpha.1 ```

``` Cluster Labels Version ----------- ------ ------------- minikube 8.0.0-alpha.1 honkcluster 8.0.3 ``` ```yaml kind: kube_service metadata: expires: "2021-12-16T16:07:14.898611765Z" id: 1639670234899200604 name: 7b3ca8d8-710c-4305-aa29-e73628ac572c spec: addr: 127.0.0.1:3027 hostname: "" kube_clusters: - name: minikube rotation: current_id: "" last_rotated: "0001-01-01T00:00:00Z" schedule: standby: "0001-01-01T00:00:00Z" update_clients: "0001-01-01T00:00:00Z" update_servers: "0001-01-01T00:00:00Z" started: "0001-01-01T00:00:00Z" version: 8.0.0-alpha.1 version: v2 --- kind: kube_service metadata: expires: "2021-12-16T16:10:13.068855399Z" id: 1639670413069866294 name: 9153a5a9-e85e-4972-8c50-6fa8923282b2 spec: addr: remote.kube.proxy.teleport.cluster.local hostname: "" kube_clusters: - name: honkcluster rotation: current_id: "" last_rotated: "0001-01-01T00:00:00Z" schedule: standby: "0001-01-01T00:00:00Z" update_clients: "0001-01-01T00:00:00Z" update_servers: "0001-01-01T00:00:00Z" started: "0001-01-01T00:00:00Z" version: 8.0.3 version: v2 ```yaml

``` Host Public Address AD Domain Labels Version ---- -------------------- ----------- -------------------- --------- corn 192.168.122.144:3389 example.com teleport..3 (9 9.0.0-dev corn 192.168.122.51:3389 example.com teleport.rd Evle.com 9.0.0-dev ``` ```yaml kind: windows_desktop metadata: expires: "2022-02-18T16:12:52.422659238Z" id: 1645200172423989197 labels: teleport.dev/computer_name: WIN-LA2V0OD7SK0 teleport.dev/dns_host_name: WIN-LA2V0OD7SK0.example.com teleport.dev/is_domain_controller: "true" teleport.dev/origin: dynamic teleport.dev/os: Windows Server 2012 R2 Standard Evaluation teleport.dev/os_version: 6.3 (9600) teleport.dev/windows_domain: example.com name: WIN-LA2V0OD7SK0-example-com spec: addr: 192.168.122.51:3389 domain: example.com host_id: 2c807641-92ae-4c70-88fe-b93e7b0aa179 version: v3 ```

TwiN · 2023-04-13T21:51:48Z

While MakeTableWithTruncatedColumn does make the outputs consistent, it also broke automations that extracted the name from ls commands 😔

Tener · 2023-04-14T06:39:40Z

@TwiN

While MakeTableWithTruncatedColumn does make the outputs consistent, it also broke automations that extracted the name from ls commands 😔

--format=json switch is there for automation purposes. For example, if you want to extract database names, you can do:

tctl db ls --format=json | jq '.[].metadata.name'

A great number of other commands support --format=json, and the output format rarely changes. If there is a command which doesn't support that flag feel free to raise a feature request and tell us about your use case.

TwiN · 2023-04-14T19:23:57Z

@Tener Good to know! I must've missed the --format flag!
Thanks :)

lxea force-pushed the lxea/tctl-ls-consistency branch from b8b2a1c to 6a95208 Compare December 22, 2021 15:20

lxea commented Dec 22, 2021

View reviewed changes

zmb3 reviewed Dec 22, 2021

View reviewed changes

tool/tctl/common/collection.go Outdated Show resolved Hide resolved

tool/tctl/common/collection.go Outdated Show resolved Hide resolved

tool/tctl/common/desktop_command.go Outdated Show resolved Hide resolved

lxea force-pushed the lxea/tctl-ls-consistency branch 3 times, most recently from 3cca378 to 0091b8f Compare February 18, 2022 17:35

lxea marked this pull request as ready for review February 18, 2022 17:37

lxea force-pushed the lxea/tctl-ls-consistency branch from 0091b8f to a9a08a6 Compare February 18, 2022 17:38

github-actions bot added desktop-access tctl tctl - Teleport admin tool tsh tsh - Teleport's command line tool for logging into nodes running Teleport. labels Feb 18, 2022

github-actions bot requested review from fspmarshall and Tener February 18, 2022 17:38

lxea requested a review from zmb3 February 18, 2022 17:40

Tener reviewed Feb 23, 2022

View reviewed changes

tool/tctl/common/collection.go Outdated Show resolved Hide resolved

tool/tctl/common/collection.go Outdated Show resolved Hide resolved

tool/tctl/common/collection.go Outdated Show resolved Hide resolved

lxea force-pushed the lxea/tctl-ls-consistency branch 5 times, most recently from 5a39773 to 1fd9a09 Compare February 28, 2022 09:52

Tener reviewed Mar 4, 2022

View reviewed changes

lxea force-pushed the lxea/tctl-ls-consistency branch from 1fd9a09 to 84c7bce Compare March 8, 2022 09:29

Tener approved these changes Mar 8, 2022

View reviewed changes

lxea force-pushed the lxea/tctl-ls-consistency branch from 84c7bce to d2d93ad Compare March 8, 2022 10:52

lxea force-pushed the lxea/tctl-ls-consistency branch from d2d93ad to 59f704b Compare March 8, 2022 14:03

r0mant self-requested a review March 8, 2022 17:05

r0mant requested changes Mar 8, 2022

View reviewed changes

api/types/app.go Outdated Show resolved Hide resolved

tool/tctl/common/collection.go Outdated Show resolved Hide resolved

lxea force-pushed the lxea/tctl-ls-consistency branch from 59f704b to 53a5a4d Compare March 9, 2022 10:18

lxea requested a review from r0mant March 10, 2022 08:14

lxea mentioned this pull request Mar 14, 2022

Long text overflow on tctl output #4677

Closed

lxea force-pushed the lxea/tctl-ls-consistency branch from 53a5a4d to d89756d Compare March 14, 2022 11:34

r0mant approved these changes Mar 15, 2022

View reviewed changes

lxea force-pushed the lxea/tctl-ls-consistency branch 2 times, most recently from 88fc84d to bf9a99b Compare March 15, 2022 12:51

lxea enabled auto-merge (rebase) March 15, 2022 12:52

Alex McGrath added 10 commits March 15, 2022 12:59

ls consistency: make tctl db ls output consistent

3744b59

``` Host Name Protocol URI Labels Version ---- -------- -------- ------------ ------------------------------- ------------- corn postgres postgres 0.0.0.0:5432 teleport.dev/origin=config-file 8.0.0-alpha.1 ```

Move 'MakeTableWithTruncatedColumn' to asciitable and truncate labels

66c240f

Add verbosity to tctl * ls commands and resource get.

3f93df4

Resolve comments

c20da58

Add configurable verbosity to tctl get roles

6187de8

Reslove comments, move all occurences of teleport.dev to use a constant

1023e3f

lxea force-pushed the lxea/tctl-ls-consistency branch from bf9a99b to 1023e3f Compare March 15, 2022 12:59

lxea merged commit 40200e8 into master Mar 15, 2022

lxea deleted the lxea/tctl-ls-consistency branch March 15, 2022 13:22

lxea mentioned this pull request Mar 23, 2022

[v9] Make tctl <resource> ls command outputs consistent (Backport #9519) #11373

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make `tctl <resource> ls` command outputs consistent #9519

Make `tctl <resource> ls` command outputs consistent #9519

lxea commented Dec 21, 2021

lxea left a comment

russjones commented Dec 22, 2021

zmb3 commented Dec 22, 2021

russjones commented Dec 22, 2021

r0mant commented Mar 1, 2022

Tener commented Mar 4, 2022

Tener left a comment

Tener commented Mar 8, 2022

r0mant left a comment

r0mant left a comment

TwiN commented Apr 13, 2023

Tener commented Apr 14, 2023

TwiN commented Apr 14, 2023

Make tctl <resource> ls command outputs consistent #9519

Make tctl <resource> ls command outputs consistent #9519

Conversation

lxea commented Dec 21, 2021

lxea left a comment

Choose a reason for hiding this comment

russjones commented Dec 22, 2021

zmb3 commented Dec 22, 2021

russjones commented Dec 22, 2021

r0mant commented Mar 1, 2022

Tener commented Mar 4, 2022

Tener left a comment

Choose a reason for hiding this comment

Tener commented Mar 8, 2022

r0mant left a comment

Choose a reason for hiding this comment

r0mant left a comment

Choose a reason for hiding this comment

TwiN commented Apr 13, 2023

Tener commented Apr 14, 2023

TwiN commented Apr 14, 2023

Make `tctl <resource> ls` command outputs consistent #9519

Make `tctl <resource> ls` command outputs consistent #9519