Skip to content

Commit

Permalink
Fetch the latest changes from next
Browse files Browse the repository at this point in the history
  • Loading branch information
@codebien
codebien committed Feb 13, 2025
1 parent 7d68526 commit ecfb713
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 20 deletions.
6 changes: 3 additions & 3 deletions docs/sources/k6/v0.57.x/get-started/running-k6.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,12 +210,12 @@ k6 supports three execution modes to run a k6 test: local, distributed, and clou

- **Distributed**: the test execution is [distributed across a Kubernetes cluster](https://k6.io/blog/running-distributed-tests-on-k8s/).

Save the following YAML as `k6-resource.yaml`:
Save the following YAML as `k6-testrun-resource.yaml`:

```yaml
---
apiVersion: k6.io/v1alpha1
kind: K6
kind: TestRun
metadata:
name: k6-sample
spec:
Expand All @@ -229,7 +229,7 @@ k6 supports three execution modes to run a k6 test: local, distributed, and clou
Apply the resource with the following command:
```bash
kubectl apply -f /path/to/k6-resource.yaml
kubectl apply -f /path/to/k6-testrun-resource.yaml
```

- **Cloud**: the test runs on [Grafana Cloud k6](https://grafana.com/docs/grafana-cloud/testing/k6/get-started/run-cloud-tests-from-the-cli/).
Expand Down
14 changes: 7 additions & 7 deletions docs/sources/k6/v0.57.x/javascript-api/k6-experimental/csv/Options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ The `Options` object describes the configuration available for the operation of

## Properties

| Property | Type | Description |
| :------------ | :---------------- | :-------------------------------------------------------------------------------------------------------- |
| delimiter | string | The character used to separate fields in the CSV file. Default is `','`. |
| asObjects | boolean | Whether to parse the CSV file's lines as JavaScript objects. If it is `false`, then they are parsed as arrays. Default is `false`. |
| skipFirstLine | boolean | Whether to skip the first line of the CSV file. Default is `false`. |
| fromLine | (optional) number | The line number from which to start reading the CSV file. Default is `0`. |
| toLine | (optional) number | The line number at which to stop reading the CSV file. If the option is not set, then read until the end. |
| Property | Type | Description |
| :------------ | :---------------- | :--------------------------------------------------------------------------------------------------------------------------------- |
| delimiter | string | The character used to separate fields in the CSV file. Default is `','`. |
| asObjects | boolean | Whether to parse the CSV file's lines as JavaScript objects. If it is `false`, then they are parsed as arrays. Default is `false`. |
| skipFirstLine | boolean | Whether to skip the first line of the CSV file. Default is `false`. |
| fromLine | (optional) number | The line number from which to start reading the CSV file. Default is `0`. |
| toLine | (optional) number | The line number at which to stop reading the CSV file. If the option is not set, then read until the end. |

### asObjects

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/k6/v0.57.x/misc/archive.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ k6 cloud upload archive.tar

### Distributed Execution

[k6-operator](https://github.com/grafana/k6-operator#multi-file-tests) can distribute a k6 test across a Kubernetes cluster.
[k6-operator](https://grafana.com/docs/k6/<K6_VERSION>/set-up/set-up-distributed-k6/usage/executing-k6-scripts-with-testrun-crd/#multi-file-tests) can distribute a k6 test across a Kubernetes cluster.

When a k6 test has multiple files, you can use the archive functionality to bundle the k6 test in a single _archived_ file and pass this file to run the test.

Expand Down
6 changes: 0 additions & 6 deletions docs/sources/k6/v0.57.x/set-up/set-up-distributed-k6/install-k6-operator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,6 @@ The k6 Operator includes custom resources called `TestRun`, `PrivateLoadZone`, a
make install
```

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

The `K6` CRD has been replaced by the `TestRun` CRD and will be deprecated in the future. We recommend using the `TestRun` CRD.

{{< /admonition >}}

## Watch namespace

By default, the k6 Operator watches the `TestRun` and `PrivateLoadZone` custom resources in all namespaces. You can also configure the k6 Operator to watch a specific namespace by setting the `WATCH_NAMESPACE` environment variable for the operator's deployment:
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/k6/v0.57.x/shared/javascript-api/k6-experimental.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: javascript-api/k6-experimental

| Modules | Description |
| ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
| [csv](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/csv) | Provides support for efficient and convenient parsing of CSV files. |
| [csv](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/csv) | Provides support for efficient and convenient parsing of CSV files. |
| [fs](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/fs) | Provides a memory-efficient way to handle file interactions within your test scripts. |
| [redis](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/redis) | Functionality to interact with [Redis](https://redis.io/). |
| [streams](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/streams) | Provides an implementation of the Streams API specification, offering support for defining and consuming readable streams. |
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/k6/v0.57.x/testing-guides/api-load-testing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ To reach a request-rate target (`RequestsRate`), follow this approach:

1. Set the rate frequency to the time unit of the target. Per second or per minute.
1. Get the number of requests per iteration (`RequestsPerIteration`).
1. Set the iteration rate to the requests per second target divided by the number of requests per iteration.
1. Set the iteration rate to the requests per second target divided by the number of requests per iteration.
`rate` = `RequestsRate ÷ RequestsPerIteration`.

To reach target of 50 reqs/s with the previous example:
Expand Down Expand Up @@ -296,7 +296,7 @@ A load test can run thousands or millions of script iterations, each with dozens
Every test should have a goal.
Engineering organizations set their reliability goals using [Service Level Objectives](https://en.wikipedia.org/wiki/Service-level_objective) (SLOs) to validate availability, performance, or any performance requirements.
SLOs maybe defined at distinct scopes, such as on the level of an infrastructure component, of an API, or of the entire application.
SLOs may be defined at distinct scopes, such as on the level of an infrastructure component, of an API, or of the entire application.
Some example SLOs could be:
- That 99% of APIs returning product information respond in less than 600ms.
Expand Down

0 comments on commit ecfb713

Please sign in to comment.