Support to manage basic k6 resources #2129

joanlopez · 2025-04-14T00:13:41Z

It adds support for the following:

Resources:
- Project
- Project limits
- Load test (w/ script)
- Installation (k6 App)
Data sources:
- Project
- Project limits
- Load test
- Load tests (to query multiple load tests by project id)

Closes #2086

github-actions · 2025-04-14T00:13:55Z

In order to lower resource usage and have a faster runtime, PRs will not run Cloud tests automatically.
To do so, a Grafana Labs employee must trigger the cloud acceptance tests workflow manually.

joanlopez · 2025-04-14T00:19:39Z

.github/CODEOWNERS

@@ -4,6 +4,7 @@
 /internal/resources/cloud/*                 @grafana/platform-monitoring @grafana/grafana-com-maintainers
 /internal/resources/cloudprovider/*         @grafana/platform-monitoring @grafana/middleware-apps
 /internal/resources/connections/*           @grafana/platform-monitoring @grafana/middleware-apps
+/internal/resources/k6/*                    @grafana/platform-monitoring @grafana/k6-core


Looks like I don't have permission to add this team to the repository, can you help, please? 🙏🏻 cc/ @spinillos @Duologic

Could you also add: grafana/k6-backend, please?
This will likely be also co-owned by https://github.com/orgs/grafana/teams/k6-backend

.github/workflows/acc-tests.yml

internal/resources/k6/resource_project.go

Duologic · 2025-04-23T09:14:20Z

internal/resources/cloud/resource_k6_installation.go

+
+		Description: `
+Sets up the k6 App on a Grafana Cloud instance and generates a token. 
+Once a Grafana Cloud stack is created, a user can either use this resource or go into the UI to install k6.


Out of curiosity, why isn't this service part of the rergular Cloud Stack (via Stack State Service)? This pattern also exists for Synthetic Monitoring and we've notice it causes friction.

For example, someone already clicked the button in the UI and now tries to create it with Terraform as well, what happens then? Does the API return a token as well?

Let me invoke @d14c here, as I think he's the best candidate to answer to this one.

why isn't this service part of the rergular Cloud Stack (via Stack State Service)?

When the puguin was implemented SSS was not yet the service entirely responsible of provisioning the plugins, but neverthenless it seems good seperation to me that SSS is only responsible of the plugin provisioning /management (including jsonData nad secureJsonData) and the k6-cloud responsible of intitating the app state from k6-cloud perspective.

For example, someone already clicked the button in the UI and now tries to create it with Terraform as well, what happens then? Does the API return a token as well?

yes the initialization api is idempotent, if the app is already intialized it will return the master token.

.github/workflows/acc-tests.yml

joanlopez · 2025-04-25T07:33:07Z

internal/resources/examples_test.go

+		{
+			category: "k6",
+			testCheck: func(t *testing.T, filename string) {
+				t.Skip() // TODO: Make all examples work


All tests here are skipped, so I added the one for k6 examples but left it skipped as well, for now.

Alex3k · 2025-04-25T09:15:07Z

@joanlopez - would this enable users to change the API used to api.staging.k6.io or does it hard code it to api.k6.io? I ask as we have a scenario internally where we use both

joanlopez · 2025-04-27T06:49:18Z

@joanlopez - would this enable users to change the API used to api.staging.k6.io or does it hard code it to api.k6.io? I ask as we have a scenario internally where we use both

The k6 client, by default connects to api.k6.io, as you can see here. But, as you can also see here, the Terraform provider overwrites that configuration if either k6_url attribute or GRAFANA_K6_URL environment variable are provided.

Alex3k · 2025-05-01T15:23:39Z

@joanlopez when this is released could we update https://docs.google.com/spreadsheets/d/1hBpYQpOq9MBlt1Fbf6A-JDsZmcf7y9BC-zk0hbJVCgo/edit?gid=0#gid=0 please? I wasn't sure if this is part of an official terraform provider release process or not but this sheet is proving incredibly useful in #terraform-provider

fornfrey · 2025-05-02T11:37:37Z

docs/data-sources/k6_load_test.md

+resource "grafana_k6_load_test" "test_load_test" {
+  project_id = grafana_k6_project.load_test_project.id
+  name       = "Terraform Test Load Test"
+  script     = <<-EOT


Can script accept a .tar archive? If not, will the provider support multi-file test scripts in any other way?

That's a very good question @fornfrey. The short answer is: no.

The challenge here is that we don't have an easy and reproducible way to check for "changes" in the script if they use an archive. I've seen that, in case of creating a new load test with an archive, then the "script" can be retrieved from the API, but it returns some form of a UTF-8 representation of the contents of the archive, which looks similar to multipart, but doesn't make it easy to check for updates.

So, in this case, we should find an alternative way for doing so. For instance, the provider could define a couple of attributes, like script_file and script_file_hash, so it uses the hash of the local file to detect whenever the file pointed by the script_file attribute has changed. AFAIK that's the pattern that some providers use when dealing with files within Terraform modules.

That said, I'd suggest that, for now, we ship this initial support without, and to add that support in the next iteration.
So we unblock this initial release, users can test it, and give us feedback for that next iteration, beyond this specific "feature".

Wdyt?

My initial concern was that we might need to change the scrip field schema to an object to support different types of scripts, but as you suggested, a separate field also solves this problem. I don't see a blocker here 👍

For instance, the provider could define a couple of attributes, like script_file and script_file_hash, so it uses the hash of the local file to detect whenever the file pointed by the script_file attribute has changed.

To clarify, will they be calculated internally in the provider based on script_file input rather than being requested from the user?

To clarify, will they be calculated internally in the provider based on script_file input rather than being requested from the user?

I'm not 100% sure how that's usually handled, but yes, I guess that could be an option. Alternatively, we may suggest users to use the filesha256 function.

joanlopez · 2025-05-07T11:56:51Z

@joanlopez when this is released could we update https://docs.google.com/spreadsheets/d/1hBpYQpOq9MBlt1Fbf6A-JDsZmcf7y9BC-zk0hbJVCgo/edit?gid=0#gid=0 please? I wasn't sure if this is part of an official terraform provider release process or not but this sheet is proving incredibly useful in #terraform-provider

I don't know how frequently is this being updated, nor if it is up to date, but I have added the rows that correspond to resources/data sources added in this PR 👍🏻

joanlopez added 9 commits April 8, 2025 11:45

Base support for GCk6 projects

a22899e

Support for GCk6 load tests and scripts

6b9759a

Support for GCk6 project limits

cb48eed

k6 App installation resource

32966cb

Rename k6-specific provider attributes

2450039

Generate docs for k6 resources

a4454bb

Accommodate tests checks

007c9c8

k6 data sources: project, limits and load tests

2c5a345

Add an example for grafana_k6_installation

49fa6e8

joanlopez requested review from Duologic and spinillos April 14, 2025 00:13

joanlopez self-assigned this Apr 14, 2025

joanlopez requested review from a team as code owners April 14, 2025 00:13

joanlopez mentioned this pull request Apr 14, 2025

Add support for managing k6 tokens in Grafana Cloud #1010

Closed

Update CODEOWNERS with k6

edddb6c

joanlopez commented Apr 14, 2025

View reviewed changes

.github/workflows/acc-tests.yml Outdated Show resolved Hide resolved

joanlopez added 2 commits April 14, 2025 10:04

Merge remote-tracking branch 'origin/main' into k6-support

5297285

Clean up after merge with conflicts

1a6b9fe

joanlopez force-pushed the k6-support branch from dcc20ce to 1a6b9fe Compare April 14, 2025 08:19

Try to make the linter happy

0e6217d

joanlopez force-pushed the k6-support branch from ceac054 to 0e6217d Compare April 14, 2025 09:50

joanlopez requested a review from fornfrey April 15, 2025 14:06

patrickeasters reviewed Apr 15, 2025

View reviewed changes

internal/resources/k6/resource_project.go Show resolved Hide resolved

Duologic reviewed Apr 23, 2025

View reviewed changes

joanlopez added 3 commits April 24, 2025 11:21

Merge remote-tracking branch 'origin/main' into k6-support

eb9ee29

Set up k6 credentials for cloud instance tests

6d190f1

Filter project's load tests by name

c948123

joanlopez added 4 commits April 24, 2025 19:09

Fetch projects by name

947cc75

Add 'grafana_folder_uid' to k6 project model

f9a4fa9

Update docs

a6d469a

Make the linter happy again

2386888

joanlopez commented Apr 25, 2025

View reviewed changes

Collection of small tweaks and refinements

66c7ebe

joanlopez force-pushed the k6-support branch from d43bd97 to 66c7ebe Compare April 25, 2025 09:04

fornfrey reviewed May 2, 2025

View reviewed changes

fornfrey approved these changes May 6, 2025

View reviewed changes

joanlopez merged commit f09610a into main May 6, 2025
26 checks passed

joanlopez deleted the k6-support branch May 6, 2025 09:56

Support to manage basic k6 resources #2129

Support to manage basic k6 resources #2129

Uh oh!

Conversation

joanlopez commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joanlopez Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Alex3k commented Apr 25, 2025

Uh oh!

joanlopez commented Apr 27, 2025

Uh oh!

Alex3k commented May 1, 2025

Uh oh!

fornfrey May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joanlopez commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

joanlopez commented Apr 14, 2025 •

edited

Loading

joanlopez Apr 25, 2025 •

edited

Loading

fornfrey May 2, 2025 •

edited

Loading

joanlopez commented May 7, 2025 •

edited

Loading