Skip to content

Commit

Permalink
add documentation for authentication
Browse files Browse the repository at this point in the history
Signed-off-by: Pablo Chacin <[email protected]>
  • Loading branch information
pablochacin committed Feb 10, 2025
1 parent e7238d6 commit 8fa7be2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,17 @@ Since k6exec tries to emulate the `k6` command line, the `help` command or the `

### Prerequisites

k6exec tries to provide the appropriate k6 executable after detecting the extension dependencies using a build service.
k6exec tries to provide the appropriate k6 executable after detecting the extension dependencies. This can be done using a build service or a native builder.

#### Build Service

No additional installation is required to use the build service, just provide the build service URL.

The build service URL can be specified in the `K6_BUILD_SERVICE_URL` environment variable or by using the `--build-service-url` flag.

There is no default URL for the build service, otherwise k6exec will automatically provide k6 with the native builder.
If the build service requires authentication, you can specify the authentication token using the `K6_BUILD_SERVICE_AUTH` environment variable.

If the `k6_BUILD_SERVICE_URL` is not specified, `k6exec` tries to use the build service provided by Grafana Cloud K6 using the credential obtained from the [k6 cloud login](https://grafana.com/docs/grafana-cloud/testing/k6/author-run/tokens-and-cli-authentication/) command. You can also provide this credentials using the `K6_CLOUD_TOKEN` environment variable.

### Dependencies

Expand Down
4 changes: 3 additions & 1 deletion cmd/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ No additional installation is required to use the build service, just provide th

The build service URL can be specified in the `K6_BUILD_SERVICE_URL` environment variable or by using the `--build-service-url` flag.

There is no default URL for the build service, otherwise k6exec will automatically provide k6 with the native builder.
If the build service requires authentication, you can specify the authentication token using the `K6_BUILD_SERVICE_AUTH` environment variable.

If the `k6_BUILD_SERVICE_URL` is not specified, `k6exec` tries to use the build service provided by Grafana Cloud K6 using the credential obtained from the [k6 cloud login](https://grafana.com/docs/grafana-cloud/testing/k6/author-run/tokens-and-cli-authentication/) command. You can also provide this credentials using the `K6_CLOUD_TOKEN` environment variable.

### Dependencies

Expand Down

0 comments on commit 8fa7be2

Please sign in to comment.