From b8260b489185752db55a2c2b063a829b75186f7c Mon Sep 17 00:00:00 2001 From: Robert Bailey Date: Fri, 19 May 2023 18:25:03 +0000 Subject: [PATCH] Strengthen the warning about reusing certificates in the yaml installation and clarify the instructions. --- .../Installation/Install Agones/_index.md | 5 ++- .../docs/Installation/Install Agones/yaml.md | 35 ++++++++++++------- 2 files changed, 27 insertions(+), 13 deletions(-) diff --git a/site/content/en/docs/Installation/Install Agones/_index.md b/site/content/en/docs/Installation/Install Agones/_index.md index 3d521ca7d0..66d0b377d4 100644 --- a/site/content/en/docs/Installation/Install Agones/_index.md +++ b/site/content/en/docs/Installation/Install Agones/_index.md @@ -4,4 +4,7 @@ linkTitle: "Install Agones" weight: 20 description: > Install Agones in your existing Kubernetes cluster. ---- \ No newline at end of file +--- + +If you have not yet created a cluster, [follow the instructions]({{< ref "/docs/Installation/Creating Cluster/" >}}) +for the environment where you will be running Agones. diff --git a/site/content/en/docs/Installation/Install Agones/yaml.md b/site/content/en/docs/Installation/Install Agones/yaml.md index 6c97e31489..f89c7545f5 100644 --- a/site/content/en/docs/Installation/Install Agones/yaml.md +++ b/site/content/en/docs/Installation/Install Agones/yaml.md @@ -6,24 +6,38 @@ description: > We can install Agones to the cluster using an install.yaml file. --- -### Installing Agones +## Installing Agones {{< alert title="Warning" color="warning">}} -Installing Agones with the `install.yaml` will set up the TLS certificates -stored in this repository for securing Kubernetes webhooks communication. +Installing Agones with the `install.yaml` file will use pre-generated, well known TLS +certificates stored in this repository for securing Kubernetes webhooks communication. -If you want to generate new certificates or use your own for production workloads, -we recommend using the [helm installation]({{< relref "helm.md" >}}). +For production workloads, we **strongly** recommend using the +[helm installation]({{< relref "helm.md" >}}) which allows you to generate +new, unique certificates or provide your own certificates. Alternatively, +you can use `helm template` as described [below](#customizing-your-install) +to generate a custom yaml installation file with unique certificates. {{< /alert >}} +Installing Agones using the pre-generated `install.yaml` file is the quickest, +simplest way to get Agones up and running in your Kubernetes cluster: + ```bash kubectl create namespace agones-system kubectl apply --server-side -f https://raw.githubusercontent.com/googleforgames/agones/{{< release-branch >}}/install/yaml/install.yaml ``` -To change the [configurable parameters](https://agones.dev/site/docs/installation/install-agones/helm/#configuration) in the `install.yaml` file, you can use helm directly to generate a custom file locally. +You can also find the `install.yaml` in the latest `agones-install` zip from the [releases](https://github.com/googleforgames/agones/releases) archive. + +### Customizing your install -The following example sets the `featureGates` and `generateTLS` helm parameters in `install.yaml`: +To change the [configurable parameters](https://agones.dev/site/docs/installation/install-agones/helm/#configuration) +in the `install.yaml` file, you can use `helm template` to generate a custom file locally +without needing to use helm to install Agones into your cluster. + +The following example sets the `featureGates` and `generateTLS` helm parameters +and creates a customized `install-custom.yaml` file (note that the `pull` +command was introduced in Helm version 3): ```bash helm pull --untar https://agones.dev/chart/stable/agones-{{< release-version >}}.tgz && \ @@ -36,11 +50,8 @@ helm template agones-manual --namespace agones-system . \ --set agones.featureGates="PlayerTracking=true" \ > install-custom.yaml ``` -Note: `pull` command was introduced in Helm version 3. - -You can also find the install.yaml in the latest `agones-install` zip from the [releases](https://github.com/googleforgames/agones/releases) archive. -### Uninstalling Agones +## Uninstalling Agones To uninstall/delete the `Agones` deployment and delete `agones-system` namespace: @@ -51,7 +62,7 @@ kubectl delete -f https://raw.githubusercontent.com/googleforgames/agones/{{< re kubectl delete namespace agones-system ``` -Note: you should wait up to a couple of minutes until all resources described in `install.yaml` file would be deleted. +Note: It may take a couple of minutes until all resources described in `install.yaml` file are deleted. ## Next Steps