kruise-game-api

README

kruise-game-api

Filtering query and update operation API for kruise-game resources.

Overview

• This repository provides three request ways: command line, REST interface, and go language package to implement filtering and updating of kruise-game resources.
• The filter syntax is based on this repository: structured-filter-go.
• GameServer implemented the following Scene filters:

Key	Value Type	Filtered Field	Filter Examples
namespace	String Filter	/metadata/namespace	{"namespace": {"$in":["minecraft", "terraria"]}}
opsState	String Filter	/spec/opsState	{"opsState": {"$eq": "None"}}
updatePriority	Number Filter	/spec/updatePriority	{"updatePriority": {"$ne": 0}}
deletionPriority	Number Filter	/spec/deletionPriority	{"deletionPriority": {"$ne": 0}}
currentState	String Filter	/status/currentState	{"currentState": {"$eq": "Ready"}}
currentNetworkState	String Filter	/status/networkStatus/currentNetworkState	{"currentNetworkState": {"$eq": "Ready"}}

• GameServerSet implemented the following Scene filters:

Key	Value Type	Filtered Field	Filter Examples
namespace	String Filter	/metadata/namespace	{"namespace": {"$in":["minecraft", "terraria"]}}
images	String Array Filter	[/spec/gameServerTemplate/spec/containers[0].name+","+/spec/gameServerTemplate/spec/containers[0].image, /spec/gameServerTemplate/spec/containers[1].name+","+/spec/gameServerTemplate/spec/containers[1].image, ...]	{"images": {"$all":["minecraft,itzg/minecraft-server:java21", "sidecar,busybox:latest"]}}

• Use JSON Patch as update syntax.

Usage

REST server

• deploy:

kubectl apply -f ./deploy

• interfaces:

Get filtered game servers:

GET /v1/gameservers

Query parameters:
filter string

Response body:
[]v1alpha1.GameServer

Get filtered game server sets:

GET /v1/gameserversets

Query parameters:
filter string

Response body:
[]v1alpha1.GameServerSet

Update game servers:

POST /v1/gameservers

Request body:
UpdateGameServersRequest

Response body:
[]UpdateGsResult

type UpdateGameServersRequest struct {
	Filter    string `json:"filter"`
	JsonPatch string `json:"jsonPatch"`
}

type UpdateGsResult struct {
	Gs        *v1alpha1.GameServer `json:"gs"`
	UpdatedGs *v1alpha1.GameServer `json:"updatedGs"`
	Err       error                `json:"err"`
}

Update game server sets:

POST /v1/gameserversets

Request body:
UpdateGameServerSetsRequest

Response body:
[]UpdateGssResult

type UpdateGameServerSetsRequest struct {
	Filter    string `json:"filter"`
	JsonPatch string `json:"jsonPatch"`
}

type UpdateGssResult struct {
	Gss        *v1alpha1.GameServerSet `json:"gss"`
	UpdatedGss *v1alpha1.GameServerSet `json:"updatedGss"`
	Err        error                   `json:"err"`
}

Delete game servers:

DELETE /v1/gameservers

Query parameters:
filter string

Response body:
[]DeleteGsResult

type DeleteGsResult struct {
	Gs        *v1alpha1.GameServer `json:"gs"`
	Err       error                `json:"err"`
}

Delete game server sets:

DELETE /v1/gameserversets

Query parameters:
filter string

Response body:
[]DeleteGssResult

type DeleteGssResult struct {
	Gss        *v1alpha1.GameServerSet `json:"gss"`
	Err        error                   `json:"err"`
}

• Use the HTTP client to call the REST interface. See examples.

• Also, can use the KruiseGameApiHttpClient provided by package github.com/CloudNativeGame/kruise-game-api/facade/rest/client in golang code. See examples.

Command line

• See examples.

Usage:
  kruisegamectl [OPTIONS]

Application Options:
  /r, /resourcekind:  resource kind: 'gameserver' or 'gameserverset'
  /f, /filter:        filter for the resources;
                      update or delete the resources that match the filter when 'jsonpatch' or 'deletion' parameter is provided
  /j, /jsonpatch:     JsonPatch for the resources; fail and do nothing when the 'deletion' parameter appears at the same time
  /d, /deletion       whether to delete resources; fail and do nothing when the 'jsonpatch' parameter appears at the same time
  /p, /pretty         whether to prettify the response JSON
  /k, /kubeconfig:    path of the kube config