diff --git a/docs/sources/next/_index.md b/docs/sources/next/_index.md index 8bb4411a39..e7503eb19d 100644 --- a/docs/sources/next/_index.md +++ b/docs/sources/next/_index.md @@ -68,7 +68,7 @@ Common k6 use cases are: - **Chaos and resilience testing** - You can use k6 to simulate traffic as part of your chaos experiments, trigger them from your k6 tests or inject different types of faults in Kubernetes with [xk6-disruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor). + You can use k6 to simulate traffic as part of your chaos experiments, trigger them from your k6 tests or inject different types of faults in Kubernetes with [xk6-disruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor). - **Performance and synthetic monitoring** diff --git a/docs/sources/next/javascript-api/xk6-disruptor/faults/_index.md b/docs/sources/next/javascript-api/xk6-disruptor/faults/_index.md deleted file mode 100644 index 677e689cf3..0000000000 --- a/docs/sources/next/javascript-api/xk6-disruptor/faults/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: 'Faults' -description: 'xk6-disruptor: Fault Description' -weight: 100 ---- - -# Faults - -A fault is as an abnormal condition that affects a system component and which may lead to a failure. - -| Fault type | Description | -| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| [gRPC Fault](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/grpc) | Fault affecting gRPC requests from a target | -| [HTTP Fault](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/http) | Fault affecting HTTP requests from a target | -| [Pod Termination Fault](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/pod-termination) | Fault terminating a number of target Pods | diff --git a/docs/sources/next/javascript-api/xk6-disruptor/get-started/_index.md b/docs/sources/next/javascript-api/xk6-disruptor/get-started/_index.md deleted file mode 100644 index 405b1eaad0..0000000000 --- a/docs/sources/next/javascript-api/xk6-disruptor/get-started/_index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: 'Get started' -description: 'xk6-disruptor is an extension that adds fault injection capabilities to k6. Start here to learn the basics and how to use the disruptor' -weight: 01 ---- - -# Get started - -Inject faults into kubernetes-based applications with `xk6-disruptor`. Start here to learn the basics to use the disruptor: - -- [About `xk6-disruptor`](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/) -- [Requirements](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/requirements) -- [Installation](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/installation) -- [Exposing your Kubernetes application](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/expose--your-application) diff --git a/docs/sources/next/misc/integrations.md b/docs/sources/next/misc/integrations.md index 557627aa2f..2ceb4b6a02 100644 --- a/docs/sources/next/misc/integrations.md +++ b/docs/sources/next/misc/integrations.md @@ -69,7 +69,7 @@ By automating load testing with your CI / CD tools, you can quickly see when a c ## Chaos engineering - [Steadybit](https://k6.io/blog/chaos-engineering-with-k6-and-steadybit) - Using k6 and Steadybit for chaos engineering. -- [xk6-disruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor) - A k6 extension for injecting faults into k6 tests. +- [xk6-disruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor) - A k6 extension for injecting faults into k6 tests. - [ChaosToolkit](http://chaostoolkit.org/drivers/k6/) - A collection of k6 actions and probes. ## Test management diff --git a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/_index.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/_index.md index a88ddb894b..b355110ed4 100644 --- a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/_index.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/_index.md @@ -1,4 +1,6 @@ --- +aliases: + - ../javascript-api/xk6-disruptor/get-started # docs/k6//javascript-api/xk6-disruptor/get-started/ title: 'Injecting faults with xk6-disruptor' description: 'xk6-disruptor is a k6 extension providing fault injection capabilities to test system reliability under turbulent conditions.' weight: 06 @@ -18,7 +20,7 @@ Key features include: Currently, the disruptor is intended to test applications running in Kubernetes. Other platforms are not supported at this time. -It provides a Javascript API to inject different [faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/) in HTTP and gRPC requests, such as errors and delays, into the selected Kubernetes [Pods](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor/) or [Services](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor/). +It provides a Javascript API to inject different [faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/) in HTTP and gRPC requests, such as errors and delays, into the selected Kubernetes [Pods](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/) or [Services](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/). Other types of faults and disruptors will be introduced in the future. The [Roadmap](https://github.com/grafana/xk6-disruptor/blob/main/ROADMAP.md) presents the project's goals for the coming months regarding new functionalities and enhancements. diff --git a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/_index.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/_index.md index 4b414d3d1d..cb67967775 100644 --- a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/_index.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/_index.md @@ -1,7 +1,7 @@ --- title: 'xk6-disruptor examples' description: 'Examples of how to use the xk6-disruptor extension to introduce faults in k6 tests.' -weight: 06 +weight: 07 --- # xk6-disruptor examples diff --git a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md index b57826f7ad..8a586a2699 100644 --- a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md @@ -6,7 +6,7 @@ weight: 01 # Inject gRPC faults into Service -This example shows a way to use the [ServiceDisruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor) to test the effect of faults injected in the gRPC requests served by a service. +This example shows a way to use the [ServiceDisruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor) to test the effect of faults injected in the gRPC requests served by a service. The complete [source code](#source-code) is at the end of this document. The next sections examine the code in detail. @@ -18,7 +18,7 @@ For the Kubernetes manifests and the instructions on how to deploy it to a clust ## Initialization -The initialization code imports the external dependencies required by the test. The [ServiceDisruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor) class imported from the `xk6-disruptor` extension provides functions for injecting faults in services. The [k6/net/grpc](https://grafana.com/docs/k6//javascript-api/k6-net-grpc) module provides functions for executing gRPC requests. The [check](https://grafana.com/docs/k6//using-k6/checks) function verifies the results from the requests. +The initialization code imports the external dependencies required by the test. The [ServiceDisruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor) class imported from the `xk6-disruptor` extension provides functions for injecting faults in services. The [k6/net/grpc](https://grafana.com/docs/k6//javascript-api/k6-net-grpc) module provides functions for executing gRPC requests. The [check](https://grafana.com/docs/k6//using-k6/checks) function verifies the results from the requests. ```javascript import { ServiceDisruptor } from 'k6/x/disruptor'; @@ -60,7 +60,7 @@ export default function () { The `disrupt` function creates a `ServiceDisruptor` for the `grpcbin` service in the namespace `grpcbin`. -The gRPC faults are injected by calling the [ServiceDisruptor.injectGrpcFaults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor/injectgrpcfaults) method using a fault definition that introduces a delay of `300ms` on each request and an error with status code `13` ("Internal error") in `10%` of the requests. +The gRPC faults are injected by calling the [ServiceDisruptor.injectGrpcFaults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injectgrpcfaults) method using a fault definition that introduces a delay of `300ms` on each request and an error with status code `13` ("Internal error") in `10%` of the requests. ```javascript export function disrupt() { diff --git a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-http-faults-into-pod.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-http-faults-into-pod.md index 6d07d2c40f..b262771bf9 100644 --- a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-http-faults-into-pod.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-http-faults-into-pod.md @@ -6,7 +6,7 @@ weight: 02 # Inject HTTP faults into Pod -This example shows how [PodDisruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor) can be used for testing the effect of faults injected in the HTTP requests served by a pod. +This example shows how [PodDisruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor) can be used for testing the effect of faults injected in the HTTP requests served by a pod. You will find the complete [source code](#source-code) at the end of this document. Next sections examine the code in detail. @@ -45,7 +45,7 @@ The test uses the `delay` endpoint which return after the requested delay. It re The `disrupt` function creates a `PodDisruptor` using a selector that matches pods in the namespace `httpbin` with the label `app: httpbin`. -The http faults are injected by calling the [PodDisruptor.injectHTTPFaults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor/injecthttpfaults) method using a fault definition that introduces a delay of `50ms` on each request and an error code `500` in `10%` of the requests. +The http faults are injected by calling the [PodDisruptor.injectHTTPFaults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injecthttpfaults) method using a fault definition that introduces a delay of `50ms` on each request and an error code `500` in `10%` of the requests. ```javascript export function disrupt(data) { diff --git a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/first-steps.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/first-steps.md index 933e41b2bc..17e062b6ef 100644 --- a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/first-steps.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/first-steps.md @@ -8,7 +8,7 @@ weight: 01 [xk6-disruptor](https://github.com/grafana/xk6-disruptor) is an extension that adds fault injection capabilities to k6. -It provides a Javascript [API](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/) to inject [faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults) such as errors and delays into HTTP and gRPC requests served by selected Kubernetes [Pods](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor) or [Services](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor). +It provides a Javascript [API](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/) to inject [faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults) such as errors and delays into HTTP and gRPC requests served by selected Kubernetes [Pods](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor) or [Services](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor). ```javascript export default function () { @@ -27,7 +27,7 @@ export default function () { ## Next steps -Explore the fault injection [API](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/) +Explore the fault injection [API](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/) See [step-by-step examples](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/examples). diff --git a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/how-it-works.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/how-it-works.md index 3a236fc129..d5414ac12d 100644 --- a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/how-it-works.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/how-it-works.md @@ -19,9 +19,9 @@ The xk6-disruptor extension installs the agent in the target and sends commands The following diagram shows how PodDisruptor works: -1. The PodDisruptor selects the target pods based on the selector attributes defined in the [constructor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor/constructor) +1. The PodDisruptor selects the target pods based on the selector attributes defined in the [constructor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/constructor) 2. The PodDisruptor attaches the xk6-disruptor-agent to each of the target pods -3. When a fault is injected (e.g. calling the [injectHTTTFault](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor/injecthttpfaults)) the PodDisruptor sends a command to the agents to inject the fault in their respective pods +3. When a fault is injected (e.g. calling the [injectHTTTFault](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injecthttpfaults)) the PodDisruptor sends a command to the agents to inject the fault in their respective pods ![How PodDisruptor works](/media/docs/k6-oss/xk6-disruptor-how-pod-disruptor-works.png) @@ -29,7 +29,7 @@ The following diagram shows how PodDisruptor works: The ServiceDisruptor works as a wrapper around a PodDisruptor, which targets the pods that back the service. -1. The ServiceDisruptor uses the definition of the service specified in the [constructor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor/constructor) to create a pod selector that matches the pods that back the service. +1. The ServiceDisruptor uses the definition of the service specified in the [constructor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/constructor) to create a pod selector that matches the pods that back the service. 2. The ServiceDisruptor creates a PodDisruptor using this pod selector. 3. The PodDisruptor installs the agent in the target pods. diff --git a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/installation.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/installation.md index 87a33c3c51..3c86e105f7 100644 --- a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/installation.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/installation.md @@ -6,7 +6,7 @@ weight: 03 # Installation -xk6-disruptor is a [k6 extension](https://grafana.com/docs/k6//extensions). You have to run a k6 version built with the disruptor extension to use the [disruptor APIs](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/) in your k6 tests. +xk6-disruptor is a [k6 extension](https://grafana.com/docs/k6//extensions). You have to run a k6 version built with the disruptor extension to use the [disruptor APIs](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/) in your k6 tests. The following sections explain the different options to get this custom binary. diff --git a/docs/sources/next/javascript-api/xk6-disruptor/_index.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/_index.md similarity index 50% rename from docs/sources/next/javascript-api/xk6-disruptor/_index.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/_index.md index 5933b2dc91..8d85cd1158 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/_index.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/_index.md @@ -1,14 +1,16 @@ --- +aliases: + - ../../javascript-api/xk6-disruptor # docs/k6//javascript-api/xk6-disruptor title: xk6-disruptor API description: 'An overview of the API for xk6-disruptor.' -weight: 14 +weight: 06 --- # xk6-disruptor API -The xk6-disruptor API is organized around _disruptors_ that affect specific targets such as pods or services. These disruptors can inject different types of [faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults) on their targets. +The xk6-disruptor API is organized around _disruptors_ that affect specific targets such as pods or services. These disruptors can inject different types of [faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults) on their targets. | Class | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [PodDisruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor) | Targets the Pods that match selection attributes such as labels. | -| [ServiceDisruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor) | Targets the Pods that back a Kubernetes Service | +| [PodDisruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor) | Targets the Pods that match selection attributes such as labels. | +| [ServiceDisruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor) | Targets the Pods that back a Kubernetes Service | diff --git a/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/_index.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/_index.md new file mode 100644 index 0000000000..3832f7bb10 --- /dev/null +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/_index.md @@ -0,0 +1,17 @@ +--- +aliases: + - ../../../javascript-api/xk6-disruptor/faults # docs/k6//javascript-api/xk6-disruptor/faults +title: 'Faults' +description: 'xk6-disruptor: Fault Description' +weight: 100 +--- + +# Faults + +A fault is as an abnormal condition that affects a system component and which may lead to a failure. + +| Fault type | Description | +| --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| [gRPC Fault](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/grpc) | Fault affecting gRPC requests from a target | +| [HTTP Fault](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/http) | Fault affecting HTTP requests from a target | +| [Pod Termination Fault](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/pod-termination) | Fault terminating a number of target Pods | diff --git a/docs/sources/next/javascript-api/xk6-disruptor/faults/grpc.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/grpc.md similarity index 94% rename from docs/sources/next/javascript-api/xk6-disruptor/faults/grpc.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/grpc.md index 4ddb962c2a..285a0edc60 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/faults/grpc.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/grpc.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/faults/grpc # docs/k6//javascript-api/xk6-disruptor/faults/grpc title: 'gRPC' description: 'xk6-disruptor: gRPC Fault attributes' weight: 01 diff --git a/docs/sources/next/javascript-api/xk6-disruptor/faults/http.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/http.md similarity index 94% rename from docs/sources/next/javascript-api/xk6-disruptor/faults/http.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/http.md index 704ceec9ed..65ca2887d1 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/faults/http.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/http.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/faults/http # docs/k6//javascript-api/xk6-disruptor/faults/http title: 'HTTP' description: 'xk6-disruptor: HTTP Fault attributes' weight: 02 diff --git a/docs/sources/next/javascript-api/xk6-disruptor/faults/pod-termination.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/pod-termination.md similarity index 90% rename from docs/sources/next/javascript-api/xk6-disruptor/faults/pod-termination.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/pod-termination.md index 30902aafff..1e13a42961 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/faults/pod-termination.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/pod-termination.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/faults/pod-termination # docs/k6//javascript-api/xk6-disruptor/faults/pod-termination title: 'Pod Termination' description: 'xk6-disruptor: Pod Termination Fault attributes' weight: 03 diff --git a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/_index.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/_index.md similarity index 67% rename from docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/_index.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/_index.md index 84289c3f54..ce3fc91d4d 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/_index.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/_index.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../javascript-api/xk6-disruptor/poddisruptor # docs/k6//javascript-api/xk6-disruptor/poddisruptor title: 'PodDisruptor' description: 'xk6-disruptor: PodDisruptor class' weight: 200 @@ -8,16 +10,16 @@ weight: 200 The `PodDisruptor` class can inject different types of faults into the pods that match a selection criteria. -To construct a `PodDisruptor`, use the [PodDisruptor() constructor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor/constructor). +To construct a `PodDisruptor`, use the [PodDisruptor() constructor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/constructor). ## Methods | Method | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| [PodDisruptor.injectGrpcFaults()](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor/injectgrpcfaults) | Inject [gRPC faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/grpc) in the target Pods | -| [PodDisruptor.injectHTTPFaults()](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor/injecthttpfaults) | Inject [HTTP faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/http) in the target Pods | +| [PodDisruptor.injectGrpcFaults()](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injectgrpcfaults) | Inject [gRPC faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/grpc) in the target Pods | +| [PodDisruptor.injectHTTPFaults()](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injecthttpfaults) | Inject [HTTP faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/http) in the target Pods | | PodDisruptor.targets() | Returns the list of target Pods of the PodDisruptor | -| [PodDisruptor.terminatePods()](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor/terminate-pods) | executes a [Pod Termination fault](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/pod-termination) in the target Pods | +| [PodDisruptor.terminatePods()](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/terminate-pods) | executes a [Pod Termination fault](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/pod-termination) in the target Pods | ## Example diff --git a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/constructor.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/constructor.md similarity index 88% rename from docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/constructor.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/constructor.md index 1add8fc9b4..543c6035e0 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/constructor.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/constructor.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/poddisruptor/constructor # docs/k6//javascript-api/xk6-disruptor/poddisruptor/constructor title: 'Constructor' description: 'xk6-disruptor: PodDisruptor constructor' weight: 100 @@ -6,7 +8,7 @@ weight: 100 # Constructor -The `PodDisruptor()` constructor creates a new instance of a [PodDisruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/poddisruptor) class. +The `PodDisruptor()` constructor creates a new instance of a [PodDisruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor) class. | Parameter | Type | Description | | ------------------ | ------ | ----------------------------------------------------------------- | diff --git a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/injectgrpcfaults.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injectgrpcfaults.md similarity index 83% rename from docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/injectgrpcfaults.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injectgrpcfaults.md index b4274fdd4c..94c583e862 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/injectgrpcfaults.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injectgrpcfaults.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/poddisruptor/injectgrpcfaults # docs/k6//javascript-api/xk6-disruptor/poddisruptor/injectgrpcfaults title: 'injectGrpcFaults()' description: 'xk6-disruptor: PodDisruptor.injectGrpcFaults method' weight: 200 @@ -10,7 +12,7 @@ injectGrpcFaults injects gRPC faults in the requests served by a target Pod. | Parameter | Type | Description | | ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------- | -| fault | object | description of the [gRPC faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/grpc) to be injected | +| fault | object | description of the [gRPC faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/grpc) to be injected | | duration | string | duration of the disruption | | options (optional) | object | [options](#options) that control the injection of the fault | diff --git a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/injecthttpfaults.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injecthttpfaults.md similarity index 86% rename from docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/injecthttpfaults.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injecthttpfaults.md index c81b4f9352..52faf21949 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/injecthttpfaults.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/injecthttpfaults.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/poddisruptor/injecthttpfaults # docs/k6//javascript-api/xk6-disruptor/poddisruptor/injecthttpfaults title: 'injectHTTPFaults()' description: 'xk6-disruptor: PodDisruptor.injectHTTPFaults method' weight: 300 @@ -10,7 +12,7 @@ injectHTTPFaults injects HTTP faults in the requests served by a target Pod. | Parameter | Type | Description | | ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------- | -| fault | object | description of the [http faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/http) to be injected | +| fault | object | description of the [http faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/http) to be injected | | duration | string | duration of the disruption | | options (optional) | object | [options](#options) that control the injection of the fault | diff --git a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/terminate-pods.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/terminate-pods.md similarity index 71% rename from docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/terminate-pods.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/terminate-pods.md index aea02db3f3..f0751d31fb 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/poddisruptor/terminate-pods.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/poddisruptor/terminate-pods.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/poddisruptor/terminate-pods # docs/k6//javascript-api/xk6-disruptor/poddisruptor/terminate-pods title: 'terminatePods()' description: 'xk6-disruptor: PodDisruptor.terminatePods method' weight: 400 @@ -10,7 +12,7 @@ weight: 400 | Parameter | Type | Description | | --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- | -| fault | object | description of the [Pod Termination fault](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/pod-termination) | +| fault | object | description of the [Pod Termination fault](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/pod-termination) | ## Example diff --git a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/_index.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/_index.md similarity index 66% rename from docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/_index.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/_index.md index 7ac76ed87b..726712ed37 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/_index.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/_index.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../javascript-api/xk6-disruptor/servicedisruptor # docs/k6//javascript-api/xk6-disruptor/servicedisruptor title: 'ServiceDisruptor' description: 'xk6-disruptor: ServiceDisruptor class' weight: 300 @@ -8,16 +10,16 @@ weight: 300 The `ServiceDisruptor` class can inject different types of faults into the pods that back a Kubernetes service. -To construct a `ServiceDisruptor`, use the [ServiceDisruptor() constructor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor/constructor). +To construct a `ServiceDisruptor`, use the [ServiceDisruptor() constructor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/constructor). ## Methods | Method | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| [ServiceDisruptor.injectGrpcFaults()](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor/injectgrpcfaults) | Inject [gRPC faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/grpc) in the target Pods | -| [ServiceDisruptor.injectHTTPFaults()](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor/injecthttpfaults) | Inject [HTTTP faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/http) in the target Pods | +| [ServiceDisruptor.injectGrpcFaults()](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injectgrpcfaults) | Inject [gRPC faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/grpc) in the target Pods | +| [ServiceDisruptor.injectHTTPFaults()](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injecthttpfaults) | Inject [HTTTP faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/http) in the target Pods | | ServiceDisruptor.targets() | Returns the list of target Pods of the ServiceDisruptor | -| [ServiceDisruptor.terminatePods()](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor/terminate-pods) | executes a [Pod Termination fault](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/pod-termination) in the target Pods | +| [ServiceDisruptor.terminatePods()](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/terminate-pods) | executes a [Pod Termination fault](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/pod-termination) in the target Pods | ## Example diff --git a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/constructor.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/constructor.md similarity index 79% rename from docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/constructor.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/constructor.md index 33cb90118c..048b5dcf74 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/constructor.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/constructor.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/servicedisruptor/constructor # docs/k6//javascript-api/xk6-disruptor/servicedisruptor/constructor title: 'Constructor' descriptiontiontion: 'xk6-disruptor: ServiceDisruptor constructor' weight: 100 @@ -6,7 +8,7 @@ weight: 100 # Constructor -The `ServiceDisruptor()` constructor creates a new instance of a [ServiceDisruptor](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/servicedisruptor) class. +The `ServiceDisruptor()` constructor creates a new instance of a [ServiceDisruptor](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor) class. | Parameter | Type | Description | | ------------------ | ------ | ----------------------------------------------------------------- | diff --git a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/injectgrpcfaults.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injectgrpcfaults.md similarity index 83% rename from docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/injectgrpcfaults.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injectgrpcfaults.md index 45c69ac0fa..6125ae14c1 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/injectgrpcfaults.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injectgrpcfaults.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/servicedisruptor/injectgrpcfaults # docs/k6//javascript-api/xk6-disruptor/servicedisruptor/injectgrpcfaults title: 'injectGrpcFaults' description: 'xk6-disruptor: ServiceDisruptor.injectGrpcFaults method' weight: 200 @@ -10,7 +12,7 @@ injectGrpcFaults injects gRPC faults in the requests served by a target Service. | Parameters | Type | Description | | ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------- | -| fault | object | description of the [gRPC faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/grpc) to be injected | +| fault | object | description of the [gRPC faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/grpc) to be injected | | duration | string | duration of the disruption | | options (optional) | object | [options](#options) that control the injection of the fault | diff --git a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/injecthttpfaults.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injecthttpfaults.md similarity index 86% rename from docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/injecthttpfaults.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injecthttpfaults.md index ca489c8797..8bd6edcbbe 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/injecthttpfaults.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/injecthttpfaults.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/servicedisruptor/injecthttpfaults # docs/k6//javascript-api/xk6-disruptor/servicedisruptor/injecthttpfaults title: 'injectHTTPFaults' description: 'xk6-disruptor: ServiceDisruptor.injectHTTPFaults method' weight: 300 @@ -10,7 +12,7 @@ injectHTTPFaults injects HTTP faults in the requests served by a target Service. | Parameters | Type | Description | | ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------- | -| fault | object | description of the [http faults](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/http) to be injected | +| fault | object | description of the [http faults](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/http) to be injected | | duration | string | duration of the disruption | | options (optional) | object | [options](#options) that control the injection of the fault | diff --git a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/terminate-pods.md b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/terminate-pods.md similarity index 70% rename from docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/terminate-pods.md rename to docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/terminate-pods.md index 44ebf76430..31bda60222 100644 --- a/docs/sources/next/javascript-api/xk6-disruptor/servicedisruptor/terminate-pods.md +++ b/docs/sources/next/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/servicedisruptor/terminate-pods.md @@ -1,4 +1,6 @@ --- +aliases: + - ../../../../javascript-api/xk6-disruptor/servicedisruptor/terminate-pods # docs/k6//javascript-api/xk6-disruptor/servicedisruptor/terminate-pods title: 'terminatePods()' description: 'xk6-disruptor: ServiceDisruptor.terminatePods method' weight: 400 @@ -10,7 +12,7 @@ weight: 400 | Parameter | Type | Description | | --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- | -| fault | object | description of the [Pod Termination fault](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/faults/pod-termination) | +| fault | object | description of the [Pod Termination fault](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/faults/pod-termination) | ## Example diff --git a/docs/sources/next/using-k6-browser/recommended-practices/hybrid-approach-to-performance.md b/docs/sources/next/using-k6-browser/recommended-practices/hybrid-approach-to-performance.md index 76e8270ad7..1aad4d9019 100644 --- a/docs/sources/next/using-k6-browser/recommended-practices/hybrid-approach-to-performance.md +++ b/docs/sources/next/using-k6-browser/recommended-practices/hybrid-approach-to-performance.md @@ -109,7 +109,7 @@ You can also run a browser test together with a failure injection test by using The following code shows an example of how to introduce faults to a Kubernetes service. At the same time, the `browser` scenario runs to ensure the frontend application is free of any unexpected errors that may not have been handled properly. -To find out more information about injecting faults to your service, check out the [Get started with xk6-disruptor guide](https://grafana.com/docs/k6//javascript-api/xk6-disruptor/get-started/). +To find out more information about injecting faults to your service, check out the [Get started with xk6-disruptor guide](https://grafana.com/docs/k6//testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor/). {{< code >}}