From 724c0e45f5abee4197c49908a023c117e925d227 Mon Sep 17 00:00:00 2001 From: Pooneh Mortazavi Date: Tue, 8 Sep 2020 16:47:21 -0700 Subject: [PATCH] Update allocator service documentation --- site/content/en/docs/Advanced/allocator-service.md | 8 ++++++-- site/content/en/docs/Advanced/multi-cluster-allocation.md | 1 + 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/site/content/en/docs/Advanced/allocator-service.md b/site/content/en/docs/Advanced/allocator-service.md index 6bf3682458..0dabe205ee 100644 --- a/site/content/en/docs/Advanced/allocator-service.md +++ b/site/content/en/docs/Advanced/allocator-service.md @@ -10,7 +10,8 @@ To allocate a game server, Agones in addition to {{< ghlink href="pkg/apis/alloc The gRPC service is accessible through a Kubernetes service that is externalized using a load balancer. For the gRPC request to succeed, a client certificate must be provided that is in the authorization list of the allocator service. -The remainder of this article describes how to manually make a successful allocation request using the gRPC API. +The remainder of this article describes how to manually make a successful allocation request using the gRPC API. +The guide assumes you have command line tools installed for [jq](https://stedolan.github.io/jq/), [go](https://golang.org/) and [openssl](https://www.openssl.org/). ## Find the external IP @@ -35,7 +36,10 @@ If the `agones-allocator` service is installed as a `LoadBalancer` [using a stat Replace the default server TLS certificate with a certificate with CN and subjectAltName. There are multiple approaches to generate a certificate. Agones recommends using [cert-manager.io](https://cert-manager.io/) solution for cluster level certificate management. -In order to use cert-manager solution, first, [install cert-manager](https://cert-manager.io/docs/installation/kubernetes/) on the cluster. Then, [configure](https://cert-manager.io/docs/configuration/) an `Issuer`/`ClusterIssuer` resource and last configure a `Certificate` resource to manage allocator-tls `Secret`. +In order to use cert-manager solution, first, [install cert-manager](https://cert-manager.io/docs/installation/kubernetes/) on the cluster. +Then, [configure](https://cert-manager.io/docs/configuration/) an `Issuer`/`ClusterIssuer` resource and +last [configure](https://cert-manager.io/docs/usage/certificate/) a `Certificate` resource to manage allocator-tls `Secret`. +Make sure to configure the `Certificate` based on your system's requirements, including the validity `duration`. Here is an example of using a self-signed `ClusterIssuer` for configuring allocator-tls `Secret`: diff --git a/site/content/en/docs/Advanced/multi-cluster-allocation.md b/site/content/en/docs/Advanced/multi-cluster-allocation.md index 4bfdded10b..d4849dba25 100644 --- a/site/content/en/docs/Advanced/multi-cluster-allocation.md +++ b/site/content/en/docs/Advanced/multi-cluster-allocation.md @@ -17,6 +17,7 @@ The remainder of this article describes how to enable multi-cluster allocation. ## Define Cluster Priority {{< ghlink href="pkg/apis/multicluster/v1/gameserverallocationpolicy.go" >}}GameServerAllocationPolicy{{< /ghlink >}} is the CRD defined by Agones for setting multi-cluster allocation rules. In addition to cluster priority, it describes the connection information for the target cluster, including the game server namespace, agones-allocator endpoint and client K8s secrets name for redirecting the allocation request. Here is an example of setting the priority for a cluster and it's connection rules. One such resource should be defined per cluster. For clusters with the same priority, the cluster is chosen with a probability relative to its weight. +The lower the `priority` number is the higher is the corresponding cluster's priority for allocating game servers. In the following example the policy is defined for cluster B in cluster A.