Skip to main content

Installation

Requirements​

Install Kubernetes Cluster, requires Kubernetes version >= 1.16.

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.4.0

Install Kruise-Game​

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

Optional: install/upgrade with customized configurations​

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

ParameterDescriptionDefault
installation.namespaceNamespace for kruise-game operation installationkruise-game-system
installation.createNamespaceWhether to create the installation.namespacetrue
kruiseGame.fullnameNick name for kruise-game deployment and other configurationskruise-game-controller-manager
kruiseGame.healthBindPortPort for checking health of kruise-game container8082
kruiseGame.webhook.portPort of webhook served by kruise-game container443
kruiseGame.webhook.targetPortObjectSelector for workloads in MutatingWebhookConfigurations9876
replicaCountReplicas of kruise-game deployment1
image.repositoryRepository for kruise-game imageopenkruise/kruise-game-manager
image.tagTag for kruise-game imagev0.2.1
image.pullPolicyImagePullPolicy for kruise-game containerAlways
serviceAccount.annotationsThe annotations for serviceAccount of kruise-game
resources.limits.cpuCPU resource limit of kruise-game container500m
resources.limits.memoryMemory resource limit of kruise-game container1Gi
resources.requests.cpuCPU resource request of kruise-game container10m
resources.requests.memoryMemory resource request of kruise-game container64Mi
prometheus.enabledWhether to bind metric endpointtrue
prometheus.monitorService.portPort of the monitorservice bind to8080
scale.service.portPort of the external scaler server binds to6000
scale.service.targetPortTargetPort of the external scaler server binds to6000
network.totalWaitTimeMaximum time to wait for network ready, the unit is seconds60
network.probeIntervalTimeTime interval for detecting network status, the unit is seconds5

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.aliyuncs.com/acs/kruise-game-manager:v0.2.1
...

Uninstall​

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

What's Next​

Here are some recommended next steps: