Skip to content

Commit

Permalink
Merge pull request #1734 from grafana/document_k6_upload
Browse files Browse the repository at this point in the history
Document the `k6 cloud upload` command
  • Loading branch information
oleiade committed Sep 24, 2024
2 parents 0ea4b11 + 7721801 commit e920b82
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
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. Use the `k6 cloud upload` command instead.

{{< /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

0 comments on commit e920b82

Please sign in to comment.