Skip to content

[CLOUDP-333407] Remove subcommand kubectl mongodb debug #293

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

Merged
merged 4 commits into from
Jul 28, 2025

Conversation

viveksinghggits
Copy link
Contributor

Summary

There are two ways to collect diagnostic information from customers enviornments. Either we can ask them to run kubectl mongodb debug or we can ask them to run public/support/mdb_operator_diagnostic_data.sh script.
From the field we got to know that people prefer .sh over the binary, that's why it looks like we have been providing the .sh file to the users. And because of that having kubectl mongodb debug just confuses us as to, which one should be provided to the users. That's why this commit removes that subcommand.

Proof of Work

Build the binary and make sure that debug subcommand has been removed.

./kubectl-mongodb                                                       
This application is a tool to simplify maintenance tasks
of MongoDB resources in your kubernetes cluster.

Build: 709d41f97a48f8e1970707401e4c8172ce163eeb, 2025-07-24T08:00:11Z

Usage:
  kubectl-mongodb [command]

Available Commands:
  completion   Generate the autocompletion script for the specified shell
  help         Help about any command
  multicluster Manage MongoDB multicluster environments on k8s

Flags:
  -h, --help   help for kubectl-mongodb

Use "kubectl-mongodb [command] --help" for more information about a command.

I tried to verify if we ever documented this, to make sure if we will have to change the docs or not. And it looks like this subcommand was not documented https://www.mongodb.com/docs/kubernetes/current/plugin-reference/. So we will not have to create/push release notes for this.

Checklist

  • Have you linked a jira ticket and/or is the ticket in the title?
  • Have you checked whether your jira ticket required DOCSP changes?
  • Have you checked for release_note changes?

There are two ways to collect diagnostic information from customers enviornments. Either
we can ask them to run `kubectl mongodb debug` or we can ask them to run `public/support/mdb_operator_diagnostic_data.sh`
script.
From the field we got to know that people prefer .sh over the binary, that's why it looks
like we have been providing the .sh file to the users.
And because of that having `kubectl mongodb debug` just confuses us as to, which one should be
provided to the users. That's why this commit removes that subcommand.
@viveksinghggits viveksinghggits requested a review from a team as a code owner July 24, 2025 10:19
Copy link
Contributor

@m1kola m1kola left a comment

Choose a reason for hiding this comment

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

LGTM, but I would still add a release note of type "other" and point to the script users should use instead of the debug command.

@viveksinghggits viveksinghggits requested a review from lsierant July 25, 2025 10:14
@viveksinghggits
Copy link
Contributor Author

The variants that are failing in CI are known issues and we are supposed to ignore them for now, details are in this thread https://mongodb.slack.com/archives/CGLP6R2PQ/p1753439731022119?thread_ts=1753361900.361289&cid=CGLP6R2PQ. I will ignore them and merge the PR.

@viveksinghggits viveksinghggits merged commit 8cd399d into master Jul 28, 2025
32 of 35 checks passed
@viveksinghggits viveksinghggits deleted the remove-kubectl-mongodb-debug branch July 28, 2025 09:39
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.

4 participants