Skip to content

Commit 0aa7cb0

Browse files
committed
update readme
1 parent 0cf7b20 commit 0aa7cb0

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,21 @@
55

66
# Controller Mesh
77

8-
KusionStack Controller Mesh is a solution that helps developers manage their controllers/operators better.
8+
KusionStack Controller Mesh is a solution that helps developers managing their controllers/operators better.
99

1010
The design architecture of this project is based on [openkruise/controllermesh](https://github.com/openkruise/controllermesh).
1111

1212
## Key Features
1313

1414
1. **Sharding**: Through relevant configurations, Kubernetes single-point deployed operator applications can be flexibly shard deployed.
15-
2. **Canary upgrade**: Depends on sharding, the controllers can be updated in canary progress instead of one time replace.
15+
2. **Canary upgrade**: Depends on sharding, the controller instances can be updated in canary progress instead of updated in one time.
1616
3. **Circuit breaker and rate limiter**: Not only Kubernetes operation requests, but also other external operation requests.
17-
4. **Multicluster routing and sharding**: This feature is supported by [kusionstack/kaera(karbour)]()
17+
4. **Multicluster routing and sharding**
18+
5. **And more**: Fault injection and Observability. (Todo)
1819

1920
<p align="center"><img width="800" src="./docs/img/mesh-arch-2.png"/></p>
2021

21-
## Quick Start
22-
Visit [Quick Start](docs/getting-started.md).
23-
24-
25-
## Installation
26-
Visit [Installation](docs/installation.md).
22+
Visit [Quick Start](docs/getting-started.md) or [Installation](docs/installation.md).
2723
## Principles
2824

2925
Generally, a `ctrlmesh-proxy` container will be injected into each operator Pod that has configured in ShardingConfigs.

docs/intro.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
# Controller Mesh
44

5-
KusionStack Controller Mesh is a solution that helps developers manage their controllers/operators better.
5+
KusionStack Controller Mesh is a solution that helps developers managing their controllers/operators better.
66

77
The design architecture of this project is based on [openkruise/controllermesh](https://github.com/openkruise/controllermesh).
88

99
## Key Features
1010

1111
1. **Sharding**: Through relevant configurations, Kubernetes single-point deployed operator applications can be flexibly shard deployed.
12-
2. **Canary upgrade**: Depends on sharding, the controllers can be updated in canary progress instead of one time replace.
12+
2. **Canary upgrade**: Depends on sharding, the controller instances can be updated in canary progress instead of updated in one time.
1313
3. **Circuit breaker and rate limiter**: Not only Kubernetes operation requests, but also other external operation requests.
14-
4. **Multicluster routing and sharding**.
14+
4. **Multicluster routing and sharding**
15+
5. **And more**: Fault injection and Observability. (Todo)
1516

1617
<p align="center"><img width="800" src="../docs/img/mesh-arch-2.png"/></p>

0 commit comments

Comments
 (0)