Fix JSON Schema validation for ServiceAccount annotations #4122

0xaravindh · 2025-03-05T15:26:50Z

What type of PR is this?

/kind bug

What this PR does / Why we need it:

Updated serviceaccount.*.annotations schema to allow key-value string pairs.
Changed additionalProperties from type: string to type: object.
Resolves issue preventing Helm chart installation when annotations are provided.

Which issue(s) this PR fixes:

Special notes for your reviewer:

- Updated `serviceaccount.*.annotations` schema to allow key-value string pairs. - Changed `additionalProperties` from `type: string` to `type: object`. - Resolves issue preventing Helm chart installation when annotations are provided. - Closes googleforgames#4119.

agones-bot · 2025-03-05T16:33:31Z

Build Succeeded 🥳

Build Id: 24722a91-abd1-4d5c-8505-049d7bb8089f

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4122/head:pr_4122 && git checkout pr_4122
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.48.0-dev-d43c88d

igooch

For this PR we only want to change the agones.serviceaccount.sdk.annotations. From our Helm install docs agones.serviceaccount.sdk.annotations is A map of namespaces to maps of [Annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) added to the Agones SDK service account for the specified namespaces, whereas the rest of the annotations are a simple map of Annotations, and not a map of a map.

igooch · 2025-03-10T05:07:03Z

install/helm/agones/values.schema.json

@@ -213,7 +213,7 @@
                "annotations": {
                  "type": "object",
                  "additionalProperties": {
-                    "type": "string"
+                    "type": "object"


Suggested change

"type": "object"

"type": "object"

"additionalProperties": {

"type": "string"

}

@igooch The additionalProperties keyword is used to control the handling of extra fields, but it may not be needed for annotations. i hope, it does not work like a map of maps. please correct me if i'm wrong.

Also, when I tried using boolean, string, and number values in additionalProperties, I got these errors during installation:

Error: INSTALLATION FAILED: values don't meet the specifications of the schema(s) in the following chart(s): agones: - agones.serviceaccount.sdk.annotations: Additional property default is not allowed Error: INSTALLATION FAILED: values don't meet the specifications of the schema(s) in the following chart(s): agones: - agones.serviceaccount.sdk.annotations.default: Invalid type. Expected: number, given: object Error: INSTALLATION FAILED: values don't meet the specifications of the schema(s) in the following chart(s): agones: - agones.serviceaccount.sdk.annotations.default: Invalid type. Expected: string, given: object

The service account annotations for sdk is a map of maps. The service account annotations for controller and allocator are maps as defined in https://agones.dev/site/docs/installation/install-agones/helm/.

So a sample section of a values.yaml file might look like:

serviceaccount: allocator: name: agones-allocator annotations: "foo": bar controller: name: agones-controller annotations: "baz": qux sdk: name: agones-sdk annotations: default: "annotation": value

In Kubernetes Annotations (and labels) are required to be strings https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/. So here we want to verify that the user only passes in string values.

gongmax · 2025-03-11T18:03:16Z

@0xaravindh can you verify the fix by following the reproduce step in #4119?

0xaravindh · 2025-03-11T18:21:01Z

@0xaravindh can you verify the fix by following the reproduce step in #4119?

yes @gongmax .I was able to reproduce the issue. it’s fixed now. The fix works as expected.

igooch · 2025-03-21T18:45:14Z

install/helm/agones/values.schema.json

@@ -213,7 +213,7 @@
                "annotations": {
                  "type": "object",
                  "additionalProperties": {
-                    "type": "string"
+                    "type": "object"


The service account annotations for sdk is a map of maps. The service account annotations for controller and allocator are maps as defined in https://agones.dev/site/docs/installation/install-agones/helm/.

So a sample section of a values.yaml file might look like:

serviceaccount: allocator: name: agones-allocator annotations: "foo": bar controller: name: agones-controller annotations: "baz": qux sdk: name: agones-sdk annotations: default: "annotation": value

In Kubernetes Annotations (and labels) are required to be strings https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/. So here we want to verify that the user only passes in string values.

igooch · 2025-03-21T18:45:28Z

install/helm/agones/values.schema.json

@@ -173,13 +173,13 @@
                "annotations": {
                  "type": "object",
                  "additionalProperties": {
-                    "type": "string"
+                    "type": "object"


Suggested change

"type": "object"

"type": "string"

igooch · 2025-03-21T18:45:39Z

install/helm/agones/values.schema.json

                  }
                },
                "labels": {
                  "type": "object",
                  "additionalProperties": {
-                    "type": "string"
+                    "type": "object"


Suggested change

"type": "object"

"type": "string"

igooch · 2025-03-21T18:45:48Z

install/helm/agones/values.schema.json

@@ -196,7 +196,7 @@
                "annotations": {
                  "type": "object",
                  "additionalProperties": {
-                    "type": "string"
+                    "type": "object"


Suggested change

"type": "object"

"type": "string"

agones-bot · 2025-03-25T06:13:11Z

Build Succeeded 🥳

Build Id: 96457c05-bae8-4848-8d4f-ab784fcbd62e

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4122/head:pr_4122 && git checkout pr_4122
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.48.0-dev-e229502

0xaravindh · 2025-03-25T06:17:16Z

@igooch please take a look!

igooch

LGTM

0xaravindh self-assigned this Mar 5, 2025

github-actions bot added the kind/bug These are bugs. label Mar 5, 2025

0xaravindh requested review from igooch and gongmax March 5, 2025 15:28

igooch reviewed Mar 10, 2025

View reviewed changes

igooch requested changes Mar 21, 2025

View reviewed changes

0xaravindh added 3 commits March 25, 2025 05:11

Merge branch 'googleforgames:main' into helm/json-schema

a8b15b0

fixes

284c4a2

fixes

e229502

igooch approved these changes Mar 25, 2025

View reviewed changes

igooch merged commit 84e1657 into googleforgames:main Mar 25, 2025
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix JSON Schema validation for ServiceAccount annotations #4122

Fix JSON Schema validation for ServiceAccount annotations #4122

0xaravindh commented Mar 5, 2025

agones-bot commented Mar 5, 2025

igooch left a comment

igooch Mar 10, 2025

0xaravindh Mar 10, 2025 •

edited

Loading

igooch Mar 21, 2025

gongmax commented Mar 11, 2025

0xaravindh commented Mar 11, 2025 •

edited

Loading

igooch Mar 21, 2025

igooch Mar 21, 2025

igooch Mar 21, 2025

igooch Mar 21, 2025

agones-bot commented Mar 25, 2025

0xaravindh commented Mar 25, 2025

igooch left a comment

Fix JSON Schema validation for ServiceAccount annotations #4122

Fix JSON Schema validation for ServiceAccount annotations #4122

Conversation

0xaravindh commented Mar 5, 2025

agones-bot commented Mar 5, 2025

igooch left a comment

Choose a reason for hiding this comment

igooch Mar 10, 2025

Choose a reason for hiding this comment

0xaravindh Mar 10, 2025 • edited Loading

Choose a reason for hiding this comment

igooch Mar 21, 2025

Choose a reason for hiding this comment

gongmax commented Mar 11, 2025

0xaravindh commented Mar 11, 2025 • edited Loading

igooch Mar 21, 2025

Choose a reason for hiding this comment

igooch Mar 21, 2025

Choose a reason for hiding this comment

igooch Mar 21, 2025

Choose a reason for hiding this comment

igooch Mar 21, 2025

Choose a reason for hiding this comment

agones-bot commented Mar 25, 2025

0xaravindh commented Mar 25, 2025

igooch left a comment

Choose a reason for hiding this comment

0xaravindh Mar 10, 2025 •

edited

Loading

0xaravindh commented Mar 11, 2025 •

edited

Loading