diff --git a/README.md b/README.md index edeed89d..a3a75063 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ # kruise-game ## Introduction -`Kruise-Game` is an open source project based on OpenKruise, to solve the problem of game server landing in Kubernetes. +Kruise-Game is a subproject of OpenKruise, to solve the problem of game server landing in Kubernetes. OpenKruiseGame logo +Kruise-Game utilizes the features of [Kruise](https://github.com/openkruise/kruise), including: +- In-Place Update +- Update sequence +- Ordinals reserve(skip) +- Pod probe marker +- … ## Why is Kruise-Game? Game servers are stateful services, and there are differences in the operation and maintenance of each game server, which also increases with time. In Kubernetes, general workloads manages a batch of game servers according to pod templates, which cannot take into account the differences in game server status. Batch management and directional management are in conflict in k8s. **Kruise-Game** was born to resolve that. Kruise-Game contains two CRDs, GameServer and GameServerSet: diff --git a/docs/getting_started/introduction.md b/docs/getting_started/introduction.md index 6e8850e5..05959b11 100644 --- a/docs/getting_started/introduction.md +++ b/docs/getting_started/introduction.md @@ -1,7 +1,16 @@ # Introduction ## What is Kruise-Game? -Kruise-Game is an open source project based on OpenKruise, to solve the problem of game server landing in Kubernetes. +Kruise-Game is a subproject of OpenKruise, to solve the problem of game server landing in Kubernetes. + +OpenKruiseGame logo + +Kruise-Game utilizes the features of [Kruise](https://github.com/openkruise/kruise), including: +- In-Place Update +- Update sequence +- Ordinals reserve(skip) +- Pod probe marker +- … ## Why is Kruise-Game? Game servers are stateful services, and there are differences in the operation and maintenance of each game server, which also increases with time. In Kubernetes, general workloads manages a batch of game servers according to pod templates, which cannot take into account the differences in game server status. Batch management and directional management are in conflict in k8s. **Kruise-Game** was born to resolve that. Kruise-Game contains two CRDs, GameServer and GameServerSet: