Doc changes for TLS and loadBalancerIP changes #1784

devloop0 · 2020-09-02T23:14:28Z

What type of PR is this?

Uncomment only one /kind <> line, hit 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:
Clarifies usage about the agones.allocator.{disableMTLS,disableTLS,http.loadBalancerIP} flags.

Which issue(s) this PR fixes:

Closes #

Special notes for your reviewer:

agones-bot · 2020-09-02T23:26:30Z

Build Failed 😱

Build Id: 4611f394-7681-4470-8ff8-299d169bc6ef

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

agones-bot · 2020-09-02T23:46:55Z

Build Succeeded 👏

Build Id: 6b2cf28f-ba21-4788-ab30-ad73df6ff50e

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1784/head:pr_1784 && git checkout pr_1784
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.9.0-b7eaa13

agones-bot · 2020-09-03T00:06:44Z

Build Succeeded 👏

Build Id: 2d2fcbbc-e68e-40b1-8e8c-8fe208b6f883

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

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

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

https://34a637d-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1784/head:pr_1784 && git checkout pr_1784
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.9.0-34a637d

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

site/content/en/docs/Advanced/allocator-service.md

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

pooneh-m · 2020-09-03T06:42:04Z

@markmandel can you please take a look?

agones-bot · 2020-09-03T09:22:05Z

Build Succeeded 👏

Build Id: 19da9e7e-f420-4d11-a86e-c58c0f8411f3

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1784/head:pr_1784 && git checkout pr_1784
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.9.0-4f73a37

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

aLekSer · 2020-09-03T10:47:03Z

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

@@ -218,6 +218,8 @@ The following tables lists the configurable parameters of the Agones chart and t
 | `agones.allocator.generateTLS`                      | Set to true to generate TLS certificates or false to provide certificates in `certs/allocator/*`| `true`                 |
 | `agones.allocator.tolerations`                      | Allocator [toleration][toleration] labels for pod assignment                                    | `[]`                   |
 | `agones.allocator.affinity`                         | Allocator [affinity][affinity] settings for pod assignment                                      | `{}`                   |
+| `agones.allocator.disableTLS`                       | Turns off the built-in encryption and authentication mechanism for the agones-allocator service. | `false`                |
+| `agones.allocator.disableMTLS`                      | Just turns off client cert authentication for incoming connections to the allocator.            | `false`                |


Could be simplified a bit, I cannot understand the difference based on the descriptions.

Suggested change

| `agones.allocator.disableMTLS` | Just turns off client cert authentication for incoming connections to the allocator. | `false` |

| `agones.allocator.disableMTLS` | Turns off client cert authentication for incoming connections to the allocator. | `false` |

I clarified the text a bit.
disableMTLS - no client cert authentication
disableTLS -. full plaintext (no client authentication, and no server cert encryption)

aLekSer

Could you please use New Configuration Features for the new disableTLS flag, and I assume that disableMTLS could be left as is. Or both could be moved to a section under publishVersion:
https://github.com/googleforgames/agones/blame/638a7fddecd23ec24881a738a59c45e0f8b0db7d/site/content/en/docs/Installation/Install%20Agones/helm.md#L227

devloop0 · 2020-09-03T11:07:47Z

I moved both disableMTLS and disableTLS to the 'New Configuration Changes' section.

aLekSer

Thanks for the fast fix. Someone is needed to verify wording before the final merge.

agones-bot · 2020-09-03T11:21:25Z

Build Failed 😱

Build Id: 59e16ebc-572b-4b0d-95b6-93b875c77c25

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

agones-bot · 2020-09-03T11:42:54Z

Build Succeeded 👏

Build Id: 986a07e1-6d81-4509-9843-3b15de0b94f1

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1784/head:pr_1784 && git checkout pr_1784
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.9.0-2015598

pooneh-m

Thanks for the changes.

site/content/en/docs/Advanced/allocator-service.md

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

roberthbailey · 2020-09-03T15:15:05Z

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

@@ -229,6 +229,8 @@ The following tables lists the configurable parameters of the Agones chart and t
 | Parameter                                           | Description                                                                                     | Default                |
 | --------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ---------------------- |
 | `agones.allocator.http.loadBalancerIP`              | The [Load Balancer IP][loadBalancerIP] of the Agones allocator load balancer. Only works if the Kubernetes provider supports this option. | ""                     |
+| `agones.allocator.disableMTLS`                      | Turns off client cert authentication for incoming connections to the allocator.            | `false`                |


Does this also need a release guard? Or are these options available in the current release?

One of these options was present, not sure if the functionality was the same as current one.

There is a breaking change for disableMTLS between 1.8 and 1.9. The helm configuration was not documented because we did not want anyone get a dependency to it, until we know exactly what are the requirements for GKE ingress. If it is moved to 1.8 documentation, a user may get a dependency and the behavior changes with the next version.

Even though it wasn't documented, should we add a 1.9 release note that mentions the breaking change?

I don't think we have to document it as a breaking change as it has not been documented at all and off by default. Only by reading the code the feature flag could be discovered. However, if there is a best practices on what to do in this situation, we should go with it. Otherwise, I would say it is unnecessary.

+1 to what Pooneh mentioned. disableMTLS was never documented earlier.

Just confirming before merging this - it is good to merge?

agones-bot · 2020-09-03T18:26:54Z

Build Succeeded 👏

Build Id: 1fbd7eba-aae9-42df-8f50-87a90bebb9b2

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1784/head:pr_1784 && git checkout pr_1784
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.9.0-df88af6

pooneh-m

Well done! Thanks for your contribution.

google-oss-robot · 2020-09-04T00:35:02Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aLekSer, devloop0, pooneh-m

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~~ [aLekSer,pooneh-m]

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-09-04T00:35:10Z

New changes are detected. LGTM label has been removed.

agones-bot · 2020-09-04T00:52:01Z

Build Failed 😱

Build Id: e87856b8-50e5-4b7b-abe0-c91973913dc8

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

agones-bot · 2020-09-04T02:34:42Z

Build Succeeded 👏

Build Id: 9f7b55cf-9ff8-4d0e-a8ef-e7f4926262e4

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

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

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

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

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/1784/head:pr_1784 && git checkout pr_1784
helm install ./install/helm/agones --namespace agones-system --name agones --set agones.image.tag=1.9.0-c228258

* Added documentation for disableMTLS and disableTLS flags. * Added documentation about the fixed load balancer IP as well. * Fixed a link typo in the allocator-service.md doc. * Fixed typo in the name of the Agones loadBalancerIP flag. * Modified wording on the docs. * Clarified the text for disableTLS vs disableMTLS. * Moved disableMTLS to the 'New Configuration Changes' section. * Fixed more wording issues. Co-authored-by: Nikhil Athreya <nathreya@google.com> Co-authored-by: pooneh-m <46979170+pooneh-m@users.noreply.github.com>

nathreya-google added 2 commits September 2, 2020 22:24

Added documentation for disableMTLS and disableTLS flags.

5ee4d00

Added documentation about the fixed load balancer IP as well.

4c04a3c

googlebot added the cla: yes label Sep 2, 2020

google-oss-robot requested review from EricFortin and roberthbailey September 2, 2020 23:14

google-oss-robot added the size/S label Sep 2, 2020

nathreya-google added 2 commits September 2, 2020 23:27

Fixed a link typo in the allocator-service.md doc.

b7eaa13

Fixed typo in the name of the Agones loadBalancerIP flag.

34a637d

pooneh-m reviewed Sep 3, 2020

View reviewed changes

aLekSer added the area/site The website itself - including redirects, styling, search, etc label Sep 3, 2020

Modified wording on the docs.

4f73a37

aLekSer reviewed Sep 3, 2020

View reviewed changes

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

aLekSer reviewed Sep 3, 2020

View reviewed changes

aLekSer suggested changes Sep 3, 2020

View reviewed changes

google-oss-robot assigned aLekSer Sep 3, 2020

nathreya-google added 2 commits September 3, 2020 11:04

Clarified the text for disableTLS vs disableMTLS.

ce8ea5c

Moved disableMTLS to the 'New Configuration Changes' section.

2015598

aLekSer approved these changes Sep 3, 2020

View reviewed changes

google-oss-robot added the lgtm label Sep 3, 2020

pooneh-m reviewed Sep 3, 2020

View reviewed changes

site/content/en/docs/Advanced/allocator-service.md Show resolved Hide resolved

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

roberthbailey reviewed Sep 3, 2020

View reviewed changes

Fixed more wording issues.

df88af6

google-oss-robot added approved and removed lgtm labels Sep 3, 2020

pooneh-m approved these changes Sep 4, 2020

View reviewed changes

google-oss-robot assigned pooneh-m Sep 4, 2020

google-oss-robot added the lgtm label Sep 4, 2020

Merge branch 'master' into doc-changes

c228258

google-oss-robot removed the lgtm label Sep 4, 2020

pooneh-m merged commit d8e0283 into googleforgames:master Sep 4, 2020

markmandel added this to the 1.9.0 milestone Sep 22, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc changes for TLS and loadBalancerIP changes #1784

Doc changes for TLS and loadBalancerIP changes #1784

devloop0 commented Sep 2, 2020

agones-bot commented Sep 2, 2020

agones-bot commented Sep 2, 2020

agones-bot commented Sep 3, 2020

pooneh-m commented Sep 3, 2020

agones-bot commented Sep 3, 2020

aLekSer Sep 3, 2020

devloop0 Sep 3, 2020

aLekSer left a comment •

edited

Loading

devloop0 commented Sep 3, 2020

aLekSer left a comment

agones-bot commented Sep 3, 2020

agones-bot commented Sep 3, 2020

pooneh-m left a comment

roberthbailey Sep 3, 2020

aLekSer Sep 3, 2020 •

edited

Loading

pooneh-m Sep 3, 2020

roberthbailey Sep 3, 2020

pooneh-m Sep 3, 2020

devloop0 Sep 3, 2020

markmandel Sep 3, 2020

agones-bot commented Sep 3, 2020

pooneh-m left a comment

google-oss-robot commented Sep 4, 2020

google-oss-robot commented Sep 4, 2020

agones-bot commented Sep 4, 2020

agones-bot commented Sep 4, 2020

	\| `agones.allocator.disableMTLS` \| Just turns off client cert authentication for incoming connections to the allocator. \| `false` \|
	\| `agones.allocator.disableMTLS` \| Turns off client cert authentication for incoming connections to the allocator. \| `false` \|

Doc changes for TLS and loadBalancerIP changes #1784

Doc changes for TLS and loadBalancerIP changes #1784

Conversation

devloop0 commented Sep 2, 2020

agones-bot commented Sep 2, 2020

agones-bot commented Sep 2, 2020

agones-bot commented Sep 3, 2020

pooneh-m commented Sep 3, 2020

agones-bot commented Sep 3, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aLekSer left a comment • edited Loading

Choose a reason for hiding this comment

devloop0 commented Sep 3, 2020

aLekSer left a comment

Choose a reason for hiding this comment

agones-bot commented Sep 3, 2020

agones-bot commented Sep 3, 2020

pooneh-m left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aLekSer Sep 3, 2020 • edited Loading

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 3, 2020

pooneh-m left a comment

Choose a reason for hiding this comment

google-oss-robot commented Sep 4, 2020

google-oss-robot commented Sep 4, 2020

agones-bot commented Sep 4, 2020

agones-bot commented Sep 4, 2020

aLekSer left a comment •

edited

Loading

aLekSer Sep 3, 2020 •

edited

Loading