Installation

Install OpenKruiseGame（OKG)

Installation Instructions

Installing OpenKruiseGame requires Kruise and Kruise-Game to be installed and Kubernetes version >= 1.18.

Install Kruise

We recommend that you use Helm V3.5 or later to install Kruise.

# Firstly add openkruise charts repository if you haven't do this.
$ helm repo add openkruise https://openkruise.github.io/charts/
# [Optional]
$ helm repo update
# Install the latest version.
$ helm install kruise openkruise/kruise --version 1.7.0

Install Kruise-Game

$ helm install kruise-game openkruise/kruise-game --version 0.9.0

Upgrade Kruise-Game

$ helm upgrade kruise-game openkruise/kruise-game --version 0.9.0 [--force]

Options

Optional: install/upgrade with customized configurations

The following table lists the configurable parameters of the kruise-game chart and their default values.

Parameter	Description	Default
installation.namespace	Namespace for kruise-game operation installation	kruise-game-system
installation.createNamespace	Whether to create the installation.namespace	true
kruiseGame.fullname	Nick name for kruise-game deployment and other configurations	kruise-game-controller-manager
kruiseGame.healthBindPort	Port for checking health of kruise-game container	8082
kruiseGame.webhook.port	Port of webhook served by kruise-game container	443
kruiseGame.webhook.targetPort	ObjectSelector for workloads in MutatingWebhookConfigurations	9876
kruiseGame.apiServerQps	Maximum sustained queries per second to send to the API server of kruise-game-controller-manager	5
kruiseGame.apiServerQpsBurst	Maximum burst queries per second to send to the API server of kruise-game-controller-manager	10
replicaCount	Replicas of kruise-game deployment	1
image.repository	Repository for kruise-game image	openkruise/kruise-game-manager
image.tag	Tag for kruise-game image	v0.9.0
image.pullPolicy	ImagePullPolicy for kruise-game container	Always
serviceAccount.annotations	The annotations for serviceAccount of kruise-game
resources.limits.cpu	CPU resource limit of kruise-game container	500m
resources.limits.memory	Memory resource limit of kruise-game container	1Gi
resources.requests.cpu	CPU resource request of kruise-game container	10m
resources.requests.memory	Memory resource request of kruise-game container	64Mi
prometheus.enabled	Whether to bind metric endpoint	true
prometheus.monitorService.port	Port of the monitorservice bind to	8080
scale.service.port	Port of the external scaler server binds to	6000
scale.service.targetPort	TargetPort of the external scaler server binds to	6000
network.totalWaitTime	Maximum time to wait for network ready, the unit is seconds	60
network.probeIntervalTime	Time interval for detecting network status, the unit is seconds	5
cloudProvider.installCRD	Whether to install CloudProvider CRD	true

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

Optional: the local image for China

If you are in China and have problem to pull image from official DockerHub, you can use the registry hosted on Alibaba Cloud:

$ helm install kruise-game https://... --set image.repository=registry-cn-hangzhou.ack.aliyuncs.com/acs/kruise-game-manager

Uninstall OpenKruiseGame（OKG）

Note that this will lead to all resources created by kruise-game, including webhook configurations, services, namespace, CRDs and CR instances kruise-game controller, to be deleted!

Please do this ONLY when you fully understand the consequence.

To uninstall kruise-game if it is installed with helm charts:

$ helm uninstall kruise-game
release "kruise-game" uninstalled

FAQ

Q: Error no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1" A: This is because the cluster does not have the prometheus operator installed. enabling the playsuit monitoring feature requires the prometheus operator to be installed on the Kubernetes cluster. If you do not use this feature, you can set prometheus.enabled to false during installation (the default is true)

Q: Error CustomResourceDefinition "poddnats.alibabacloud.com" in namespace "" exists and cannot be imported into the cureent release A: This is because the CRD is already installed in the cluster and you can set cloudProvider.installCRD to false during installation (default is true)

What's Next

Here are some recommended next steps:

• Learn kruise-game's Deploy GameServers.