Skip to content

Commit fb272b2

Browse files
committed
docs(cockpit): mark scaleway_cockpit resource as deprecated and add migration guidance
1 parent d888258 commit fb272b2

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/resources/cockpit.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ page_title: "Scaleway: scaleway_cockpit"
55

66
# Resource: scaleway_cockpit
77

8+
~> **Important:** The resource `scaleway_cockpit` has been deprecated and will no longer be supported after January 1st, 2025. Instead, use the new specialized resources:
9+
10+
- `scaleway_cockpit_source` for managing data sources (metrics, logs, traces)
11+
- `scaleway_cockpit_alert_manager` for managing alert manager
12+
- `scaleway_cockpit_grafana_user` for managing Grafana users
13+
14+
For detailed migration instructions, see the [Cockpit Migration Guide](../guides/migration_guide_cockpit_plan.md).
15+
816
-> **Note:**
917
As of September 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
1018
If you have created customized dashboards with data for your Scaleway resources before April 2024, you will need to update your queries in Grafana, with the new regionalized [data sources](../resources/cockpit_source.md).
@@ -74,8 +82,12 @@ resource "grafana_folder" "test_folder" {
7482
- `plan` - (Deprecated) Name of the plan to use. Available plans are: free, premium, and custom.
7583
~> **Important:** The plan field is deprecated. Any modification or selection will have no effect.
7684

85+
~> **Warning:** This entire resource is deprecated and will be removed after January 1st, 2025. Please migrate to the new specialized resources as described in the [Cockpit Migration Guide](../guides/migration_guide_cockpit_plan.md).
86+
7787
## Attributes Reference
7888

89+
~> **Warning:** This entire resource is deprecated and will be removed after January 1st, 2025. All attributes below are deprecated and will no longer be available.
90+
7991
In addition to all arguments above, the following attributes are exported:
8092

8193
- `plan_id` - (Deprecated) The ID of the current pricing plan.
@@ -86,10 +98,20 @@ In addition to all arguments above, the following attributes are exported:
8698
- `grafana_url` - (Deprecated) URL for Grafana.
8799
- `traces_url` - (Deprecated) URL for [traces](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#traces) to retrieve in the [Data sources tab](https://console.scaleway.com/cockpit/dataSource) of the Scaleway console.
88100

101+
## Migration
102+
103+
This resource is deprecated and will be removed after January 1st, 2025. To migrate to the new infrastructure, please refer to the [Cockpit Migration Guide](../guides/migration_guide_cockpit_plan.md) which provides step-by-step instructions for transitioning to:
104+
105+
- `scaleway_cockpit_source` for managing data sources (metrics, logs, traces)
106+
- `scaleway_cockpit_alert_manager` for managing alert manager
107+
- `scaleway_cockpit_grafana_user` for managing Grafana users
108+
89109
## Import
90110

91111
This section explains how to import a Cockpit using its `{project_id}`.
92112

93113
```bash
94114
terraform import scaleway_cockpit.main 11111111-1111-1111-1111-111111111111
95115
```
116+
117+
~> **Note:** Import functionality will be removed when this resource is deprecated.

0 commit comments

Comments
 (0)