Document missing Allocation Service helm variables #3053

Kalaiselvi84 · 2023-03-30T04:32:03Z

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

/kind cleanup

What this PR does / Why we need it:

Which issue(s) this PR fixes:

Closes #2987

Special notes for your reviewer:

agones-bot · 2023-03-30T05:24:03Z

Build Succeeded 👏

Build Id: b059b993-d4e8-4cf8-98f6-42da2e0806b2

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.31.0-d17ea14-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.31.0-d17ea14-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.31.0-d17ea14-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.31.0-d17ea14-amd64
Linux C++ SDK (build): agonessdk-1.31.0-d17ea14-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.31.0-d17ea14-amd64.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3053/head:pr_3053 && git checkout pr_3053
helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.31.0-d17ea14-amd64

markmandel · 2023-03-30T16:37:02Z

site/content/en/docs/Installation/Install Agones/helm.md

@@ -177,14 +177,17 @@ The following tables lists the configurable parameters of the Agones chart and t
 | `agones.allocator.replicas`                              | The number of replicas to run in the deployment                                                                                                                                                                         | `3`                                |
 | `agones.allocator.service.name`                          | Service name for the allocator                                                                                                                                                                                          | `agones-allocator`                 |
 | `agones.allocator.service.serviceType`                   | The [Service Type][service] of the HTTP Service                                                                                                                                                                         | `LoadBalancer`                     |
+| `agones.allocator.service.http.nodePort`, `agones.allocator.service.grpc.nodePort`                   | The [NodePort] serves as the external entry point for incoming requests for your app                                                                                                                                                                         | `30000-32767`                     |


Let's not combine the two, but have separate rows for each please.

We should also make clear - This parameter is only used if the ServiceType is set to "NodePort".

Thanks!

These two parameters are added in separate rows. Thanks!

markmandel

Couple of minor tweaks, and I think this is good to go (but we should also check the preview, just in case)

markmandel · 2023-03-30T17:55:05Z

site/content/en/docs/Installation/Install Agones/helm.md

@@ -177,14 +177,18 @@ The following tables lists the configurable parameters of the Agones chart and t
 | `agones.allocator.replicas`                              | The number of replicas to run in the deployment                                                                                                                                                                         | `3`                                |
 | `agones.allocator.service.name`                          | Service name for the allocator                                                                                                                                                                                          | `agones-allocator`                 |
 | `agones.allocator.service.serviceType`                   | The [Service Type][service] of the HTTP Service                                                                                                                                                                         | `LoadBalancer`                     |
+| `agones.allocator.service.http.nodePort`                   | The NodePort parameter is used if the ServiceType is set to "NodePort" and it serves as the external entry point for the incoming requests                                                                                                                                                                         | `30000-32767`                     |


Suggested change

| `agones.allocator.service.http.nodePort` | The NodePort parameter is used if the ServiceType is set to "NodePort" and it serves as the external entry point for the incoming requests | `30000-32767` |

| `agones.allocator.service.http.nodePort` | If the ServiceType is set to "NodePort", this is the NodePort that the allocator http service is exposed on. | `30000-32767` |

Modified it.

markmandel · 2023-03-30T17:55:29Z

site/content/en/docs/Installation/Install Agones/helm.md

 | `agones.allocator.service.http.targetPort`               | The port that is used by the allocator pod to listen for [REST requests][rest-requests]. Note that the allocator server cannot bind to low numbered ports.                                                              | `8443`                             |
 | `agones.allocator.service.grpc.enabled`                  | If true the [allocator service][allocator] will respond to [gRPC requests][grpc-requests]                                                                                                                               | `true`                             |
 | `agones.allocator.service.grpc.port`                     | The port that is exposed externally by the [allocator service][allocator] for [gRPC requests][grpc-requests]                                                                                                            | `443`                              |
+| `agones.allocator.service.grpc.portName`                     | The name of exposed port                                                                                                            | ``                              |
+| `agones.allocator.service.grpc.nodePort`                   | The NodePort parameter is used if the ServiceType is set to "NodePort" and it serves as the external entry point for the incoming requests                                                                                                                                                                          | `30000-32767`                     |


Suggested change

| `agones.allocator.service.grpc.nodePort` | The NodePort parameter is used if the ServiceType is set to "NodePort" and it serves as the external entry point for the incoming requests | `30000-32767` |

| `agones.allocator.service.grpc.nodePort` | If the ServiceType is set to "NodePort", this is the NodePort that the allocator gRPC service is exposed on. | `30000-32767` |

Modified with this description.

markmandel · 2023-03-30T18:14:24Z

Sweet. Will wait on preview and if all looks good approve and merge 👍🏻

agones-bot · 2023-03-30T20:28:06Z

Build Failed 😱

Build Id: ed6fa5d5-4eda-4997-898b-038783ce3423

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

agones-bot · 2023-04-04T01:32:27Z

Build Succeeded 👏

Build Id: 6a0e87c1-d88c-43b6-9e0a-898bae23aabd

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.31.0-06ea647-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.31.0-06ea647-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.31.0-06ea647-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.31.0-06ea647-amd64
Linux C++ SDK (build): agonessdk-1.31.0-06ea647-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.31.0-06ea647-amd64.zip

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

https://06ea647-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3053/head:pr_3053 && git checkout pr_3053
helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.31.0-06ea647-amd64

google-oss-prow · 2023-04-04T15:02:49Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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-04-04T21:26:13Z

New changes are detected. LGTM label has been removed.

agones-bot · 2023-04-05T02:56:54Z

Build Succeeded 👏

Build Id: 1f1f1571-9697-4e7d-90b1-c93d17541d4e

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.31.0-58b9bb5-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.31.0-58b9bb5-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.31.0-58b9bb5-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.31.0-58b9bb5-amd64
Linux C++ SDK (build): agonessdk-1.31.0-58b9bb5-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.31.0-58b9bb5-amd64.zip

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

https://58b9bb5-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3053/head:pr_3053 && git checkout pr_3053
helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.31.0-58b9bb5-amd64

agones-bot · 2023-04-05T06:02:01Z

Build Succeeded 👏

Build Id: c4f35394-906a-4237-b07c-48ea67dc652f

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.31.0-ca04eb2-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.31.0-ca04eb2-linux-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.31.0-ca04eb2-amd64
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.31.0-ca04eb2-amd64
Linux C++ SDK (build): agonessdk-1.31.0-ca04eb2-amd64-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.31.0-ca04eb2-amd64.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3053/head:pr_3053 && git checkout pr_3053
helm install agones ./install/helm/agones --namespace agones-system --agones.image.release=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.31.0-ca04eb2-amd64

* Document missing Allocation Service helm variable * Document update for allocation service helm variable * changes in the description --------- Co-authored-by: Mark Mandel <markmandel@google.com>

Document missing Allocation Service helm variable

d17ea14

Kalaiselvi84 added the kind/cleanup Refactoring code, fixing up documentation, etc label Mar 30, 2023

Kalaiselvi84 added this to the 1.31.0 milestone Mar 30, 2023

Kalaiselvi84 requested a review from markmandel March 30, 2023 04:32

google-oss-prow bot requested review from EricFortin and roberthbailey March 30, 2023 04:32

google-oss-prow bot added the size/XS label Mar 30, 2023

markmandel reviewed Mar 30, 2023

View reviewed changes

Kalaiselvi84 marked this pull request as draft March 30, 2023 16:47

google-oss-prow bot added the do-not-merge/work-in-progress label Mar 30, 2023

Document update for allocation service helm variable

cb4e117

markmandel reviewed Mar 30, 2023

View reviewed changes

changes in the description

25f4be4

Kalaiselvi84 removed the do-not-merge/work-in-progress label Mar 30, 2023

Kalaiselvi84 marked this pull request as ready for review March 30, 2023 18:11

google-oss-prow bot requested a review from cyriltovena March 30, 2023 18:11

Merge branch 'main' into issue/275758536

06ea647

markmandel approved these changes Apr 4, 2023

View reviewed changes

google-oss-prow bot assigned markmandel Apr 4, 2023

google-oss-prow bot added the lgtm label Apr 4, 2023

google-oss-prow bot added the approved label Apr 4, 2023

markmandel enabled auto-merge (squash) April 4, 2023 15:02

Merge branch 'main' into issue/275758536

2d3ae13

google-oss-prow bot removed the lgtm label Apr 4, 2023

zmerlynn added 2 commits April 4, 2023 16:57

Merge branch 'main' into issue/275758536

bad511b

Merge branch 'main' into issue/275758536

58b9bb5

Merge branch 'main' into issue/275758536

ca04eb2

markmandel merged commit 6c8d338 into googleforgames:main Apr 5, 2023

Kalaiselvi84 deleted the issue/275758536 branch March 15, 2024 01:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document missing Allocation Service helm variables #3053

Document missing Allocation Service helm variables #3053

Kalaiselvi84 commented Mar 30, 2023

agones-bot commented Mar 30, 2023

markmandel Mar 30, 2023

Kalaiselvi84 Mar 30, 2023

markmandel left a comment

markmandel Mar 30, 2023

Kalaiselvi84 Mar 30, 2023

markmandel Mar 30, 2023

Kalaiselvi84 Mar 30, 2023

markmandel commented Mar 30, 2023

agones-bot commented Mar 30, 2023

agones-bot commented Apr 4, 2023

google-oss-prow bot commented Apr 4, 2023

google-oss-prow bot commented Apr 4, 2023

agones-bot commented Apr 5, 2023

agones-bot commented Apr 5, 2023

	\| `agones.allocator.service.http.nodePort` \| The NodePort parameter is used if the ServiceType is set to "NodePort" and it serves as the external entry point for the incoming requests \| `30000-32767` \|
	\| `agones.allocator.service.http.nodePort` \| If the ServiceType is set to "NodePort", this is the NodePort that the allocator http service is exposed on. \| `30000-32767` \|

	\| `agones.allocator.service.grpc.nodePort` \| The NodePort parameter is used if the ServiceType is set to "NodePort" and it serves as the external entry point for the incoming requests \| `30000-32767` \|
	\| `agones.allocator.service.grpc.nodePort` \| If the ServiceType is set to "NodePort", this is the NodePort that the allocator gRPC service is exposed on. \| `30000-32767` \|

Document missing Allocation Service helm variables #3053

Document missing Allocation Service helm variables #3053

Conversation

Kalaiselvi84 commented Mar 30, 2023

agones-bot commented Mar 30, 2023

markmandel Mar 30, 2023

Choose a reason for hiding this comment

Kalaiselvi84 Mar 30, 2023

Choose a reason for hiding this comment

markmandel left a comment

Choose a reason for hiding this comment

markmandel Mar 30, 2023

Choose a reason for hiding this comment

Kalaiselvi84 Mar 30, 2023

Choose a reason for hiding this comment

markmandel Mar 30, 2023

Choose a reason for hiding this comment

Kalaiselvi84 Mar 30, 2023

Choose a reason for hiding this comment

markmandel commented Mar 30, 2023

agones-bot commented Mar 30, 2023

agones-bot commented Apr 4, 2023

google-oss-prow bot commented Apr 4, 2023

google-oss-prow bot commented Apr 4, 2023

agones-bot commented Apr 5, 2023

agones-bot commented Apr 5, 2023