[CLOUDP-332196] Move `kubectl-mongodb` plugin to `cmd` dir for atomic releases #271

viveksinghggits · 2025-07-16T16:03:54Z

Summary

In the efforts towards atomic releases this PR tries to move the kubectl-mongodb plugin code from the directory public/tools/multicluster to the root of the project cmd/. This is to align the project with how other Go based projects are structured.
Apart from that this PR also moves the .goreleaser.yaml for the kubectl-mongodb plugin from public/tools/multicluster/.goreleaser.yaml directory to the root of the repo. This is also done in order to align how .goreleaser.yaml is kept in other Go based opensource projects.
This PR also moves the evergreen file that releases kubectl-mongodb plugin from the location public/.evergreen.yml to the root of the repo and is renamed to .evergreen-kubectlplugin.yml. This is to make sure the evergreen files are kept at the same location, i.e. the root of the repo.

Note on LICENSE-THIRD-PARTY

The licenses that are used by the third party go libraries that we use in our kubectl plugin, are documented in public docs at this link.
When we generated the file (LICENSE-THIRD-PARTY) after moving the kubectl-mongodb code to cmd/ directory, we can only see a new package added, that is sigs.k8s.io/yaml/goyaml this seems to be part of the module sigs.k8s.io/yaml which was already part of the LICENSE-THIRD-PARTY, that's why we don't need to re-publish the docs for third party licenses.

To generate the LICENSE-THIRD-PARTY, make precommit can be run after setting env var export MDB_UPDATE_LICENSES=true.

This PR also fixes https://jira.mongodb.org/browse/CLOUDP-332234

Proof of Work

Run goreleaser command locally and verify the binaries that are generated in the dist directory that they output the correct subcommands.

~/work/opensource/mongodb-kubernetes/dist/kubectl-mongodb_darwin_arm64_v8.0 (mongodb-kubectlplugin-refactor*) » ./kubectl-mongodb                             
This application is a tool to simplify maintenance tasks
of MongoDB resources in your kubernetes cluster.

Build: 1cd782d97de76ed25d6170a1d0aaa50382022c08, 2025-07-17T12:10:32Z

Usage:
  kubectl-mongodb [command]

Available Commands:
  completion   Generate the autocompletion script for the specified shell
  debug        Downloads all resources required for debugging and stores them into the disk
  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.

Testing via evergreen:
Since we are experiencing some issues while testing the entire release process I am planning to merge this PR to master and then would test the release from master.

Jira: https://jira.mongodb.org/browse/CLOUDP-332196

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?

Reminder (Please remove this when merging)

Please try to Approve or Reject Changes the PR, keep PRs in review as short as possible
Our Short Guide for PRs: Link
Remember the following Communication Standards - use comment prefixes for clarity:
- blocking: Must be addressed before approval.
- follow-up: Can be addressed in a later PR or ticket.
- q: Clarifying question.
- nit: Non-blocking suggestions.
- note: Side-note, non-actionable. Example: Praise
- --> no prefix is considered a question

…ster This commit moves the source code of mongodb kubectl plugin from `public/tools/multicluster` to `cmd` directory. This is to align with how go code that ships a CLI is structured. The command/subcommand building logic is moved to the `cmd` directory and and rest of the logic The command/subcommand building logic is moved to the `cmd` directory and and rest of the logic is moved to the new package `pkg/kubectl-mongodb`. This commit also moves the `.goreleaser.yaml` to the root of the project because kubectl plugin is now at the root of the project.

1. Since most of our evergreen config files are in root of the repo and now that kubectl plugin is also moved to `cmd/` it makes sense to move the evergreen config file to the root of repo with correct name. 2. Change the goreleaser config file to version 1. We upgraded it temporarily to version 2 but CI complains that only version 1 is supported.

The evergreen function `build_multi_cluster_binary` is used to build the `kubectl-mongodb` plugin. And this function gets used in the main `.evergreen.yml` file to build the `kubectl-mongodb` binary. Since we moved the location of the source files for `kubectl-mongodb` plugin as part of [PR](#271), this PR makes respective changes in the evergreen function so that it can properly build the `kubectl-mongodb` plugin from the new location.

MaciejKaras · 2025-07-18T07:47:36Z

Thanks for very well documented PR!

Some general notes:

please add ticket number to PR title similar to other PRs, example
init_test_run/build_test_image task fails, it cannot build mcli for test usage
you need to run .githooks/pre-commit in order to fix linter issues

.goreleaser.yaml

viveksinghggits · 2025-07-18T09:08:50Z

Thank you for the feedback @MaciejKaras.

init_test_run/build_test_image task fails, it cannot build mcli for test usage

Right, we knew think is going to happen and I have raised the change as part of the other PR #275 which is based on this PR, to make things easy to review.

I will work on other comments.

…m `multi_cluster/tools`

…to correct kubectl-mongodb root

Since we moved the code of `kubectl-mongodb` plugin to `cmd/` we needed to move the licenses files to the new location. This commit does that.

viveksinghggits · 2025-07-18T16:05:36Z

@MaciejKaras can you please have a look into this PR again?

MaciejKaras

The refactor looks really good!

Please also check and update old multicluster usages in other files. Examples I found:

mongodb-kubernetes/.dockerignore

Line 57 in 12d1b90

!/public/tools/multicluster/go.mod
mongodb-kubernetes/.gitignore

Line 6 in 896db65

public/tools/multicluster/vendor

mongodb-kubernetes/.evergreen-functions.yml

Line 667 in 0f58ef3

    
           files: [ "src/github.com/mongodb/mongodb-kubernetes/*.suite", "src/github.com/mongodb/mongodb-kubernetes/public/tools/multicluster/*.suite", "src/github.com/mongodb/mongodb-kubernetes/docker/mongodb-kubernetes-init-ops-manager/mmsconfiguration/*.suite" ]

mongodb-kubernetes/public/samples/multi-cluster-cli-gitops/README.md

Lines 15 to 22 in ccf22c8

    
           ### Build the multi-cluster CLI image 
        
           You can build a minimal image containing the CLI executable using the `Dockerfile` [provided in this repo](./../../tools/multicluster/Dockerfile). 
        
           ``` shell 
        
           git clone https://github.com/mongodb/mongodb-kubernetes 
        
           cd mongodb-kubernetes/public/tools/multicluster 
        
           docker build . -t "your-registry/multi-cluster-cli:latest" 
        
           docker push "your-registry/multi-cluster-cli:latest" 
        
           ```

viveksinghggits · 2025-07-21T10:45:17Z

Hi @Julien-Ben,
Can you please have a look into this as well.

viveksinghggits · 2025-07-21T11:58:10Z

The refactor looks really good!

Please also check and update old multicluster usages in other files. Examples I found:

mongodb-kubernetes/.dockerignore

Line 57 in 12d1b90

!/public/tools/multicluster/go.mod

mongodb-kubernetes/.gitignore

Line 6 in 896db65

public/tools/multicluster/vendor

mongodb-kubernetes/.evergreen-functions.yml

Line 667 in 0f58ef3

files: [ "src/github.com/mongodb/mongodb-kubernetes/*.suite", "src/github.com/mongodb/mongodb-kubernetes/public/tools/multicluster/*.suite", "src/github.com/mongodb/mongodb-kubernetes/docker/mongodb-kubernetes-init-ops-manager/mmsconfiguration/*.suite" ]

mongodb-kubernetes/public/samples/multi-cluster-cli-gitops/README.md

Lines 15 to 22 in ccf22c8

### Build the multi-cluster CLI image

You can build a minimal image containing the CLI executable using the `Dockerfile` [provided in this repo](./../../tools/multicluster/Dockerfile).

``` shell

git clone https://github.com/mongodb/mongodb-kubernetes

cd mongodb-kubernetes/public/tools/multicluster

docker build . -t "your-registry/multi-cluster-cli:latest"

docker push "your-registry/multi-cluster-cli:latest"

```

Thank you @MaciejKaras.
Those are good points, I am planning to raise those changes as part of a new PR.

Julien-Ben

Great work 👏

…ngodb` (#280) # Summary Since we [moved](#271) the code for kubectl plugin to the dir `cmd/`, we also need to move the Dockerfile there. This PR does the same and moves the Dockerfile to the `cmd/kubectl-mongodb` dir. ## Proof of Work Go to the root of the repo and run the below command to build the image ```bash ~/work/opensource/mongodb-kubernetes (move-kplugin-dockerfile*) » docker build -t viveksinghggits/mongodb-mc-plugin:0.0.1 . -f cmd/kubectl-mongodb/Dockerfile vivek.s@M-HYXVRF7WDG [+] Building 11.5s (10/10) FINISHED docker:desktop-linux => [internal] load build definition from Dockerfile 0.0s => => transferring dockerfile: 309B 0.0s => [internal] load metadata for docker.io/library/golang:1.24 0.7s => [internal] load .dockerignore 0.0s => => transferring context: 1.16kB 0.0s => [builder 1/4] FROM docker.io/library/golang:1.24@sha256:14fd8a55e59a560704e5fc44970b301d00d344e45d6b914dda228e09f359a088 0.0s => => resolve docker.io/library/golang:1.24@sha256:14fd8a55e59a560704e5fc44970b301d00d344e45d6b914dda228e09f359a088 0.0s => [internal] load build context 0.1s => => transferring context: 172.97kB 0.1s => CACHED [builder 2/4] WORKDIR /go/src 0.0s => [builder 3/4] ADD . . 0.2s => [builder 4/4] RUN CGO_ENABLED=0 go build -a -buildvcs=false -o /go/bin/mongodb-multicluster 10.4s => CACHED [stage-1 1/1] COPY --from=builder /go/bin/mongodb-multicluster /go/bin/mongodb-multicluster 0.0s => exporting to image 0.0s => => exporting layers 0.0s => => exporting manifest sha256:f0d3ef2864de3f81ec287382c66a76897419bddb5337a4e2fb9b56b7e3ca14dc 0.0s => => exporting config sha256:ce9089ec4e89d1b2c2b3dd5edeb4053eaae95c62a3182e7c015dd4d63ecf6be2 0.0s => => exporting attestation manifest sha256:19f49f2aebd733e6a259441c81d0fef424c6af4fadf6f86e8032e77b7f1f3d51 0.0s => => exporting manifest list sha256:1574999c4354dbe1915980c0baf9aab438cbc59c7b909e34bf73b84ec98945e9 0.0s => => naming to docker.io/viveksinghggits/mongodb-mc-plugin:0.0.1 0.0s => => unpacking to docker.io/viveksinghggits/mongodb-mc-plugin:0.0.1 0.0s ``` ## Checklist - [x] Have you linked a jira ticket and/or is the ticket in the title? - [x] Have you checked whether your jira ticket required DOCSP changes? - [x] Have you checked for release_note changes?

# Summary As part of [the PR](#271) we moved the kubectl-mongodb code from `public/tools/multicluster` to `cmd/kubectl-mongodb`. This PR, tries to move the license file from `public/tools/multicluster` to `cmd/kubectl-mongodb`. The next [PR](#281) in this chain are going to actually remove the `public/tools` directory entirely. ## Proof of Work NA ## Checklist - [x] Have you linked a jira ticket and/or is the ticket in the title? - [x] Have you checked whether your jira ticket required DOCSP changes? - [x] Have you checked for release_note changes?

viveksinghggits force-pushed the mongodb-kubectlplugin-refactor branch from 198327f to de60a3e Compare July 16, 2025 16:09

viveksinghggits force-pushed the mongodb-kubectlplugin-refactor branch from de60a3e to 02b94d0 Compare July 16, 2025 16:10

viveksinghggits force-pushed the mongodb-kubectlplugin-refactor branch from 94fab09 to 1884f19 Compare July 17, 2025 17:48

viveksinghggits marked this pull request as ready for review July 17, 2025 18:06

viveksinghggits requested a review from a team as a code owner July 17, 2025 18:06

viveksinghggits requested review from Julien-Ben and lucian-tosa July 17, 2025 18:06

viveksinghggits mentioned this pull request Jul 17, 2025

[CLOUDP-332234] Change the way kubectl-mongodb plugin is built by evergreen function #275

Closed

3 tasks

viveksinghggits requested a review from MaciejKaras July 17, 2025 19:32

MaciejKaras reviewed Jul 18, 2025

View reviewed changes

.goreleaser.yaml Outdated Show resolved Hide resolved

viveksinghggits changed the title ~~Move kubectl-mongodb plugin to cmd dir for atomic releases~~ [CLOUDP-332196] Move kubectl-mongodb plugin to cmd dir for atomic releases Jul 18, 2025

viveksinghggits added 2 commits July 18, 2025 11:17

Run `make precommit' to fix lint issues

1ae3bc4

Move release related scripts to scripts/release/kubectl-mongodb fro…

1255172

…m `multi_cluster/tools`

viveksinghggits requested a review from MaciejKaras July 18, 2025 09:40

viveksinghggits added 3 commits July 18, 2025 13:01

Fix golangci lint issues

b631771

Change script (build_multi_cluster_kubeconfig_creator.sh) to point …

5d9b986

…to correct kubectl-mongodb root

Move LICENSE-THIRD-PARTY to new dir cmd/

d83a293

Since we moved the code of `kubectl-mongodb` plugin to `cmd/` we needed to move the licenses files to the new location. This commit does that.

MaciejKaras approved these changes Jul 21, 2025

View reviewed changes

viveksinghggits mentioned this pull request Jul 21, 2025

[CLOUDP-332196] Move Dockerfile for kubectl-plugin to cmd/kubectl-mongodb #280

Merged

3 tasks

Julien-Ben approved these changes Jul 21, 2025

View reviewed changes

viveksinghggits merged commit 9a883c9 into master Jul 21, 2025
35 checks passed

viveksinghggits deleted the mongodb-kubectlplugin-refactor branch July 21, 2025 14:49

viveksinghggits mentioned this pull request Jul 21, 2025

Move LICENSE file for kubectl-plugin from public/ to cmd/ #282

Merged

3 tasks

lsierant mentioned this pull request Jul 23, 2025

CLOUDP-332943: Refactor unit test execution #288

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[CLOUDP-332196] Move `kubectl-mongodb` plugin to `cmd` dir for atomic releases #271

[CLOUDP-332196] Move `kubectl-mongodb` plugin to `cmd` dir for atomic releases #271

Uh oh!

viveksinghggits commented Jul 16, 2025 •

edited

Loading

Uh oh!

MaciejKaras commented Jul 18, 2025

Uh oh!

Uh oh!

viveksinghggits commented Jul 18, 2025

Uh oh!

viveksinghggits commented Jul 18, 2025

Uh oh!

MaciejKaras left a comment

Uh oh!

viveksinghggits commented Jul 21, 2025

Uh oh!

viveksinghggits commented Jul 21, 2025

Uh oh!

Julien-Ben left a comment

Uh oh!

Uh oh!

Uh oh!

	### Build the multi-cluster CLI image
	You can build a minimal image containing the CLI executable using the `Dockerfile` [provided in this repo](./../../tools/multicluster/Dockerfile).
	``` shell
	git clone https://github.com/mongodb/mongodb-kubernetes
	cd mongodb-kubernetes/public/tools/multicluster
	docker build . -t "your-registry/multi-cluster-cli:latest"
	docker push "your-registry/multi-cluster-cli:latest"
	```

[CLOUDP-332196] Move kubectl-mongodb plugin to cmd dir for atomic releases #271

[CLOUDP-332196] Move kubectl-mongodb plugin to cmd dir for atomic releases #271

Uh oh!

Conversation

viveksinghggits commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Note on LICENSE-THIRD-PARTY

Proof of Work

Checklist

Reminder (Please remove this when merging)

Uh oh!

MaciejKaras commented Jul 18, 2025

Uh oh!

Uh oh!

viveksinghggits commented Jul 18, 2025

Uh oh!

viveksinghggits commented Jul 18, 2025

Uh oh!

MaciejKaras left a comment

Choose a reason for hiding this comment

Uh oh!

viveksinghggits commented Jul 21, 2025

Uh oh!

viveksinghggits commented Jul 21, 2025

Uh oh!

Julien-Ben left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

[CLOUDP-332196] Move `kubectl-mongodb` plugin to `cmd` dir for atomic releases #271

[CLOUDP-332196] Move `kubectl-mongodb` plugin to `cmd` dir for atomic releases #271

viveksinghggits commented Jul 16, 2025 •

edited

Loading