Skip to content

Commit

Permalink
Clarify usage of create-track with TLS
Browse files Browse the repository at this point in the history
  • Loading branch information
danielmitterdorfer committed Apr 27, 2020
1 parent 1745eb4 commit 99b2317
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/adding_tracks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ Creating a track from data in an existing cluster

If you already have a cluster with data in it you can use the ``create-track`` subcommand of Rally to create a basic Rally track. To create a Rally track with data from the indices ``products`` and ``companies`` that are hosted by a locally running Elasticsearch cluster, issue the following command::

esrally create-track --track=acme --target-hosts=127.0.0.1:9200 --indices="products,companies" --output-path=~/tracks
esrally create-track --track=acme --target-hosts=127.0.0.1: --indices="products,companies" --output-path=~/tracks

.. note::
If the cluster requires authentication specify credentials via ``--client-options`` as described in the :ref:`command line reference <clr_client_options>`.
If TLS and basic authentication is enabled, also specify :ref:`--client-options <clr_client_options>` and change ``basic_auth_user`` and ``basic_auth_password`` accordingly::

esrally create-track --track=acme --target-hosts=127.0.0.1:9200 --client-options="timeout:60,use_ssl:true,verify_certs:false,basic_auth_user:'rally',basic_auth_password:'rally-password'" --indices="products,companies" --output-path=~/tracks

The track generator will create a folder with the track's name in the specified output directory::

Expand Down
3 changes: 3 additions & 0 deletions docs/command_line_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -814,6 +814,9 @@ Use index patterns::
esrally create-track --track=my-logs --indices="logs-*" --target-hosts=127.0.0.1:9200 --output-path=~/tracks


.. note::
If the cluster requires authentication specify credentials via ``--client-options`` as described in the :ref:`command line reference <clr_client_options>`.

.. _command_line_reference_advanced_topics:

Advanced topics
Expand Down

0 comments on commit 99b2317

Please sign in to comment.