Skip to content

Commit 0509db2

Browse files
authored
document memory recommendations (#125)
Signed-off-by: Michael Kalantar <[email protected]>
1 parent ce8f5be commit 0509db2

17 files changed

+36
-41
lines changed

docs/getting-started/first-abn.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This tutorial describes how to do A/B testing of a backend component using the [
1111
***
1212

1313
???+ warning "Before you begin"
14-
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. You can create a local Kubernetes cluster using tools like [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/).
14+
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
1515
2. Have Grafana available. For example, Grafana can be installed on your cluster as follows:
1616
```shell
1717
kubectl create deploy grafana --image=grafana/grafana
@@ -111,7 +111,7 @@ Inspect the metrics using Grafana. If Grafana is deployed to your cluster, port-
111111
kubectl port-forward service/grafana 3000:3000
112112
```
113113

114-
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000)
114+
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000) and login. The default username/password are `admin`/`admin`.
115115

116116
[Add a JSON API data source](http://localhost:3000/connections/datasources/marcusolsson-json-datasource) `default/backend` with the following parameters:
117117

docs/getting-started/first-performance.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Run your first performance test by load testing a Kubernetes HTTP service and vi
99
![Load test HTTP](images/kubernetesusage.png)
1010

1111
???+ warning "Before you begin"
12-
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. You can create a local Kubernetes cluster using tools like [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/).
12+
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
1313
2. Deploy the sample HTTP service in the Kubernetes cluster.
1414
```shell
1515
kubectl create deploy httpbin --image=kennethreitz/httpbin --port=80
@@ -66,7 +66,7 @@ Inspect the metrics using Grafana. If Grafana is deployed to your cluster, port-
6666
kubectl port-forward service/grafana 3000:3000
6767
```
6868

69-
Open Grafana by going to [http://localhost:3000](http://localhost:3000).
69+
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000) and login. The default username/password are `admin`/`admin`.
7070

7171
[Add a JSON API data source](http://localhost:3000/connections/datasources/marcusolsson-json-datasource) `httpbin-test` with the following parameters:
7272

docs/getting-started/first-release.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The chart provides the configuration needed for Iter8 to automatically deploy ap
1414
![Blue-green rollout](../tutorials/images/blue-green.png)
1515

1616
???+ warning "Before you begin"
17-
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. You can create a local Kubernetes cluster using tools like [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/).
17+
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
1818
2. Install [Istio](https://istio.io). It suffices to install the [demo profile](https://istio.io/latest/docs/setup/getting-started/), for example by using:
1919
```shell
2020
istioctl install --set profile=demo -y

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

+4-7
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,8 @@ This tutorial describes how to do A/B testing as part of the release of a backen
1111
***
1212

1313
???+ warning "Before you begin"
14-
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. You can create a local Kubernetes cluster using tools like [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/).
15-
2. Have access to a cluster running [KServe ModelMesh Serving](https://github.com/kserve/modelmesh-serving). For example, you can create a modelmesh-serving [Quickstart](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md) environment. If using the Quickstart environment, change your default namespace to `modelmesh-serving`:
16-
```shell
17-
kubectl config set-context --current --namespace=modelmesh-serving
18-
```
14+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
15+
2. Have access to a cluster running [KServe ModelMesh Serving](https://github.com/kserve/modelmesh-serving). For example, you can create a modelmesh-serving [Quickstart](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md) environment. If using the Quickstart environment, your default namespace will be changed to `modelmesh-serving`. If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
1916
3. Have Grafana available. For example, Grafana can be installed on your cluster as follows:
2017
```shell
2118
kubectl create deploy grafana --image=grafana/grafana
@@ -131,9 +128,9 @@ Inspect the metrics using Grafana. If Grafana is deployed to your cluster, port-
131128
kubectl port-forward service/grafana 3000:3000
132129
```
133130

134-
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000)
131+
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000) and login. The default username/password are `admin`/`admin`.
135132

136-
[Add a JSON API data source](http://localhost:3000/connections/datasources/marcusolsson-json-datasource) `default/backend` with the following parameters:
133+
[Add a JSON API data source](http://localhost:3000/connections/datasources/marcusolsson-json-datasource) `modelmesh-serving/backend` with the following parameters:
137134

138135
* URL: `http://iter8.modelmesh-serving:8080/abnDashboard`
139136
* Query string: `namespace=modelmesh-serving&application=backend`

docs/tutorials/integrations/kserve-mm/blue-green.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ The chart provides the configuration needed for Iter8 to automatically deploy ap
1414
![Blue-green rollout](../../images/blue-green.png)
1515

1616
???+ warning "Before you begin"
17-
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs.
18-
2. Have access to a cluster running [KServe ModelMesh Serving](https://github.com/kserve/modelmesh-serving). For example, you can create a modelmesh-serving [Quickstart](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md) environment. If using the Quickstart environment, change your default namespace to `modelmesh-serving`:
19-
```shell
20-
kubectl config set-context --current --namespace=modelmesh-serving
21-
```
17+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
18+
2. Have access to a cluster running [KServe ModelMesh Serving](https://github.com/kserve/modelmesh-serving). For example, you can create a modelmesh-serving [Quickstart](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md) environment. If using the Quickstart environment, your default namespace will be changed to `modelmesh-serving`. If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
2219
3. Install [Istio](https://istio.io). It suffices to install the [demo profile](https://istio.io/latest/docs/setup/getting-started/), for example by using:
2320
```shell
2421
istioctl install --set profile=demo -y

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

+2-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ The chart provides the configuration needed for Iter8 to automatically deploy ap
1414
![Canary rollout](../../images/canary.png)
1515

1616
???+ warning "Before you begin"
17-
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs.
18-
2. Have access to a cluster running [KServe ModelMesh Serving](https://github.com/kserve/modelmesh-serving). For example, you can create a modelmesh-serving [Quickstart](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md) environment. If using the Quickstart environment, change your default namespace to `modelmesh-serving`:
19-
```shell
20-
kubectl config set-context --current --namespace=modelmesh-serving
21-
```
17+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
18+
2. Have access to a cluster running [KServe ModelMesh Serving](https://github.com/kserve/modelmesh-serving). For example, you can create a modelmesh-serving [Quickstart](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md) environment. If using the Quickstart environment, your default namespace will be changed to `modelmesh-serving`. If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
2219
3. Install [Istio](https://istio.io). It suffices to install the [demo profile](https://istio.io/latest/docs/setup/getting-started/), for example by using:
2320
```shell
2421
istioctl install --set profile=demo -y

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ This tutorial describes how to do A/B testing as part of the release of a backen
1111
***
1212

1313
???+ warning "Before you begin"
14-
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. You can create a local Kubernetes cluster using tools like [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/).
14+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
1515
2. Have access to a cluster running [KServe](https://kserve.github.io/website). You can create a [KServe Quickstart](https://kserve.github.io/website/0.11/get_started/#before-you-begin) environment as follows:
1616
```shell
1717
curl -s "https://raw.githubusercontent.com/kserve/kserve/release-0.11/hack/quick_install.sh" | bash
1818
```
19+
If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
1920
3. Have Grafana available. For example, Grafana can be installed on your cluster as follows:
2021
```shell
2122
kubectl create deploy grafana --image=grafana/grafana
@@ -139,7 +140,7 @@ Inspect the metrics using Grafana. If Grafana is deployed to your cluster, port-
139140
kubectl port-forward service/grafana 3000:3000
140141
```
141142

142-
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000)
143+
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000) and login. The default username/password are `admin`/`admin`.
143144

144145
[Add a JSON API data source](http://localhost:3000/connections/datasources/marcusolsson-json-datasource) `default/backend` with the following parameters:
145146

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ This tutorial describes how to do A/B testing as part of the release of a backen
1111
***
1212

1313
???+ warning "Before you begin"
14-
1. Ensure that you have a Kubernetes cluster and the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs. You can create a local Kubernetes cluster using tools like [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/).
14+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
1515
2. Have access to a cluster running [KServe](https://kserve.github.io/website). You can create a [KServe Quickstart](https://kserve.github.io/website/0.11/get_started/#before-you-begin) environment as follows:
1616
```shell
1717
curl -s "https://raw.githubusercontent.com/kserve/kserve/release-0.11/hack/quick_install.sh" | bash
1818
```
19+
If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
1920
3. Have Grafana available. For example, Grafana can be installed on your cluster as follows:
2021
```shell
2122
kubectl create deploy grafana --image=grafana/grafana
@@ -131,7 +132,7 @@ Inspect the metrics using Grafana. If Grafana is deployed to your cluster, port-
131132
kubectl port-forward service/grafana 3000:3000
132133
```
133134

134-
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000)
135+
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000) and login. The default username/password are `admin`/`admin`.
135136

136137
[Add a JSON API data source](http://localhost:3000/connections/datasources/marcusolsson-json-datasource) `default/backend` with the following parameters:
137138

docs/tutorials/integrations/kserve/blue-green.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ The chart provides the configuration needed for Iter8 to automatically deploy ap
1414
![Blue-green rollout](../../images/blue-green.png)
1515

1616
???+ warning "Before you begin"
17-
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs.
17+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
1818
2. Have access to a cluster running [KServe](https://kserve.github.io/website). You can create a [KServe Quickstart](https://kserve.github.io/website/0.11/get_started/#before-you-begin) environment as follows:
1919
```shell
2020
curl -s "https://raw.githubusercontent.com/kserve/kserve/release-0.11/hack/quick_install.sh" | bash
2121
```
22+
If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
2223
<!-- Istio is installed as part of kserve install -->
2324

2425
## Install the Iter8 controller

docs/tutorials/integrations/kserve/canary.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ The chart provides the configuration needed for Iter8 to automatically deploy ap
1414
![Canary rollout](../../images/canary.png)
1515

1616
???+ warning "Before you begin"
17-
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs.
17+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
1818
2. Have access to a cluster running [KServe](https://kserve.github.io/website). You can create a [KServe Quickstart](https://kserve.github.io/website/0.11/get_started/#before-you-begin) environment as follows:
1919
```shell
2020
curl -s "https://raw.githubusercontent.com/kserve/kserve/release-0.11/hack/quick_install.sh" | bash
2121
```
22+
If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
2223
<!-- Istio is installed as part of kserve install -->
2324

2425
## Install the Iter8 controller

docs/tutorials/integrations/kserve/grpc.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ template: main.html
77
This tutorial shows how easy it is to run a load test for KServe when using gRPC to make requests. We use a sklearn model to demonstrate. The same approach works for any model type.
88

99
???+ warning "Before you begin"
10-
1. Try [Your first performance test](../../../getting-started/first-performance.md). Understand the main [concepts](../../../getting-started/concepts.md) behind Iter8.
11-
2. Ensure that you have the [kubectl](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs.
12-
3. Have access to a cluster running [KServe](https://kserve.github.io/website). You can create a [KServe Quickstart](https://kserve.github.io/website/0.11/get_started/#before-you-begin) environment as follows:
10+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
11+
2. Have access to a cluster running [KServe](https://kserve.github.io/website). You can create a [KServe Quickstart](https://kserve.github.io/website/0.11/get_started/#before-you-begin) environment as follows:
1312
```shell
1413
curl -s "https://raw.githubusercontent.com/kserve/kserve/release-0.11/hack/quick_install.sh" | bash
1514
```
15+
If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
1616
4. Have Grafana available. For example, Grafana can be installed on your cluster as follows:
1717
```shell
1818
kubectl create deploy grafana --image=grafana/grafana
@@ -81,7 +81,7 @@ Inspect the metrics using Grafana. If Grafana is deployed to your cluster, port-
8181
kubectl port-forward service/grafana 3000:3000
8282
```
8383

84-
Open Grafana by going to [http://localhost:3000](http://localhost:3000).
84+
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000) and login. The default username/password are `admin`/`admin`.
8585

8686
[Add a JSON API data source](http://localhost:3000/connections/datasources/marcusolsson-json-datasource) `model-test` with the following parameters:
8787

docs/tutorials/integrations/kserve/http.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ template: main.html
77
This tutorial shows how easy it is to run a load test for KServe when using HTTP to make requests. We use a sklearn model to demonstrate. The same approach works for any model type.
88

99
???+ warning "Before you begin"
10-
1. Try [Your first performance test](../../../getting-started/first-performance.md). Understand the main [concepts](../../../getting-started/concepts.md) behind Iter8.
11-
2. Ensure that you have the [kubectl](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs.
12-
3. Have access to a cluster running [KServe](https://kserve.github.io/website). You can create a [KServe Quickstart](https://kserve.github.io/website/0.11/get_started/#before-you-begin) environment as follows:
10+
1. Ensure that you have the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/) and [`helm`](https://helm.sh/) CLIs installed.
11+
2. Have access to a cluster running [KServe](https://kserve.github.io/website). You can create a [KServe Quickstart](https://kserve.github.io/website/0.11/get_started/#before-you-begin) environment as follows:
1312
```shell
1413
curl -s "https://raw.githubusercontent.com/kserve/kserve/release-0.11/hack/quick_install.sh" | bash
1514
```
15+
If using a local cluster (for example, [Kind](https://kind.sigs.k8s.io/) or [Minikube](https://minikube.sigs.k8s.io/docs/)), we recommend providing the cluster with at least 16GB of memory.
1616
4. Have Grafana available. For example, Grafana can be installed on your cluster as follows:
1717
```shell
1818
kubectl create deploy grafana --image=grafana/grafana
@@ -70,7 +70,7 @@ Inspect the metrics using Grafana. If Grafana is deployed to your cluster, port-
7070
kubectl port-forward service/grafana 3000:3000
7171
```
7272

73-
Open Grafana by going to [http://localhost:3000](http://localhost:3000).
73+
Open Grafana in a browser by going to [http://localhost:3000](http://localhost:3000) and login. The default username/password are `admin`/`admin`.
7474

7575
[Add a JSON API data source](http://localhost:3000/connections/datasources/marcusolsson-json-datasource) `model-test` with the following parameters:
7676

0 commit comments

Comments
 (0)