Skip to content

Commit 9b78991

Browse files
authored
Replace the 'k6 cloud' references with the new subcommands (#1689)
1 parent 5746fe9 commit 9b78991

File tree

6 files changed

+43
-43
lines changed

6 files changed

+43
-43
lines changed

docs/sources/next/get-started/running-k6.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Follow along to learn how to:
1414
4. Ramp the number of requests up and down as the test runs.
1515

1616
With these example snippets, you'll run the test with your machine's resources.
17-
But, if you have a k6 Cloud account, you can also use the `k6 cloud` command to outsource the test to k6 servers.
17+
But, if you have a k6 Cloud account, you can also use the `k6 cloud run` command to outsource the test to k6 servers.
1818

1919
## Before you begin
2020

@@ -235,7 +235,7 @@ k6 supports three execution modes to run a k6 test: local, distributed, and clou
235235
- **Cloud**: the test runs on [Grafana Cloud k6](https://grafana.com/docs/grafana-cloud/testing/k6/get-started/run-cloud-tests-from-the-cli/).
236236

237237
```bash
238-
k6 cloud script.js
238+
k6 cloud run script.js
239239
```
240240

241241
Additionally, cloud-based solutions can run cloud tests on your [own cloud infrastructure](https://grafana.com/docs/grafana-cloud/testing/k6/author-run/private-load-zone-v2/), and accept the test results from a [local](https://grafana.com/docs/k6/<K6_VERSION>/results-output/real-time/cloud) or [distributed test](https://github.com/grafana/k6-operator#k6-cloud-output).

docs/sources/next/misc/archive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ as needed.
7979

8080
k6 offers a commercial service for running large scale and geographically
8181
distributed load tests on managed cloud infrastructure. Cloud executed tests are triggered
82-
from the k6 command-line via the `k6 cloud script.js` command (similar to `k6 run`) which will
82+
from the k6 command-line via the `k6 cloud run script.js` command (similar to `k6 run`) which will
8383
trigger an implicit creation of a k6 archive that is uploaded and distributed to k6 cloud
8484
load generators for execution.
8585

docs/sources/next/results-output/real-time/cloud.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ When streaming the results to the cloud, the machine - where you execute the k6
1212

1313
## Streaming results vs. running on cloud servers
1414

15-
Don't confuse `k6 run --out cloud script.js` (what this page is about) with `k6 cloud script.js`.
15+
Don't confuse `k6 run --out cloud script.js` (what this page is about) with `k6 cloud run script.js`.
1616

1717
Fundamentally the difference is the machine that the test runs on:
1818

1919
- `k6 run --out cloud` runs k6 locally and streams the results to the cloud.
20-
- `k6 cloud`, on the other hand, uploads your script to the cloud solution and runs the test on the cloud infrastructure. In this case you'll only see status updates in your CLI.
20+
- `k6 cloud run`, on the other hand, uploads your script to the cloud solution and runs the test on the cloud infrastructure. In this case you'll only see status updates in your CLI.
2121

2222
In all cases you'll be able to see your test results at [k6 Cloud](https://app.k6.io) or [Grafana Cloud](https://grafana.com/products/cloud/).
2323

@@ -34,14 +34,14 @@ so `k6 run --out cloud` will consume VUH or test runs from your subscription.
3434

3535
Assuming you have installed k6, the first step is to log in to the cloud service.
3636

37-
With the `k6 login cloud` command, you can set up your API token on the k6 machine to authenticate against the cloud service.
37+
With the `k6 cloud login` command, you can set up your API token on the k6 machine to authenticate against the cloud service.
3838

3939
Copy your token from [k6 Cloud](https://app.k6.io/account/api-token) or [Grafana Cloud k6](https://grafana.com/docs/grafana-cloud/testing/k6/author-run/tokens-and-cli-authentication/) and pass it as:
4040

4141
{{< code >}}
4242

4343
```bash
44-
$ k6 login cloud --token <YOUR_API_TOKEN>
44+
$ k6 cloud login --token <YOUR_API_TOKEN>
4545
```
4646

4747
{{< /code >}}
@@ -58,7 +58,7 @@ so `k6 run --out cloud` will consume VUH or test runs from your subscription.
5858

5959
{{< /code >}}
6060

61-
Alternatively, you could skip the `k6 login cloud` command when passing your API token to the `k6 run` command as:
61+
Alternatively, you could skip the `k6 cloud login` command when passing your API token to the `k6 run` command as:
6262

6363
{{< code >}}
6464

@@ -131,7 +131,7 @@ Outlier data&mdash;far outside the lower and upper quartiles&mdash; is not aggre
131131
| `K6_CLOUD_AGGREGATION_OUTLIER_IQR_COEF_LOWER` | How many quartiles below the lower quartile are treated as non-aggregatable outliers (default `1.5`) |
132132
| `K6_CLOUD_AGGREGATION_OUTLIER_IQR_COEF_UPPER` | How many quartiles above the upper quartile are treated as non-aggregatable outliers (default `1.3`) |
133133

134-
> When running a test entirely in the cloud with `k6 cloud`, `k6` will always
134+
> When running a test entirely in the cloud with `k6 cloud run`, `k6` will always
135135
> aggregate. For that case the aggregation settings are however set by the
136136
> cloud infrastructure and are not controllable from the CLI.
137137

docs/sources/next/set-up/set-up-distributed-k6/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,10 @@ Unlike `TestRun` deployment, when a `PrivateLoadZone` is first created, there ar
119119

120120
### Running tests in `PrivateLoadZone`
121121

122-
Each time a user runs a test in a PLZ, for example with `k6 cloud script.js`, there is a corresponding `TestRun` being deployed by the k6 Operator. This `TestRun` will be deployed in the same namespace as its `PrivateLoadZone`. If the test is misbehaving, for example, it errors out, or doesn't produce the expected result, then you can check:
122+
Each time a user runs a test in a PLZ, for example with `k6 cloud run script.js`, there is a corresponding `TestRun` being deployed by the k6 Operator. This `TestRun` will be deployed in the same namespace as its `PrivateLoadZone`. If the test is misbehaving, for example, it errors out, or doesn't produce the expected result, then you can check:
123123

124124
1. If there are any messages in the GCk6 UI.
125-
2. If there are any messages in the output of the `k6 cloud` command.
125+
2. If there are any messages in the output of the `k6 cloud run` command.
126126
3. The resources and their logs, the same way as with a [standalone `TestRun` deployment](#testrun-deployment)
127127

128128
## Common scenarios

docs/sources/next/using-k6/environment-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ PS C:\k6> $env:MY_HOSTNAME="test.k6.io"; k6 run script.js
6565

6666
#### ⚠️ Warning
6767

68-
By default, passing system environment variables doesn't work for `k6 archive`, `k6 cloud`, and `k6 inspect`.
68+
By default, passing system environment variables doesn't work for `k6 archive`, `k6 cloud run`, and `k6 inspect`.
6969
This is a security measure to avoid the risk of uploading sensitive data to k6 Cloud.
7070
To override this mode, specify [--include-system-env-vars](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/k6-options/reference#include-system-env-vars).
7171

0 commit comments

Comments
 (0)