Add PDC network and PDC network token resources #1975

aangelisc · 2025-01-03T17:39:06Z

Feedback welcome here (my first time creating some TF resources), this is essentially a duplicate of the access policy and token resources with some minor changes that are specific to PDC.

Add resource lister function that will return a slice of resources

Fixes #1222
Fixes #1638

- Add resource lister function that will return a slice of resources

github-actions · 2025-01-03T17:39:19Z

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.

dafydd-t

This looks really good! Thanks a lot for starting it off. I've added some comments around the naming of things for now. We need a more thorough review of the terraform itself, we can get to that soon.

examples/resources/grafana_cloud_private_datasource_connect/resource.tf

dafydd-t · 2025-01-06T16:34:24Z

examples/resources/grafana_cloud_private_datasource_connect/resource.tf

+  pdc_network_id = grafana_cloud_private_datasource_connect.test.network_id
+  region         = "us"


could we pass the whole network resource as input? Then we could get the region from the network schema, and we wouldn't need to repeat the region input in the token schema. This would feel more natural to me, since a token MUST be in the same region as its Access Policy

I don't think this is straightforward. I've updated the example to use the region from the previously created network.

Fair enough. I'll leave this comment open in case someone with some TF experience has input.

internal/resources/cloud/resource_private_datasource_connect.go

internal/resources/grafana/resource_data_source.go

- Tidy up property names

aangelisc · 2025-01-06T20:51:45Z

Updated based on your suggestions @dafydd-t. I've also added a data source to allow retrieval of networks that may not be managed by TF.

dafydd-t · 2025-01-08T12:12:25Z

docs/data-sources/data_source.md

@@ -59,6 +59,7 @@ data "grafana_data_source" "from_uid" {
 - `id` (String) The ID of this resource.
 - `is_default` (Boolean) Whether to set the data source as default. This should only be `true` to a single data source.
 - `json_data_encoded` (String) Serialized JSON string containing the json data. This attribute can be used to pass configuration options to the data source. To figure out what options a datasource has available, see its docs or inspect the network data when saving it from the Grafana UI. Note that keys in this map are usually camelCased.
+- `private_datasource_connect_network_id` (String) (Can only be used with data sources in Grafana Cloud) The ID of the private data source network to use with this data source.


Suggested change

- `private_datasource_connect_network_id` (String) (Can only be used with data sources in Grafana Cloud) The ID of the private data source network to use with this data source.

- `private_datasource_connect_network_id` (String) (Can only be used with data sources in Grafana Cloud) The ID of the Private Data source Connect network to use with this data source.

dafydd-t · 2025-01-08T12:12:40Z

docs/data-sources/cloud_private_data_source_connect_networks.md

+page_title: "grafana_cloud_private_data_source_connect_networks Data Source - terraform-provider-grafana"
+subcategory: "Cloud"
+description: |-
+  Fetches Private data source connect networks from Grafana Cloud.


Suggested change

Fetches Private data source connect networks from Grafana Cloud.

Fetches Private Data source Connect networks from Grafana Cloud.

doh i see this is generated, but please update in the source

Fixed in source

dafydd-t · 2025-01-08T12:12:52Z

docs/data-sources/cloud_private_data_source_connect_networks.md

+
+# grafana_cloud_private_data_source_connect_networks (Data Source)
+
+Fetches Private data source connect networks from Grafana Cloud.


Suggested change

Fetches Private data source connect networks from Grafana Cloud.

Fetches Private Data source Connect networks from Grafana Cloud.

dafydd-t · 2025-01-08T12:15:26Z

internal/resources/cloud/data_source_private_data_source_connect_network.go

+	)
+}
+
+type PrivateDatasourceConnectNetworksDataSource struct {


Can we be consistent about typing on Datasource please?

I think it would be OK to use PDC in the type names too - up to you.

Switched to using PDC

dafydd-t · 2025-01-08T12:22:04Z

@aangelisc do you have an example terraform plan that you used to run this locally? I'd love to give it a go

aangelisc · 2025-01-08T14:06:03Z

Hey @dafydd-t, I've pushed some more updates 😊

You should be able to test this with the following tf:

terraform {
  required_providers {
    grafana = {
      source = "grafana/grafana"
    }
  }
}

provider "grafana" {
  alias                     = "cloud"
  cloud_access_policy_token = "<token>"
}


data "grafana_cloud_stack" "stack" {
  provider = grafana.cloud

  slug = "stack"
}

resource "grafana_cloud_stack_service_account" "cloud_sa" {
  provider   = grafana.cloud
  stack_slug = data.grafana_cloud_stack.stack.slug

  name        = "pdc-test-sa"
  role        = "Admin"
  is_disabled = false
}

resource "grafana_cloud_stack_service_account_token" "cloud_sa" {
  provider   = grafana.cloud
  stack_slug = data.grafana_cloud_stack.stack.slug

  name               = "terraform serviceaccount key"
  service_account_id = grafana_cloud_stack_service_account.cloud_sa.id
}

provider "grafana" {
  alias = "stack"

  url                       = data.grafana_cloud_stack.stack.url
  auth                      = grafana_cloud_stack_service_account_token.cloud_sa.key
  cloud_access_policy_token = "<token>"
}

resource "grafana_cloud_private_data_source_connect_network" "test" {
  provider = grafana.stack

  region           = data.grafana_cloud_stack.stack.region_slug
  name             = "test-pdc"
  display_name     = "Test PDC"
  stack_identifier = data.grafana_cloud_stack.stack.id
}

resource "grafana_cloud_private_data_source_connect_network_token" "test" {
  provider = grafana.stack

  pdc_network_id = grafana_cloud_private_data_source_connect_network.test.pdc_network_id
  region         = grafana_cloud_private_data_source_connect_network.test.region
  name           = "my-pdc-token"
  display_name   = "My PDC Token"
}

resource "grafana_data_source" "influxdb" {
  provider = grafana.stack

  type                = "influxdb"
  name                = "pdc-test-influx"
  url                 = "http://influxdb.example.net:8086/"
  basic_auth_enabled  = true
  basic_auth_username = "username"
  database_name       = "dbname" // Example: influxdb_database.metrics.name

  json_data_encoded = jsonencode({
    authType          = "default"
    basicAuthPassword = "mypassword"
  })

  private_data_source_connect_network_id = grafana_cloud_private_data_source_connect_network.test.pdc_network_id
}

Add PDC network and PDC network token resources

f7d9496

- Add resource lister function that will return a slice of resources

aangelisc self-assigned this Jan 3, 2025

aangelisc requested review from a team as code owners January 3, 2025 17:39

aangelisc added 2 commits January 3, 2025 19:14

Support PDC in data sources

087f887

Add examples and generate docs

ab4ed8c

aangelisc requested review from julienduchesne and dafydd-t and removed request for a team January 3, 2025 19:15

Regen

4c5ae4a

dafydd-t requested changes Jan 6, 2025

View reviewed changes

aangelisc added 3 commits January 6, 2025 20:48

Update data source property name

bf7a522

Add PDC network data sources

cc0ac2e

Rename resources for clarity

1823a56

- Tidy up property names

Some more naming updates

fb95d66

aangelisc requested a review from dafydd-t January 6, 2025 21:02

aangelisc added 6 commits January 7, 2025 13:30

Update docs

25c76cf

Merge branch 'main' into andreas/pdc-provider

3487011

Fix pdc network Id check

3c4fddf

Update docs and add test

4dfce8b

Docs update

9b11736

Add reference to access policies naming reqs

6b013eb

dafydd-t reviewed Jan 8, 2025

View reviewed changes

Minor updates for type names and docs

b83bd0a

aangelisc added 2 commits January 8, 2025 14:08

Fix replace

7b47bef

Merge branch 'main' into andreas/pdc-provider

922a35f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add PDC network and PDC network token resources #1975

Add PDC network and PDC network token resources #1975

aangelisc commented Jan 3, 2025 •

edited

Loading

github-actions bot commented Jan 3, 2025

dafydd-t left a comment

dafydd-t Jan 6, 2025

aangelisc Jan 6, 2025

dafydd-t Jan 8, 2025

aangelisc commented Jan 6, 2025

dafydd-t Jan 8, 2025

aangelisc Jan 8, 2025

dafydd-t Jan 8, 2025

dafydd-t Jan 8, 2025

aangelisc Jan 8, 2025

dafydd-t Jan 8, 2025

aangelisc Jan 8, 2025

dafydd-t Jan 8, 2025

dafydd-t Jan 8, 2025

aangelisc Jan 8, 2025

dafydd-t commented Jan 8, 2025

aangelisc commented Jan 8, 2025

		pdc_network_id = grafana_cloud_private_datasource_connect.test.network_id
		region = "us"

	- `private_datasource_connect_network_id` (String) (Can only be used with data sources in Grafana Cloud) The ID of the private data source network to use with this data source.
	- `private_datasource_connect_network_id` (String) (Can only be used with data sources in Grafana Cloud) The ID of the Private Data source Connect network to use with this data source.

	Fetches Private data source connect networks from Grafana Cloud.
	Fetches Private Data source Connect networks from Grafana Cloud.


		# grafana_cloud_private_data_source_connect_networks (Data Source)

		Fetches Private data source connect networks from Grafana Cloud.

Add PDC network and PDC network token resources #1975

Are you sure you want to change the base?

Add PDC network and PDC network token resources #1975

Conversation

aangelisc commented Jan 3, 2025 • edited Loading

github-actions bot commented Jan 3, 2025

dafydd-t left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aangelisc commented Jan 6, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dafydd-t commented Jan 8, 2025

aangelisc commented Jan 8, 2025

aangelisc commented Jan 3, 2025 •

edited

Loading