From ce8bb187d2e0da70eee237bd8dfb5f763ee2e91e Mon Sep 17 00:00:00 2001 From: Nikolay Samokhin Date: Wed, 11 Sep 2024 20:23:28 +0300 Subject: [PATCH] fix readme proposal (#2) * fix readme proposal * GitHub Action Auto-Docs --------- Co-authored-by: Nikolai Samokhin Co-authored-by: github-actions[bot] --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 936eac4..896539d 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 @@ -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) + ### 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: