Skip to content

Commit d3e00a2

Browse files
authored
update README.md (#1661)
* update README.md Signed-off-by: Michael Kalantar <[email protected]> * spelling Signed-off-by: Michael Kalantar <[email protected]> * spelling Signed-off-by: Michael Kalantar <[email protected]> * wording Signed-off-by: Michael Kalantar <[email protected]> --------- Signed-off-by: Michael Kalantar <[email protected]>
1 parent 086b507 commit d3e00a2

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed

.github/wordlist.txt

+5
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@ apis
55
ArgoCD
66
AutoX
77
backend
8+
backends
89
benchmarking
910
Cha
1011
chaosengine
1112
CLI
13+
composable
14+
CRD
15+
CRDs
1216
cronjob
1317
crontab
1418
DCO
@@ -23,6 +27,7 @@ frontend
2327
GitOps
2428
gRPC
2529
GitHub
30+
Grafana
2631
GVR
2732
Homebrew
2833
http

README.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,25 @@ Iter8 is the Kubernetes release optimizer built for DevOps, MLOps, SRE and data
77

88
Iter8 supports the following use-cases:
99

10-
1. Performance testing of HTTP services.
11-
2. Performance testing of gRPC services.
12-
3. A/B/n testing of applications and ML models
13-
4. Reliable and automated routing: blue-green and canary
10+
1. Progressive release with automated traffic management
11+
2. A/B/n testing with a client SDK and business metrics
12+
3. Performance testing for HTTP and gRPC endpoints
1413

15-
## :rocket: Iter8 performance test
14+
Any Kubernetes resource type, including CRDs can be used with Iter8.
1615

17-
Iter8 introduces a set of tasks which which can be composed in order to conduct a variety of performance tests.
16+
## :rocket: Features
17+
18+
Iter8 introduces a set of tasks which can be composed in order to conduct tests.
1819

1920
<p align='center'>
20-
<img alt-text="Iter8 performance test" src="https://iter8-tools.github.io/docs/0.9/images/iter8-intro-dark.png" width="70%" />
21+
<img alt-text="Iter8 performance test" src="https://iter8-tools.github.io/docs/0.18/images/iter8-intro-dark.png" width="70%" />
2122
</p>
2223

23-
Iter8 packs a number of powerful features that facilitate Kubernetes app testing. They include the following.
24+
Iter8 packs a number of powerful features that facilitate Kubernetes application and ML model testing. They include the following:
2425

25-
1. **Generating load and collecting built-in metrics for HTTP and gRPC services.** Simplifies performance testing by eliminating the need to setup and use metrics databases.
26-
2. **Readiness check.** The performance testing portion can be configured to start only after the service is ready.
27-
3. **Test anywhere.** Iter8 performance tests can be launched inside a Kubernetes cluster, in local environments, or inside a GitHub Actions pipeline.
28-
4. **Traffic controller.** Automatically and dynamically reconfigures routing resources based on the state of Kubernetes apps/ML models.
29-
5. **Client-side SDK.** Facilitates routing and metrics collection task associated with distributed (i.e., client-server architecture-based) A/B/n testing in Kubernetes.
26+
1. **Use any resource types.** Iter8 is easily extensible so that an application being tested can be composed of any resource types including CRDs.
27+
2. **Client SDK.** A client SDK enables application frontend components to reliably associate business metrics with the contributing version of the backend thereby enabling A/B/n testing of backends.
28+
3. **Composable test tasks.** Performance test tasks include load generation and metrics storage simplifying setup.
3029

3130
Please see [https://iter8.tools](https://iter8.tools) for the complete documentation.
3231

@@ -42,6 +41,8 @@ See [here](CONTRIBUTING.md) for information about ways to contribute, finding an
4241
Iter8 is primarily written in `Go` and builds on a few awesome open source projects including:
4342

4443
- [Helm](https://helm.sh)
45-
- [ghz](https://ghz.sh)
44+
- [Istio](https://istio.io)
45+
- [Kubernetes Gateway API](https://gateway-api.sigs.k8s.io/)
4646
- [Fortio](https://github.com/fortio/fortio)
47-
- [plotly.js](https://github.com/plotly/plotly.js)
47+
- [ghz](https://ghz.sh)
48+
- [Grafana](https://grafana.com/)

0 commit comments

Comments
 (0)