Skip to content

k6-operator: add link to CRD reference doc #2026

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
weight: 300
title: Common options
title: Configuring TestRun CRD
---

# Common options
# Configuring `TestRun` CRD

<!-- TODO: consider removing this page once full reference is generated -->
<!-- TODO: consider removing this page once machine-generated reference becomes part of the docs -->

The only options that are required as part of the `TestRun` CRD spec are `script` and `parallelism`. This guide covers some of the most common options.
The only options that are required as part of the `TestRun` CRD spec are `script` and `parallelism`. But there are many other options that can be set in `TestRun` CRD. Refer to the [crd-generated.md](https://github.com/grafana/k6-operator/blob/main/docs/crd-generated.md) for a complete list of all available fields.

Let's look at some of the most common options in greater detail.

## Parallelism

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
weight: 300
title: Common options
title: Configuring TestRun CRD
---

# Common options
# Configuring `TestRun` CRD

<!-- TODO: consider removing this page once full reference is generated -->
<!-- TODO: consider removing this page once machine-generated reference becomes part of the docs -->

The only options that are required as part of the `TestRun` CRD spec are `script` and `parallelism`. This guide covers some of the most common options.
The only options that are required as part of the `TestRun` CRD spec are `script` and `parallelism`. But there are many other options that can be set in `TestRun` CRD. Refer to the [crd-generated.md](https://github.com/grafana/k6-operator/blob/main/docs/crd-generated.md) for a complete list of all available fields.

Let's look at some of the most common options in greater detail.

## Parallelism

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
weight: 300
title: Common options
title: Configuring TestRun CRD
---

# Common options
# Configuring `TestRun` CRD

<!-- TODO: consider removing this page once full reference is generated -->
<!-- TODO: consider removing this page once machine-generated reference becomes part of the docs -->

The only options that are required as part of the `TestRun` CRD spec are `script` and `parallelism`. This guide covers some of the most common options.
The only options that are required as part of the `TestRun` CRD spec are `script` and `parallelism`. But there are many other options that can be set in `TestRun` CRD. Refer to the [crd-generated.md](https://github.com/grafana/k6-operator/blob/main/docs/crd-generated.md) for a complete list of all available fields.

Let's look at some of the most common options in greater detail.

## Parallelism

Expand Down