Skip to content

Commit

Permalink
Improve documentation in various ways (elastic#1326)
Browse files Browse the repository at this point in the history
  • Loading branch information
@pquentin
pquentin authored Sep 10, 2021
1 parent 4c7ac3f commit 4355771
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 37 deletions.
4 changes: 2 additions & 2 deletions docs/adding_tracks.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ The numbers under the ``documents`` property are needed to verify integrity and

The new track appears when you run ``esrally list tracks --track-path=~/rally-tracks/tutorial``::

dm@io:~ $ esrally list tracks --track-path=~/rally-tracks/tutorial
$ esrally list tracks --track-path=~/rally-tracks/tutorial

____ ____
/ __ \____ _/ / /_ __
Expand All @@ -240,7 +240,7 @@ The new track appears when you run ``esrally list tracks --track-path=~/rally-tr

You can also show details about your track with ``esrally info --track-path=~/rally-tracks/tutorial``::

dm@io:~ $ esrally info --track-path=~/rally-tracks/tutorial
$ esrally info --track-path=~/rally-tracks/tutorial

____ ____
/ __ \____ _/ / /_ __
Expand Down
29 changes: 15 additions & 14 deletions docs/docker.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,21 @@ You can test the Rally Docker image by first issuing a simple command to list th
Available tracks:

Name Description Documents Compressed Size Uncompressed Size Default Challenge All Challenges
------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ----------- ----------------- ------------------- ----------------------- ---------------------------------------------------------------------------------------------------------------------------
geopoint Point coordinates from PlanetOSM 60,844,404 481.9 MB 2.3 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-fast-with-conflicts
eventdata This benchmark indexes HTTP access logs generated based sample logs from the elastic.co website using the generator available in https://github.com/elastic/rally-eventdata-track 20,000,000 755.1 MB 15.3 GB append-no-conflicts append-no-conflicts
nested StackOverflow Q&A stored as nested docs 11,203,029 663.1 MB 3.4 GB nested-search-challenge nested-search-challenge,index-only
so Indexing benchmark using up to questions and answers from StackOverflow 36,062,278 8.9 GB 33.1 GB append-no-conflicts append-no-conflicts
------------- --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ----------- ----------------- ------------------- ----------------------- ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
eql EQL benchmarks based on endgame index of SIEM demo cluster 60,782,211 4.5 GB 109.2 GB default default
eventdata This benchmark indexes HTTP access logs generated based sample logs from the elastic.co website using the generator available in https://github.com/elastic/rally-eventdata-track 20,000,000 756.0 MB 15.3 GB append-no-conflicts append-no-conflicts,transform
geonames POIs from Geonames 11,396,503 252.9 MB 3.3 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-sorted-no-conflicts,append-fast-with-conflicts,significant-text
geopoint Point coordinates from PlanetOSM 60,844,404 482.1 MB 2.3 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-fast-with-conflicts
geopointshape Point coordinates from PlanetOSM indexed as geoshapes 60,844,404 470.8 MB 2.6 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-fast-with-conflicts
geoshape Shapes from PlanetOSM 60,523,283 13.4 GB 45.4 GB append-no-conflicts append-no-conflicts
http_logs HTTP server log data 247,249,096 1.2 GB 31.1 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-sorted-no-conflicts,append-index-only-with-ingest-pipeline,update
geonames POIs from Geonames 11,396,505 252.4 MB 3.3 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-sorted-no-conflicts,append-fast-with-conflicts
noaa Global daily weather measurements from NOAA 33,659,481 947.3 MB 9.0 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only
percolator Percolator benchmark based on AOL queries 2,000,000 102.7 kB 104.9 MB append-no-conflicts append-no-conflicts
nyc_taxis Taxi rides in New York in 2015 165,346,692 4.5 GB 74.3 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-sorted-no-conflicts-index-only,update,append-ml
geopointshape Point coordinates from PlanetOSM indexed as geoshapes 60,844,404 470.5 MB 2.6 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-fast-with-conflicts
metricbeat Metricbeat data 1,079,600 87.6 MB 1.2 GB append-no-conflicts append-no-conflicts
pmc Full text benchmark with academic papers from PMC 574,199 5.5 GB 21.7 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-sorted-no-conflicts,append-fast-with-conflicts
http_logs HTTP server log data 247,249,096 1.2 GB 31.1 GB append-no-conflicts append-no-conflicts,runtime-fields,append-no-conflicts-index-only,append-sorted-no-conflicts,append-index-only-with-ingest-pipeline,update,append-no-conflicts-index-reindex-only
metricbeat Metricbeat data 1,079,600 87.7 MB 1.2 GB append-no-conflicts append-no-conflicts
nested StackOverflow Q&A stored as nested docs 11,203,029 663.3 MB 3.4 GB nested-search-challenge nested-search-challenge,index-only
noaa Global daily weather measurements from NOAA 33,659,481 949.4 MB 9.0 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,top_metrics,aggs
nyc_taxis Taxi rides in New York in 2015 165,346,692 4.5 GB 74.3 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-sorted-no-conflicts-index-only,update,append-ml,date-histogram,indexing-querying
percolator Percolator benchmark based on AOL queries 2,000,000 121.1 kB 104.9 MB append-no-conflicts append-no-conflicts
pmc Full text benchmark with academic papers from PMC 574,199 5.5 GB 21.7 GB append-no-conflicts append-no-conflicts,append-no-conflicts-index-only,append-sorted-no-conflicts,append-fast-with-conflicts,indexing-querying
so Indexing benchmark using up to questions and answers from StackOverflow 36,062,278 8.9 GB 33.1 GB append-no-conflicts append-no-conflicts

-------------------------------
[INFO] SUCCESS (took 3 seconds)
Expand Down Expand Up @@ -122,7 +123,7 @@ To further examine the contents we can bind mount it from another image e.g.::
Specifics about the image
-------------------------

Rally runs as user ``1000`` and its files are installed with uid:gid ``1000:0`` (to support `Arbitrary User IDs <https://docs.openshift.com/container-platform/3.11/creating_images/guidelines.html>`_).
Rally runs as user ``1000`` and its files are installed with uid:gid ``1000:0`` (to support `OpenShift arbitrary user IDs <https://docs.openshift.com/container-platform/4.8/openshift_images/create-images.html#use-uid_create-images>`_).

Extending the Docker image
--------------------------
Expand Down
4 changes: 3 additions & 1 deletion docs/faq.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ This error occurs when Rally cannot build an Elasticsearch distribution from sou
To see what's the problem, try building Elasticsearch yourself. First, find out where the source code is located (run ``grep src ~/.rally/rally.ini``). Then change to the directory (``src.root.dir`` + ``elasticsearch.src.subdir`` which is usually ``~/.rally/benchmarks/src/elasticsearch``) and run the following commands::

./gradlew clean
./gradlew :distribution:tar:assemble
./gradlew :distribution:archives:$OSNAME-tar:assemble

Where ``$OSNAME`` can be either ``darwin`` (for macOS) or ``linux``.

By that you are mimicking what Rally does. Fix any errors that show up here and then retry.

Expand Down
8 changes: 4 additions & 4 deletions docs/install.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,10 @@ Installing Rally
2. Ensure pip is the latest version: ``python3 -m pip install --user --upgrade pip``
3. Install Rally: ``python3 -m pip install --user esrally``.

VirtualEnv Install
------------------
Virtual environment Install
---------------------------

You can also use Virtualenv to install Rally into an isolated Python environment without sudo.
You can also use virtualenv to install Rally into an isolated Python environment without sudo.

1. Set up a new virtualenv environment in a directory with ``python3 -m venv .venv``
2. Activate the environment with ``source /path/to/virtualenv/.venv/bin/activate``
Expand All @@ -138,7 +138,7 @@ Whenever you want to use Rally, run the activation script (step 2 above) first.
Docker
------

Docker images of Rally can be found in `DockerHub <https://hub.docker.com/r/elastic/rally>`_.
Docker images of Rally can be found in `Docker Hub <https://hub.docker.com/r/elastic/rally>`_.

Please refer to :doc:`Running Rally with Docker <docker/>` for detailed instructions.

Expand Down
Loading

0 comments on commit 4355771

Please sign in to comment.