Add ability to specify annotations for the SDK service account #2317

highlyunavailable · 2021-10-18T22:43:22Z

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:
The gameserver SDK account commonly wants annotations, e.g. for cloud permissions for storing logs or replays. This adds the ability to map SDK accounts per namespace to maps of annotations to be added to the SDK account for the specified namespace in the Helm chart during creation. An example value from the values file for the helm chart would be:

agones:
  serviceaccount:
    sdk:
      annotations:
        gameservers:
          cloud-permission-id: 123456
        xbox:
          cloud-permission-id: 537934
gameservers:
  namespaces:
    - gameservers
    - xbox
    - staging

In this example yaml, the agones-sdk accounts in the gameservers and xbox namespaces would get annotations as follows:

name: agones-sdk
namespace: gameservers
annotations:
  cloud-permission-id: 123456

name: agones-sdk
namespace: xbox
annotations:
  cloud-permission-id: 537934

The agones-sdk service account in the staging namespace would get no annotations.

Which issue(s) this PR fixes:
N/A

Special notes for your reviewer:

agones-bot · 2021-10-18T23:10:22Z

Build Succeeded 👏

Build Id: b9c0c387-5f33-4c1f-ad3c-bc38ae5c5073

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-4a6e2f7
image: gcr.io/agones-images/agones-ping:1.19.0-4a6e2f7
Linux C++ SDK (build): agonessdk-1.19.0-4a6e2f7-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-4a6e2f7.zip

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

https://4a6e2f7-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2317/head:pr_2317 && git checkout pr_2317
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-4a6e2f7

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

roberthbailey · 2021-10-18T23:17:38Z

install/helm/agones/templates/serviceaccounts/sdk.yaml

@@ -23,6 +23,10 @@ metadata:
    chart: {{ template "agones.chart" $ }}
    release: {{ $.Release.Name }}
    heritage: {{ $.Release.Service }}
+{{- if hasKey $.Values.agones.serviceaccount.sdk.annotations . }}


In other places we just check for existence, e.g.:

{{- if .Values.agones.allocator.service.annotations }} annotations: {{ toYaml .Values.agones.allocator.service.annotations | indent 4 }} {{- end }}

The reason it is "hasKey" is because that checks for existence of a variable key.

Given this:

agones: serviceaccounts: sdk: annotations: gameservers-eu-central-1: eks.amazonaws.com/role-arn: arn:aws:iam::12345:role/IAMROLEHERE

hasKey $.Values.agones.serviceaccount.sdk.annotations . where . is gameservers-eu-central-1 is saying "does the key gameservers-eu-central-1 exist under Values.agones.serviceaccount.sdk.annotations? If yes, then put the entire map below that into annotations. As far as I know, that's the correct way to check for if .Values.agones.serviceaccount.sdk.annotations.somevariablevalue - let me know if there's a better way.

Sorry, I totally missed in my initial review that this allows you to set different annotations in each namespace, which is why you are checking for keys in a map and then pulling values from the map.

I wonder if it would be worthwhile to document somewhere the expected structure here (since it is different from the other places we allow annotations). Right now, your PR is the only place people could look to see how to properly set these annotations.

@markmandel - I know we have the reference pages for the yaml files that show all of the possible options (with comments) but I don't think there is anything similar for the helm values file. As it gets more expansive, I wonder if it would make sense to better document all of the options that we are adding. WDYT?

The gameserver SDK account commonly wants annotations, e.g. for cloud file store permissions for logs. This adds the ability to map gameserver namespaces to maps of annotations to be added to the SDK account for the specified namespace.

agones-bot · 2021-10-18T23:39:56Z

Build Succeeded 👏

Build Id: 4a477ee9-d595-4195-a2c5-d9d8f1f840c6

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-a3b7a84
image: gcr.io/agones-images/agones-ping:1.19.0-a3b7a84
Linux C++ SDK (build): agonessdk-1.19.0-a3b7a84-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-a3b7a84.zip

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

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

To install this version:

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

agones-bot · 2021-10-19T00:24:41Z

Build Succeeded 👏

Build Id: 34904944-43ec-4cf4-8219-46875d1645d8

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-6a0128b
image: gcr.io/agones-images/agones-ping:1.19.0-6a0128b
Linux C++ SDK (build): agonessdk-1.19.0-6a0128b-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-6a0128b.zip

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

https://6a0128b-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2317/head:pr_2317 && git checkout pr_2317
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-6a0128b

roberthbailey · 2021-10-19T04:02:34Z

install/helm/agones/templates/serviceaccounts/sdk.yaml

@@ -23,6 +23,10 @@ metadata:
    chart: {{ template "agones.chart" $ }}
    release: {{ $.Release.Name }}
    heritage: {{ $.Release.Service }}
+{{- if hasKey $.Values.agones.serviceaccount.sdk.annotations . }}


Sorry, I totally missed in my initial review that this allows you to set different annotations in each namespace, which is why you are checking for keys in a map and then pulling values from the map.

I wonder if it would be worthwhile to document somewhere the expected structure here (since it is different from the other places we allow annotations). Right now, your PR is the only place people could look to see how to properly set these annotations.

@markmandel - I know we have the reference pages for the yaml files that show all of the possible options (with comments) but I don't think there is anything similar for the helm values file. As it gets more expansive, I wonder if it would make sense to better document all of the options that we are adding. WDYT?

google-oss-robot · 2021-10-19T04:04:51Z

New changes are detected. LGTM label has been removed.

google-oss-robot · 2021-10-19T04:04:57Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: highlyunavailable, 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~~ [roberthbailey]

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

agones-bot · 2021-10-19T04:32:49Z

Build Succeeded 👏

Build Id: aa55fd1e-9893-4b60-963f-3096903a3754

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-7dbd38d
image: gcr.io/agones-images/agones-ping:1.19.0-7dbd38d
Linux C++ SDK (build): agonessdk-1.19.0-7dbd38d-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.19.0-7dbd38d.zip

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/2317/head:pr_2317 && git checkout pr_2317
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.19.0-7dbd38d

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

google-oss-robot added the size/XS label Oct 18, 2021

google-oss-robot requested review from EricFortin and roberthbailey October 18, 2021 22:43

highlyunavailable force-pushed the add-sdk-annotations branch from 4a6e2f7 to a3b7a84 Compare October 18, 2021 23:12

roberthbailey reviewed Oct 18, 2021

View reviewed changes

site/content/en/docs/Installation/Install Agones/helm.md Outdated Show resolved Hide resolved

roberthbailey reviewed Oct 18, 2021

View reviewed changes

highlyunavailable force-pushed the add-sdk-annotations branch from a3b7a84 to 6a0128b Compare October 18, 2021 23:57

roberthbailey added the kind/feature New features for Agones label Oct 19, 2021

roberthbailey approved these changes Oct 19, 2021

View reviewed changes

google-oss-robot assigned roberthbailey Oct 19, 2021

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

Merge branch 'main' into add-sdk-annotations

7dbd38d

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

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

roberthbailey merged commit 7f7a434 into googleforgames:main Oct 19, 2021

highlyunavailable deleted the add-sdk-annotations branch October 19, 2021 15:56

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

Add ability to specify annotations for the SDK service account #2317

Add ability to specify annotations for the SDK service account #2317

highlyunavailable commented Oct 18, 2021 •

edited

Loading

agones-bot commented Oct 18, 2021

roberthbailey Oct 18, 2021

highlyunavailable Oct 18, 2021 •

edited

Loading

roberthbailey Oct 19, 2021

agones-bot commented Oct 18, 2021

agones-bot commented Oct 19, 2021

roberthbailey Oct 19, 2021

google-oss-robot commented Oct 19, 2021

google-oss-robot commented Oct 19, 2021

agones-bot commented Oct 19, 2021

Add ability to specify annotations for the SDK service account #2317

Add ability to specify annotations for the SDK service account #2317

Conversation

highlyunavailable commented Oct 18, 2021 • edited Loading

agones-bot commented Oct 18, 2021

roberthbailey Oct 18, 2021

Choose a reason for hiding this comment

highlyunavailable Oct 18, 2021 • edited Loading

Choose a reason for hiding this comment

roberthbailey Oct 19, 2021

Choose a reason for hiding this comment

agones-bot commented Oct 18, 2021

agones-bot commented Oct 19, 2021

roberthbailey Oct 19, 2021

Choose a reason for hiding this comment

google-oss-robot commented Oct 19, 2021

google-oss-robot commented Oct 19, 2021

agones-bot commented Oct 19, 2021

highlyunavailable commented Oct 18, 2021 •

edited

Loading

highlyunavailable Oct 18, 2021 •

edited

Loading