Skip to content

Commit 139a2d8

Browse files
eleijonmarckeleijonmarck
authored
Docs: Remove -ignore deprecated (#879)
* remove: ignore depreacted * change from cloud_api_key to cloud_stack_api_key * update URL * update URL
1 parent 6ad5496 commit 139a2d8

14 files changed

+338
-5
lines changed

‎docs/data-sources/oncall_action.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "grafana_oncall_action Data Source - terraform-provider-grafana"
4+
subcategory: "OnCall"
5+
description: |-
6+
Note: This data source is going to be deprecated, please use outgoing webhook data source instead.
7+
* HTTP API https://grafana.com/docs/oncall/latest/oncall-api-reference/outgoing_webhooks/
8+
|> Deprecated: Use the grafana_oncall_outgoing_webhook data source instead.
9+
---
10+
11+
# grafana_oncall_action (Data Source)
12+
13+
**Note:** This data source is going to be deprecated, please use outgoing webhook data source instead.
14+
* [HTTP API](https://grafana.com/docs/oncall/latest/oncall-api-reference/outgoing_webhooks/)
15+
16+
|> Deprecated: Use the `grafana_oncall_outgoing_webhook` data source instead.
17+
18+
19+
20+
<!-- schema generated by tfplugindocs -->
21+
## Schema
22+
23+
### Required
24+
25+
- `name` (String) The action name.
26+
27+
### Read-Only
28+
29+
- `id` (String) The ID of this resource.
30+
31+

‎docs/resources/alert_notification.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "grafana_alert_notification Resource - terraform-provider-grafana"
4+
subcategory: "Deprecated"
5+
description: |-
6+
This resource is used to configure the legacy alerting system which has been replaced by the unified alerting system https://grafana.com/docs/grafana/latest/alerting/ in Grafana 9+. See resources in the Alerting section https://registry.terraform.io/providers/grafana/grafana/latest/docs for info on how to configure alerting with Terraform.
7+
* HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_notification_channels/
8+
|> Deprecated: This resource is used to configure the legacy alerting system which has been replaced by the unified alerting system https://grafana.com/docs/grafana/latest/alerting/ in Grafana 9+. See resources in the Alerting section https://registry.terraform.io/providers/grafana/grafana/latest/docs for info on how to configure alerting with Terraform.
9+
---
10+
11+
# grafana_alert_notification (Resource)
12+
13+
This resource is used to configure the legacy alerting system which has been replaced by the [unified alerting system](https://grafana.com/docs/grafana/latest/alerting/) in Grafana 9+. See resources in the [Alerting section](https://registry.terraform.io/providers/grafana/grafana/latest/docs) for info on how to configure alerting with Terraform.
14+
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_notification_channels/)
15+
16+
|> Deprecated: This resource is used to configure the legacy alerting system which has been replaced by the [unified alerting system](https://grafana.com/docs/grafana/latest/alerting/) in Grafana 9+. See resources in the [Alerting section](https://registry.terraform.io/providers/grafana/grafana/latest/docs) for info on how to configure alerting with Terraform.
17+
18+
## Example Usage
19+
20+
```terraform
21+
resource "grafana_alert_notification" "email_someteam" {
22+
name = "Email that team"
23+
type = "email"
24+
is_default = false
25+
send_reminder = true
26+
frequency = "24h"
27+
28+
settings = {
29+
addresses = "[email protected];[email protected]"
30+
uploadImage = "false"
31+
}
32+
}
33+
```
34+
35+
<!-- schema generated by tfplugindocs -->
36+
## Schema
37+
38+
### Required
39+
40+
- `name` (String) The name of the alert notification channel.
41+
- `type` (String) The type of the alert notification channel.
42+
43+
### Optional
44+
45+
- `disable_resolve_message` (Boolean) Whether to disable sending resolve messages. Defaults to `false`.
46+
- `frequency` (String) Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``.
47+
- `is_default` (Boolean) Is this the default channel for all your alerts. Defaults to `false`.
48+
- `secure_settings` (Map of String, Sensitive) Additional secure settings, for full reference lookup [Grafana Supported Settings documentation](https://grafana.com/docs/grafana/latest/administration/provisioning/#supported-settings).
49+
- `send_reminder` (Boolean) Whether to send reminders for triggered alerts. Defaults to `false`.
50+
- `settings` (Map of String) Additional settings, for full reference see [Grafana HTTP API documentation](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_notification_channels/).
51+
- `uid` (String) Unique identifier. If unset, this will be automatically generated.
52+
53+
### Read-Only
54+
55+
- `id` (String) The ID of this resource.
56+
57+
## Import
58+
59+
Import is supported using the following syntax:
60+
61+
```shell
62+
terraform import grafana_alert_notification.alert_notification_name {{alert_notification_id}}
63+
```

‎docs/resources/api_key.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "grafana_api_key Resource - terraform-provider-grafana"
4+
subcategory: "Grafana OSS"
5+
description: |-
6+
Manages Grafana API Keys.
7+
HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/auth/
8+
!> Deprecated: please use grafana_service_account and grafana_service_account_token instead, see Migrate API keys to Grafana service accounts using Terraform https://grafana.com/docs/grafana/latest/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-terraform for more information.
9+
---
10+
11+
# grafana_api_key (Resource)
12+
13+
Manages Grafana API Keys.
14+
15+
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/auth/)
16+
17+
!> Deprecated: please use `grafana_service_account` and `grafana_service_account_token` instead, see [Migrate API keys to Grafana service accounts using Terraform](https://grafana.com/docs/grafana/latest/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-terraform) for more information.
18+
19+
## Example Usage
20+
21+
```terraform
22+
resource "grafana_api_key" "foo" {
23+
name = "key_foo"
24+
role = "Viewer"
25+
}
26+
27+
resource "grafana_api_key" "bar" {
28+
name = "key_bar"
29+
role = "Admin"
30+
seconds_to_live = 30
31+
}
32+
33+
34+
output "api_key_foo_key_only" {
35+
value = grafana_api_key.foo.key
36+
sensitive = true
37+
}
38+
39+
output "api_key_bar" {
40+
value = grafana_api_key.bar
41+
}
42+
```
43+
44+
<!-- schema generated by tfplugindocs -->
45+
## Schema
46+
47+
### Required
48+
49+
- `name` (String)
50+
- `role` (String)
51+
52+
### Optional
53+
54+
- `cloud_stack_slug` (String, Deprecated) Deprecated: Use `grafana_cloud_stack_service_account` and `grafana_cloud_stack_service_account_token` resources instead
55+
- `org_id` (String) The Organization ID. If not set, the Org ID defined in the provider block will be used.
56+
- `seconds_to_live` (Number)
57+
58+
### Read-Only
59+
60+
- `expiration` (String)
61+
- `id` (String) The ID of this resource.
62+
- `key` (String, Sensitive)
63+
64+

‎docs/resources/builtin_role_assignment.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "grafana_builtin_role_assignment Resource - terraform-provider-grafana"
4+
subcategory: "Grafana Enterprise"
5+
description: |-
6+
Note: This resource is going to be deprecated with Grafana 9.+, please use grafana_role https://registry.terraform.io/providers/grafana/grafana/latest/docs/resources/role instead.
7+
Note: This resource is available only with Grafana Enterprise 8.+.
8+
Official documentation https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/access_control/
9+
---
10+
11+
# grafana_builtin_role_assignment (Resource)
12+
13+
**Note:** This resource is going to be deprecated with Grafana 9.+, please use [grafana_role](https://registry.terraform.io/providers/grafana/grafana/latest/docs/resources/role) instead.
14+
**Note:** This resource is available only with Grafana Enterprise 8.+.
15+
16+
* [Official documentation](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/)
17+
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/access_control/)
18+
19+
## Example Usage
20+
21+
```terraform
22+
resource "grafana_builtin_role_assignment" "viewer" {
23+
builtin_role = "Viewer"
24+
roles {
25+
uid = "firstuid"
26+
global = false
27+
}
28+
roles {
29+
uid = "seconduid"
30+
global = true
31+
}
32+
}
33+
```
34+
35+
<!-- schema generated by tfplugindocs -->
36+
## Schema
37+
38+
### Required
39+
40+
- `builtin_role` (String) Organization roles (`Viewer`, `Editor`, `Admin`) or `Grafana Admin` to assign the roles to.
41+
- `roles` (Block Set, Min: 1) Fixed or custom roles which provide granular access for specific resources within Grafana. (see [below for nested schema](#nestedblock--roles))
42+
43+
### Read-Only
44+
45+
- `id` (String) The ID of this resource.
46+
47+
<a id="nestedblock--roles"></a>
48+
### Nested Schema for `roles`
49+
50+
Required:
51+
52+
- `uid` (String) Unique identifier of the role to assign to `builtin_role`.
53+
54+
Optional:
55+
56+
- `global` (Boolean) States whether the assignment is available across all organizations or not. Defaults to `false`.
57+
58+
## Import
59+
60+
Import is supported using the following syntax:
61+
62+
```shell
63+
terraform import grafana_builtin_role_assignment.builtin_role_name {{builtin_role_name}}
64+
```

‎docs/resources/cloud_api_key.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "grafana_cloud_api_key Resource - terraform-provider-grafana"
4+
subcategory: "Cloud"
5+
description: |-
6+
Manages a single API key on the Grafana Cloud portal (on the organization level)
7+
* API documentation https://grafana.com/docs/grafana-cloud/reference/cloud-api/#api-keys
8+
---
9+
10+
# grafana_cloud_api_key (Resource)
11+
12+
Manages a single API key on the Grafana Cloud portal (on the organization level)
13+
* [API documentation](https://grafana.com/docs/grafana-cloud/reference/cloud-api/#api-keys)
14+
15+
## Example Usage
16+
17+
```terraform
18+
resource "grafana_cloud_api_key" "test" {
19+
cloud_org_slug = "myorg"
20+
name = "my-key"
21+
role = "Admin"
22+
}
23+
```
24+
25+
<!-- schema generated by tfplugindocs -->
26+
## Schema
27+
28+
### Required
29+
30+
- `cloud_org_slug` (String) The slug of the organization to create the API key in. This is the same slug as the organization name in the URL.
31+
- `name` (String) Name of the API key.
32+
- `role` (String) Role of the API key. Should be one of [Viewer Editor Admin MetricsPublisher PluginPublisher]. See https://grafana.com/docs/grafana-cloud/api/#create-api-key for details.
33+
34+
### Read-Only
35+
36+
- `id` (String) The ID of this resource.
37+
- `key` (String, Sensitive) The generated API key.
38+
39+
## Import
40+
41+
Import is supported using the following syntax:
42+
43+
```shell
44+
terraform import grafana_cloud_api_key.resource_name "{{org-name}}-{{api_key_name}}"
45+
```

‎docs/resources/cloud_stack_api_key.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ description: |-
66
Manages API keys of a Grafana Cloud stack using the Cloud API
77
This can be used to bootstrap a management API key for a new stack
88
HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/auth/
9+
|> Deprecated: please use grafana_cloud_stack_service_account and grafana_cloud_stack_service_account_token instead, see https://grafana.com/docs/grafana/next/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-terraform.
910
---
1011

1112
# grafana_cloud_stack_api_key (Resource)
@@ -15,6 +16,8 @@ This can be used to bootstrap a management API key for a new stack
1516

1617
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/auth/)
1718

19+
|> Deprecated: please use `grafana_cloud_stack_service_account` and `grafana_cloud_stack_service_account_token` instead, see https://grafana.com/docs/grafana/next/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-terraform.
20+
1821

1922

2023
<!-- schema generated by tfplugindocs -->

‎docs/resources/team_preferences.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "grafana_team_preferences Resource - terraform-provider-grafana"
4+
subcategory: "Grafana OSS"
5+
description: |-
6+
Official documentation https://grafana.com/docs/grafana/latest/administration/organization-preferences/HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/team/
7+
|> Deprecated: Use the preferences attribute of the grafana_team resource instead.
8+
---
9+
10+
# grafana_team_preferences (Resource)
11+
12+
* [Official documentation](https://grafana.com/docs/grafana/latest/administration/organization-preferences/)
13+
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/team/)
14+
15+
|> Deprecated: Use the `preferences` attribute of the `grafana_team` resource instead.
16+
17+
## Example Usage
18+
19+
```terraform
20+
resource "grafana_dashboard" "metrics" {
21+
config_json = file("grafana-dashboard.json")
22+
}
23+
24+
resource "grafana_team" "team" {
25+
name = "Team Name"
26+
}
27+
28+
resource "grafana_team_preferences" "team_preferences" {
29+
team_id = grafana_team.team.id
30+
theme = "dark"
31+
timezone = "browser"
32+
home_dashboard_id = grafana_dashboard.metrics.dashboard_id
33+
}
34+
```
35+
36+
<!-- schema generated by tfplugindocs -->
37+
## Schema
38+
39+
### Required
40+
41+
- `team_id` (Number) The numeric team ID.
42+
43+
### Optional
44+
45+
- `home_dashboard_id` (Number) The numeric ID of the dashboard to display when a team member logs in.
46+
- `theme` (String) The theme for the specified team. Available themes are `light`, `dark`, or an empty string for the default theme.
47+
- `timezone` (String) The timezone for the specified team. Available values are `utc`, `browser`, or an empty string for the default.
48+
49+
### Read-Only
50+
51+
- `id` (String) The ID of this resource.
52+
53+

‎internal/resources/cloud/resource_cloud_api_key.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ func ResourceAPIKey() *schema.Resource {
2525
Importer: &schema.ResourceImporter{
2626
StateContext: schema.ImportStatePassthroughContext,
2727
},
28-
DeprecationMessage: "Use `grafana_cloud_stack_service_account` together with `grafana_cloud_stack_service_account_token` resources instead see https://grafana.com/docs/grafana/next/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-terraform",
2928

3029
Schema: map[string]*schema.Schema{
3130
"cloud_org_slug": {

‎internal/resources/cloud/resource_cloud_stack_api_key.go‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,14 @@ Manages API keys of a Grafana Cloud stack using the Cloud API
2121
This can be used to bootstrap a management API key for a new stack
2222
2323
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/auth/)
24+
25+
|> Deprecated: please use ` + "`grafana_cloud_stack_service_account`" + ` and ` + "`grafana_cloud_stack_service_account_token`" + ` instead, see https://grafana.com/docs/grafana/next/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-terraform.
2426
`,
2527

26-
CreateContext: resourceStackAPIKeyCreate,
27-
ReadContext: resourceStackAPIKeyRead,
28-
DeleteContext: resourceStackAPIKeyDelete,
28+
CreateContext: resourceStackAPIKeyCreate,
29+
ReadContext: resourceStackAPIKeyRead,
30+
DeleteContext: resourceStackAPIKeyDelete,
31+
DeprecationMessage: "Use `grafana_cloud_stack_service_account` together with `grafana_cloud_stack_service_account_token` resources instead see https://grafana.com/docs/grafana/next/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-terraform",
2932

3033
Schema: map[string]*schema.Schema{
3134
"stack_slug": {

‎internal/resources/grafana/resource_api_key.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ func ResourceAPIKey() *schema.Resource {
1818
Manages Grafana API Keys.
1919
2020
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/auth/)
21+
22+
!> Deprecated: please use ` + "`grafana_service_account`" + ` and ` + "`grafana_service_account_token`" + ` instead, see [Migrate API keys to Grafana service accounts using Terraform](https://grafana.com/docs/grafana/latest/administration/api-keys/#migrate-api-keys-to-grafana-service-accounts-using-terraform) for more information.
2123
`,
2224

2325
CreateContext: resourceAPIKeyCreate,

0 commit comments

Comments
 (0)