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.

Sign up for GitHub

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

Jump to bottom

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

Open
13 tasks
kadel opened this issue Mar 15, 2023 · 5 comments
Open
13 tasks

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

kadel opened this issue Mar 15, 2023 · 5 comments
Labels
kind/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@kadel
Copy link
Member

kadel commented Mar 15, 2023 •
edited by rm3l
Loading

/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
    • odo doctor: check storage/volume creation #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
@openshift-ci openshift-ci bot added the kind/user-story An issue of user-story kind label Mar 15, 2023
@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. label Mar 15, 2023
@rm3l rm3l added the triage/needs-information Indicates an issue needs more information in order to work on it. label Mar 17, 2023
@rm3l
Copy link
Member

rm3l commented Mar 17, 2023

Assigning to myself to add more details.

/assign @rm3l

@rm3l
Copy link
Member

rm3l commented Mar 23, 2023

/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.

@openshift-ci openshift-ci bot unassigned rm3l Mar 23, 2023
@openshift-ci openshift-ci bot changed the title odo doctor odo doctor as a diagnostic tool to find issues that would prevent from making the most out of odo Mar 23, 2023
@openshift-ci openshift-ci bot removed the triage/needs-information Indicates an issue needs more information in order to work on it. label Mar 23, 2023
@rm3l rm3l changed the title odo doctor as a diagnostic tool to find issues that would prevent from making the most out of odo odo doctor as a diagnostic command to find issues that would prevent from making the most out of odo Mar 23, 2023
@github-actions
Copy link
Contributor

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 github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 22, 2023
@rm3l rm3l removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 22, 2023
@rm3l rm3l removed the needs-triage Indicates an issue or PR lacks a `triage/*` and requires one. label Jul 6, 2023
@rm3l rm3l added kind/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks and removed kind/user-story An issue of user-story kind labels Jul 21, 2023
@github-actions
Copy link
Contributor

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 github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 20, 2023
@rm3l
Copy link
Member

rm3l commented Oct 20, 2023

/remove-lifecycle stale
/lifecycle frozen

@openshift-ci openshift-ci bot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/epic An issue categorized as a high-level Epic. Needs to be scoped and broken down in 1+ stories/tasks lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
odo Project
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kadel @rm3l