Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

check the health of Conduit using the command-line #92

Closed
pcalcado opened this issue Dec 26, 2017 · 1 comment
Closed

check the health of Conduit using the command-line #92

pcalcado opened this issue Dec 26, 2017 · 1 comment
Assignees
Labels
Milestone

Comments

@pcalcado
Copy link
Contributor

Narrative

So that I can quickly identify problems with my service mesh infrastructure
As an operator
I want to check the health of Conduit using the command-line

Rationale

As it happens with any distributed system, there are plenty of things that can go wrong in a Conduit deployment. To make it worse, sometimes it can be hard to distinguish between problems in the users' services or with the underlying infrastructure.

The $ conduit status command-line utility will help users save time diagnosing problems with the service mesh itself.

The command must check as much as possible, being accurate and exhaustive is more important than finishing quickly. It must provide useful and actionable advice whenever possible, and ask users to open an issue with the project if the current condition feels like a bug (e.g. some component throws errors instead of returning proper error states).

Acceptance criteria:

Required items to check:

  • Presence of, access & health of kubectl
  • Version compatibility for K8S both server and client
  • Access & health of K8s API
  • Access & health of Conduit API
  • Health of control plane server-side components
Given a  Conduit deployment
When an operator runs the status command
And everything is healthy and accessible
Then a message is displayed in the terminal saying that everything is ok
And the process exits with status code 0
Given a Conduit deployment 
When an operator runs the status command
And one or more components aren't healthy or accessible
Then a message is displayed in the terminal with descriptions for each error found
And the process exits with status code != 0
Given a Conduit deployment 
When an operator runs the status command
And one or more components are in an unexpected error condition
Then a message is displayed in the terminal asking users to open an issue
And the message contains useful yet anonymised information they should copy and paste on the issue to help with the investigation
And the process exits with status code != 0
@pcalcado pcalcado self-assigned this Dec 26, 2017
pcalcado added a commit that referenced this issue Dec 28, 2017
* Add framework for healthcheck in CLI

Signed-off-by: Phil Calcado <phil@buoyant.io>

* Add self-checked for kubectl

Signed-off-by: Phil Calcado <phil@buoyant.io>

* Clear formatting code

Signed-off-by: Phil Calcado <phil@buoyant.io>

* Removed ununsed objects from status

Signed-off-by: Phil Calcado <phil@buoyant.io>

* Removed ununsed parameter

Signed-off-by: Phil Calcado <phil@buoyant.io>

* Ignore errored self checkers

Signed-off-by: Phil Calcado <phil@buoyant.io>

* Make the check error by default

Signed-off-by: Phil Calcado <phil@buoyant.io>

* Log error, format changes

Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado pushed a commit that referenced this issue Jan 4, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado pushed a commit that referenced this issue Jan 4, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado pushed a commit that referenced this issue Jan 4, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado pushed a commit that referenced this issue Jan 5, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado pushed a commit that referenced this issue Jan 5, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado pushed a commit that referenced this issue Jan 5, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado pushed a commit that referenced this issue Jan 5, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado pushed a commit that referenced this issue Jan 5, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
pcalcado added a commit that referenced this issue Jan 5, 2018
Signed-off-by: Phil Calcado <phil@buoyant.io>
@siggy siggy added this to the 0.1.2 milestone Jan 11, 2018
@pcalcado
Copy link
Contributor Author

I am moving the last acceptance criteria to #139 as we need a bit more discussion on what should be listed and it doesn't block the rest of this feature.

@pcalcado pcalcado added the review/ready Issue has a reviewable PR label Jan 11, 2018
@pcalcado pcalcado removed the review/ready Issue has a reviewable PR label Jan 12, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants