Skip to content

Commit 6b50c38

Browse files
Split up extensions in Explore between official and community (#1996)
* Split up extensions in Explore between official and community * Update extension-registry-changed script Update script so it creates two separate lists for the Official and Community extensions * Fix nav-cards element * Fix extension-registry-changed script Update section that replaces list of extensions * Fix explore.md extension order * Fix readlink issue * Apply to previous versions * Apply suggestions from code review Co-authored-by: Jack Baldry <[email protected]> * Update docs/sources/k6/next/extensions/explore.md --------- Co-authored-by: Jack Baldry <[email protected]>
1 parent 2ae1e04 commit 6b50c38

File tree

4 files changed

+254
-172
lines changed

4 files changed

+254
-172
lines changed

docs/sources/k6/next/extensions/explore.md

Lines changed: 60 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,66 @@ docker run --rm -u "$(id -u):$(id -g)" -v "${PWD}:/xk6" grafana/xk6 build \
3030

3131
Use the table to explore the many extensions. Questions? Feel free to join the discussion about extensions in the [k6 Community Forum](https://community.grafana.com/c/grafana-k6/extensions/82).
3232

33+
## Official extensions
34+
35+
These are the official extensions, which are owned and maintained by the Grafana organization.
36+
37+
<div class="nav-cards">
38+
<a href="https://github.com/grafana/xk6-client-prometheus-remote" target="_blank" class="nav-cards__item nav-cards__item--guide">
39+
<h4>xk6-client-prometheus-remote</h4>
40+
<p>Test Prometheus Remote Write-compatible endpoints</p>
41+
</a>
42+
<a href="https://github.com/grafana/xk6-dashboard" target="_blank" class="nav-cards__item nav-cards__item--guide">
43+
<h4>xk6-dashboard</h4>
44+
<p>Create a web-based metrics dashboard</p>
45+
</a>
46+
<a href="https://github.com/grafana/xk6-disruptor" target="_blank" class="nav-cards__item nav-cards__item--guide">
47+
<h4>xk6-disruptor</h4>
48+
<p>Inject faults to test 💣</p>
49+
</a>
50+
<a href="https://github.com/grafana/xk6-exec" target="_blank" class="nav-cards__item nav-cards__item--guide">
51+
<h4>xk6-exec</h4>
52+
<p>Run external commands</p>
53+
</a>
54+
<a href="https://github.com/grafana/xk6-faker" target="_blank" class="nav-cards__item nav-cards__item--guide">
55+
<h4>xk6-faker</h4>
56+
<p>Generate fake data in your tests</p>
57+
</a>
58+
<a href="https://github.com/grafana/xk6-kubernetes" target="_blank" class="nav-cards__item nav-cards__item--guide">
59+
<h4>xk6-kubernetes</h4>
60+
<p>Interact with Kubernetes clusters</p>
61+
</a>
62+
<a href="https://github.com/grafana/xk6-output-influxdb" target="_blank" class="nav-cards__item nav-cards__item--guide">
63+
<h4>xk6-output-influxdb</h4>
64+
<p>Export results to InfluxDB v2</p>
65+
</a>
66+
<a href="https://github.com/grafana/xk6-sql" target="_blank" class="nav-cards__item nav-cards__item--guide">
67+
<h4>xk6-sql</h4>
68+
<p>Load-test SQL Servers</p>
69+
</a>
70+
<a href="https://github.com/grafana/xk6-sql-driver-mysql" target="_blank" class="nav-cards__item nav-cards__item--guide">
71+
<h4>xk6-sql-driver-mysql</h4>
72+
<p>xk6-sql driver extension for MySQL database support</p>
73+
</a>
74+
<a href="https://github.com/grafana/xk6-sql-driver-postgres" target="_blank" class="nav-cards__item nav-cards__item--guide">
75+
<h4>xk6-sql-driver-postgres</h4>
76+
<p>xk6-sql driver extension for Postgres database support</p>
77+
</a>
78+
<a href="https://github.com/grafana/xk6-sql-driver-sqlite3" target="_blank" class="nav-cards__item nav-cards__item--guide">
79+
<h4>xk6-sql-driver-sqlite3</h4>
80+
<p>xk6-sql driver extension for SQLite v3 database support</p>
81+
</a>
82+
<a href="https://github.com/grafana/xk6-ssh" target="_blank" class="nav-cards__item nav-cards__item--guide">
83+
<h4>xk6-ssh</h4>
84+
<p>Use SSH connections in your tests</p>
85+
</a>
86+
</div>
87+
88+
## Community extensions
89+
90+
These are the community extensions, which are owned by our community members.
91+
The Grafana team makes a best-effort assistance to keep these extensions in compliance.
92+
3393
<div class="nav-cards">
3494
<a href="https://github.com/prmuthu/xk6-amqp" target="_blank" class="nav-cards__item nav-cards__item--guide">
3595
<h4>xk6-amqp</h4>
@@ -51,10 +111,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
51111
<h4>xk6-cache</h4>
52112
<p>Enable vendoring remote HTTP modules to a single source-control-friendly file</p>
53113
</a>
54-
<a href="https://github.com/grafana/xk6-client-prometheus-remote" target="_blank" class="nav-cards__item nav-cards__item--guide">
55-
<h4>xk6-client-prometheus-remote</h4>
56-
<p>Test Prometheus Remote Write-compatible endpoints</p>
57-
</a>
58114
<a href="https://github.com/grafana/xk6-client-tracing" target="_blank" class="nav-cards__item nav-cards__item--guide">
59115
<h4>xk6-client-tracing</h4>
60116
<p>Client for load testing distributed tracing backends</p>
@@ -79,14 +135,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
79135
<h4>xk6-csv</h4>
80136
<p>Parse CSV values</p>
81137
</a>
82-
<a href="https://github.com/grafana/xk6-dashboard" target="_blank" class="nav-cards__item nav-cards__item--guide">
83-
<h4>xk6-dashboard</h4>
84-
<p>Create a web-based metrics dashboard</p>
85-
</a>
86-
<a href="https://github.com/grafana/xk6-disruptor" target="_blank" class="nav-cards__item nav-cards__item--guide">
87-
<h4>xk6-disruptor</h4>
88-
<p>Inject faults to test 💣</p>
89-
</a>
90138
<a href="https://github.com/szkiba/xk6-dotenv" target="_blank" class="nav-cards__item nav-cards__item--guide">
91139
<h4>xk6-dotenv</h4>
92140
<p>Load env vars from a .env file</p>
@@ -95,14 +143,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
95143
<h4>xk6-ethereum</h4>
96144
<p>K6 extension for ethereum protocols</p>
97145
</a>
98-
<a href="https://github.com/grafana/xk6-exec" target="_blank" class="nav-cards__item nav-cards__item--guide">
99-
<h4>xk6-exec</h4>
100-
<p>Run external commands</p>
101-
</a>
102-
<a href="https://github.com/grafana/xk6-faker" target="_blank" class="nav-cards__item nav-cards__item--guide">
103-
<h4>xk6-faker</h4>
104-
<p>Generate fake data in your tests</p>
105-
</a>
106146
<a href="https://github.com/domsolutions/xk6-fasthttp" target="_blank" class="nav-cards__item nav-cards__item--guide">
107147
<h4>xk6-fasthttp</h4>
108148
<p>Enable RPS increase & file streaming on HTTP/1.1 requests</p>
@@ -139,10 +179,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
139179
<h4>xk6-kafka</h4>
140180
<p>Load test Apache Kafka. Includes support for Avro messages.</p>
141181
</a>
142-
<a href="https://github.com/grafana/xk6-kubernetes" target="_blank" class="nav-cards__item nav-cards__item--guide">
143-
<h4>xk6-kubernetes</h4>
144-
<p>Interact with Kubernetes clusters</p>
145-
</a>
146182
<a href="https://github.com/oleiade/xk6-kv" target="_blank" class="nav-cards__item nav-cards__item--guide">
147183
<h4>xk6-kv</h4>
148184
<p>Share key-value data between VUs</p>
@@ -183,10 +219,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
183219
<h4>xk6-output-elasticsearch</h4>
184220
<p>Export results to Elasticsearch 8.x</p>
185221
</a>
186-
<a href="https://github.com/grafana/xk6-output-influxdb" target="_blank" class="nav-cards__item nav-cards__item--guide">
187-
<h4>xk6-output-influxdb</h4>
188-
<p>Export results to InfluxDB v2</p>
189-
</a>
190222
<a href="https://github.com/grafana/xk6-output-kafka" target="_blank" class="nav-cards__item nav-cards__item--guide">
191223
<h4>xk6-output-kafka</h4>
192224
<p>Export k6 results in real-time to Kafka</p>
@@ -247,10 +279,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
247279
<h4>xk6-smtp</h4>
248280
<p>Use SMTP protocol to send emails</p>
249281
</a>
250-
<a href="https://github.com/grafana/xk6-sql" target="_blank" class="nav-cards__item nav-cards__item--guide">
251-
<h4>xk6-sql</h4>
252-
<p>Load-test SQL Servers</p>
253-
</a>
254282
<a href="https://github.com/grafana/xk6-sql-driver-azuresql" target="_blank" class="nav-cards__item nav-cards__item--guide">
255283
<h4>xk6-sql-driver-azuresql</h4>
256284
<p>xk6-sql driver extension for Microsoft Azure SQL database support</p>
@@ -259,22 +287,10 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
259287
<h4>xk6-sql-driver-clickhouse</h4>
260288
<p>xk6-sql driver extension for ClickHouse database support</p>
261289
</a>
262-
<a href="https://github.com/grafana/xk6-sql-driver-mysql" target="_blank" class="nav-cards__item nav-cards__item--guide">
263-
<h4>xk6-sql-driver-mysql</h4>
264-
<p>xk6-sql driver extension for MySQL database support</p>
265-
</a>
266-
<a href="https://github.com/grafana/xk6-sql-driver-postgres" target="_blank" class="nav-cards__item nav-cards__item--guide">
267-
<h4>xk6-sql-driver-postgres</h4>
268-
<p>xk6-sql driver extension for Postgres database support</p>
269-
</a>
270290
<a href="https://github.com/grafana/xk6-sql-driver-ramsql" target="_blank" class="nav-cards__item nav-cards__item--guide">
271291
<h4>xk6-sql-driver-ramsql</h4>
272292
<p>xk6-sql driver extension for RamSQL database support</p>
273293
</a>
274-
<a href="https://github.com/grafana/xk6-sql-driver-sqlite3" target="_blank" class="nav-cards__item nav-cards__item--guide">
275-
<h4>xk6-sql-driver-sqlite3</h4>
276-
<p>xk6-sql driver extension for SQLite v3 database support</p>
277-
</a>
278294
<a href="https://github.com/grafana/xk6-sql-driver-sqlserver" target="_blank" class="nav-cards__item nav-cards__item--guide">
279295
<h4>xk6-sql-driver-sqlserver</h4>
280296
<p>xk6-sql driver extension for Microsoft SQL Server database support</p>
@@ -283,10 +299,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
283299
<h4>xk6-sse</h4>
284300
<p>Server Sent Event</p>
285301
</a>
286-
<a href="https://github.com/grafana/xk6-ssh" target="_blank" class="nav-cards__item nav-cards__item--guide">
287-
<h4>xk6-ssh</h4>
288-
<p>Use SSH connections in your tests</p>
289-
</a>
290302
<a href="https://github.com/walterwanderley/xk6-stomp" target="_blank" class="nav-cards__item nav-cards__item--guide">
291303
<h4>xk6-stomp</h4>
292304
<p>Client for STOMP protocol</p>

docs/sources/k6/v1.0.x/extensions/explore.md

Lines changed: 64 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,71 @@ docker run --rm -u "$(id -u):$(id -g)" -v "${PWD}:/xk6" grafana/xk6 build \
3030

3131
Use the table to explore the many extensions. Questions? Feel free to join the discussion about extensions in the [k6 Community Forum](https://community.grafana.com/c/grafana-k6/extensions/82).
3232

33+
## Official extensions
34+
35+
These are the official extensions, which are owned and maintained by the Grafana organization.
36+
3337
<div class="nav-cards">
38+
<a href="https://github.com/grafana/xk6-client-prometheus-remote" target="_blank" class="nav-cards__item nav-cards__item--guide">
39+
<h4>xk6-client-prometheus-remote</h4>
40+
<p>Test Prometheus Remote Write-compatible endpoints</p>
41+
</a>
42+
<a href="https://github.com/grafana/xk6-dashboard" target="_blank" class="nav-cards__item nav-cards__item--guide">
43+
<h4>xk6-dashboard</h4>
44+
<p>Create a web-based metrics dashboard</p>
45+
</a>
46+
<a href="https://github.com/grafana/xk6-disruptor" target="_blank" class="nav-cards__item nav-cards__item--guide">
47+
<h4>xk6-disruptor</h4>
48+
<p>Inject faults to test 💣</p>
49+
</a>
50+
<a href="https://github.com/grafana/xk6-exec" target="_blank" class="nav-cards__item nav-cards__item--guide">
51+
<h4>xk6-exec</h4>
52+
<p>Run external commands</p>
53+
</a>
54+
<a href="https://github.com/grafana/xk6-faker" target="_blank" class="nav-cards__item nav-cards__item--guide">
55+
<h4>xk6-faker</h4>
56+
<p>Generate fake data in your tests</p>
57+
</a>
58+
<a href="https://github.com/grafana/xk6-kubernetes" target="_blank" class="nav-cards__item nav-cards__item--guide">
59+
<h4>xk6-kubernetes</h4>
60+
<p>Interact with Kubernetes clusters</p>
61+
</a>
62+
<a href="https://github.com/grafana/xk6-output-influxdb" target="_blank" class="nav-cards__item nav-cards__item--guide">
63+
<h4>xk6-output-influxdb</h4>
64+
<p>Export results to InfluxDB v2</p>
65+
</a>
66+
<a href="https://github.com/grafana/xk6-sql" target="_blank" class="nav-cards__item nav-cards__item--guide">
67+
<h4>xk6-sql</h4>
68+
<p>Load-test SQL Servers</p>
69+
</a>
70+
<a href="https://github.com/grafana/xk6-sql-driver-mysql" target="_blank" class="nav-cards__item nav-cards__item--guide">
71+
<h4>xk6-sql-driver-mysql</h4>
72+
<p>xk6-sql driver extension for MySQL database support</p>
73+
</a>
74+
<a href="https://github.com/grafana/xk6-sql-driver-postgres" target="_blank" class="nav-cards__item nav-cards__item--guide">
75+
<h4>xk6-sql-driver-postgres</h4>
76+
<p>xk6-sql driver extension for Postgres database support</p>
77+
</a>
78+
<a href="https://github.com/grafana/xk6-sql-driver-sqlite3" target="_blank" class="nav-cards__item nav-cards__item--guide">
79+
<h4>xk6-sql-driver-sqlite3</h4>
80+
<p>xk6-sql driver extension for SQLite v3 database support</p>
81+
</a>
82+
<a href="https://github.com/grafana/xk6-ssh" target="_blank" class="nav-cards__item nav-cards__item--guide">
83+
<h4>xk6-ssh</h4>
84+
<p>Use SSH connections in your tests</p>
85+
</a>
86+
</div>
87+
88+
## Community extensions
89+
90+
These are the community extensions, which are owned by our community members.
91+
The Grafana team makes a best-effort assistance to keep these extensions in compliance.
92+
93+
<div class="nav-cards">
94+
<a href="https://github.com/prmuthu/xk6-amqp" target="_blank" class="nav-cards__item nav-cards__item--guide">
95+
<h4>xk6-amqp</h4>
96+
<p>To publish and consume messages using AMQP protocol</p>
97+
</a>
3498
<a href="https://github.com/szkiba/xk6-ansible-vault" target="_blank" class="nav-cards__item nav-cards__item--guide">
3599
<h4>xk6-ansible-vault</h4>
36100
<p>Encrypt and decrypt Ansible Vault</p>
@@ -47,10 +111,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
47111
<h4>xk6-cache</h4>
48112
<p>Enable vendoring remote HTTP modules to a single source-control-friendly file</p>
49113
</a>
50-
<a href="https://github.com/grafana/xk6-client-prometheus-remote" target="_blank" class="nav-cards__item nav-cards__item--guide">
51-
<h4>xk6-client-prometheus-remote</h4>
52-
<p>Test Prometheus Remote Write-compatible endpoints</p>
53-
</a>
54114
<a href="https://github.com/grafana/xk6-client-tracing" target="_blank" class="nav-cards__item nav-cards__item--guide">
55115
<h4>xk6-client-tracing</h4>
56116
<p>Client for load testing distributed tracing backends</p>
@@ -75,14 +135,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
75135
<h4>xk6-csv</h4>
76136
<p>Parse CSV values</p>
77137
</a>
78-
<a href="https://github.com/grafana/xk6-dashboard" target="_blank" class="nav-cards__item nav-cards__item--guide">
79-
<h4>xk6-dashboard</h4>
80-
<p>Create a web-based metrics dashboard</p>
81-
</a>
82-
<a href="https://github.com/grafana/xk6-disruptor" target="_blank" class="nav-cards__item nav-cards__item--guide">
83-
<h4>xk6-disruptor</h4>
84-
<p>Inject faults to test 💣</p>
85-
</a>
86138
<a href="https://github.com/szkiba/xk6-dotenv" target="_blank" class="nav-cards__item nav-cards__item--guide">
87139
<h4>xk6-dotenv</h4>
88140
<p>Load env vars from a .env file</p>
@@ -91,14 +143,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
91143
<h4>xk6-ethereum</h4>
92144
<p>K6 extension for ethereum protocols</p>
93145
</a>
94-
<a href="https://github.com/grafana/xk6-exec" target="_blank" class="nav-cards__item nav-cards__item--guide">
95-
<h4>xk6-exec</h4>
96-
<p>Run external commands</p>
97-
</a>
98-
<a href="https://github.com/grafana/xk6-faker" target="_blank" class="nav-cards__item nav-cards__item--guide">
99-
<h4>xk6-faker</h4>
100-
<p>Generate fake data in your tests</p>
101-
</a>
102146
<a href="https://github.com/domsolutions/xk6-fasthttp" target="_blank" class="nav-cards__item nav-cards__item--guide">
103147
<h4>xk6-fasthttp</h4>
104148
<p>Enable RPS increase & file streaming on HTTP/1.1 requests</p>
@@ -135,10 +179,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
135179
<h4>xk6-kafka</h4>
136180
<p>Load test Apache Kafka. Includes support for Avro messages.</p>
137181
</a>
138-
<a href="https://github.com/grafana/xk6-kubernetes" target="_blank" class="nav-cards__item nav-cards__item--guide">
139-
<h4>xk6-kubernetes</h4>
140-
<p>Interact with Kubernetes clusters</p>
141-
</a>
142182
<a href="https://github.com/oleiade/xk6-kv" target="_blank" class="nav-cards__item nav-cards__item--guide">
143183
<h4>xk6-kv</h4>
144184
<p>Share key-value data between VUs</p>
@@ -163,10 +203,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
163203
<h4>xk6-nostr</h4>
164204
<p>Interact with Nostr relays</p>
165205
</a>
166-
<a href="https://github.com/grafana/xk6-notification" target="_blank" class="nav-cards__item nav-cards__item--guide">
167-
<h4>xk6-notification</h4>
168-
<p>Create notifications</p>
169-
</a>
170206
<a href="https://github.com/frankhefeng/xk6-oauth-pkce" target="_blank" class="nav-cards__item nav-cards__item--guide">
171207
<h4>xk6-oauth-pkce</h4>
172208
<p>Generate OAuth PKCE code verifier and code challenge</p>
@@ -183,10 +219,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
183219
<h4>xk6-output-elasticsearch</h4>
184220
<p>Export results to Elasticsearch 8.x</p>
185221
</a>
186-
<a href="https://github.com/grafana/xk6-output-influxdb" target="_blank" class="nav-cards__item nav-cards__item--guide">
187-
<h4>xk6-output-influxdb</h4>
188-
<p>Export results to InfluxDB v2</p>
189-
</a>
190222
<a href="https://github.com/grafana/xk6-output-kafka" target="_blank" class="nav-cards__item nav-cards__item--guide">
191223
<h4>xk6-output-kafka</h4>
192224
<p>Export k6 results in real-time to Kafka</p>
@@ -247,10 +279,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
247279
<h4>xk6-smtp</h4>
248280
<p>Use SMTP protocol to send emails</p>
249281
</a>
250-
<a href="https://github.com/grafana/xk6-sql" target="_blank" class="nav-cards__item nav-cards__item--guide">
251-
<h4>xk6-sql</h4>
252-
<p>Load-test SQL Servers</p>
253-
</a>
254282
<a href="https://github.com/grafana/xk6-sql-driver-azuresql" target="_blank" class="nav-cards__item nav-cards__item--guide">
255283
<h4>xk6-sql-driver-azuresql</h4>
256284
<p>xk6-sql driver extension for Microsoft Azure SQL database support</p>
@@ -259,22 +287,10 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
259287
<h4>xk6-sql-driver-clickhouse</h4>
260288
<p>xk6-sql driver extension for ClickHouse database support</p>
261289
</a>
262-
<a href="https://github.com/grafana/xk6-sql-driver-mysql" target="_blank" class="nav-cards__item nav-cards__item--guide">
263-
<h4>xk6-sql-driver-mysql</h4>
264-
<p>xk6-sql driver extension for MySQL database support</p>
265-
</a>
266-
<a href="https://github.com/grafana/xk6-sql-driver-postgres" target="_blank" class="nav-cards__item nav-cards__item--guide">
267-
<h4>xk6-sql-driver-postgres</h4>
268-
<p>xk6-sql driver extension for Postgres database support</p>
269-
</a>
270290
<a href="https://github.com/grafana/xk6-sql-driver-ramsql" target="_blank" class="nav-cards__item nav-cards__item--guide">
271291
<h4>xk6-sql-driver-ramsql</h4>
272292
<p>xk6-sql driver extension for RamSQL database support</p>
273293
</a>
274-
<a href="https://github.com/grafana/xk6-sql-driver-sqlite3" target="_blank" class="nav-cards__item nav-cards__item--guide">
275-
<h4>xk6-sql-driver-sqlite3</h4>
276-
<p>xk6-sql driver extension for SQLite v3 database support</p>
277-
</a>
278294
<a href="https://github.com/grafana/xk6-sql-driver-sqlserver" target="_blank" class="nav-cards__item nav-cards__item--guide">
279295
<h4>xk6-sql-driver-sqlserver</h4>
280296
<p>xk6-sql driver extension for Microsoft SQL Server database support</p>
@@ -283,10 +299,6 @@ Use the table to explore the many extensions. Questions? Feel free to join the d
283299
<h4>xk6-sse</h4>
284300
<p>Server Sent Event</p>
285301
</a>
286-
<a href="https://github.com/grafana/xk6-ssh" target="_blank" class="nav-cards__item nav-cards__item--guide">
287-
<h4>xk6-ssh</h4>
288-
<p>Use SSH connections in your tests</p>
289-
</a>
290302
<a href="https://github.com/walterwanderley/xk6-stomp" target="_blank" class="nav-cards__item nav-cards__item--guide">
291303
<h4>xk6-stomp</h4>
292304
<p>Client for STOMP protocol</p>

0 commit comments

Comments
 (0)