-
Notifications
You must be signed in to change notification settings - Fork 224
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Remove -ignore deprecated (#879)
* remove: ignore depreacted * change from cloud_api_key to cloud_stack_api_key * update URL * update URL
- Loading branch information
1 parent
6ad5496
commit 139a2d8
Showing
14 changed files
with
338 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "grafana_oncall_action Data Source - terraform-provider-grafana" | ||
subcategory: "OnCall" | ||
description: |- | ||
Note: This data source is going to be deprecated, please use outgoing webhook data source instead. | ||
* HTTP API https://grafana.com/docs/oncall/latest/oncall-api-reference/outgoing_webhooks/ | ||
|> Deprecated: Use the grafana_oncall_outgoing_webhook data source instead. | ||
--- | ||
|
||
# grafana_oncall_action (Data Source) | ||
|
||
**Note:** This data source is going to be deprecated, please use outgoing webhook data source instead. | ||
* [HTTP API](https://grafana.com/docs/oncall/latest/oncall-api-reference/outgoing_webhooks/) | ||
|
||
|> Deprecated: Use the `grafana_oncall_outgoing_webhook` data source instead. | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `name` (String) The action name. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "grafana_alert_notification Resource - terraform-provider-grafana" | ||
subcategory: "Deprecated" | ||
description: |- | ||
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. | ||
* HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_notification_channels/ | ||
|> 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. | ||
--- | ||
|
||
# grafana_alert_notification (Resource) | ||
|
||
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. | ||
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/alerting_notification_channels/) | ||
|
||
|> 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. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "grafana_alert_notification" "email_someteam" { | ||
name = "Email that team" | ||
type = "email" | ||
is_default = false | ||
send_reminder = true | ||
frequency = "24h" | ||
settings = { | ||
addresses = "[email protected];[email protected]" | ||
uploadImage = "false" | ||
} | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `name` (String) The name of the alert notification channel. | ||
- `type` (String) The type of the alert notification channel. | ||
|
||
### Optional | ||
|
||
- `disable_resolve_message` (Boolean) Whether to disable sending resolve messages. Defaults to `false`. | ||
- `frequency` (String) Frequency of alert reminders. Frequency must be set if reminders are enabled. Defaults to ``. | ||
- `is_default` (Boolean) Is this the default channel for all your alerts. Defaults to `false`. | ||
- `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). | ||
- `send_reminder` (Boolean) Whether to send reminders for triggered alerts. Defaults to `false`. | ||
- `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/). | ||
- `uid` (String) Unique identifier. If unset, this will be automatically generated. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
terraform import grafana_alert_notification.alert_notification_name {{alert_notification_id}} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "grafana_api_key Resource - terraform-provider-grafana" | ||
subcategory: "Grafana OSS" | ||
description: |- | ||
Manages Grafana API Keys. | ||
HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/auth/ | ||
!> 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. | ||
--- | ||
|
||
# grafana_api_key (Resource) | ||
|
||
Manages Grafana API Keys. | ||
|
||
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/auth/) | ||
|
||
!> 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. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "grafana_api_key" "foo" { | ||
name = "key_foo" | ||
role = "Viewer" | ||
} | ||
resource "grafana_api_key" "bar" { | ||
name = "key_bar" | ||
role = "Admin" | ||
seconds_to_live = 30 | ||
} | ||
output "api_key_foo_key_only" { | ||
value = grafana_api_key.foo.key | ||
sensitive = true | ||
} | ||
output "api_key_bar" { | ||
value = grafana_api_key.bar | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `name` (String) | ||
- `role` (String) | ||
|
||
### Optional | ||
|
||
- `cloud_stack_slug` (String, Deprecated) Deprecated: Use `grafana_cloud_stack_service_account` and `grafana_cloud_stack_service_account_token` resources instead | ||
- `org_id` (String) The Organization ID. If not set, the Org ID defined in the provider block will be used. | ||
- `seconds_to_live` (Number) | ||
|
||
### Read-Only | ||
|
||
- `expiration` (String) | ||
- `id` (String) The ID of this resource. | ||
- `key` (String, Sensitive) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "grafana_builtin_role_assignment Resource - terraform-provider-grafana" | ||
subcategory: "Grafana Enterprise" | ||
description: |- | ||
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. | ||
Note: This resource is available only with Grafana Enterprise 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/ | ||
--- | ||
|
||
# grafana_builtin_role_assignment (Resource) | ||
|
||
**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. | ||
**Note:** This resource is available only with Grafana Enterprise 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/) | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "grafana_builtin_role_assignment" "viewer" { | ||
builtin_role = "Viewer" | ||
roles { | ||
uid = "firstuid" | ||
global = false | ||
} | ||
roles { | ||
uid = "seconduid" | ||
global = true | ||
} | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `builtin_role` (String) Organization roles (`Viewer`, `Editor`, `Admin`) or `Grafana Admin` to assign the roles to. | ||
- `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)) | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
|
||
<a id="nestedblock--roles"></a> | ||
### Nested Schema for `roles` | ||
|
||
Required: | ||
|
||
- `uid` (String) Unique identifier of the role to assign to `builtin_role`. | ||
|
||
Optional: | ||
|
||
- `global` (Boolean) States whether the assignment is available across all organizations or not. Defaults to `false`. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
terraform import grafana_builtin_role_assignment.builtin_role_name {{builtin_role_name}} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "grafana_cloud_api_key Resource - terraform-provider-grafana" | ||
subcategory: "Cloud" | ||
description: |- | ||
Manages a single API key on the Grafana Cloud portal (on the organization level) | ||
* API documentation https://grafana.com/docs/grafana-cloud/reference/cloud-api/#api-keys | ||
--- | ||
|
||
# grafana_cloud_api_key (Resource) | ||
|
||
Manages a single API key on the Grafana Cloud portal (on the organization level) | ||
* [API documentation](https://grafana.com/docs/grafana-cloud/reference/cloud-api/#api-keys) | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "grafana_cloud_api_key" "test" { | ||
cloud_org_slug = "myorg" | ||
name = "my-key" | ||
role = "Admin" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `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. | ||
- `name` (String) Name of the API key. | ||
- `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. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
- `key` (String, Sensitive) The generated API key. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
terraform import grafana_cloud_api_key.resource_name "{{org-name}}-{{api_key_name}}" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "grafana_team_preferences Resource - terraform-provider-grafana" | ||
subcategory: "Grafana OSS" | ||
description: |- | ||
Official documentation https://grafana.com/docs/grafana/latest/administration/organization-preferences/HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/team/ | ||
|> Deprecated: Use the preferences attribute of the grafana_team resource instead. | ||
--- | ||
|
||
# grafana_team_preferences (Resource) | ||
|
||
* [Official documentation](https://grafana.com/docs/grafana/latest/administration/organization-preferences/) | ||
* [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/team/) | ||
|
||
|> Deprecated: Use the `preferences` attribute of the `grafana_team` resource instead. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "grafana_dashboard" "metrics" { | ||
config_json = file("grafana-dashboard.json") | ||
} | ||
resource "grafana_team" "team" { | ||
name = "Team Name" | ||
} | ||
resource "grafana_team_preferences" "team_preferences" { | ||
team_id = grafana_team.team.id | ||
theme = "dark" | ||
timezone = "browser" | ||
home_dashboard_id = grafana_dashboard.metrics.dashboard_id | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `team_id` (Number) The numeric team ID. | ||
|
||
### Optional | ||
|
||
- `home_dashboard_id` (Number) The numeric ID of the dashboard to display when a team member logs in. | ||
- `theme` (String) The theme for the specified team. Available themes are `light`, `dark`, or an empty string for the default theme. | ||
- `timezone` (String) The timezone for the specified team. Available values are `utc`, `browser`, or an empty string for the default. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.