diff --git a/README.md b/README.md index 7edaeea..1aded48 100644 --- a/README.md +++ b/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 this documentation page 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`|
BASE64 encoded authorized key string in JSON format. This setting is preferred over auth-key-json
.
The action will perform all operations on behalf of a service account for which this authorized key was generated.
Given a json file, encode it via command line base64 <authorized_key.json >authorized_key.pem
and add the content of result file to GitHub secrets.
Use 'auth-key-json-base64'.
An authorized key string in JSON format.
The use of this parameter is discouraged because it can lead to unwanted logs obfuscation (see naming your secrets).
|``|no| |`action-log-level`|Action log level.|`NOTICE`|no| -|`data-bucket`|Bucket used as a proxy storage to send arbitrary test data needed for test execution to agent.
WARNING:
CI service account (authorized via auth-key-json(-base64)) must be able to upload data to this bucket
WARNING2:
agent service account must be able to download data from this bucket.
Yandex Cloud Object Storage Bucket used as a proxy storage to send arbitrary test data needed for test execution to agent.
WARNING:
CI service account (authorized via auth-key-json(-base64)) must be able to upload data to this bucket
WARNING2:
agent service account must be able to download data from this bucket.
Bucket to store artifacts generated by agent during test execution.
WARNING:
agent service account must be able to upload data to this bucket.
A filter expression to select agents to execute tests.
Example:
- 'name contains github' - agents with 'github' substring in name.
- 'labels.workflow=$WORKFLOW_ID' - agents with label 'workflow' equals to $WORKFLOW_ID