Feat: enable remote debugging with minikube by lacroixthomas · Pull Request #4341 · agones-dev/agones

lacroixthomas · 2025-11-20T18:25:49Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind documentation
/kind feature

What this PR does / Why we need it:
Enable remote debugging with minikube locally

Which issue(s) this PR fixes:

Closes #4340

Special notes for your reviewer:

lacroixthomas · 2025-11-20T18:26:41Z

This is in Work in progress, still need to update things around the agones-sdk, not sure if it's possible to add the option to debug it

agones-bot · 2025-11-20T19:29:15Z

Build Failed 😭

Build Id: 0a00fd05-b822-42a7-a796-0880841e1776

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

build/includes/minikube.mk

build/README.md

agones-bot · 2025-11-20T22:27:45Z

Build Succeeded 🥳

Build Id: c31bb841-be9a-4fa1-aed6-f583fd91ae23

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-3d196bf
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-3d196bf
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-3d196bf-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-3d196bf
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-3d196bf
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-3d196bf
Linux C++ SDK (build): agonessdk-1.54.0-dev-3d196bf-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-3d196bf.zip

A preview of the website (the last 30 builds are retained):

https://3d196bf-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4341/head:pr_4341 && git checkout pr_4341
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-3d196bf

build/Makefile

agones-bot · 2025-11-25T17:22:34Z

Build Failed 😭

Build Id: f9d969c3-0bf8-46f5-afe9-38c24c26870d

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

agones-bot · 2025-11-27T03:00:18Z

Build Succeeded 🥳

Build Id: 4fdf098a-33e4-4202-baed-27a64aa8e5f0

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-7c21c62
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-7c21c62
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-7c21c62-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-7c21c62
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-7c21c62
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-7c21c62
Linux C++ SDK (build): agonessdk-1.54.0-dev-7c21c62-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-7c21c62.zip

A preview of the website (the last 30 builds are retained):

https://7c21c62-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4341/head:pr_4341 && git checkout pr_4341
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-7c21c62

agones-bot · 2025-11-28T00:19:42Z

Build Succeeded 🥳

Build Id: b6219f42-2f74-4bb4-9443-b6d79bcefd64

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-e0f933e
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-e0f933e
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-e0f933e-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-e0f933e
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-e0f933e
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-e0f933e
Linux C++ SDK (build): agonessdk-1.54.0-dev-e0f933e-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-e0f933e.zip

A preview of the website (the last 30 builds are retained):

https://e0f933e-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4341/head:pr_4341 && git checkout pr_4341
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-e0f933e

github-actions · 2025-11-28T22:49:57Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2025-11-28T23:48:58Z

Build Succeeded 🥳

Build Id: 9c5a1a36-82e8-49a1-9ee6-519129b11b82

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-a4f1b8f
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-a4f1b8f
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-a4f1b8f-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-a4f1b8f
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-a4f1b8f
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-a4f1b8f
Linux C++ SDK (build): agonessdk-1.54.0-dev-a4f1b8f-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-a4f1b8f.zip

A preview of the website (the last 30 builds are retained):

https://a4f1b8f-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4341/head:pr_4341 && git checkout pr_4341
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-a4f1b8f

markmandel

Exciting stuff. We've kinda blended the two projects into one PR, but I think both are close enough to being done that it's not worth splitting at this point.

markmandel · 2025-11-29T19:12:17Z

build/README.md

@@ -1,4 +1,4 @@
-# Developing, Testing and Building Agones
+# Agones Development Documentation


Love this split - makes things so much more approachable!

markmandel · 2025-11-29T19:12:51Z

build/README.md

-
-#### make helm-repo-update
+# Run tests and build images
+make test-go build-images


Suggested change

make test-go build-images

make lint test-go build-images

Since linting is not included in test-go ?

markmandel · 2025-11-29T19:13:17Z

build/README.md

-Create GKE cluster and install current version of agones.
-The current version should be built and pushed to `$(REGISTRY)` beforehand:
+# Run end-to-end tests
+make test-e2e


Suggested change

make test-e2e

Shall we delete this, since it won't work on minikube?

markmandel · 2025-11-29T19:14:37Z

build/README.md

-The current version should be built and pushed to `$(REGISTRY)` beforehand:
+# Run end-to-end tests
+make test-e2e
+make minikube-test-e2e


Suggested change

make minikube-test-e2e

# This takes a _while_, so run at your peril!

make minikube-test-e2e

Given how comprehensive and long e2e tests take, this definitely needs a warning I figure?

Ooh yep definitively, maybe I will add an example as well to run a single e2e locally (to avoid running them all)

I was debating this. There are some e2e tests that definitely need more than one node to complete too. Although I don't think we have a make target that let's you pick just one e2e test? (maybe we should).

It should works with a single one: https://github.com/googleforgames/agones/blob/main/build/README.md#make-test-e2e-integration
It's what I'm using, basically it will run the 4 from https://github.com/googleforgames/agones/blob/main/build/Makefile#L326 and will match the one you put in the args

But I can definitively put the number of nodes to 2 for the make minikube-test-cluster!

build/README.md

markmandel · 2025-11-29T19:29:26Z

build/docs/troubleshooting.md

+
+## Performance and Profiling Issues
+
+### I want to use pprof to profile the controller.


Should we move this pprof guide to development-workflow.md? Seems like it would be a good fit?

markmandel · 2025-11-29T19:30:16Z

build/docs/make-reference.md

@@ -0,0 +1,490 @@
+# Make Reference Guide


Not for now - but we should at some point explore having this not be so manual.

markmandel · 2025-11-29T19:32:52Z

build/includes/minikube.mk

+
+# Push debug images to minikube
+# This will load the debug images and retag them to the normal tag
+minikube-push-debug:


🤔 random thought - rather than having explicit debug image tags, could/should we reuse the standard tags instead? Then it's just the as pushing via the regular commands, and there is less Makefile targets to maintain?

Basically the same as what we do for pprof builds?

Totally, that would make things clearer / avoid duplications everywhere etc.
Gonna get rid of all the *_debug_tag and use the original one (and also remove this minikube-push-debug 👌🏼

markmandel · 2025-11-29T19:43:59Z

build/Makefile

+# Build controller with debug symbols for debugging
+build-controller-debug-binary: $(ensure-build-image)
+	$(GO_BUILD_LINUX_AMD64) \
+	-tags $(GO_BUILD_TAGS) -gcflags="all=-N -l" -o $(go_build_base_path)/cmd/controller/bin/controller.linux.amd64 \
+	$(go_rebuild_flags) $(go_version_flags) -installsuffix cgo $(agones_package)/cmd/controller


Suggested change

# Build controller with debug symbols for debugging

build-controller-debug-binary: $(ensure-build-image)

$(GO_BUILD_LINUX_AMD64) \

-tags $(GO_BUILD_TAGS) -gcflags="all=-N -l" -o $(go_build_base_path)/cmd/controller/bin/controller.linux.amd64 \

$(go_rebuild_flags) $(go_version_flags) -installsuffix cgo $(agones_package)/cmd/controller

# Build controller with debug symbols for debugging

build-controller-debug-binary: GO_BUILD_TAGS += "-gcflags="all=-N -l""

build-controller-debug-binary: build-controller-binary-linux-amd64

This looks close enough to make build-controller-binary-linux-amd64 that I think this might work (I haven't tested it though), and shrink maintenance paths. (same for the other targets as well). Worth a shot to avoid duplication.

Similar to what we do here:

https://github.com/lacroixthomas/agones/blob/a4f1b8f0791c66467e677ecaa5744cd32edcb00a/build/includes/minikube.mk#L91-L93

markmandel · 2025-11-29T19:44:34Z

cmd/allocator/Dockerfile.debug

+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM gcr.io/distroless/static-debian12:nonroot as base


My kingdom for some kind of Docker include, but alas it does not exist.

github-actions · 2025-11-30T23:35:21Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

github-actions · 2025-11-30T23:40:44Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

lacroixthomas · 2025-11-30T23:41:14Z

Exciting stuff. We've kinda blended the two projects into one PR, but I think both are close enough to being done that it's not worth splitting at this point.

I should definitively have done it in 2 PRs, would have been simpler to review my bad 😅

github-actions · 2025-12-01T00:09:00Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2025-12-01T01:26:15Z

Build Succeeded 🥳

Build Id: 7b49d06a-856f-4c32-ab9c-1c67b6e0f902

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-56246bf
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-56246bf
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-56246bf-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-56246bf
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-56246bf
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-56246bf
Linux C++ SDK (build): agonessdk-1.54.0-dev-56246bf-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-56246bf.zip

A preview of the website (the last 30 builds are retained):

https://56246bf-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4341/head:pr_4341 && git checkout pr_4341
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-56246bf

markmandel

Looking good - just a couple of outstanding bits.

github-actions · 2025-12-03T22:49:30Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

github-actions · 2025-12-03T22:49:58Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

lacroixthomas · 2025-12-03T22:50:37Z

Looking good - just a couple of outstanding bits.

Should be all good, github might be a bit funky around the comments about the make targets for the binary (it doesn't set them as outdated), but It's updated in the diff 😄

agones-bot · 2025-12-04T00:03:17Z

Build Succeeded 🥳

Build Id: f2d1b85b-1018-4bec-95c7-1a415cadf8f8

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-807bab3
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-807bab3
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-807bab3-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-807bab3
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-807bab3
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-807bab3
Linux C++ SDK (build): agonessdk-1.54.0-dev-807bab3-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-807bab3.zip

A preview of the website (the last 30 builds are retained):

https://807bab3-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4341/head:pr_4341 && git checkout pr_4341
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-807bab3

markmandel · 2025-12-05T04:02:38Z

Nice work!

github-actions · 2025-12-05T04:03:37Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

agones-bot · 2025-12-05T04:59:57Z

Build Succeeded 🥳

Build Id: 1d57e1bb-64ab-4265-909b-8067081c677e

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-2215eec
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-2215eec
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-2215eec-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-2215eec
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-2215eec
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-2215eec
Linux C++ SDK (build): agonessdk-1.54.0-dev-2215eec-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-2215eec.zip

A preview of the website (the last 30 builds are retained):

https://2215eec-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4341/head:pr_4341 && git checkout pr_4341
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-2215eec

* feat: enable remote debugging with minikube * feat: allow agones-sdk in debug mode * feat: pudate minikube port-forwards targets * Feat: fix some minikube commands and update doc * feat: split big readme from build in multiple ones * feat: update doc / make targets * feat: move pprof from troubleshooting to dev-workflow * Feat: fix tags * feat: update doc to create minikube cluters with 2 nodes

feat: enable remote debugging with minikube

0b2b5a6

github-actions bot added the kind/documentation Documentation for Agones label Nov 20, 2025

Merge branch 'main' into features/enhance-debug-mode-with-minikube

137cf18

github-actions bot added the size/M label Nov 20, 2025

lacroixthomas marked this pull request as draft November 20, 2025 18:26

feat: allow agones-sdk in debug mode

3d196bf

lacroixthomas commented Nov 20, 2025

View reviewed changes

build/includes/minikube.mk Outdated Show resolved Hide resolved

lacroixthomas commented Nov 20, 2025

View reviewed changes

build/README.md Outdated Show resolved Hide resolved

lacroixthomas commented Nov 20, 2025

View reviewed changes

build/Makefile Outdated Show resolved Hide resolved

feat: pudate minikube port-forwards targets

9cfdf55

lacroixthomas force-pushed the features/enhance-debug-mode-with-minikube branch from f422940 to 9cfdf55 Compare November 27, 2025 01:56

Merge branch 'main' into features/enhance-debug-mode-with-minikube

7c21c62

github-actions bot added the size/L label Nov 27, 2025

Merge branch 'main' into features/enhance-debug-mode-with-minikube

e0f933e

lacroixthomas added 2 commits November 28, 2025 17:00

Feat: fix some minikube commands and update doc

d9b6aa8

feat: split big readme from build in multiple ones

a4f1b8f

github-actions bot added the size/XL label Nov 28, 2025

lacroixthomas marked this pull request as ready for review November 28, 2025 22:54

lacroixthomas requested review from igooch and markmandel November 28, 2025 22:54

markmandel reviewed Nov 29, 2025

View reviewed changes

feat: update doc / make targets

da61315

feat: move pprof from troubleshooting to dev-workflow

c3363e4

Feat: fix tags

56246bf

markmandel reviewed Dec 2, 2025

View reviewed changes

feat: update doc to create minikube cluters with 2 nodes

04c9ddb

Merge branch 'main' into features/enhance-debug-mode-with-minikube

807bab3

markmandel approved these changes Dec 5, 2025

View reviewed changes

markmandel enabled auto-merge (squash) December 5, 2025 04:03

Merge branch 'main' into features/enhance-debug-mode-with-minikube

2215eec

markmandel merged commit c60bb86 into agones-dev:main Dec 5, 2025
4 checks passed

		@@ -1,4 +1,4 @@
		# Developing, Testing and Building Agones
		# Agones Development Documentation

	make minikube-test-e2e
	# This takes a _while_, so run at your peril!
	make minikube-test-e2e


		## Performance and Profiling Issues

		### I want to use pprof to profile the controller.

Conversation

lacroixthomas commented Nov 20, 2025

Uh oh!

lacroixthomas commented Nov 20, 2025

Uh oh!

agones-bot commented Nov 20, 2025

Uh oh!

Uh oh!

Uh oh!

agones-bot commented Nov 20, 2025

Uh oh!

Uh oh!

agones-bot commented Nov 25, 2025

Uh oh!

agones-bot commented Nov 27, 2025

Uh oh!

agones-bot commented Nov 28, 2025

Uh oh!

github-actions bot commented Nov 28, 2025

Uh oh!

agones-bot commented Nov 28, 2025

Uh oh!

markmandel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lacroixthomas Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 30, 2025

Uh oh!

github-actions bot commented Nov 30, 2025

Uh oh!

lacroixthomas commented Nov 30, 2025

Uh oh!

github-actions bot commented Dec 1, 2025

Uh oh!

agones-bot commented Dec 1, 2025

Uh oh!

markmandel left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 3, 2025

Uh oh!

github-actions bot commented Dec 3, 2025

Uh oh!

lacroixthomas commented Dec 3, 2025

Uh oh!

agones-bot commented Dec 4, 2025

Uh oh!

markmandel commented Dec 5, 2025

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

agones-bot commented Dec 5, 2025

lacroixthomas Dec 3, 2025 •

edited

Loading