Skip to content

Commit d94f01f

Browse files
aliottaaliotta
authored
fix example docs (#209)
1 parent f82f779 commit d94f01f

File tree

3 files changed

+77
-77
lines changed

3 files changed

+77
-77
lines changed

‎docs/resources/cluster.md

+38-38
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Cluster resource. If creating multiple clusters, add a delay between each cluste
1515
```terraform
1616
resource "astro_cluster" "aws_example" {
1717
type = "DEDICATED"
18-
name = "LIOTTA"
18+
name = "my first aws cluster"
1919
region = "us-east-1"
2020
cloud_provider = "AWS"
2121
vpc_subnet_range = "172.20.0.0/20"
@@ -27,43 +27,43 @@ resource "astro_cluster" "aws_example" {
2727
}
2828
}
2929
30-
# resource "astro_cluster" "azure_example" {
31-
# type = "DEDICATED"
32-
# name = "my first azure cluster"
33-
# region = "westus2"
34-
# cloud_provider = "AZURE"
35-
# vpc_subnet_range = "172.20.0.0/19"
36-
# workspace_ids = ["clv4wcf6f003u01m3zp7gsvzg"]
37-
# }
38-
#
39-
# resource "astro_cluster" "gcp_example" {
40-
# type = "DEDICATED"
41-
# name = "my first gcp cluster"
42-
# region = "us-central1"
43-
# cloud_provider = "GCP"
44-
# pod_subnet_range = "172.21.0.0/19"
45-
# service_peering_range = "172.23.0.0/20"
46-
# service_subnet_range = "172.22.0.0/22"
47-
# vpc_subnet_range = "172.20.0.0/22"
48-
# workspace_ids = []
49-
# }
50-
#
51-
# // Import an existing cluster
52-
# import {
53-
# id = "clozc036j01to01jrlgvuf98d" // ID of the existing cluster
54-
# to = astro_cluster.imported_cluster
55-
# }
56-
# resource "astro_cluster" "imported_cluster" {
57-
# type = "DEDICATED"
58-
# name = "an existing cluster to import"
59-
# region = "us-central1"
60-
# cloud_provider = "GCP"
61-
# pod_subnet_range = "172.21.0.0/19"
62-
# service_peering_range = "172.23.0.0/20"
63-
# service_subnet_range = "172.22.0.0/22"
64-
# vpc_subnet_range = "172.20.0.0/22"
65-
# workspace_ids = []
66-
# }
30+
resource "astro_cluster" "azure_example" {
31+
type = "DEDICATED"
32+
name = "my first azure cluster"
33+
region = "westus2"
34+
cloud_provider = "AZURE"
35+
vpc_subnet_range = "172.20.0.0/19"
36+
workspace_ids = ["clv4wcf6f003u01m3zp7gsvzg"]
37+
}
38+
39+
resource "astro_cluster" "gcp_example" {
40+
type = "DEDICATED"
41+
name = "my first gcp cluster"
42+
region = "us-central1"
43+
cloud_provider = "GCP"
44+
pod_subnet_range = "172.21.0.0/19"
45+
service_peering_range = "172.23.0.0/20"
46+
service_subnet_range = "172.22.0.0/22"
47+
vpc_subnet_range = "172.20.0.0/22"
48+
workspace_ids = []
49+
}
50+
51+
// Import an existing cluster
52+
import {
53+
id = "clozc036j01to01jrlgvuf98d" // ID of the existing cluster
54+
to = astro_cluster.imported_cluster
55+
}
56+
resource "astro_cluster" "imported_cluster" {
57+
type = "DEDICATED"
58+
name = "an existing cluster to import"
59+
region = "us-central1"
60+
cloud_provider = "GCP"
61+
pod_subnet_range = "172.21.0.0/19"
62+
service_peering_range = "172.23.0.0/20"
63+
service_subnet_range = "172.22.0.0/22"
64+
vpc_subnet_range = "172.20.0.0/22"
65+
workspace_ids = []
66+
}
6767
```
6868

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

‎examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This directory contains examples that are mostly used for documentation, but can
44

55
The document generation tool looks for files in the following locations by default. All other *.tf files besides the ones mentioned below are ignored by the documentation tool. This is useful for creating examples that can run and/or ar testable even if some parts are not relevant for the documentation.
66

7-
* **provider/provider.tf**: example file for the provider index page
7+
* **provider/provider.tf**: example files for the provider index page
88
* **data-sources/`full data source name`/data-source.tf**: example file for the named data source page
99
* **resources/`full resource name`/resource.tf**: example file for the named data source page
1010
* **scenarios**: directory containing standard Astro scenarios

‎examples/resources/astro_cluster/resource.tf

+38-38
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
resource "astro_cluster" "aws_example" {
22
type = "DEDICATED"
3-
name = "LIOTTA"
3+
name = "my first aws cluster"
44
region = "us-east-1"
55
cloud_provider = "AWS"
66
vpc_subnet_range = "172.20.0.0/20"
@@ -12,40 +12,40 @@ resource "astro_cluster" "aws_example" {
1212
}
1313
}
1414

15-
# resource "astro_cluster" "azure_example" {
16-
# type = "DEDICATED"
17-
# name = "my first azure cluster"
18-
# region = "westus2"
19-
# cloud_provider = "AZURE"
20-
# vpc_subnet_range = "172.20.0.0/19"
21-
# workspace_ids = ["clv4wcf6f003u01m3zp7gsvzg"]
22-
# }
23-
#
24-
# resource "astro_cluster" "gcp_example" {
25-
# type = "DEDICATED"
26-
# name = "my first gcp cluster"
27-
# region = "us-central1"
28-
# cloud_provider = "GCP"
29-
# pod_subnet_range = "172.21.0.0/19"
30-
# service_peering_range = "172.23.0.0/20"
31-
# service_subnet_range = "172.22.0.0/22"
32-
# vpc_subnet_range = "172.20.0.0/22"
33-
# workspace_ids = []
34-
# }
35-
#
36-
# // Import an existing cluster
37-
# import {
38-
# id = "clozc036j01to01jrlgvuf98d" // ID of the existing cluster
39-
# to = astro_cluster.imported_cluster
40-
# }
41-
# resource "astro_cluster" "imported_cluster" {
42-
# type = "DEDICATED"
43-
# name = "an existing cluster to import"
44-
# region = "us-central1"
45-
# cloud_provider = "GCP"
46-
# pod_subnet_range = "172.21.0.0/19"
47-
# service_peering_range = "172.23.0.0/20"
48-
# service_subnet_range = "172.22.0.0/22"
49-
# vpc_subnet_range = "172.20.0.0/22"
50-
# workspace_ids = []
51-
# }
15+
resource "astro_cluster" "azure_example" {
16+
type = "DEDICATED"
17+
name = "my first azure cluster"
18+
region = "westus2"
19+
cloud_provider = "AZURE"
20+
vpc_subnet_range = "172.20.0.0/19"
21+
workspace_ids = ["clv4wcf6f003u01m3zp7gsvzg"]
22+
}
23+
24+
resource "astro_cluster" "gcp_example" {
25+
type = "DEDICATED"
26+
name = "my first gcp cluster"
27+
region = "us-central1"
28+
cloud_provider = "GCP"
29+
pod_subnet_range = "172.21.0.0/19"
30+
service_peering_range = "172.23.0.0/20"
31+
service_subnet_range = "172.22.0.0/22"
32+
vpc_subnet_range = "172.20.0.0/22"
33+
workspace_ids = []
34+
}
35+
36+
// Import an existing cluster
37+
import {
38+
id = "clozc036j01to01jrlgvuf98d" // ID of the existing cluster
39+
to = astro_cluster.imported_cluster
40+
}
41+
resource "astro_cluster" "imported_cluster" {
42+
type = "DEDICATED"
43+
name = "an existing cluster to import"
44+
region = "us-central1"
45+
cloud_provider = "GCP"
46+
pod_subnet_range = "172.21.0.0/19"
47+
service_peering_range = "172.23.0.0/20"
48+
service_subnet_range = "172.22.0.0/22"
49+
vpc_subnet_range = "172.20.0.0/22"
50+
workspace_ids = []
51+
}

0 commit comments

Comments
 (0)