odo icon indicating copy to clipboard operation
odo copied to clipboard

`odo doctor` as a diagnostic command to find issues that would prevent from making the most out of odo

Open kadel opened this issue 2 years ago • 5 comments

/kind user-story

User Story

As an odo user, I want to quickly verify that there are no issues that would prevent me from using all odo's features.

odo doctor can be used as a diagnostic command to find potential issues (on my local machine or in my cluster) in advance, and provide helpful information about what needs to be resolved if any issues arise.

Acceptance Criteria

  • [ ] It should run all checks and should continue even if one check in the middle does not pass
  • [ ] Possible checks (we can iterate on those and more later on):
    • [ ] Validate my local devfile (syntax)
    • [ ] Check if podman or docker binary (PODMAN_CMD env var) is available, and if the version is compatible with building images via odo
    • [ ] Check if podman (PODMAN_CMD env var) is available and if the version is compatible with running odo dev on Podman
    • [ ] Check if Service Binding operator is installed (???)
    • [ ] Check if cluster is reachable and if user has the necessary permissions (we need to clarify which permissions are needed)
    • [ ] Check that current namespace is not the default one on OpenShift
    • [ ] https://github.com/redhat-developer/odo/issues/6992
  • [ ] For each failing check, it should provide information about possible remediation steps
  • [ ] It should provide JSON output
  • [ ] Optional: It should accept a --checks flag that allows specifying a comma-separated list of checks to run
  • [ ] Documentation should provide a clear description of each check and the possible remediation steps for each issue

Links

  • Related Epic (mandatory):

/kind user-story

kadel avatar Mar 15 '23 12:03 kadel

Assigning to myself to add more details.

/assign @rm3l

rm3l avatar Mar 17 '23 15:03 rm3l

/remove-triage needs-information /retitle odo doctor as a diagnostic tool to find issues that would prevent from making the most out of odo /unassign

Updated the description and title of this issue.

rm3l avatar Mar 23 '23 16:03 rm3l

A friendly reminder that this issue had no activity for 90 days. Stale issues will be closed after an additional 30 days of inactivity.

github-actions[bot] avatar Jun 22 '23 00:06 github-actions[bot]

A friendly reminder that this issue had no activity for 90 days. Stale issues will be closed after an additional 30 days of inactivity.

github-actions[bot] avatar Oct 20 '23 00:10 github-actions[bot]

/remove-lifecycle stale /lifecycle frozen

rm3l avatar Oct 20 '23 15:10 rm3l