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

K8S diagnostics image with debugging tools #584

Merged
merged 9 commits into from Apr 24, 2020
Merged

Conversation

pmm-sumo
Copy link
Contributor

@pmm-sumo pmm-sumo commented Apr 21, 2020

Description

This adds a diagnostics image that is a place to keep various tools helping to solve potential issues with K8S deployment quickly. It starts with K8S API tools but can be easily extended.

Testing performed
  • ci/build.sh
  • Redeploy fluentd and fluentd-events pods
  • Confirm events, logs, and metrics are coming in

ci/build.sh Outdated Show resolved Hide resolved
diagnostics/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sumo-drosiek sumo-drosiek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I like the idea :)

@samjsong samjsong requested a review from frankreno April 22, 2020 16:05
Copy link
Contributor

@samjsong samjsong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM I also like this idea. I think there were some ideas previously around a script that can check your environment for other prerequisites, so tagging @frankreno for his input as well

Copy link
Contributor

@frankreno frankreno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general I love this idea and it was something that @abhi-sumo built a protoype CLI for that went a bit farther than this. It analyze the clsuter and determine the optimimal settings to install with. The intention was to reduce the cognitive overload for users. it likely needs some imporvements but we might be able to learn from the concepts of this. - https://github.com/abhi-sumo/sumo-k8s-cli

Copy link
Contributor

@vsinghal13 vsinghal13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM Thanks @pmm-sumo !

@pmm-sumo
Copy link
Contributor Author

pmm-sumo commented Apr 22, 2020

In general I love this idea and it was something that @abhi-sumo built a protoype CLI for that went a bit farther than this. It analyze the clsuter and determine the optimimal settings to install with. The intention was to reduce the cognitive overload for users. it likely needs some imporvements but we might be able to learn from the concepts of this. - https://github.com/abhi-sumo/sumo-k8s-cli

Thank you @frankreno , I think that @abhi-sumo's project serves a slightly different purpose. If I read the code right, it provides a wizard-like experience for the setup.

What I am proposing here is more like a standalone image that can be very easily executed to check what's the environment (no installation is even needed). It can be extended in a bunch of ways. I started with making it provide some answers that will help with figuring out why metadata tagging is not working for one of the alpha customers in a convenient way

@sumo-drosiek
Copy link
Contributor

Does it make sense to merge both ideas?.
I believe the investigation and installation wizard can coexist in one tooling image :)

I know that this code is pretty urgent right now, but we can make some effort in the future to merge both solutions

Copy link
Contributor

@perk-sumo perk-sumo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this idea but I think the name of the image should not be kubernetes-diagnostics but rather kubernetes-tools as this additional image might be used for many other side things (eg. generating helm templates etc.)

Copy link
Contributor

@perk-sumo perk-sumo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(comment duplicate)

Copy link
Contributor

@sumo-drosiek sumo-drosiek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. I would like to have kubectl run tools --generator=run-pod/v1 -it --rm --restart=Never --image sumologic/kubernetes-tools -- check, but I will take care about it while working on template generator :)

Copy link
Contributor

@frankreno frankreno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@perk-sumo perk-sumo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

@perk-sumo perk-sumo merged commit 74b1556 into master Apr 24, 2020
@perk-sumo perk-sumo deleted the k8s-diagnostics branch April 24, 2020 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants