Skip to content

Commit

Permalink
update README (openkruise#3)
Browse files Browse the repository at this point in the history
Signed-off-by: ChrisLiu <[email protected]>

Signed-off-by: ChrisLiu <[email protected]>
  • Loading branch information
chrisliu1995 authored Sep 23, 2022
1 parent 6d1ba74 commit f1d2929
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

<img width="250px" src="./docs/images/logo.jpg" alt="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:
Expand Down
11 changes: 10 additions & 1 deletion docs/getting_started/introduction.md
Original file line number Diff line number Diff line change
@@ -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.

<img width="250px" src="../images/logo.jpg" alt="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:
Expand Down

0 comments on commit f1d2929

Please sign in to comment.