fix readme proposal

README.md

@@ -1,9 +1,11 @@
-# GitHub Actions for Yandex Cloud Load Testig service
+# GitHub Actions for Yandex Cloud Load Testing service
+
+**NOTE**: All actions require `auth-key-json` to authorize requests to Yandex Cloud services. Please check <a href="https://yandex.cloud/en/docs/iam/operations/authorized-key/create#cli_1" target="_blank">this documentation page</a> for instructions how to create one.
 
 ## Short reference
 
 * **test-suite** - execute multiple load tests sequentially
-* **agents-create** - create and start load testing agents using Yandex Cloud Compute VMs for hosting (Compute is billed separately)
+* **agents-create** - create and start load testing agents using Yandex Cloud Compute VMs as a hosting (Compute is billed separately)
 * **agents-delete** - delete load testing agents
 * **test-single-run** - execute a single load test
 * **test-single-check** - check results of a single load test
@@ -32,7 +34,7 @@ A list of directories containing `test-config.yaml` test configuration files sho
 |`auth-key-json-base64`|<p>BASE64 encoded authorized key string in JSON format. This setting is preferred over <code>auth-key-json</code>.</p><p>The action will perform all operations on behalf of a service account for which this authorized key was generated.</p><p>Given a json file, encode it via command line <code>base64 &lt;authorized_key.json &gt;authorized_key.pem</code> and add the content of result file to GitHub secrets.</p>|n/a|no|
 |`auth-key-json`|<p>Use 'auth-key-json-base64'.</p><p>An authorized key string in JSON format.</p><p>The use of this parameter is discouraged because it can lead to unwanted logs obfuscation (see <a href="https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#naming-your-secrets">naming your secrets</a>).</p>|``|no|
 |`action-log-level`|Action log level.|`NOTICE`|no|
-|`data-bucket`|<p>Bucket used as a proxy storage to send arbitrary test data needed for test execution to agent.</p><p><strong>WARNING</strong>:<br />CI service account (authorized via auth-key-json(-base64)) must be able to upload data to this bucket</p><p><strong>WARNING2</strong>:<br />agent service account must be able to download data from this bucket.</p>|``|no|
+|`data-bucket`|<p><a href="https://yandex.cloud/en/services/storage" target="_blank">Yandex Cloud Object Storage</a> Bucket used as a proxy storage to send arbitrary test data needed for test execution to agent.</p><p><strong>WARNING</strong>:<br />CI service account (authorized via auth-key-json(-base64)) must be able to upload data to this bucket</p><p><strong>WARNING2</strong>:<br />agent service account must be able to download data from this bucket.</p>|``|no|
 |`artifacts-bucket`|<p>Bucket to store artifacts generated by agent during test execution.</p><p><strong>WARNING</strong>:<br />agent service account must be able to upload data to this bucket.</p>|``|no|
 |`test-directories`|A whitespace-separated list of directory paths containing test configuration files.|n/a|yes|
 |`agent-filter`|<p>A filter expression to select agents to execute tests.</p><p>Example:<br />  - 'name contains github' - agents with 'github' substring in name.<br />  - 'labels.workflow=$WORKFLOW_ID' - agents with label 'workflow' equals to $WORKFLOW_ID</p>|`labels.workflow=${{ github.run_id }}`|no|
@@ -73,6 +75,8 @@ Create agents alongside with Cloud Compute VMs to host them.
 
 This action is usually used used in pair with 'agents-delete' action.
 
+**NOTE**: For security reasons you should create new service account with 'loadtesting.generatorClient' role to assign to loadtesting agent (see `service-account-id` input below) 
+
 <!--doc-begin-agents-create-->
 ### Inputs
 |Input|Description|Default|Required|
@@ -190,7 +194,7 @@ This action is usually used used in pair with 'agents-create' action.
 
 ### Example
 
-This action is usually used in pair with `create-agent`:
+This action is usually used in pair with `agents-create` action:
 
 ```yaml
 loadtesting: