Skip to content

Commit 25d9e00

Browse files
jremy42jremy42
committed
feat(datawarehouse): add documentation templates and generated docs for deployment, database and user resources
1 parent 7dc697c commit 25d9e00

File tree

10 files changed

+427
-12
lines changed

10 files changed

+427
-12
lines changed

‎docs/resources/datawarehouse_database.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
subcategory: "Data Warehouse"
3+
page_title: "Scaleway: scaleway_datawarehouse_database"
4+
---
5+
6+
# Resource: scaleway_datawarehouse_database
7+
8+
Creates and manages Scaleway Data Warehouse databases within a deployment.
9+
For more information refer to the [product documentation](https://www.scaleway.com/en/docs/data-warehouse/).
10+
11+
## Example Usage
12+
13+
### Basic
14+
15+
```terraform
16+
resource "scaleway_datawarehouse_deployment" "main" {
17+
name = "my-datawarehouse"
18+
version = "v25"
19+
replica_count = 1
20+
cpu_min = 2
21+
cpu_max = 4
22+
ram_per_cpu = 4
23+
password = "thiZ_is_v&ry_s3cret"
24+
}
25+
26+
resource "scaleway_datawarehouse_database" "main" {
27+
deployment_id = scaleway_datawarehouse_deployment.main.id
28+
name = "my_database"
29+
}
30+
```
31+
32+
## Argument Reference
33+
34+
The following arguments are supported:
35+
36+
- `deployment_id` - (Required) ID of the Data Warehouse deployment to which this database belongs.
37+
- `name` - (Required) Name of the database.
38+
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the database should be created.
39+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the database is associated with.
40+
41+
## Attributes Reference
42+
43+
In addition to all arguments above, the following attributes are exported:
44+
45+
- `id` - The ID of the database (format: `{region}/{deployment_id}/{name}`).
46+
- `size` - Size of the database in GB.
47+
48+
## Import
49+
50+
Data Warehouse databases can be imported using the `{region}/{deployment_id}/{name}`, e.g.
51+
52+
```bash
53+
terraform import scaleway_datawarehouse_database.main fr-par/11111111-1111-1111-1111-111111111111/my_database
54+
```
55+

‎docs/resources/datawarehouse_deployment.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
subcategory: "Data Warehouse"
3+
page_title: "Scaleway: scaleway_datawarehouse_deployment"
4+
---
5+
6+
# Resource: scaleway_datawarehouse_deployment
7+
8+
Creates and manages Scaleway Data Warehouse deployments.
9+
For more information refer to the [product documentation](https://www.scaleway.com/en/docs/data-warehouse/).
10+
11+
## Example Usage
12+
13+
### Basic
14+
15+
```terraform
16+
resource "scaleway_datawarehouse_deployment" "main" {
17+
name = "my-datawarehouse"
18+
version = "v25"
19+
replica_count = 1
20+
cpu_min = 2
21+
cpu_max = 4
22+
ram_per_cpu = 4
23+
password = "thiZ_is_v&ry_s3cret"
24+
}
25+
```
26+
27+
### With Tags
28+
29+
```terraform
30+
resource "scaleway_datawarehouse_deployment" "main" {
31+
name = "my-datawarehouse"
32+
version = "v25"
33+
replica_count = 1
34+
cpu_min = 2
35+
cpu_max = 4
36+
ram_per_cpu = 4
37+
password = "thiZ_is_v&ry_s3cret"
38+
tags = ["production", "analytics"]
39+
}
40+
```
41+
42+
## Argument Reference
43+
44+
The following arguments are supported:
45+
46+
- `name` - (Required) Name of the Data Warehouse deployment.
47+
- `version` - (Required) ClickHouse version to use (e.g., "v25").
48+
- `replica_count` - (Required) Number of replicas.
49+
- `cpu_min` - (Required) Minimum CPU count.
50+
- `cpu_max` - (Required) Maximum CPU count.
51+
- `ram_per_cpu` - (Required) RAM per CPU in GB.
52+
- `password` - (Optional) Password for the first user of the deployment. If not specified, a random password will be generated.
53+
- `tags` - (Optional) List of tags to apply to the deployment.
54+
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the deployment should be created.
55+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the deployment is associated with.
56+
57+
~> **Important:** Private endpoints are not yet supported by the API. A public endpoint is always created.
58+
59+
~> **Note:** During the private beta phase, modifying `cpu_min`, `cpu_max`, and `replica_count` has no effect until the feature is launched in general availability.
60+
61+
## Attributes Reference
62+
63+
In addition to all arguments above, the following attributes are exported:
64+
65+
- `id` - The ID of the deployment.
66+
- `public_network` - Public endpoint information.
67+
- `id` - The ID of the public endpoint.
68+
- `dns_record` - DNS record for the public endpoint.
69+
- `protocol` - Service protocol (e.g., "tcp", "https", "mysql").
70+
- `port` - TCP port number for the public endpoint.
71+
72+
## Import
73+
74+
Data Warehouse deployments can be imported using the `{region}/{id}`, e.g.
75+
76+
```bash
77+
terraform import scaleway_datawarehouse_deployment.main fr-par/11111111-1111-1111-1111-111111111111
78+
```
79+

‎docs/resources/datawarehouse_user.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
subcategory: "Data Warehouse"
3+
page_title: "Scaleway: scaleway_datawarehouse_user"
4+
---
5+
6+
# Resource: scaleway_datawarehouse_user
7+
8+
Creates and manages Scaleway Data Warehouse users within a deployment.
9+
For more information refer to the [product documentation](https://www.scaleway.com/en/docs/data-warehouse/).
10+
11+
## Example Usage
12+
13+
### Basic
14+
15+
```terraform
16+
resource "scaleway_datawarehouse_deployment" "main" {
17+
name = "my-datawarehouse"
18+
version = "v25"
19+
replica_count = 1
20+
cpu_min = 2
21+
cpu_max = 4
22+
ram_per_cpu = 4
23+
password = "thiZ_is_v&ry_s3cret"
24+
}
25+
26+
resource "scaleway_datawarehouse_user" "main" {
27+
deployment_id = scaleway_datawarehouse_deployment.main.id
28+
name = "my_user"
29+
password = "user_password_123"
30+
}
31+
```
32+
33+
### Admin User
34+
35+
```terraform
36+
resource "scaleway_datawarehouse_deployment" "main" {
37+
name = "my-datawarehouse"
38+
version = "v25"
39+
replica_count = 1
40+
cpu_min = 2
41+
cpu_max = 4
42+
ram_per_cpu = 4
43+
password = "thiZ_is_v&ry_s3cret"
44+
}
45+
46+
resource "scaleway_datawarehouse_user" "admin" {
47+
deployment_id = scaleway_datawarehouse_deployment.main.id
48+
name = "admin_user"
49+
password = "admin_password_456"
50+
is_admin = true
51+
}
52+
```
53+
54+
## Argument Reference
55+
56+
The following arguments are supported:
57+
58+
- `deployment_id` - (Required) ID of the Data Warehouse deployment to which this user belongs.
59+
- `name` - (Required) Name of the ClickHouse user.
60+
- `password` - (Required) Password for the ClickHouse user.
61+
- `is_admin` - (Optional) Whether the user has administrator privileges. Defaults to `false`.
62+
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the user should be created.
63+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the user is associated with.
64+
65+
## Attributes Reference
66+
67+
In addition to all arguments above, the following attributes are exported:
68+
69+
- `id` - The ID of the user (format: `{region}/{deployment_id}/{name}`).
70+
71+
## Import
72+
73+
Data Warehouse users can be imported using the `{region}/{deployment_id}/{name}`, e.g.
74+
75+
```bash
76+
terraform import scaleway_datawarehouse_user.main fr-par/11111111-1111-1111-1111-111111111111/my_user
77+
```
78+

‎internal/services/datawarehouse/database_test.go‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ resource "scaleway_datawarehouse_deployment" "main" {
4545
cpu_max = 4
4646
ram_per_cpu = 4
4747
password = "password@1234567"
48-
public_network {}
4948
}
5049
5150
resource "scaleway_datawarehouse_database" "mydb" {

‎internal/services/datawarehouse/deployment.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,13 @@ func ResourceDeployment() *schema.Resource {
7474
Optional: true,
7575
Description: "Password for the first user of the deployment",
7676
},
77-
// Public endpoint (optional). If not specified, a public endpoint is created by default.
77+
// Public endpoint (computed). A public endpoint is always created by default.
7878
// Private endpoints are not yet supported by the API.
7979
"public_network": {
8080
Type: schema.TypeList,
81-
Optional: true,
8281
Computed: true,
8382
MaxItems: 1,
84-
Description: "Public endpoint configuration. If not specified, a public endpoint is created by default.",
83+
Description: "Public endpoint configuration. A public endpoint is created by default.",
8584
Elem: &schema.Resource{
8685
Schema: map[string]*schema.Schema{
8786
"id": {

‎internal/services/datawarehouse/deployment_test.go‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,6 @@ resource "scaleway_datawarehouse_deployment" "main" {
4343
cpu_max = 4
4444
ram_per_cpu = 4
4545
password = "password@1234567"
46-
47-
# Public endpoint is required
48-
public_network {}
4946
}
5047
`, latestVersion),
5148
Check: resource.ComposeTestCheckFunc(
@@ -63,7 +60,7 @@ resource "scaleway_datawarehouse_deployment" "main" {
6360
},
6461

6562
{
66-
// Update tags only; leave public_network untouched
63+
// Update tags only
6764
Config: fmt.Sprintf(`
6865
resource "scaleway_datawarehouse_deployment" "main" {
6966
name = "tf-test-deploy-basic"
@@ -74,8 +71,6 @@ resource "scaleway_datawarehouse_deployment" "main" {
7471
ram_per_cpu = 4
7572
tags = ["tag1", "tag2"]
7673
password = "password@1234567"
77-
78-
public_network {}
7974
}
8075
`, latestVersion),
8176
Check: resource.ComposeTestCheckFunc(

‎internal/services/datawarehouse/user_test.go‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ resource "scaleway_datawarehouse_deployment" "test_deploy" {
4444
cpu_max = 4
4545
ram_per_cpu = 4
4646
password = "password@1234567"
47-
public_network {}
4847
}
4948
5049
resource "scaleway_datawarehouse_user" "test_user" {
@@ -73,7 +72,6 @@ resource "scaleway_datawarehouse_deployment" "test_deploy" {
7372
cpu_max = 4
7473
ram_per_cpu = 4
7574
password = "password@1234567"
76-
public_network {}
7775
}
7876
7977
resource "scaleway_datawarehouse_user" "test_user" {

‎templates/resources/datawarehouse_database.md.tmpl‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
subcategory: "Data Warehouse"
3+
page_title: "Scaleway: scaleway_datawarehouse_database"
4+
---
5+
6+
# Resource: scaleway_datawarehouse_database
7+
8+
Creates and manages Scaleway Data Warehouse databases within a deployment.
9+
For more information refer to the [product documentation](https://www.scaleway.com/en/docs/data-warehouse/).
10+
11+
## Example Usage
12+
13+
### Basic
14+
15+
```terraform
16+
resource "scaleway_datawarehouse_deployment" "main" {
17+
name = "my-datawarehouse"
18+
version = "v25"
19+
replica_count = 1
20+
cpu_min = 2
21+
cpu_max = 4
22+
ram_per_cpu = 4
23+
password = "thiZ_is_v&ry_s3cret"
24+
}
25+
26+
resource "scaleway_datawarehouse_database" "main" {
27+
deployment_id = scaleway_datawarehouse_deployment.main.id
28+
name = "my_database"
29+
}
30+
```
31+
32+
## Argument Reference
33+
34+
The following arguments are supported:
35+
36+
- `deployment_id` - (Required) ID of the Data Warehouse deployment to which this database belongs.
37+
- `name` - (Required) Name of the database.
38+
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the database should be created.
39+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the database is associated with.
40+
41+
## Attributes Reference
42+
43+
In addition to all arguments above, the following attributes are exported:
44+
45+
- `id` - The ID of the database (format: `{region}/{deployment_id}/{name}`).
46+
- `size` - Size of the database in GB.
47+
48+
## Import
49+
50+
Data Warehouse databases can be imported using the `{region}/{deployment_id}/{name}`, e.g.
51+
52+
```bash
53+
terraform import scaleway_datawarehouse_database.main fr-par/11111111-1111-1111-1111-111111111111/my_database
54+
```
55+

0 commit comments

Comments
 (0)