Docs for running docker-compose locally with SDK and server #3390

mbychkowski · 2023-09-20T15:32:11Z

What type of PR is this?

/kind documentation

What this PR does / Why we need it:
Simplify running Client SDK and game server locally for troubleshooting and testing by using Docker Compose to run both in one step.

Which issue(s) this PR fixes:
Relevant issue/comment

agones-bot · 2023-09-20T16:35:01Z

Build Succeeded 👏

Build Id: 3bbf8e67-765b-4952-a115-dbf3f0055f3a

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

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

https://49ddc88-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3390/head:pr_3390 && git checkout pr_3390
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.35.0-dev-49ddc88-amd64

markmandel

Yay! I've wanted this for ages!

markmandel · 2023-09-21T22:49:40Z

site/content/en/docs/Guides/Client SDKs/local.md

+      - "127.0.0.1:7777:7777/udp"
+
+  sdk-server:
+    image: "us-docker.pkg.dev/agones-images/release/agones-sdk:1.34.0"


Suggested change

image: "us-docker.pkg.dev/agones-images/release/agones-sdk:1.34.0"

image: "us-docker.pkg.dev/agones-images/release/agones-sdk:{{<release-version>}}"

Should work (I think 😃)

markmandel · 2023-09-21T22:50:48Z

site/content/en/docs/Guides/Client SDKs/local.md

+version: '3'
+services:
+  gameserver:
+    build: . # <location to your image here>


Is build a path to the image, or a path to the build context?

(Just looking at https://docs.docker.com/compose/compose-file/compose-file-v3/#build ?)

Ah, good question. build is to the context, but also defaults to assuming Dockerfile is at the root of that path. Happy to split this out to make more explicit for the docs like what is shown in that second example in your link. What do you think?

Updated verbiage here to # <path to build context>

markmandel · 2023-09-21T22:54:20Z

site/content/en/docs/Guides/Client SDKs/local.md

@@ -158,6 +158,34 @@ chmod o+r gameserver.yaml
 docker run --network=host --rm -v $(pwd)/gameserver.yaml:/tmp/gameserver.yaml us-docker.pkg.dev/agones-images/release/agones-sdk:{{<release-version>}} --local -f /tmp/gameserver.yaml
 ```

+If you would like to run the ClientSDK and your game server container together with Docker Compose create a `docker-compose.yaml` file.


Do we want to add an extra note here that's something like...

Suggested change

If you would like to run the ClientSDK and your game server container together with Docker Compose create a `docker-compose.yaml` file.

if you run Docker on a OS that doesn't run Docker natively or in a VM, such as on Windows or macOS., you may want to to run the ClientSDK and your game server container together with Docker Compose . To do so, create a `docker-compose.yaml` file setup with a network overlay shared between them:

Just so people have a why on they might want to do this.

WDYT?

I like, makes sense. Updated in latest commit.

markmandel · 2023-09-21T22:54:58Z

site/content/en/docs/Guides/Client SDKs/local.md

+  sdk-server:
+    image: "us-docker.pkg.dev/agones-images/release/agones-sdk:1.34.0"
+    command: --local -f /gs_config
+    network_mode: service:gameserver


Wondering if we want an extra comment here explaining that this is the shared network?

It's a good idea. I added a comment in the code block pointing this out: # <shared network between sdk and game server>

agones-bot · 2023-09-25T15:30:27Z

Build Succeeded 👏

Build Id: c018a4d6-b192-44e3-ba60-58f4747aae22

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3390/head:pr_3390 && git checkout pr_3390
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.35.0-dev-fad9f27-amd64

markmandel · 2023-09-28T20:21:34Z

site/content/en/docs/Guides/Client SDKs/local.md

@@ -158,6 +158,34 @@ chmod o+r gameserver.yaml
 docker run --network=host --rm -v $(pwd)/gameserver.yaml:/tmp/gameserver.yaml us-docker.pkg.dev/agones-images/release/agones-sdk:{{<release-version>}} --local -f /tmp/gameserver.yaml
 ```

+If you run Docker on a OS that doesn't run Docker natively or in a VM, such as on Windows or macOS, you may want to to run the ClientSDK and your game server container together with Docker Compose. To do so, create a `docker-compose.yaml` file setup with a network overlay shared between them:


Suggested change

If you run Docker on a OS that doesn't run Docker natively or in a VM, such as on Windows or macOS, you may want to to run the ClientSDK and your game server container together with Docker Compose. To do so, create a `docker-compose.yaml` file setup with a network overlay shared between them:

If you run Docker on a OS that doesn't run Docker natively or in a VM, such as on Windows or macOS, you may want to to run the ClientSDK and your game server container together with [Docker Compose](https://docs.docker.com/compose/). To do so, create a `docker-compose.yaml` file setup with a network overlay shared between them:

One final improvement I'd like to see - otherwise, this is good to go 👍🏻

agones-bot · 2023-09-29T15:52:53Z

Build Succeeded 👏

Build Id: 67808ebc-262c-4f24-9da4-487cd8f7d99d

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3390/head:pr_3390 && git checkout pr_3390
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.35.0-dev-b1cd568-amd64

google-oss-prow · 2023-09-29T20:56:20Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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]

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

google-oss-prow · 2023-09-29T20:56:33Z

New changes are detected. LGTM label has been removed.

agones-bot · 2023-09-29T21:58:12Z

Build Succeeded 👏

Build Id: 66e21008-330c-4ca5-acd9-74d1593339f9

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

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

https://358c5e0-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3390/head:pr_3390 && git checkout pr_3390
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.36.0-dev-358c5e0-amd64

Docs for running docker-compose locally with SDK and server

49ddc88

google-oss-prow bot added the size/M label Sep 20, 2023

github-actions bot added the kind/other label Sep 20, 2023

google-oss-prow bot requested review from aLekSer and EricFortin September 20, 2023 15:32

markmandel reviewed Sep 21, 2023

View reviewed changes

Changes to doc based on PR googleforgames#3390 review

fad9f27

markmandel reviewed Sep 28, 2023

View reviewed changes

Add docker compose link to readme

b1cd568

markmandel approved these changes Sep 29, 2023

View reviewed changes

google-oss-prow bot assigned markmandel Sep 29, 2023

google-oss-prow bot added the lgtm label Sep 29, 2023

google-oss-prow bot added the approved label Sep 29, 2023

markmandel enabled auto-merge (squash) September 29, 2023 20:56

Merge branch 'main' into doc/clientsdk-docker-compose

358c5e0

google-oss-prow bot removed the lgtm label Sep 29, 2023

markmandel merged commit 56c87de into googleforgames:main Sep 29, 2023
3 checks passed

Kalaiselvi84 added kind/documentation Documentation for Agones and removed kind/other labels Nov 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs for running docker-compose locally with SDK and server #3390

Docs for running docker-compose locally with SDK and server #3390

mbychkowski commented Sep 20, 2023

agones-bot commented Sep 20, 2023

markmandel left a comment

markmandel Sep 21, 2023

mbychkowski Sep 25, 2023

markmandel Sep 21, 2023

mbychkowski Sep 25, 2023

mbychkowski Sep 25, 2023

markmandel Sep 21, 2023

mbychkowski Sep 25, 2023

markmandel Sep 21, 2023

mbychkowski Sep 25, 2023

agones-bot commented Sep 25, 2023

markmandel Sep 28, 2023

agones-bot commented Sep 29, 2023

google-oss-prow bot commented Sep 29, 2023

google-oss-prow bot commented Sep 29, 2023

agones-bot commented Sep 29, 2023

	image: "us-docker.pkg.dev/agones-images/release/agones-sdk:1.34.0"
	image: "us-docker.pkg.dev/agones-images/release/agones-sdk:{{<release-version>}}"

	If you would like to run the ClientSDK and your game server container together with Docker Compose create a `docker-compose.yaml` file.
	if you run Docker on a OS that doesn't run Docker natively or in a VM, such as on Windows or macOS., you may want to to run the ClientSDK and your game server container together with Docker Compose . To do so, create a `docker-compose.yaml` file setup with a network overlay shared between them:

Docs for running docker-compose locally with SDK and server #3390

Docs for running docker-compose locally with SDK and server #3390

Conversation

mbychkowski commented Sep 20, 2023

agones-bot commented Sep 20, 2023

markmandel left a comment

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agones-bot commented Sep 25, 2023

Choose a reason for hiding this comment

agones-bot commented Sep 29, 2023

google-oss-prow bot commented Sep 29, 2023

google-oss-prow bot commented Sep 29, 2023

agones-bot commented Sep 29, 2023