Skip to content

Commit

Permalink
Explain that users need to choose their authentication mode
Browse files Browse the repository at this point in the history
  • Loading branch information
pquentin committed Sep 13, 2023
1 parent 20abc5a commit 4f73902
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/command_line_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -711,13 +711,16 @@ Rally recognizes the following client options in addition:
* ``static_responses``: The path to a JSON file containing path patterns and the corresponding responses. When this value is set to ``true``, Rally will not send requests to Elasticsearch but return static responses as specified by the file. This is useful to diagnose performance issues in Rally itself. See below for a specific example.
* ``create_api_key_per_client`` (default: ``false``): If set to ``true``, Rally will create a unique `Elasticsearch API key <https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html>`_ for each simulated client that issues requests against Elasticsearch during the benchmark. This is useful for simulating workloads where data is indexed by many distinct agents, each configured with its own API key, as is typical with Elastic Agent. Note that ``basic_auth_user`` and ``basic_auth_password`` must also be provided, and the ``basic_auth_user`` must have `sufficient privileges <https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html#security-api-create-api-key-prereqs>`_ to create API keys. These basic auth credentials are used to create the API keys at the start of the benchmark and delete them at the end, but only the generated API keys will be used during benchmark execution.

**Examples**
**Authentication**

You can choose between two authentication modes:

* API key authentication (preferred): ``--client-options="api_key:'a0V...2dw=='"``
* Basic authentication: ``--client-options="basic_auth_user:'user',basic_auth_password:'password'"``. Avoid the characters ``'``, ``,`` and ``:`` in user name and password as Rally's parsing of these options is currently really simple and there is no possibility to escape characters.

Here are a few common examples:
**HTTP compression**

* Enable HTTP compression: ``--client-options="http_compress:true"``
* Enable basic authentication: ``--client-options="basic_auth_user:'user',basic_auth_password:'password'"``. Avoid the characters ``'``, ``,`` and ``:`` in user name and password as Rally's parsing of these options is currently really simple and there is no possibility to escape characters.
* Enable API key authentication: ``--client-options="api_key:'a0V...2dw=='"``
Enable HTTP compression using ``--client-options="http_compress:true"``.

**TLS/SSL**

Expand Down

0 comments on commit 4f73902

Please sign in to comment.