Skip to content

Commit c692272

Browse files
authored
[FSTORE-1777][APPEND] Tutorial for benchmarking Deployments (#331)
* correcting links in README * updating readme to add secrets * correcting spelling mistakes
1 parent 8b18a68 commit c692272

File tree

1 file changed

+12
-10
lines changed
  • benchmarks/online-inference-pipeline

1 file changed

+12
-10
lines changed

benchmarks/online-inference-pipeline/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,30 @@ This repository benchmarks a deployment running inside **Hopsworks** using [Locu
88
- Run all the provided notebooks to set up your deployment inside Hopsworks.
99

1010
2. **Configure Target Host**
11-
- Add the **host name** and **IP address** of your deployment in [`locustfile.py`](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/model-deployment/locust/locustfile.py#L12).
11+
- Add the **host name** and **IP address** of your deployment in [`locustfile.py`](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/online-inference-pipeline/locust/locustfile.py#L12).
1212
- You can find this information in the Hopsworks **Deployment UI**.
1313

1414
3. **Add Hopsworks API Key**
15-
- Insert your Hopsworks API key into the same [`locustfile.py`](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/model-deployment/locust/locustfile.py#L12).
15+
- Insert your Hopsworks API key into the same [`locustfile.py`](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/online-inference-pipeline/locust/locustfile.py#L12).
1616
- Generate the API key by following [this guide](https://docs.hopsworks.ai/latest/user_guides/projects/api_key/create_api_key/).
1717

18-
4. **Build the Locust Docker Image**
19-
- Use the provided [Dockerfile](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/model-deployment/locust/Dockerfile) to build a Locust image.
18+
4. **Create the 'HOPSWORKS_API_KEY' secret**
19+
- Create a secret with the name `HOPSWORKS_API_KEY` which contains the API key by following [this guide](https://docs.hopsworks.ai/latest/user_guides/projects/secrets/create_secret/).
20+
5. **Build the Locust Docker Image**
21+
- Use the provided [Dockerfile](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/online-inference-pipeline/locust/Dockerfile) to build a Locust image.
2022
- Push the image to your preferred container registry.
2123

22-
5. **Update Kubernetes Manifests**
24+
6. **Update Kubernetes Manifests**
2325
- Update the image URL in both:
24-
- [`master-deployment.yaml`](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/model-deployment/locust/kubernetes-locust/master-deployment.yaml#L28)
25-
- [`slave-deployment.yaml`](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/model-deployment/locust/kubernetes-locust/slave-deployment.yaml#L28)
26+
- [`master-deployment.yaml`](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/online-inference-pipeline/locust/kubernetes-locust/master-deployment.yaml#L28)
27+
- [`slave-deployment.yaml`](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/online-inference-pipeline/locust/kubernetes-locust/slave-deployment.yaml#L28)
2628

27-
6. **Deploy Locust**
28-
- Run the [deployment script](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/model-deployment/locust/kubernetes-locust/deploy.sh) to deploy Locust master and worker nodes.
29+
7. **Deploy Locust**
30+
- Run the [deployment script](https://github.com/logicalclocks/hopsworks-tutorials/blob/master/benchmarks/online-inference-pipeline/locust/kubernetes-locust/deploy.sh) to deploy Locust master and worker nodes.
2931
- This will deploy into a Kubernetes namespace named `locust`.
3032
- **Note:** Ensure you have `kubectl` access to the cluster.
3133

32-
7. **Access Locust UI**
34+
8. **Access Locust UI**
3335
- Once deployed, port-forward port `8089` from the `locust-master` service to your local machine.
3436
- Access the Locust Web UI at [http://localhost:8089](http://localhost:8089) to run and monitor your load tests.
3537

0 commit comments

Comments
 (0)