Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix readme proposal #2

Merged
merged 2 commits into from
Sep 11, 2024
Merged

fix readme proposal #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83aa531
fix readme proposal
Sep 11, 2024
a8873d9
GitHub Action Auto-Docs
github-actions[bot] Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
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