Skip to content

Commit

Permalink
fix readme proposal (#2)
Browse files Browse the repository at this point in the history
* fix readme proposal

* GitHub Action Auto-Docs

---------

Co-authored-by: Nikolai Samokhin <nsamokhin@yandex-team.ru>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored and vitaly4n committed Sep 11, 2024
1 parent cdae7ea commit ce8bb18
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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|
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit ce8bb18

Please sign in to comment.