Skip to content

Commit

Permalink
Replace k6.io/docs links with grafana.com/docs/k6
Browse files Browse the repository at this point in the history
  • Loading branch information
heitortsergent authored and ppcano committed Jul 9, 2024
1 parent 62fc3e9 commit 1c840d4
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The tests written for `QuickPizza` demonstrates the basic and advanced functiona
## Requirements

- [Docker](https://docs.docker.com/get-docker/)
- [Grafana k6](https://k6.io/docs/get-started/installation/) (v.0.46.0 or higher)
- [Grafana k6](https://grafana.com/docs/k6/latest/set-up/install-k6/) (v.0.46.0 or higher)

## Run locally with Docker

Expand All @@ -38,9 +38,9 @@ Now you can go to [localhost:3333](http://localhost:3333) and get some pizza rec
All tests live in the `k6` folder. Within this folder, you will find the following folders:

- [foundations](k6/foundations/) - covers the basic functionalities of k6.
- [browser](k6/browser/) - covers the [k6 browser module](https://k6.io/docs/using-k6-browser/overview/) for browser and web performance testing.
- [extensions](k6/extensions/) - covers basic tests using [k6 extensions](https://k6.io/docs/extensions/).
- [disruptor](k6/disruptor/) - covers a more deep-dive look on how to use [xk6-disruptor](https://k6.io/docs/javascript-api/xk6-disruptor/) for failure injection testing.
- [browser](k6/browser/) - covers the [k6 browser module](https://grafana.com/docs/k6/latest/using-k6-browser/) for browser and web performance testing.
- [extensions](k6/extensions/) - covers basic tests using [k6 extensions](https://grafana.com/docs/k6/latest/extensions/).
- [disruptor](k6/disruptor/) - covers a more deep-dive look on how to use [xk6-disruptor](https://grafana.com/docs/k6/latest/testing-guides/injecting-faults-with-xk6-disruptor/first-steps/) for failure injection testing.

To run tests on the `foundations` folder, you can use the following commands:

Expand All @@ -65,8 +65,8 @@ k6 run -e BASE_URL=https://acmecorp.dev:3333 01.basic.js
<summary>Using k6 extensions</summary>
If the test uses an extension, you need to build a k6 binary that includes the required extension/s. For detailed instructions, refer to k6 docs:

- [Build a k6 binary using Go](https://k6.io/docs/extensions/guides/build-a-k6-binary-using-go/)
- [Build a k6 binary using Docker](https://k6.io/docs/extensions/guides/build-a-k6-binary-using-docker/)
- [Build a k6 binary using Go](https://grafana.com/docs/k6/latest/extensions/build-k6-binary-using-go/)
- [Build a k6 binary using Docker](https://grafana.com/docs/k6/latest/extensions/build-k6-binary-using-docker/)

```bash
cd k6/extensions
Expand Down Expand Up @@ -147,7 +147,7 @@ The local Grafana instance includes the [k6 Prometheus](https://grafana.com/graf
![k6 provisioned dashboards](./docs/images/provisioned-k6-prometheus-dashboards.png)
For detailed instructions about the different options of the k6 Prometheus output, refer to the [k6 output guide for Prometheus remote write](https://k6.io/docs/results-output/real-time/prometheus-remote-write).
For detailed instructions about the different options of the k6 Prometheus output, refer to the [k6 output guide for Prometheus remote write](https://grafana.com/docs/k6/latest/results-output/real-time/prometheus-remote-write/).
### Grafana Cloud
Expand Down Expand Up @@ -200,7 +200,7 @@ K6_PROMETHEUS_RW_SERVER_URL=REMOTE_WRITE_ENDPOINT \
k6 run -o experimental-prometheus-rw script.js
```

For detailed instructions, refer to the [k6 output guide for Grafana Cloud Prometheus](https://k6.io/docs/results-output/real-time/grafana-cloud-prometheus/).
For detailed instructions, refer to the [k6 output guide for Grafana Cloud Prometheus](https://grafana.com/docs/k6/latest/results-output/real-time/grafana-cloud-prometheus/).

## Deploy QuickPizza Docker image

Expand Down Expand Up @@ -234,7 +234,7 @@ export QUICKPIZZA_DB="quickpizza.db"

## Deploy application to Kubernetes

If you want to run a test that uses [xk6-disruptor](https://k6.io/docs/javascript-api/xk6-disruptor/), or want to experiment with distributed tracing, you will need to deploy QuickPizza to Kubernetes.
If you want to run a test that uses [xk6-disruptor](https://grafana.com/docs/k6/latest/testing-guides/injecting-faults-with-xk6-disruptor/first-steps/), or want to experiment with distributed tracing, you will need to deploy QuickPizza to Kubernetes.

For a detailed setup instructions, see the [QuickPizza Kubernetes guide](./docs/kubernetes-setup.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/kubernetes-setup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## Deploy QuickPizza to Kubernetes

If you want to run a test that uses [xk6-disruptor](https://k6.io/docs/javascript-api/xk6-disruptor/), or want to experiment with distributed tracing, you will need to deploy QuickPizza to Kubernetes.
If you want to run a test that uses [xk6-disruptor](https://grafana.com/docs/k6/latest/testing-guides/injecting-faults-with-xk6-disruptor/first-steps/), or want to experiment with distributed tracing, you will need to deploy QuickPizza to Kubernetes.


This section explains how to deploy QuickPizza to a local Kubernetes cluster using [minikube](https://minikube.sigs.k8s.io/docs/start/), which you can run on your own machine if you use Linux, MacOS, or Windows.
Expand Down Expand Up @@ -51,7 +51,7 @@ QuickPizza-recs ClusterIP 10.103.37.197 <none> 3333/TCP
QuickPizza-ws ClusterIP 10.106.51.76 <none> 3333/TCP 6s
```

A service of particular interest is `QuickPizza-frontend`, of type `LoadBalancer`. This is the service we need to access in our browser to reach the application. You should see that the external IP for this service is currently `<pending>`. In order to make it reachable from outside the cluster, we need to [expose it](https://k6.io/docs/javascript-api/xk6-disruptor/get-started/expose-your-application/). To do this with minikube, open another terminal window and run:
A service of particular interest is `QuickPizza-frontend`, of type `LoadBalancer`. This is the service we need to access in our browser to reach the application. You should see that the external IP for this service is currently `<pending>`. In order to make it reachable from outside the cluster, we need to [expose it](https://grafana.com/docs/k6/latest/testing-guides/injecting-faults-with-xk6-disruptor/expose-your-application/). To do this with minikube, open another terminal window and run:

```bash
minikube tunnel
Expand Down
6 changes: 3 additions & 3 deletions grafana/dashboards/definitions/18030_rev8.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"title": "Grafana k6 OSS Docs: Prometheus Remote Write",
"tooltip": "Open docs in a new tab",
"type": "link",
"url": "https://k6.io/docs/results-output/real-time/prometheus-remote-write/"
"url": "https://grafana.com/docs/k6/latest/results-output/real-time/prometheus-remote-write/"
}
],
"liveNow": false,
Expand Down Expand Up @@ -835,7 +835,7 @@
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"description": "Select a different quantile to change the query\n\n<a href=\"https://k6.io/docs/using-k6/metrics/reference/#http\" target=\"_blank\">HTTP-specific built-in metrics</a>",
"description": "Select a different quantile to change the query\n\n<a href=\"https://grafana.com/docs/k6/latest/using-k6/metrics/reference/#http\" target=\"_blank\">HTTP-specific built-in metrics</a>",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -1949,7 +1949,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "### Visualize other k6 results \n\nAt the top of the dashboard, click `Add` and select `Visualization` from the dropdown menu. Choose the visualization type and input the PromQL queries for the `k6_` metric(s).\n\nAlternatively, click on the `Explore` icon on the menu bar and input the queries for the `k6_` metric(s). From `Explore`, you can add new Panels to this dashboard. \n\nNote that all <a href=\"https://k6.io/docs/using-k6/metrics/\" target=\"_blank\">k6 metrics</a> are prefixed with the `k6_` namespace when sent to Prometheus.",
"content": "### Visualize other k6 results \n\nAt the top of the dashboard, click `Add` and select `Visualization` from the dropdown menu. Choose the visualization type and input the PromQL queries for the `k6_` metric(s).\n\nAlternatively, click on the `Explore` icon on the menu bar and input the queries for the `k6_` metric(s). From `Explore`, you can add new Panels to this dashboard. \n\nNote that all <a href=\"https://grafana.com/docs/k6/latest/using-k6/metrics/\" target=\"_blank\">k6 metrics</a> are prefixed with the `k6_` namespace when sent to Prometheus.",
"mode": "markdown"
},
"pluginVersion": "10.1.2",
Expand Down
6 changes: 3 additions & 3 deletions grafana/dashboards/definitions/19665_rev2.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"title": "Grafana k6 OSS Docs: Prometheus Remote Write",
"tooltip": "Open docs in a new tab",
"type": "link",
"url": "https://k6.io/docs/results-output/real-time/prometheus-remote-write/"
"url": "https://grafana.com/docs/k6/latest/results-output/real-time/prometheus-remote-write/"
}
],
"liveNow": false,
Expand Down Expand Up @@ -835,7 +835,7 @@
"type": "prometheus",
"uid": "${DS_PROMETHEUS}"
},
"description": "Select a different Stat to change the query\n\n<a href=\"https://k6.io/docs/using-k6/metrics/reference/#http\" target=\"_blank\">HTTP-specific built-in metrics</a>",
"description": "Select a different Stat to change the query\n\n<a href=\"https://grafana.com/docs/k6/latest/using-k6/metrics/reference/#http\" target=\"_blank\">HTTP-specific built-in metrics</a>",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -1955,7 +1955,7 @@
"showLineNumbers": false,
"showMiniMap": false
},
"content": "### Visualize other k6 results \n\nAt the top of the dashboard, click `Add` and select `Visualization` from the dropdown menu. Choose the visualization type and input the PromQL queries for the `k6_` metric(s).\n\nAlternatively, click on the `Explore` icon on the menu bar and input the queries for the `k6_` metric(s). From `Explore`, you can add new Panels to this dashboard. \n\nNote that all <a href=\"https://k6.io/docs/using-k6/metrics/\" target=\"_blank\">k6 metrics</a> are prefixed with the `k6_` namespace when sent to Prometheus.",
"content": "### Visualize other k6 results \n\nAt the top of the dashboard, click `Add` and select `Visualization` from the dropdown menu. Choose the visualization type and input the PromQL queries for the `k6_` metric(s).\n\nAlternatively, click on the `Explore` icon on the menu bar and input the queries for the `k6_` metric(s). From `Explore`, you can add new Panels to this dashboard. \n\nNote that all <a href=\"https://grafana.com/docs/k6/latest/using-k6/metrics/\" target=\"_blank\">k6 metrics</a> are prefixed with the `k6_` namespace when sent to Prometheus.",
"mode": "markdown"
},
"pluginVersion": "10.1.2",
Expand Down

0 comments on commit 1c840d4

Please sign in to comment.