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.

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

Document the k6 cloud upload command #1734

Merged
merged 3 commits into from
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
16 changes: 16 additions & 0 deletions docs/sources/next/misc/archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,22 @@ from the k6 command-line via the `k6 cloud run script.js` command (similar to `k
trigger an implicit creation of a k6 archive that is uploaded and distributed to k6 cloud
load generators for execution.

#### Uploading an archive to k6 Cloud

Under certain scenarios, such as scheduled executions, users might want to upload an archive to k6 Cloud without triggering
a test execution in the process.

To cater to this use case, the `k6 cloud upload` command was introduced. This command allows users to upload an archive to k6 Cloud
without triggering a test execution. The command syntax is as follows:

{{< code >}}

```bash
k6 cloud upload archive.tar
```

{{< /code >}}

### Distributed Execution

[k6-operator](https://github.com/grafana/k6-operator#multi-file-tests) can distribute a k6 test across a Kubernetes cluster.
Expand Down
8 changes: 7 additions & 1 deletion docs/sources/next/using-k6/k6-options/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1476,7 +1476,13 @@ The possible keys with their meanings and default values:
| proto | the protocol to use when connecting with the traces backend | `grpc` |
| header.`headerName` | adds an additional HTTP header with the provided header name and value to each HTTP request made to the traces backend | N/A |

## Upload Only
## Upload Only (deprecated)

{{< admonition type="caution" >}}

The "Upload Only" option is deprecated and will be removed in a future release. Please use the `k6 cloud upload` command instead.
oleiade marked this conversation as resolved.
Show resolved Hide resolved

{{< /admonition >}}

A boolean specifying whether the test should just be uploaded to the cloud, but not run it. Available in `k6 cloud` command.

Expand Down
Loading