Skip to content

Commit 94bac7f

Browse files
authored
update references for v0.18 (#117)
* update references for v0.18 Signed-off-by: Michael Kalantar <[email protected]> * update wordlist Signed-off-by: Michael Kalantar <[email protected]> --------- Signed-off-by: Michael Kalantar <[email protected]>
1 parent 2883a04 commit 94bac7f

30 files changed

+150
-433
lines changed

.github/wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ CLI
1212
CLIs
1313
cronjob
1414
crontab
15+
ConfigMap
1516
DCO
1617
default_encoding
1718
declaratively

docs/getting-started/first-abn.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,25 +31,23 @@ A sample application using the Iter8 SDK is provided. Deploy both the frontend a
3131

3232
=== "node"
3333
```shell
34-
kubectl create deployment frontend --image=iter8/abn-sample-frontend-node:0.15.0
34+
kubectl create deployment frontend --image=iter8/abn-sample-frontend-node:0.17.3
3535
kubectl expose deployment frontend --name=frontend --port=8090
3636
```
37-
<!-- kubectl create deployment frontend --image=kalantar/frontend-node:20230717-1552 -->
3837

3938
=== "Go"
4039
```shell
41-
kubectl create deployment frontend --image=iter8/abn-sample-frontend-go:0.15.0
40+
kubectl create deployment frontend --image=iter8/abn-sample-frontend-go:0.17.3
4241
kubectl expose deployment frontend --name=frontend --port=8090
4342
```
44-
<!-- kubectl create deployment frontend --image=kalantar/frontend-go:20230717-1339 -->
4543

4644
The frontend component is implemented to call `Lookup()` before each call to the backend component. The frontend component uses the returned version number to route the request to the recommended version of the backend component.
4745

4846
=== "backend"
4947
Deploy an initial version of the *backend* component:
5048

5149
```shell
52-
kubectl create deployment backend --image=iter8/abn-sample-backend:0.13-v1
50+
kubectl create deployment backend --image=iter8/abn-sample-backend:0.17-v1
5351
kubectl label deployment backend iter8.tools/watch="true"
5452

5553
kubectl expose deployment backend --name=backend --port=8091
@@ -68,7 +66,7 @@ metadata:
6866
labels:
6967
app.kubernetes.io/managed-by: iter8
7068
iter8.tools/kind: routemap
71-
iter8.tools/version: "v0.17"
69+
iter8.tools/version: "v0.18"
7270
immutable: true
7371
data:
7472
strSpec: |
@@ -99,15 +97,15 @@ In separate shells, port-forward requests to the frontend component and generate
9997
kubectl port-forward service/frontend 8090:8090
10098
```
10199
```shell
102-
curl -s https://raw.githubusercontent.com/iter8-tools/docs/v0.15.0/samples/abn-sample/generate_load.sh | sh -s --
100+
curl -s https://raw.githubusercontent.com/iter8-tools/docs/v0.17.3/samples/abn-sample/generate_load.sh | sh -s --
103101
```
104102

105103
## Deploy candidate
106104

107105
Deploy the candidate version of the *backend* component, naming it `backend-candidate-1`.
108106

109107
```shell
110-
kubectl create deployment backend-candidate-1 --image=iter8/abn-sample-backend:0.13-v2
108+
kubectl create deployment backend-candidate-1 --image=iter8/abn-sample-backend:0.17-v2
111109
kubectl label deployment backend-candidate-1 iter8.tools/watch="true"
112110

113111
kubectl expose deployment backend-candidate-1 --name=backend-candidate-1 --port=8091
@@ -131,7 +129,7 @@ Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3
131129
* URL: `http://iter8.default:8080/abnDashboard`
132130
* Query string: `namespace=default&application=backend`
133131

134-
[Create a new dashboard](http://localhost:3000/dashboards) by *import*. Copy and paste the contents of the [`abn` Grafana dashboard](https://raw.githubusercontent.com/iter8-tools/iter8/v0.16.2/grafana/abn.json) into the text box and *load* it. Associate it with the JSON API data source above.
132+
[Create a new dashboard](http://localhost:3000/dashboards) by *import*. Copy and paste the contents of the [`abn` Grafana dashboard](https://raw.githubusercontent.com/iter8-tools/iter8/v0.18.3/grafana/abn.json) into the text box and *load* it. Associate it with the JSON API data source above.
135133

136134
The Iter8 dashboard allows you to compare the behavior of the two versions of the backend component against each other and select a winner. Since user requests are being sent by the load generation script, the values in the report may change over time. The Iter8 dashboard will look like the following:
137135

@@ -144,7 +142,7 @@ Once you identify a winner, it can be promoted, and the candidate version delete
144142
To promote the candidate version (`backend-candidate-1`), first update the primary version, `backend`, using the new image. You can also overwrite any metadata describing the version.
145143

146144
```shell
147-
kubectl set image deployment/backend abn-sample-backend=iter8/abn-sample-backend:0.13-v2
145+
kubectl set image deployment/backend abn-sample-backend=iter8/abn-sample-backend:0.17-v2
148146
```
149147

150148
Finally, delete the candidate version:

docs/getting-started/first-performance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ template: main.html
44

55
# Load test HTTP endpoint
66

7-
Run your first [Iter8 performance test](concepts.md#design) by load testing a Kubernetes HTTP service and visualizing the performance with an Iter8 Grafana dashboard.
7+
Run your first performance test by load testing a Kubernetes HTTP service and visualizing the performance with an Iter8 Grafana dashboard.
88

99
![Load test HTTP](images/kubernetesusage.png)
1010

@@ -32,7 +32,7 @@ Run your first [Iter8 performance test](concepts.md#design) by load testing a Ku
3232
=== "GET example"
3333
```shell
3434
helm upgrade --install \
35-
--repo https://iter8-tools.github.io/iter8 --version 0.17 httpbin-test iter8 \
35+
--repo https://iter8-tools.github.io/iter8 --version 0.18 httpbin-test iter8 \
3636
--set "tasks={ready,http}" \
3737
--set ready.deploy=httpbin \
3838
--set ready.service=httpbin \
@@ -43,7 +43,7 @@ Run your first [Iter8 performance test](concepts.md#design) by load testing a Ku
4343
=== "POST example"
4444
```shell
4545
helm upgrade --install \
46-
--repo https://iter8-tools.github.io/iter8 --version 0.17 httpbin-test iter8 \
46+
--repo https://iter8-tools.github.io/iter8 --version 0.18 httpbin-test iter8 \
4747
--set "tasks={ready,http}" \
4848
--set ready.deploy=httpbin \
4949
--set ready.service=httpbin \
@@ -73,7 +73,7 @@ Open Grafana by going to [http://localhost:3000](http://localhost:3000).
7373
* URL: `http://iter8.default:8080/httpDashboard`
7474
* Query string: `namespace=default&test=httpbin-test`
7575

76-
[Create a new dashboard](http://localhost:3000/dashboards) by *import*. Paste the contents of the [`http` Grafana dashboard](https://raw.githubusercontent.com/iter8-tools/iter8/v0.16.2/grafana/http.json) into the text box and *load* it. Associate it with the JSON API data source defined above.
76+
[Create a new dashboard](http://localhost:3000/dashboards) by *import*. Paste the contents of the [`http` Grafana dashboard](https://raw.githubusercontent.com/iter8-tools/iter8/v0.18.3/grafana/http.json) into the text box and *load* it. Associate it with the JSON API data source defined above.
7777

7878
The Iter8 dashboard will look like the following:
7979

docs/getting-started/first-routing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ kubectl get deployment httpbin-0
4949
Initialize the routing resources for the application to use a blue-green rollout strategy:
5050

5151
```shell
52-
cat <<EOF | helm template routing --repo https://iter8-tools.github.io/iter8 routing-actions --version 0.1.5 -f - | kubectl apply -f -
52+
cat <<EOF | helm template routing --repo https://iter8-tools.github.io/iter8 routing-actions --version 0.18 -f - | kubectl apply -f -
5353
appType: deployment
5454
appName: httpbin
5555
action: initialize
5656
strategy: blue-green
5757
EOF
5858
```
5959

60-
The `initialize` action (with strategy `blue-green`) configures the (Istio) service mesh to route all requests to the primary version of the application (`httpbin-0`). It further defines the routing policy that will be used when changes are observed in the application resources. By default, this routing policy splits requests 50-50 between the primary and candidate versions. For detailed configuration options, see the [Helm chart](https://github.com/iter8-tools/iter8/blob/v0.16.0/charts/routing-actions/values.yaml).
60+
The `initialize` action (with strategy `blue-green`) configures the (Istio) service mesh to route all requests to the primary version of the application (`httpbin-0`). It further defines the routing policy that will be used when changes are observed in the application resources. By default, this routing policy splits requests 50-50 between the primary and candidate versions. For detailed configuration options, see the [Helm chart](https://github.com/iter8-tools/iter8/blob/v0.18.3/charts/routing-actions/values.yaml).
6161

6262
### Verify routing
6363

@@ -72,7 +72,7 @@ To send inference requests to the model:
7272
=== "From within the cluster"
7373
1. Create a `sleep` pod in the cluster from which requests can be made:
7474
```shell
75-
curl -s https://raw.githubusercontent.com/iter8-tools/docs/v0.15.2/samples/kserve-serving/sleep.sh | sh -
75+
curl -s https://raw.githubusercontent.com/iter8-tools/docs/v0.17.3/samples/kserve-serving/sleep.sh | sh -
7676
```
7777

7878
2. Exec into the sleep pod:
@@ -156,7 +156,7 @@ You can send additional inference requests as described above. They will be hand
156156
You can modify the weight distribution of inference requests as follows:
157157

158158
```shell
159-
cat <<EOF | helm template routing --repo https://iter8-tools.github.io/iter8 routing-actions --version 0.1.5 -f - | kubectl apply -f -
159+
cat <<EOF | helm template routing --repo https://iter8-tools.github.io/iter8 routing-actions --version 0.18 -f - | kubectl apply -f -
160160
appType: deployment
161161
appName: httpbin
162162
action: modify-weights
@@ -208,7 +208,7 @@ kubectl delete deployment/httpbin-1 service/httpbin-1
208208
Delete routing:
209209

210210
```shell
211-
cat <<EOF | helm template routing --repo https://iter8-tools.github.io/iter8 routing-actions --version 0.1.5 -f - | kubectl delete -f -
211+
cat <<EOF | helm template routing --repo https://iter8-tools.github.io/iter8 routing-actions --version 0.18 -f - | kubectl delete -f -
212212
appType: deployment
213213
appName: httpbin
214214
action: initialize

docs/images/logo.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/tutorials/deleteiter8controller.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
=== "Kustomize"
77
=== "Namespace scoped"
88
```shell
9-
kubectl delete -k 'https://github.com/iter8-tools/iter8.git/kustomize/controller/namespaceScoped?ref=v0.17.1'
9+
kubectl delete -k 'https://github.com/iter8-tools/iter8.git/kustomize/controller/namespaceScoped?ref=v0.18.3'
1010
```
1111

1212
=== "Cluster scoped"
1313
```shell
14-
kubectl delete -k 'https://github.com/iter8-tools/iter8.git/kustomize/controller/clusterScoped?ref=v0.17.1'
14+
kubectl delete -k 'https://github.com/iter8-tools/iter8.git/kustomize/controller/clusterScoped?ref=v0.18.3'
1515
```
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
=== "Helm"
22
=== "Namespace scoped"
33
```shell
4-
helm install --repo https://iter8-tools.github.io/iter8 --version 0.1.12 iter8 controller
4+
helm install --repo https://iter8-tools.github.io/iter8 --version 0.18 iter8 controller
55
```
66

77
=== "Cluster scoped"
88
```shell
9-
helm install --repo https://iter8-tools.github.io/iter8 --version 0.1.12 iter8 controller \
9+
helm install --repo https://iter8-tools.github.io/iter8 --version 0.18 iter8 controller \
1010
--set clusterScoped=true
1111
```
1212

1313
=== "Kustomize"
1414
=== "Namespace scoped"
1515
```shell
16-
kubectl apply -k 'https://github.com/iter8-tools/iter8.git/kustomize/controller/namespaceScoped?ref=v0.17.1'
16+
kubectl apply -k 'https://github.com/iter8-tools/iter8.git/kustomize/controller/namespaceScoped?ref=v0.18.3'
1717
```
1818

1919
=== "Cluster scoped"
2020
```shell
21-
kubectl apply -k 'https://github.com/iter8-tools/iter8.git/kustomize/controller/clusterScoped?ref=v0.17.1'
21+
kubectl apply -k 'https://github.com/iter8-tools/iter8.git/kustomize/controller/clusterScoped?ref=v0.18.3'
2222
```

docs/tutorials/integrations/ghactions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ jobs:
3131
- run: 'echo "payload: ${{ toJson(github.event.client_payload) }}"'
3232
```
3333
34-
Note that this workflow has one job that will print out the `client_payload`. The default `github` task [payload](https://raw.githubusercontent.com/iter8-tools/iter8/v0.16.5/templates/notify/_payload-github.tpl) is configured with `client_payload` set to `.Report`, a summary of the performance test.
34+
Note that this workflow has one job that will print out the `client_payload`. The default `github` task [payload](https://raw.githubusercontent.com/iter8-tools/iter8/v0.18.3/templates/notify/_payload-github.tpl) is configured with `client_payload` set to `.Report`, a summary of the performance test.
3535

36-
Also note that the `on.repository_dispatch.types` is set to `iter8`. The default `github` task [payload](https://raw.githubusercontent.com/iter8-tools/iter8/v0.16.5/templates/notify/_payload-github.tpl) is configured with `event_type` set to `iter8`. This indicates that once the `repository_dispatch` has been sent, only workflows on the default branch with `on.repository_dispatch.types` set to `iter8` will be triggered.
36+
Also note that the `on.repository_dispatch.types` is set to `iter8`. The default `github` task [payload](https://raw.githubusercontent.com/iter8-tools/iter8/v0.18.3/templates/notify/_payload-github.tpl) is configured with `event_type` set to `iter8`. This indicates that once the `repository_dispatch` has been sent, only workflows on the default branch with `on.repository_dispatch.types` set to `iter8` will be triggered.
3737

3838
3. Create a GitHub [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) for the `token` parameter.
3939
4. Ensure that you have a Kubernetes cluster and the [`kubectl` CLI](https://kubernetes.io/docs/reference/kubectl/). You can create a local Kubernetes cluster using tools like [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/).
@@ -49,7 +49,7 @@ kubectl expose deploy httpbin --port=80
4949
7. Launch the performance test using the `github` task with the appropriate values.
5050
```shell
5151
helm upgrade --install \
52-
--repo https://iter8-tools.github.io/iter8 --version 0.17 httpbin-test iter8 \
52+
--repo https://iter8-tools.github.io/iter8 --version 0.18 httpbin-test iter8 \
5353
--set "tasks={http,github}" \
5454
--set http.url=http://httpbin.default/get \
5555
--set github.owner=<GitHub owner> \
@@ -59,8 +59,8 @@ helm upgrade --install \
5959
8. Verify that the workflow has been triggered after the performance test has completed.
6060

6161
??? note "Some variations and extensions of the `github` task"
62-
The default `github` task [payload](https://raw.githubusercontent.com/iter8-tools/iter8/v0.16.5/templates/notify/_payload-github.tpl) sends a summary of the performance test.
62+
The default `github` task [payload](https://raw.githubusercontent.com/iter8-tools/iter8/v0.18.3/templates/notify/_payload-github.tpl) sends a summary of the performance test.
6363

6464
In your workflow, you can read from the report and use that data for control flow or use snippets of that data in different actions. For example, you can check to see if there have been any task failures and take alternative actions.
6565

66-
You do not need to use the default `github` task [payload](https://raw.githubusercontent.com/iter8-tools/iter8/v0.16.5/templates/notify/_payload-github.tpl). You can provide your own payload by overriding the default of the `payloadTemplateURL`.
66+
You do not need to use the default `github` task [payload](https://raw.githubusercontent.com/iter8-tools/iter8/v0.18.3/templates/notify/_payload-github.tpl). You can provide your own payload by overriding the default of the `payloadTemplateURL`.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A sample application using the Iter8 SDK is provided. Deploy both the frontend a
3232

3333
=== "frontend"
3434
```shell
35-
kubectl create deployment frontend --image=iter8/abn-sample-mm-frontend-go:0.17.2
35+
kubectl create deployment frontend --image=iter8/abn-sample-mm-frontend-go:0.17.3
3636
kubectl expose deployment frontend --name=frontend --port=8090
3737
```
3838

@@ -83,7 +83,7 @@ metadata:
8383
labels:
8484
app.kubernetes.io/managed-by: iter8
8585
iter8.tools/kind: routemap
86-
iter8.tools/version: "v0.17"
86+
iter8.tools/version: "v0.18"
8787
immutable: true
8888
data:
8989
strSpec: |
@@ -109,7 +109,7 @@ In separate shells, port-forward requests to the frontend component and generate
109109
```
110110

111111
```shell
112-
curl -s https://raw.githubusercontent.com/iter8-tools/docs/v0.15.0/samples/abn-sample/generate_load.sh | sh -s --
112+
curl -s https://raw.githubusercontent.com/iter8-tools/docs/v0.17.3/samples/abn-sample/generate_load.sh | sh -s --
113113
```
114114

115115
## Deploy candidate
@@ -159,7 +159,7 @@ Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3
159159
* URL: `http://iter8.modelmesh-serving:8080/abnDashboard`
160160
* Query string: `namespace=modelmesh-serving&application=backend`
161161

162-
[Create a new dashboard](http://localhost:3000/dashboards) by *import*. Copy and paste the contents of the [`abn` Grafana dashboard](https://raw.githubusercontent.com/iter8-tools/iter8/v0.16.2/grafana/abn.json) into the text box and *load* it. Associate it with the JSON API data source above.
162+
[Create a new dashboard](http://localhost:3000/dashboards) by *import*. Copy and paste the contents of the [`abn` Grafana dashboard](https://raw.githubusercontent.com/iter8-tools/iter8/v0.18.3/grafana/abn.json) into the text box and *load* it. Associate it with the JSON API data source above.
163163

164164
The Iter8 dashboard allows you to compare the behavior of the two versions of the backend component against each other and select a winner. Since user requests are being sent by the load generation script, the values in the report may change over time. The Iter8 dashboard will look like the following:
165165

0 commit comments

Comments
 (0)