Skip to content

Commit

Permalink
Address Running k6 review
Browse files Browse the repository at this point in the history
  • Loading branch information
ppcano committed May 25, 2020
1 parent 926e21b commit 63afdcc
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
Expand Up @@ -183,15 +183,15 @@ export default function() {
## Running cloud tests
One of the goals with k6 is to support three execution modes to run your k6 tests:
k6 supports three execution modes to run your k6 tests:
- [Local](#running-local-tests): on your local machine or a CI server.
- [Cloud](/cloud): on cloud infrastructure managed by `k6 Cloud`.
- Clustered: on more than one machine managed by you. Not supported yet.
- [Cloud](/cloud): on cloud infrastructure managed by k6 Cloud.
- Clustered: on more than one machine managed by you. [Not supported yet](https://github.com/loadimpact/k6/issues/140).
The goal of k6 is to support running a test on the three execution modes without making modifications to the script.
One of the goals with k6 is to support running a test in the three execution modes without making modifications to the script.
For running cloud tests, you must sign up with the k6 Cloud and log in with the CLI. Then, you'd only have to pass your existing script to the `k6 cloud` command.
For running cloud tests from the CLI, you must first register a k6 Cloud account and then log into your account via the CLI. Then, you only have to pass your existing script to the `k6 cloud` command.
<div class="code-group" data-props='{"labels": ["Running a cloud test"]}'>
Expand Down
Expand Up @@ -93,13 +93,13 @@ Reasons for triggering cloud tests from the k6 CLI include:

7. Navigate to the URL to check your test results. When the test is running, the test result page is shown.

![Insights results](/images/cloud-insights-results.png 'k6 Cloud Test Results')
![k6 Cloud Test Results](/images/cloud-insights-results.png 'k6 Cloud Test Results')

Learn more about the different test result sections on the [k6 Cloud Results docs](/cloud/analyzing-results/overview).

## Cloud execution options

All the [k6 Options](/using-k6/options), like `--vus` and `--duration` are the same between the `k6 run` and `k6 cloud` commands. k6 aims to run the same script on different execution modes without making any script modifications.
All the [k6 Options](/using-k6/options), like `--vus` and `--duration` are the same between the `k6 run` and `k6 cloud` commands. k6 aims to run the same script in different execution modes without making any script modifications.

Optionally, you can define some cloud options in your k6 script.

Expand Down Expand Up @@ -148,6 +148,7 @@ export let options = {
| N. California | `amazon:us:palo alto` |
| Oregon | `amazon:us:portland` |
| Hong Kong | `amazon:cn:hong kong` |
| São Paulo | `amazon:br:sao paulo` |


### Running tests under a different project than your default one
Expand All @@ -156,7 +157,7 @@ By default tests and test runs will be created and run under your default projec

To create and run tests under a different project, whether under your default organization or one you've been invited to, you have to pass the `Project ID` to k6.

Select the project on the sidebar menu and you will find the `Project ID` on the header of the Project Dashboard page.
Select the project on the sidebar menu and you will find the `Project ID` in the header of the Project Dashboard page.

![k6 Cloud Project ID](/images/dashboard-project-id.png 'Project ID')

Expand Down Expand Up @@ -261,5 +262,5 @@ Your [setup and teardown life cycle functions](/using-k6/test-life-cycle)
are executed as normal when running cloud tests. Depending on the size
of your test, it will execute from one or more cloud servers, but the
setup and teardown will only execute from one server, so execute once
each test-wide. There's no guarantee though that the same cloud server
for each test run. There's no guarantee though that the same cloud server
that executed the `setup()` will execute the `teardown()`.

0 comments on commit 63afdcc

Please sign in to comment.