Add pod annotations #1849

8398a7 · 2020-10-16T10:10:37Z

What type of PR is this?

/kind feature

What this PR does / Why we need it:

refs: #1848

Which issue(s) this PR fixes:

Closes #1848

Special notes for your reviewer:

agones-bot · 2020-10-16T10:31:46Z

Build Succeeded 👏

Build Id: eeca5afe-1483-4505-9b2c-4f7d371b5f69

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1849/head:pr_1849 && git checkout pr_1849
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.10.0-3fd9c4c

markmandel

Looks great! Just one small tweak in the docs.

Not sure if you want to - but you could also do the Ping service while you are in there?
https://github.com/googleforgames/agones/blob/master/install/helm/agones/templates/ping.yaml

markmandel · 2020-10-16T20:13:40Z

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

@@ -186,6 +186,7 @@ The following tables lists the configurable parameters of the Agones chart and t
 | `agones.controller.nodeSelector`                    | Controller [node labels][nodeSelector] for pod assignment                                       | `{}`                   |
 | `agones.controller.tolerations`                     | Controller [toleration][toleration] labels for pod assignment                                   | `[]`                   |
 | `agones.controller.affinity`                        | Controller [affinity][affinity] settings for pod assignment                                     | `{}`                   |
+| `agones.controller.annotations`                     | Controller [annotations][annotations] settings for pod assignment                               | `{}`                   |


Please move this down to where we have the section "New Configuration Features:" - so they only get displayed on the next release 👍

Context: https://agones.dev/site/docs/contribute/#within-a-page

Thank you. I fixed it with ab93fd6.

markmandel · 2020-10-16T20:13:51Z

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

@@ -226,6 +227,7 @@ The following tables lists the configurable parameters of the Agones chart and t
 | `agones.allocator.disableTLS`                       | Turns off TLS security for incoming connections to the allocator. | `false`                |
 | `agones.allocator.tolerations`                      | Allocator [toleration][toleration] labels for pod assignment                                    | `[]`                   |
 | `agones.allocator.affinity`                         | Allocator [affinity][affinity] settings for pod assignment                                      | `{}`                   |
+| `agones.allocator.annotations`                      | Allocator [annotations][annotations] settings for pod assignment                                | `{}`                   |


Please also move this down to where we have the section "New Configuration Features:" - so they only get displayed on the next release 👍

Thank you. I fixed it with ab93fd6.

8398a7 · 2020-10-17T02:44:58Z

Looks great! Just one small tweak in the docs.

Not sure if you want to - but you could also do the Ping service while you are in there?
https://github.com/googleforgames/agones/blob/master/install/helm/agones/templates/ping.yaml

Do you mean agones.ping.http.annotations and agones.ping.udp.annotations that already exist?
I had noticed that these weren't documented, but the background is somewhat different, so I thought I'd make a different PR.
But it looks like I can change them together, so I'll change it.

Only ping Deployment doesn't have annotations, which seems strange, so I'll add them together.

agones-bot · 2020-10-17T03:24:13Z

Build Failed 😱

Build Id: c614896e-770d-4ffa-91de-3b3082170344

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

markmandel · 2020-10-17T03:59:47Z

Not quite seeing it, but there something going wrong with the annotation link:

htmltest started at 03:18:20 on /tmp/website
========================================================================
site/docs/installation/install-agones/helm/index.html
  target does not exist --- site/docs/installation/install-agones/helm/index.html --> annotations
========================================================================
✘✘✘ failed in 375.927952ms
1 errors in 118 documents
Html Test: Attempt 2
htmltest started at 03:19:21 on /tmp/website

If you want to test it yourself make site-server will start create the website locally.

8398a7 · 2020-10-17T04:09:22Z

Oh, moving annotations to "New Configuration Features" seems to have affected it.
I should have moved the annotations link along with it.

I'm trying the make site-server at hand, so I'll push it if it's OK.

agones-bot · 2020-10-17T04:32:00Z

Build Failed 😱

Build Id: eeafd610-2941-4664-9026-fa71665c0d68

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

8398a7 · 2020-10-17T04:40:03Z

It's still no good...
The make site-server seems to work, but...

I've written a patch to run the site-test at hand and will push it when the test passes.

diff --git a/build/Makefile b/build/Makefile
index 99cb5843..aa7bb85d 100644
--- a/build/Makefile
+++ b/build/Makefile
@@ -235,6 +235,8 @@ push-release-chart: $(ensure-build-image)
 # Run all tests
 test: $(ensure-build-image) test-go test-sdks test-install-yaml site-test

+site-test: $(ensure-build-image) site-test
+
 # Run go tests
 test-go: $(ensure-build-image)
        $(GO_TEST) $(agones_package)/pkg/... \

8398a7 · 2020-10-17T04:47:47Z

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

+| `agones.controller.annotations`                     | Controller [annotations][annotations] settings for pod assignment                               | `{}`                   |
+| `agones.allocator.annotations`                      | Allocator [annotations][annotations] settings for pod assignment                                | `{}`                   |
+| `agones.ping.annotations`                           | Ping [annotations][annotations] settings for pod assignment                                     | `{}`                   |
+| `agones.ping.http.annotations`                      | [Annotations](annotations) for ping http service                                                | `{}`                   |


[Annotations](annotations) 😭
my typo...

agones-bot · 2020-10-17T05:11:36Z

Build Succeeded 👏

Build Id: 67da3b06-d3f0-4a47-8160-4d97f2d024e6

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1849/head:pr_1849 && git checkout pr_1849
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.10.0-b707bb0

markmandel · 2020-10-19T23:40:24Z

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

+| `agones.controller.annotations`                     | Controller [annotations][annotations] settings for pod assignment                               | `{}`                   |
+| `agones.allocator.annotations`                      | Allocator [annotations][annotations] settings for pod assignment                                | `{}`                   |
+| `agones.ping.annotations`                           | Ping [annotations][annotations] settings for pod assignment                                     | `{}`                   |
+| `agones.ping.http.annotations`                      | [Annotations][annotations] for ping http service                                                | `{}`                   |


Sorry to make you juggle this around, but agones.ping.udp.annotations and agones.ping.http.annotations already exist in the current release, but aren't documented - so they can go in the section up above.

There new, remaining values should stay down here.

Random thought - do we think there is any confusion given that agones.ping.udp.annotations is a annotation on a service, but agones.controller.annotations is on Pods?

Random thought - do we think there is any confusion given that agones.ping.udp.annotations is a annotation on a service, but agones.controller.annotations is on Pods?

Hmmm, it's somewhat confusing.
Should I revise it to agones.controller.podAnnotations or agones.ping.udp.serviceAnnotations or something?

Sorry to make you juggle this around, but agones.ping.udp.annotations and agones.ping.http.annotations already exist in the current release, but aren't documented - so they can go in the section up above.

There new, remaining values should stay down here.

I understand.
I'll fix the name I asked for in my comment above when I decide what to do with it.

@roberthbailey @pooneh-m would love a second opinion?

Worth noting, agones.ping.udp.annotations and agones.ping.http.annotations where in previous releases, but weren't documented.

WDYT?

If you look at the structure in https://github.com/googleforgames/agones/blob/master/install/helm/agones/values.yaml I don't actually think it's all that confusing. The annotations for the service / pod are clearly nested under the values for the service / pod respectively.

I think the descriptions in this table should make it clear what type of k8s resource the annotations are being applied to. e.g.

| agones.controller.annotations | [Annotations][annotations] added to the Agones controller pods |
| agones.ping.http.annotations | [Annotations][annotations] added to the Agones ping http service |

SGTM! Thanks for the second/third pair of eyes - that works for me 👍

markmandel · 2020-10-20T17:57:58Z

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

@@ -236,7 +236,14 @@ The following tables lists the configurable parameters of the Agones chart and t

 | Parameter                                           | Description                                                                                     | Default                |
 | --------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ---------------------- |
-|                                                     |                                                                                                 |                        |             
+| `agones.controller.annotations`                     | Controller [annotations][annotations] settings for pod assignment                               | `{}`                   |


Suggested change

| `agones.controller.annotations` | Controller [annotations][annotations] settings for pod assignment | `{}` |

| `agones.controller.annotations` | [Annotations][annotations] added to the Agones controller pods | `{}` |

Just going by Robbie's suggestion, to make it super clear. WDYT?

markmandel · 2020-10-20T18:00:12Z

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

+| `agones.controller.annotations`                     | Controller [annotations][annotations] settings for pod assignment                               | `{}`                   |
+| `agones.allocator.annotations`                      | Allocator [annotations][annotations] settings for pod assignment                                | `{}`                   |
+| `agones.ping.annotations`                           | Ping [annotations][annotations] settings for pod assignment                                     | `{}`                   |
+| `agones.ping.http.annotations`                      | [Annotations][annotations] for ping http service                                                | `{}`                   |


Suggested change

| `agones.ping.http.annotations` | [Annotations][annotations] for ping http service | `{}` |

| `agones.ping.http.annotations` | [Annotations][annotations] added to the Agones ping http service | `{}` |

Minor tweaks for just some extra clarity based on Robbie's suggestions. Just to make things extra clear.

agones-bot · 2020-10-20T23:55:35Z

Build Succeeded 👏

Build Id: 59c57d02-8cf7-4cc6-bb26-ff5496334897

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1849/head:pr_1849 && git checkout pr_1849
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.10.0-6890160

agones-bot · 2020-10-21T00:00:18Z

Build Succeeded 👏

Build Id: d3f465e3-8302-483e-ad9b-2d96ad932e66

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1849/head:pr_1849 && git checkout pr_1849
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.10.0-9b70197

markmandel

Let's get this in!

google-oss-robot · 2020-10-21T00:05:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 8398a7, 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-robot · 2020-10-21T00:06:35Z

New changes are detected. LGTM label has been removed.

agones-bot · 2020-10-21T00:26:50Z

Build Succeeded 👏

Build Id: c78afe37-fe54-4d67-8ad6-f0f74df02d23

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

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

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

https://05a97c6-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1849/head:pr_1849 && git checkout pr_1849
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.10.0-05a97c6

* Changed to allow annotations to be injected (googleforgames#1848) * Docs: Added explanation of annotations (googleforgames#1848) Co-authored-by: Mark Mandel <markmandel@google.com>

8398a7 added 2 commits October 16, 2020 19:06

Changed to allow annotations to be injected (googleforgames#1848)

fcafc61

Docs: Added explanation of annotations (googleforgames#1848)

3fd9c4c

google-cla bot added the cla: yes label Oct 16, 2020

google-oss-robot requested review from dzlier-gcp and markmandel October 16, 2020 10:10

google-oss-robot added the size/S label Oct 16, 2020

markmandel added area/operations Installation, updating, metrics etc kind/feature New features for Agones labels Oct 16, 2020

markmandel reviewed Oct 16, 2020

View reviewed changes

8398a7 added 2 commits October 17, 2020 11:50

Changed to allow annotations to be injected (googleforgames#1848)

87e4ef1

Docs: Fixed docs related to annotations (googleforgames#1848)

ab93fd6

8398a7 commented Oct 17, 2020

View reviewed changes

Fixed the annotation link (googleforgames#1848)

b707bb0

8398a7 force-pushed the addPodAnnotations branch from 124c261 to b707bb0 Compare October 17, 2020 04:50

markmandel reviewed Oct 19, 2020

View reviewed changes

markmandel reviewed Oct 20, 2020

View reviewed changes

8398a7 added 2 commits October 21, 2020 08:29

Docs: Improve the description (googleforgames#1848)

9b70197

Docs: Move the annotation from feature (googleforgames#1848)

6890160

markmandel approved these changes Oct 21, 2020

View reviewed changes

google-oss-robot assigned markmandel Oct 21, 2020

google-oss-robot added the lgtm label Oct 21, 2020

google-oss-robot added the approved label Oct 21, 2020

Merge branch 'master' into addPodAnnotations

05a97c6

google-oss-robot removed the lgtm label Oct 21, 2020

markmandel added this to the 1.10.0 milestone Oct 21, 2020

markmandel merged commit 8a81ddc into googleforgames:master Oct 21, 2020

8398a7 deleted the addPodAnnotations branch October 21, 2020 02:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pod annotations #1849

Add pod annotations #1849

8398a7 commented Oct 16, 2020 •

edited

agones-bot commented Oct 16, 2020

markmandel left a comment

markmandel Oct 16, 2020

8398a7 Oct 17, 2020

markmandel Oct 16, 2020

8398a7 Oct 17, 2020

8398a7 commented Oct 17, 2020

agones-bot commented Oct 17, 2020

markmandel commented Oct 17, 2020 •

edited

8398a7 commented Oct 17, 2020

agones-bot commented Oct 17, 2020

8398a7 commented Oct 17, 2020

8398a7 Oct 17, 2020 •

edited

agones-bot commented Oct 17, 2020

markmandel Oct 19, 2020

8398a7 Oct 20, 2020

8398a7 Oct 20, 2020

markmandel Oct 20, 2020

roberthbailey Oct 20, 2020

markmandel Oct 20, 2020

8398a7 Oct 20, 2020

markmandel Oct 20, 2020

8398a7 Oct 20, 2020 •

edited

markmandel Oct 20, 2020

8398a7 Oct 20, 2020 •

edited

agones-bot commented Oct 20, 2020

agones-bot commented Oct 21, 2020

markmandel left a comment

google-oss-robot commented Oct 21, 2020

google-oss-robot commented Oct 21, 2020

agones-bot commented Oct 21, 2020

	\| `agones.controller.annotations` \| Controller [annotations][annotations] settings for pod assignment \| `{}` \|
	\| `agones.controller.annotations` \| [Annotations][annotations] added to the Agones controller pods \| `{}` \|

	\| `agones.ping.http.annotations` \| [Annotations][annotations] for ping http service \| `{}` \|
	\| `agones.ping.http.annotations` \| [Annotations][annotations] added to the Agones ping http service \| `{}` \|

Add pod annotations #1849

Add pod annotations #1849

Conversation

8398a7 commented Oct 16, 2020 • edited

agones-bot commented Oct 16, 2020

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

8398a7 commented Oct 17, 2020

agones-bot commented Oct 17, 2020

markmandel commented Oct 17, 2020 • edited

8398a7 commented Oct 17, 2020

agones-bot commented Oct 17, 2020

8398a7 commented Oct 17, 2020

8398a7 Oct 17, 2020 • edited

Choose a reason for hiding this comment

agones-bot commented Oct 17, 2020

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

8398a7 Oct 20, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

8398a7 Oct 20, 2020 • edited

Choose a reason for hiding this comment

agones-bot commented Oct 20, 2020

agones-bot commented Oct 21, 2020

markmandel left a comment

Choose a reason for hiding this comment

google-oss-robot commented Oct 21, 2020

google-oss-robot commented Oct 21, 2020

agones-bot commented Oct 21, 2020

8398a7 commented Oct 16, 2020 •

edited

markmandel commented Oct 17, 2020 •

edited

8398a7 Oct 17, 2020 •

edited

8398a7 Oct 20, 2020 •

edited

8398a7 Oct 20, 2020 •

edited