Skip to content

Commit

Permalink
Various documentation updates.
Browse files Browse the repository at this point in the history
Remove old broken stuff from documentation.

Move third party things to the Extensions wiki page instead of the offical docs.
  • Loading branch information
cyberw committed Apr 26, 2024
1 parent a89d334 commit 2a4a61c
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 45 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Locust's code base is intentionally kept small and doesn't solve everything out
* [Send real time reporting data to TimescaleDB and visualize it in Grafana](https://github.com/SvenskaSpel/locust-plugins/blob/master/locust_plugins/dashboards/README.md)
* [Wrap calls to handle the peculiarities of your REST API](https://github.com/SvenskaSpel/locust-plugins/blob/8af21862d8129a5c3b17559677fe92192e312d8f/examples/rest_ex.py#L87)
* [Use a totally custom load shape/profile](https://docs.locust.io/en/latest/custom-load-shape.html#custom-load-shape)
* ...
* [...](https://github.com/locustio/locust/wiki/Extensions)

## Links

Expand Down
8 changes: 1 addition & 7 deletions docs/extending-locust.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,7 @@ to the Flask app instance and use that to set up a new route::
def my_added_page():
return "Another page"

You should now be able to start locust and browse to http://127.0.0.1:8089/added_page

.. note::

Please note that at the moment Locust does not show the extended Web UI under the default root path `"/"`.
To view your extensions, navigate to the newly added web route. In this example, `"/added_page"`.

You should now be able to start locust and browse to http://127.0.0.1:8089/added_page. Note that it doesnt get automatically added as a new tab - you'll need to enter the URL directly.

Extending Web UI
================
Expand Down
1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ Running your Locust tests
running-distributed
running-in-debugger
running-in-docker
running-cloud-integration
running-without-web-ui
Expand Down
17 changes: 0 additions & 17 deletions docs/running-cloud-integration.rst

This file was deleted.

21 changes: 3 additions & 18 deletions docs/running-in-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,7 @@ official Locust docker image as a base image::
FROM locustio/locust
RUN pip3 install some-python-package

Running a distributed load test on Kubernetes
==============================================
Running Locust using Kubernetes
===============================

HELM
*****

One of the ways to run Locust on Kubernetes is to use a `Helm chart <https://helm.sh/>`_.

There is a good helm chart here: `github.com/deliveryhero/helm-charts <https://github.com/deliveryhero/helm-charts/tree/master/stable/locust>`_.

Note: this Helm chart is a separate project, and not supported by Locust maintainers.

Kubernetes Operator
*******************
Another way to run Locust on Kubernetes is to use the `Locust Kubernetes Operator <https://abdelrhmanhamouda.github.io/locust-k8s-operator/>`_.

The Locust Operator is designed to unlock easy, seamless & effortless distributed performance testing in the cloud.

Note: the Locust Kubernetes Operator is a separate project and is not supported by Locust maintainers.
See [Extensions](https://github.com/locustio/locust/wiki/Extensions#helm) in the wiki.
1 change: 0 additions & 1 deletion docs/what-is-locust.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ Authors
- Jonatan Heyman (`@heyman <https://github.com/heyman>`_)
- Lars Holmberg (`@cyberw <https://github.com/cyberw>`_)
- Andrew Baldwin (`@andrewbaldwin44 <https://github.com/andrewbaldwin44>`_)
- Carl Byström, Joakim Hamrén & Hugo Heyman

Many thanks to our other great `contributors <https://github.com/locustio/locust/graphs/contributors>`_!

Expand Down

0 comments on commit 2a4a61c

Please sign in to comment.