Skip to content

Commit ce8f5be

Browse files
kalantarkalantar
authored
using redis (#124)
* using redis Signed-off-by: Michael Kalantar <[email protected]> * spelling Signed-off-by: Michael Kalantar <[email protected]> * minor wordsmithing Signed-off-by: Michael Kalantar <[email protected]> * fix spelling Signed-off-by: Michael Kalantar <[email protected]> * fix link Signed-off-by: Michael Kalantar <[email protected]> --------- Signed-off-by: Michael Kalantar <[email protected]>
1 parent f88c99f commit ce8f5be

File tree

14 files changed

+66
-11
lines changed

14 files changed

+66
-11
lines changed

‎.github/wordlist.txt

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ apis
55
ArgoCD
66
AutoX
77
backend
8+
BadgerDB
89
benchmarking
910
Cha
1011
chaosengine
@@ -25,6 +26,7 @@ Fortio
2526
frontend
2627
GitOps
2728
gRPC
29+
GetClient
2830
GitHub
2931
Grafana
3032
GVR

‎docs/getting-started/first-abn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Uninstall the Iter8 controller:
166166
If you installed Grafana, you can delete it as follows:
167167

168168
```shell
169-
kubectl delete svc/grafana, deploy/grafana
169+
kubectl delete svc/grafana deploy/grafana
170170
```
171171

172172
***

‎docs/getting-started/first-performance.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ kubectl delete deploy/httpbin
105105
If you installed Grafana, you can delete it as follows:
106106

107107
```shell
108-
kubectl delete svc/grafana, deploy/grafana
108+
kubectl delete svc/grafana deploy/grafana
109109
```
110110

111111
***

‎docs/getting-started/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```shell
2-
helm install --repo https://iter8-tools.github.io/iter8 --version 0.18 iter8 controller \
2+
helm upgrade --install --repo https://iter8-tools.github.io/iter8 --version 0.18 iter8 controller \
33
--set clusterScoped=true
44
```
55

‎docs/tutorials/integrations/kserve-mm/abn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -200,5 +200,5 @@ Uninstall Iter8 controller:
200200
If you installed Grafana, you can delete it as follows:
201201

202202
```shell
203-
kubectl delete svc/grafana, deploy/grafana
203+
kubectl delete svc/grafana deploy/grafana
204204
```

‎docs/tutorials/integrations/kserve/abn-grpc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -212,5 +212,5 @@ Uninstall Iter8 controller:
212212
If you installed Grafana, you can delete it as follows:
213213

214214
```shell
215-
kubectl delete svc/grafana, deploy/grafana
215+
kubectl delete svc/grafana deploy/grafana
216216
```

‎docs/tutorials/integrations/kserve/abn-http.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -199,5 +199,5 @@ Uninstall Iter8 controller:
199199
If you installed Grafana, you can delete it as follows:
200200

201201
```shell
202-
kubectl delete svc/grafana, deploy/grafana
202+
kubectl delete svc/grafana deploy/grafana
203203
```

‎docs/tutorials/integrations/kserve/grpc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ kubectl delete inferenceservice sklearn-irisv2
108108
If you installed Grafana, you can delete it as follows:
109109

110110
```shell
111-
kubectl delete svc/grafana, deploy/grafana
111+
kubectl delete svc/grafana deploy/grafana
112112
```
113113

114114
??? note "Some variations and extensions of this performance test"

‎docs/tutorials/integrations/kserve/http.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ kubectl delete inferenceservice sklearn-irisv2
9797
If you installed Grafana, you can delete it as follows:
9898

9999
```shell
100-
kubectl delete svc/grafana, deploy/grafana
100+
kubectl delete svc/grafana deploy/grafana
101101
```
102102

103103
??? note "Some variations and extensions of this performance test"

‎docs/tutorials/load-test-grpc-multiple.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ kubectl delete deploy/routeguide
9595
If you installed Grafana, you can delete it as follows:
9696

9797
```shell
98-
kubectl delete svc/grafana, deploy/grafana
98+
kubectl delete svc/grafana deploy/grafana
9999
```
100100

101101
??? note "Some variations and extensions of this performance test"

‎docs/tutorials/load-test-grpc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ kubectl delete deploy/routeguide
137137
If you installed Grafana, you can delete it as follows:
138138

139139
```shell
140-
kubectl delete svc/grafana, deploy/grafana
140+
kubectl delete svc/grafana deploy/grafana
141141
```
142142

143143
??? note "Some variations and extensions of this performance test"

‎docs/tutorials/load-test-http-multiple.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ kubectl delete deploy/httpbin
9393
If you installed Grafana, you can delete it as follows:
9494

9595
```shell
96-
kubectl delete svc/grafana, deploy/grafana
96+
kubectl delete svc/grafana deploy/grafana
9797
```
9898

9999
??? note "Some variations and extensions of this performance test"

‎docs/user-guide/topics/metrics_store.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
template: main.html
3+
---
4+
5+
# Metrics store
6+
7+
One of Iter8's key advantages is that it incorporates its own metrics store simplifying the set up and execution of A/B/n and performance tests. Iter8 currently supports the following databases:
8+
9+
- BadgerDB
10+
- Redis
11+
12+
Iter8 uses BadgerDB by default. Note, however, that BadgerDB is not suitable for production use and is only suitable for a single instance of Iter8. Support for other databases are in the works. See [below](#contribute-a-new-metrics-store-implementation) for details on how to contribute additional implementations.
13+
14+
## Using Redis as the metrics store
15+
16+
We assume that Redis is deployed. For example, for a basic deployment:
17+
18+
```shell
19+
kubectl create deploy redis --image=redis/redis-stack:latest --port=6379
20+
kubectl expose deploy redis --port=6379
21+
```
22+
23+
Run Iter8 with the metrics store implementation set to `redis` and specify its endpoint:
24+
25+
```shell
26+
helm upgrade --install --repo https://iter8-tools.github.io/iter8 --version 0.18 iter8 controller \
27+
--set clusterScoped=true \
28+
--set metrics.implementation=redis \
29+
--set metrics.redis.addresss=redis:6379
30+
```
31+
32+
## Contribute a new metrics store implementation
33+
34+
To contribute a new metrics store implementation:
35+
36+
1. Create an [issue](https://github.com/iter8-tools/iter8/issues) for discussion.
37+
38+
2. Submit a pull request on the [Iter8 project](https://github.com/iter8-tools/iter8) with the following updates:
39+
40+
- Create sub-folder in [storage](https://github.com/iter8-tools/iter8/tree/master/storage) and provide an implementation of this [interface](https://github.com/iter8-tools/iter8/blob/master/storage/interface.go) including test cases.
41+
42+
- Add a new case to [metrics.GetClient()](https://github.com/iter8-tools/iter8/blob/master/storage/client/client.go)
43+
44+
- Update [go.mod](https://github.com/iter8-tools/iter8/blob/master/go.mod) and [go.sum](https://github.com/iter8-tools/iter8/blob/master/go.sum) if needed.
45+
46+
- Update the default Helm chart configuration [values.yaml](https://github.com/iter8-tools/iter8/blob/master/charts/controller/values.yaml) and bump the chart version in [Chart.yaml](https://github.com/iter8-tools/iter8/blob/master/charts/controller/Chart.yaml).
47+
48+
- Please also consider including your information in our list of [adopters](https://github.com/iter8-tools/iter8/blob/master/ADOPTERS.md).
49+
50+
3. Submit a second pull request on the Iter8 [docs project](https://github.com/iter8-tools/docs) updating the list of available implementations.
51+
52+
4. Alert the project reviewers on [Slack](https://join.slack.com/t/iter8-tools/shared_invite/zt-awl2se8i-L0pZCpuHntpPejxzLicbmw) `#development` channel.

‎mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ nav:
161161
- Routemaps: user-guide/topics/routemap.md
162162
- Install options: user-guide/topics/install.md
163163
- Uninstall options: user-guide/topics/uninstall.md
164+
- Metrics store options: user-guide/topics/metrics_store.md
164165
- Contributing: contributing.md
165166
- Roadmap: roadmap.md
166167
- Community:

0 commit comments

Comments
 (0)