update docs and rename Tls to TLS

googleforgames · May 22, 2018 · 350642e · 350642e
1 parent c4490df
commit 350642e
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 6 deletions.
diff --git a/build/Makefile b/build/Makefile
@@ -171,7 +171,7 @@ push-agones-sdk-image: ensure-build-image
 gen-install: ensure-build-image
 	docker run --rm $(common_mounts) $(DOCKER_RUN_ARGS) $(build_tag) bash -c \
 		'helm template --name=agones-manual $(mount_path)/install/helm/agones \
-		--set agones.controller.generateTls=false \
+		--set agones.controller.generateTLS=false \
 		> $(mount_path)/install/yaml/install.yaml'
 
 # Generate the SDK gRPC server and client code

diff --git a/docs/installing_agones.md b/docs/installing_agones.md
@@ -193,6 +193,10 @@ We can install Agones to the cluster using the
 kubectl apply -f https://raw.githubusercontent.com/googlecloudplatform/agones/release-0.1/install.yaml
 ```
 
+> Note: Installing Agones with the `intall.yaml` will setup the TLS certificates stored in this repository for securing 
+> kubernetes webhooks communication. If you want to generates new certificates or use your own,
+> we recommend using the helm installation.
+
 ## Install using Helm
 
 Also, we can install Agones using [Helm][helm] package manager. If you want more details and configuration

diff --git a/install/helm/README.md b/install/helm/README.md
@@ -78,7 +78,7 @@ The following tables lists the configurable parameters of the Agones chart and t
 | `agones.controller.healthCheck.failureThreshold`       | Number of times before giving up (in seconds)                   | `3`                        |
 | `agones.controller.healthCheck.timeoutSeconds`         | Number of seconds after which the probe times out (in seconds)  | `1`                        |
 | `agones.controller.resources`  | Controller resource requests/limit | `{}`
-| `agones.controller.generateTls`  | Set to true to generate tls certificates or false to provide your own certificates in `certs/*` | `true`
+| `agones.controller.generateTLS`  | Set to true to generate TLS certificates or false to provide your own certificates in `certs/*` | `true`
 | `gameservers.namespaces`                         | a list of namespaces you are planning to use to deploy game servers | `["defaut"]` |
 | `gameservers.minPort`                            | Minimum port to use for dynamic port allocation                 | `7000`                     |
 | `gameservers.maxPort`                            | Maximum port to use for dynamic port allocation                 | `8000`                     |

diff --git a/install/helm/agones/templates/admissionregistration.yaml b/install/helm/agones/templates/admissionregistration.yaml
@@ -30,7 +30,7 @@ webhooks:
         name: agones-controller-service
         namespace: {{ .Values.agones.namespace }}
         path: /validate
-{{- if .Values.agones.controller.generateTls }}
+{{- if .Values.agones.controller.generateTLS }}
       caBundle: {{ b64enc $ca.Cert }}
 {{- else }}
       caBundle: {{ .Files.Get "certs/server.crt" | b64enc }}
@@ -74,7 +74,7 @@ webhooks:
         name: agones-controller-service
         namespace: {{ .Values.agones.namespace }}
         path: /mutate
-{{- if .Values.agones.controller.generateTls }}
+{{- if .Values.agones.controller.generateTLS }}
       caBundle: {{ b64enc $ca.Cert }}
 {{- else }}
       caBundle: {{ .Files.Get "certs/server.crt" | b64enc }}
@@ -103,7 +103,7 @@ metadata:
     heritage: "{{ .Release.Service }}"
 type: Opaque
 data:
-{{- if .Values.agones.controller.generateTls }}
+{{- if .Values.agones.controller.generateTLS }}
   server.crt: {{ b64enc $cert.Cert }}
   server.key: {{ b64enc $cert.Key }}
 {{- else }}

diff --git a/install/helm/agones/values.yaml b/install/helm/agones/values.yaml
@@ -21,7 +21,7 @@ agones:
     sdk: agones-sdk
   controller:
     resources: {}
-    generateTls: true
+    generateTLS: true
     healthCheck:
       http:
         port: 8080