velero-io/velero

Make printer column titles consistent across all types

Open

#2,989 opened on Oct 6, 2020

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Go (1,550 forks)auto 404
Area/CLIGood first issueReviewed Q2 2021

Repository metrics

Stars
 (10,111 stars)
PR merge metrics
 (PR metrics pending)

Description

That does, however, put us in an awkward spot since I think all other .status.startTimestamp fields should match, due to the existence of the creationTimestamp field. Ideally, we'd have clean mappings between the field name in the YAML and printer column, but I think due to historical reasons we're a little stuck.

I think we could put that on the docket for v2.0 to update those velero commands so we don't break any scripts.

Originally posted by @nrb in https://github.com/vmware-tanzu/velero/pull/2881#discussion_r496236736

In adding the additional printer columns for CRDs, it was noted that the columns for the get commands were named inconsistently from the fields being displayed, but also that they were inconsistent across types. For example, .status.startTimestamp is displayed under the column CREATED when running velero get backups but is displayed under the column STARTED when running velero get restores.

We should revisit each of these types and determine how they should be printed and ensure they are all consistent with each other.

Contributor guide

Research direction
Identify all printer column definitions across different resource types (backups, restores, etc.) and propose a consistent naming scheme that aligns with the YAML field names.
Tech stack
go
Domain
backendcli
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoKubernetesVelero
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65