Minikube: more options for connectivity #2312

markmandel · 2021-10-14T19:51:47Z

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 breaking
/kind bug
/kind cleanup

/kind documentation

/kind feature
/kind hotfix

What this PR does / Why we need it:

Minikube is a bit of a nightmare, since depending on your OS and your driver, you may or may not be able to connect to a UDP GameServer, with or without workarounds.

These changes capture two things:

A few more workaround to try and some dead ends to avoid.
Which OS+driver combos are known to work.
That it may not actually be possible, in which case, it's time to try something else.

Which issue(s) this PR fixes:

N/A

Special notes for your reviewer:

N/A

agones-bot · 2021-10-14T20:08:44Z

Build Failed 😱

Build Id: 0b33a33a-97a3-4ec1-8c3c-3bdf25e7ee11

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

markmandel · 2021-10-14T20:21:32Z

  Compiling async-stream v0.3.2
   Compiling tracing v0.1.29
   Compiling thiserror v1.0.30
   Compiling pin-project v1.0.8
   Compiling tracing-futures v0.2.5
   Compiling prost v0.8.0
   Compiling prost-types v0.8.0
   Compiling tonic-build v0.5.2
   Compiling tokio-util v0.6.8
   Compiling tokio-stream v0.1.7
   Compiling tokio-io-timeout v1.1.1
   Compiling h2 v0.3.6
   Compiling tower v0.4.9
error[E0710]: an unknown tool name found in scoped lint: `rustdoc::broken_intra_doc_links`
 --> /go/src/agones.dev/agones/test/sdk/rust/.cargo/registry/src/git.luolix.top-1ecc6299db9ec823/tower-0.4.9/src/lib.rs:8:9
  |
8 | #![deny(rustdoc::broken_intra_doc_links)]
  |         ^^^^^^^

   Compiling agones v0.1.0 (/go/src/agones.dev/agones/sdks/rust)
error: aborting due to previous error

For more information about this error, try `rustc --explain E0710`.
error: could not compile `tower`

includes/sdk.mk:168: recipe for target 'run-sdk-conformance-test-rust' failed rust sdk conformance failure.

agones-bot · 2021-10-14T20:37:09Z

Build Failed 😱

Build Id: cce5eb14-b82a-434a-a214-99a58adb974f

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

agones-bot · 2021-10-15T02:58:51Z

Build Succeeded 👏

Build Id: b9efd895-b73e-4a60-acf9-d79e0ad5c451

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

image: gcr.io/agones-images/agones-controller:1.19.0-9c946b6
image: gcr.io/agones-images/agones-ping:1.19.0-9c946b6
Linux C++ SDK (build): agonessdk-1.19.0-9c946b6-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-9c946b6.zip

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

https://9c946b6-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2312/head:pr_2312 && git checkout pr_2312
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-9c946b6

roberthbailey · 2021-10-15T02:29:35Z

site/content/en/docs/Installation/Creating Cluster/minikube.md

 {{< /alert >}}

+### Known working drivers
+
+Other OS's and drivers may work, but at this stage have not been verified. 


nit: Should this be OSes?

Or if we can't figure out the proper english, we could write it out as Operating Systems.

I'm definitely into clearer words. Switching to "Operating Systems".

google-oss-robot · 2021-10-15T03:42:02Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: markmandel, roberthbailey

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel,roberthbailey]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

mvlabat · 2021-10-16T10:01:26Z

site/content/en/docs/Installation/Creating Cluster/minikube.md

+* hyper-v (might need [this comment](https://github.com/microsoft/WSL/issues/4288#issuecomment-652259640) 
+  for WSL support)


Users will likely need more workarounds to make WSL work. When I was experimenting with it, I was also partially following this guide:
https://blog.thepolyglotprogrammer.com/setting-up-kubernetes-on-wsl-to-work-with-minikube-on-windows-10-90dac3c72fa1

It mentions that users will need to use the Windows version of minikube and manually edit kubectl config to point it to the Windows certificates.

I found out that Windows version of minikube is optional unless you need UDP support, but using Linux minikube will also require you to use minikube tunnel.

In my opinion, we should either lead a user through the whole setup for WSL if we feel like we want to or avoid mentioning it at all.

Thanks for the blog post link, added!

In my opinion, we should either lead a user through the whole setup for WSL if we feel like we want to or avoid mentioning it at all.

I'm happy to point to external resources, but these things go stale so quick, I'd rather not maintain a guide to setting up an external tool that we don't maintain.

mvlabat · 2021-10-16T10:06:36Z

site/content/en/docs/Installation/Creating Cluster/minikube.md

+{{< alert title="Warning" color="warning">}}
+`minikube tunnel` does not support UDP ([Github Issue](https://github.com/kubernetes/minikube/issues/12362)) on some 
+combination of OS platforms and drivers.
+{{< /alert >}}


it might be worth giving a bit more context on why users may need to use minikube tunnel.

Good idea. Added!

Minikube is a bit of a nightmare, since depending on your OS and your driver, you may or may not be able to connect to a UDP GameServer, with or without workarounds. These changes capture two things: 1. A few more workaround to try and some dead ends to avoid. 2. Which OS+driver combos are known to work. 3. That it may not actually be possible, in which case, it's time to try something else.

google-oss-robot · 2021-10-19T21:15:19Z

New changes are detected. LGTM label has been removed.

agones-bot · 2021-10-19T21:41:41Z

Build Succeeded 👏

Build Id: f9b948c1-272e-4fb2-9144-2ad78b8abc06

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

image: gcr.io/agones-images/agones-controller:1.19.0-a5a7422
image: gcr.io/agones-images/agones-ping:1.19.0-a5a7422
Linux C++ SDK (build): agonessdk-1.19.0-a5a7422-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-a5a7422.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2312/head:pr_2312 && git checkout pr_2312
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-a5a7422

roberthbailey · 2021-10-20T04:55:01Z

@mvlabat - want to take another look?

mvlabat · 2021-10-20T11:11:14Z

site/content/en/docs/Installation/Creating Cluster/minikube.md

+`minikube tunnel` ([docs](https://minikube.sigs.k8s.io/docs/handbook/accessing/)) 
+does not support UDP ([Github Issue](https://github.com/kubernetes/minikube/issues/12362)) on some combination of 
+operating system, platforms and drivers, but is required when using the `Service` workaround.
+{{< /alert >}}


From what I gathered when testing the workarounds locally, minikube tunnel is actually a self-sufficient workaround itself and can be used without creating a separate service.

minikube tunnel tunnels the traffic itself, thus making gameserver pods accessible from the host. On the setups where the address returned by minikube ip isn't accessible from the host, the service workaround will be useless, as the service is still behind the minikube ip address.

So if the purpose of the "Create a service" workaround is to tunnel the traffic to the host, I'm afraid it doesn't work at all (it'll be accessible if using minikube tunnel, but that defeats the purpose of the service then). Please correct me if I misinterpreted what the service workaround is supposed to do or if it did work in some cases. So my suggestion is to remove "Create a service" section completely and just mention minikube tunnel -p agones command as the workaround.

Copy pasting from https://minikube.sigs.k8s.io/docs/handbook/accessing/

Services of type LoadBalancer can be exposed via the minikube tunnel command. It must be run in a separate terminal window to keep the LoadBalancer running.

From: https://minikube.sigs.k8s.io/docs/commands/tunnel/

tunnel creates a route to services deployed with type LoadBalancer and sets their Ingress to their ClusterIP. for a detailed example see https://minikube.sigs.k8s.io/docs/tasks/loadbalancer

So as far as I read it, minikube tunnel can only be used with a Service. As far as I can tell it doesn't do anything else, so I don't think we should remove the Service workaround section, since it's part of the possible workaround solution.

I don't see anything in the documentation that states that minikube tunnel connects the node to the host machine for generalised traffic (maybe it does do that though on some platforms??? 🤔 )

Oh, I think you're right. I believe I tested it on a service that happened to be also a load balancer (and didn't notice that), so this is why I got such an impression.

I've got no other comments or suggestions then. Thanks a lot for updating the documentation!

Thanks for working through so much of this with me!

agones-bot · 2021-10-21T18:11:56Z

Build Failed 😱

Build Id: 050517fe-0c46-49fd-b84b-adeb33159e14

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

roberthbailey · 2021-10-21T18:14:27Z

SDK conformance flaked.

agones-bot · 2021-10-21T18:42:27Z

Build Succeeded 👏

Build Id: fada9015-8358-4000-a7c8-3ef02d847e82

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

image: gcr.io/agones-images/agones-controller:1.19.0-0caa728
image: gcr.io/agones-images/agones-ping:1.19.0-0caa728
Linux C++ SDK (build): agonessdk-1.19.0-0caa728-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-0caa728.zip

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

https://0caa728-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2312/head:pr_2312 && git checkout pr_2312
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-0caa728

markmandel added kind/documentation Documentation for Agones kind/cleanup Refactoring code, fixing up documentation, etc labels Oct 14, 2021

markmandel requested a review from roberthbailey October 14, 2021 19:51

google-cla bot added the cla: yes label Oct 14, 2021

google-oss-robot added the size/M label Oct 14, 2021

google-oss-robot requested a review from pooneh-m October 14, 2021 19:52

google-oss-robot added the approved label Oct 14, 2021

roberthbailey approved these changes Oct 15, 2021

View reviewed changes

google-oss-robot assigned roberthbailey Oct 15, 2021

google-oss-robot added the lgtm label Oct 15, 2021

mvlabat reviewed Oct 16, 2021

View reviewed changes

markmandel added 2 commits October 19, 2021 14:06

Review updates.

a5a7422

markmandel force-pushed the docs/minikube-connect branch from 9c946b6 to a5a7422 Compare October 19, 2021 21:15

google-oss-robot removed the lgtm label Oct 19, 2021

mvlabat reviewed Oct 20, 2021

View reviewed changes

Merge branch 'main' into docs/minikube-connect

0caa728

roberthbailey merged commit 717aa12 into googleforgames:main Oct 21, 2021

markmandel deleted the docs/minikube-connect branch October 25, 2021 21:39

roberthbailey added this to the 1.19.0 milestone Nov 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Minikube: more options for connectivity #2312

Minikube: more options for connectivity #2312

markmandel commented Oct 14, 2021

agones-bot commented Oct 14, 2021

markmandel commented Oct 14, 2021

agones-bot commented Oct 14, 2021

agones-bot commented Oct 15, 2021

roberthbailey Oct 15, 2021

roberthbailey Oct 15, 2021

markmandel Oct 19, 2021

google-oss-robot commented Oct 15, 2021

mvlabat Oct 16, 2021 •

edited

Loading

markmandel Oct 19, 2021

mvlabat Oct 16, 2021

markmandel Oct 19, 2021

google-oss-robot commented Oct 19, 2021

agones-bot commented Oct 19, 2021

roberthbailey commented Oct 20, 2021

mvlabat Oct 20, 2021 •

edited

Loading

markmandel Oct 20, 2021

mvlabat Oct 21, 2021

markmandel Oct 21, 2021

agones-bot commented Oct 21, 2021

roberthbailey commented Oct 21, 2021

agones-bot commented Oct 21, 2021

		* hyper-v (might need [this comment](https://github.com/microsoft/WSL/issues/4288#issuecomment-652259640)
		for WSL support)

Minikube: more options for connectivity #2312

Minikube: more options for connectivity #2312

Conversation

markmandel commented Oct 14, 2021

agones-bot commented Oct 14, 2021

markmandel commented Oct 14, 2021

agones-bot commented Oct 14, 2021

agones-bot commented Oct 15, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

google-oss-robot commented Oct 15, 2021

mvlabat Oct 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

google-oss-robot commented Oct 19, 2021

agones-bot commented Oct 19, 2021

roberthbailey commented Oct 20, 2021

mvlabat Oct 20, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Oct 21, 2021

roberthbailey commented Oct 21, 2021

agones-bot commented Oct 21, 2021

mvlabat Oct 16, 2021 •

edited

Loading

mvlabat Oct 20, 2021 •

edited

Loading