Revisit linkerd check output format #1471
Assignees
Labels
Milestone
Comments
This was referenced Aug 20, 2018
|
Step 1: get some design feedback on the overall UX of the CLI |
This was referenced Sep 19, 2018
|
As part of this work, we should consider embellishing cli output with emoji/color/lol, as mentioned in TGIK8s: emoji and color in linkerd check: ascii art / color / lolgopher for linkerd dashboard: |
|
Also related, #1739. |
|
Here's a proposal for updated formating: $ linkerd check
kubernetes-api
---------------
can initialize the client ✔️
can query the Kubernetes API ✔️
RBAC
----
can create Namespaces ❌
Missing permissions to create Namespace
See https://linkerd.io/2/troubleshooting#rbac for hints
Version
-------
cli is up-to-date ✔️
data plane is up-to-date ⚠️
You are running 18.11.1 and the latest version is 18.11.2
See https://linkerd.io/2/troubleshooting#version-mismatch for hintsIn addition, it would be nice to add a spinner when we are retrying (instead of outputting another line). Something like https://github.com/briandowns/spinner. |
|
Sweet emojis. I would suggest moving the checks or Xs or warning signs to be the first character rather than the last character in the line. Will help with scannability. |
siggy
added a commit
that referenced
this issue
Jan 14, 2019
The `linkerd check` command organized the various checks via loosely coupled category IDs, category names, and checkers themselves, all with ordering defined by consumers of this code. This change removes category IDs in favor of category names, groups all checkers by category, and enforces ordering at the `HealthChecker` level. Part of #1471, depends on #2078. Signed-off-by: Andrew Seigner <siggy@buoyant.io>
siggy
added a commit
that referenced
this issue
Jan 15, 2019
The linkerd check command organized the various checks via loosely coupled category IDs, category names, and checkers themselves, all with ordering defined by consumers of this code. This change removes category IDs in favor of category names, groups all checkers by category, and enforces ordering at the HealthChecker level. Part of #1471, depends on #2078. Signed-off-by: Andrew Seigner <siggy@buoyant.io>
siggy
added a commit
that referenced
this issue
Jan 15, 2019
The linkerd check command organized the various checks via loosely coupled category IDs, category names, and checkers themselves, all with ordering defined by consumers of this code. This change removes category IDs in favor of category names, groups all checkers by category, and enforces ordering at the HealthChecker level. Part of #1471, depends on #2078. Signed-off-by: Andrew Seigner <siggy@buoyant.io>
siggy
added a commit
that referenced
this issue
Jan 15, 2019
siggy
added a commit
that referenced
this issue
Jan 15, 2019
The outputs of the `check` and inject commands did not vary much between successful and failed executions, and were a bit verbose and visually challenging to parse. Reorganize output of check and inject commands, to provide more info when errors occur, and less output when successful. Specific changes: `linkerd check` - visually group checks by category - introduce `hintURL`'s, to provide doc links when checks fail - add spinners when retrying, remove addtional retry lines - colored emojis to indicate success/warning/failure `linkerd inject` - modify default output to mirror `kubectl apply` - only output non-successful inject reports - support `--verbose` flag to output all inject reports Fixes #1471, #1653, #1656, #1739 Signed-off-by: Andrew Seigner <siggy@buoyant.io>
siggy
added a commit
that referenced
this issue
Jan 15, 2019
The outputs of the `check` and inject commands did not vary much between successful and failed executions, and were a bit verbose and visually challenging to parse. Reorganize output of check and inject commands, to provide more info when errors occur, and less output when successful. Specific changes: `linkerd check` - visually group checks by category - introduce `hintURL`'s, to provide doc links when checks fail - add spinners when retrying, remove addtional retry lines - colored emojis to indicate success/warning/failure `linkerd inject` - modify default output to mirror `kubectl apply` - only output non-successful inject reports - support `--verbose` flag to output all inject reports Fixes #1471, #1653, #1656, #1739 Signed-off-by: Andrew Seigner <siggy@buoyant.io>
siggy
added a commit
that referenced
this issue
Jan 15, 2019
The outputs of the `check` and `inject` commands did not vary much between successful and failed executions, and were a bit verbose and challenging to parse. Reorganize output of `check` and `inject` commands, to provide more output when errors occur, and less output when successful. Specific changes: `linkerd check` - visually group checks by category - introduce `hintURL`'s, to provide doc links when checks fail - add spinners when retrying, remove addtional retry lines - colored emojis to indicate success/warning/failure `linkerd inject` - modify default output to mirror `kubectl apply` - only output non-successful inject reports - support `--verbose` flag to output all inject reports Fixes #1471, #1653, #1656, #1739 Signed-off-by: Andrew Seigner <siggy@buoyant.io>
siggy
added a commit
that referenced
this issue
Jan 16, 2019
The outputs of the `check` and `inject` commands did not vary much between successful and failed executions, and were a bit verbose and challenging to parse. Reorganize output of `check` and `inject` commands, to provide more output when errors occur, and less output when successful. Specific changes: `linkerd check` - visually group checks by category - introduce `hintURL`'s, to provide doc links when checks fail - add spinners when retrying, remove addtional retry lines - colored emojis to indicate success/warning/failure `linkerd inject` - modify default output to mirror `kubectl apply` - only output non-successful inject reports - support `--verbose` flag to output all inject reports Fixes #1471, #1653, #1656, #1739 Signed-off-by: Andrew Seigner <siggy@buoyant.io>
siggy
added a commit
that referenced
this issue
Jan 16, 2019
The outputs of the `check` and `inject` commands did not vary much between successful and failed executions, and were a bit verbose and challenging to parse. Reorganize output of `check` and `inject` commands, to provide more output when errors occur, and less output when successful. Specific changes: `linkerd check` - visually group checks by category - introduce `hintURL`'s, to provide doc links when checks fail - add spinners when retrying, remove additional retry lines - colored unicode characters to indicate success/warning/failure `linkerd inject` - modify default output to mirror `kubectl apply` - only output non-successful inject reports - support `--verbose` flag to output all inject reports Fixes #1471, #1653, #1656, #1739 Signed-off-by: Andrew Seigner <siggy@buoyant.io>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Per #1081, we should streamline the linkerd check output to be less verbose when checks are passing, and more verbose when checks are failing. We should also group the checks as Pre-Install and Post-Install. Relates to #1470.
The text was updated successfully, but these errors were encountered: