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

Epic: Create diagnostics page #2319

Closed
4 of 8 tasks
jandubois opened this issue Jun 1, 2022 · 4 comments
Closed
4 of 8 tasks

Epic: Create diagnostics page #2319

jandubois opened this issue Jun 1, 2022 · 4 comments
Assignees
Labels
area/diagnostics kind/epic Umbrella-bug for a group of related issues
Milestone

Comments

@jandubois
Copy link
Member

jandubois commented Jun 1, 2022

Stories, ordered so we have a working PoC as soon as possible:

There are several checks we could do automatically to verify that the local system is configured properly:

  • Are the bundled utilities accessible from a user's shell?
  • Are the files under ~/.docker/cli-plugins symlinks to ~/.rd/bin?
  • Has the docker context been set to rancher-desktop (or not present, if the symlink in /var/run/docker.sock is in place)?
  • Is the current kubectl context set to rancher-desktop?
  • Is the API endpoint responding properly (docker socket on the host, containerd socket inside the VM, k3s socket on the host)
  • (macOS) Is the external cluster IP on the bridged network?
  • Does the host have an active internet connection (to pull k3s versions, and container images)?
  • Is the docker-credential-* helper configured and working? Make sure it is not set to none.
  • Are the log files growing beyond a reasonable size?
  • Are we almost out of space inside the data volume?

This is just an initial brain-dump; there are probably more.

Any problems found should also display instructions how to debug this further and/or how to fix this.

See also brew doctor for other software providing a similar tool (but from the CLI).

@jandubois jandubois added the kind/enhancement New feature or request label Jun 1, 2022
@rak-phillip
Copy link
Contributor

This might be related to #1217

@gaktive
Copy link
Contributor

gaktive commented Jul 18, 2022

The "Run Diagnostics" command would be data driven so this could also be logged somewhere for a feature like a support bundle whereby people can easily spot errors.

@jandubois
Copy link
Member Author

Moving this Epic to the following milestone.

Normally I would close it, and create a new one for the next release cycle, but this one has open issues referencing it, and I want to retain this information (for now).

@jandubois jandubois modified the milestones: Next, Later Sep 24, 2022
@jandubois
Copy link
Member Author

Ideas for additional checks have been moved to discussion in #3157.

We'll create a new epic for adding "fix actions" and other diagnostic improvements in the future.

@jandubois jandubois modified the milestones: Later, v1.6.0 Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/diagnostics kind/epic Umbrella-bug for a group of related issues
Projects
None yet
Development

No branches or pull requests

5 participants