Skip to content

Commit ecea888

Browse files
authored
Merge pull request #33 from shanye997/docExample
add doc examples for CBWP, CloudStorageGateway
2 parents e6434e8 + ca5c025 commit ecea888

File tree

33 files changed

+892
-0
lines changed

33 files changed

+892
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Introduction
3+
4+
This example is used to create a `alicloud_cloud_storage_gateway_express_sync` resource.
5+
6+
## Providers
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | n/a |
11+
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
12+
13+
## Resources
14+
15+
| Name | Type |
16+
|------|------|
17+
| [alicloud_cloud_storage_gateway_express_sync.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_express_sync) | resource |
18+
| [alicloud_cloud_storage_gateway_gateway.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway) | resource |
19+
| [alicloud_cloud_storage_gateway_gateway_cache_disk.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway_cache_disk) | resource |
20+
| [alicloud_cloud_storage_gateway_gateway_file_share.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway_file_share) | resource |
21+
| [alicloud_cloud_storage_gateway_storage_bundle.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_storage_bundle) | resource |
22+
| [alicloud_oss_bucket.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/oss_bucket) | resource |
23+
| [alicloud_vpc.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/vpc) | resource |
24+
| [alicloud_vswitch.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/vswitch) | resource |
25+
| [random_uuid.default](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource |
26+
| [alicloud_cloud_storage_gateway_stocks.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/data-sources/cloud_storage_gateway_stocks) | data source |
27+
| [alicloud_regions.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/data-sources/regions) | data source |
28+
29+
## Inputs
30+
31+
| Name | Description | Type | Default | Required |
32+
|------|-------------|------|---------|:--------:|
33+
| <a name="input_name"></a> [name](#input\_name) | n/a | `string` | `"tf-example"` | no |
34+
<!-- END_TF_DOCS -->
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
variable "name" {
2+
default = "tf-example"
3+
}
4+
5+
data "alicloud_regions" "default" {
6+
current = true
7+
}
8+
resource "random_uuid" "default" {
9+
}
10+
resource "alicloud_cloud_storage_gateway_storage_bundle" "default" {
11+
storage_bundle_name = substr("tf-example-${replace(random_uuid.default.result, "-", "")}", 0, 16)
12+
}
13+
14+
resource "alicloud_oss_bucket" "default" {
15+
bucket = substr("tf-example-${replace(random_uuid.default.result, "-", "")}", 0, 16)
16+
acl = "public-read-write"
17+
}
18+
19+
resource "alicloud_vpc" "default" {
20+
vpc_name = var.name
21+
cidr_block = "172.16.0.0/12"
22+
}
23+
data "alicloud_cloud_storage_gateway_stocks" "default" {
24+
gateway_class = "Standard"
25+
}
26+
resource "alicloud_vswitch" "default" {
27+
vpc_id = alicloud_vpc.default.id
28+
cidr_block = "172.16.0.0/21"
29+
zone_id = data.alicloud_cloud_storage_gateway_stocks.default.stocks.0.zone_id
30+
vswitch_name = var.name
31+
}
32+
33+
resource "alicloud_cloud_storage_gateway_gateway" "default" {
34+
gateway_name = var.name
35+
description = var.name
36+
gateway_class = "Standard"
37+
type = "File"
38+
payment_type = "PayAsYouGo"
39+
vswitch_id = alicloud_vswitch.default.id
40+
release_after_expiration = true
41+
public_network_bandwidth = 40
42+
storage_bundle_id = alicloud_cloud_storage_gateway_storage_bundle.default.id
43+
location = "Cloud"
44+
}
45+
46+
resource "alicloud_cloud_storage_gateway_gateway_cache_disk" "default" {
47+
cache_disk_category = "cloud_efficiency"
48+
gateway_id = alicloud_cloud_storage_gateway_gateway.default.id
49+
cache_disk_size_in_gb = 50
50+
}
51+
52+
resource "alicloud_cloud_storage_gateway_gateway_file_share" "default" {
53+
gateway_file_share_name = var.name
54+
gateway_id = alicloud_cloud_storage_gateway_gateway.default.id
55+
local_path = alicloud_cloud_storage_gateway_gateway_cache_disk.default.local_file_path
56+
oss_bucket_name = alicloud_oss_bucket.default.bucket
57+
oss_endpoint = alicloud_oss_bucket.default.extranet_endpoint
58+
protocol = "NFS"
59+
remote_sync = true
60+
polling_interval = 4500
61+
fe_limit = 0
62+
backend_limit = 0
63+
cache_mode = "Cache"
64+
squash = "none"
65+
lag_period = 5
66+
}
67+
68+
resource "alicloud_cloud_storage_gateway_express_sync" "default" {
69+
bucket_name = alicloud_cloud_storage_gateway_gateway_file_share.default.oss_bucket_name
70+
bucket_region = data.alicloud_regions.default.regions.0.id
71+
description = var.name
72+
express_sync_name = var.name
73+
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
terraform {
2+
required_providers {
3+
alicloud = {
4+
source = "aliyun/alicloud"
5+
}
6+
}
7+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Introduction
3+
4+
This example is used to create a `alicloud_cloud_storage_gateway_express_sync_share_attachment` resource.
5+
6+
## Providers
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | n/a |
11+
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
12+
13+
## Resources
14+
15+
| Name | Type |
16+
|------|------|
17+
| [alicloud_cloud_storage_gateway_express_sync.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_express_sync) | resource |
18+
| [alicloud_cloud_storage_gateway_express_sync_share_attachment.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_express_sync_share_attachment) | resource |
19+
| [alicloud_cloud_storage_gateway_gateway.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway) | resource |
20+
| [alicloud_cloud_storage_gateway_gateway_cache_disk.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway_cache_disk) | resource |
21+
| [alicloud_cloud_storage_gateway_gateway_file_share.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway_file_share) | resource |
22+
| [alicloud_cloud_storage_gateway_storage_bundle.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_storage_bundle) | resource |
23+
| [alicloud_oss_bucket.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/oss_bucket) | resource |
24+
| [alicloud_vpc.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/vpc) | resource |
25+
| [alicloud_vswitch.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/vswitch) | resource |
26+
| [random_uuid.default](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource |
27+
| [alicloud_cloud_storage_gateway_stocks.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/data-sources/cloud_storage_gateway_stocks) | data source |
28+
| [alicloud_regions.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/data-sources/regions) | data source |
29+
30+
## Inputs
31+
32+
| Name | Description | Type | Default | Required |
33+
|------|-------------|------|---------|:--------:|
34+
| <a name="input_name"></a> [name](#input\_name) | n/a | `string` | `"tf-example"` | no |
35+
<!-- END_TF_DOCS -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
variable "name" {
2+
default = "tf-example"
3+
}
4+
5+
data "alicloud_regions" "default" {
6+
current = true
7+
}
8+
resource "random_uuid" "default" {
9+
}
10+
resource "alicloud_cloud_storage_gateway_storage_bundle" "default" {
11+
storage_bundle_name = substr("tf-example-${replace(random_uuid.default.result, "-", "")}", 0, 16)
12+
}
13+
14+
resource "alicloud_oss_bucket" "default" {
15+
bucket = substr("tf-example-${replace(random_uuid.default.result, "-", "")}", 0, 16)
16+
acl = "public-read-write"
17+
}
18+
19+
resource "alicloud_vpc" "default" {
20+
vpc_name = var.name
21+
cidr_block = "172.16.0.0/12"
22+
}
23+
data "alicloud_cloud_storage_gateway_stocks" "default" {
24+
gateway_class = "Standard"
25+
}
26+
resource "alicloud_vswitch" "default" {
27+
vpc_id = alicloud_vpc.default.id
28+
cidr_block = "172.16.0.0/21"
29+
zone_id = data.alicloud_cloud_storage_gateway_stocks.default.stocks.0.zone_id
30+
vswitch_name = var.name
31+
}
32+
33+
resource "alicloud_cloud_storage_gateway_gateway" "default" {
34+
gateway_name = var.name
35+
description = var.name
36+
gateway_class = "Standard"
37+
type = "File"
38+
payment_type = "PayAsYouGo"
39+
vswitch_id = alicloud_vswitch.default.id
40+
release_after_expiration = true
41+
public_network_bandwidth = 40
42+
storage_bundle_id = alicloud_cloud_storage_gateway_storage_bundle.default.id
43+
location = "Cloud"
44+
}
45+
46+
resource "alicloud_cloud_storage_gateway_gateway_cache_disk" "default" {
47+
cache_disk_category = "cloud_efficiency"
48+
gateway_id = alicloud_cloud_storage_gateway_gateway.default.id
49+
cache_disk_size_in_gb = 50
50+
}
51+
52+
resource "alicloud_cloud_storage_gateway_gateway_file_share" "default" {
53+
gateway_file_share_name = var.name
54+
gateway_id = alicloud_cloud_storage_gateway_gateway.default.id
55+
local_path = alicloud_cloud_storage_gateway_gateway_cache_disk.default.local_file_path
56+
oss_bucket_name = alicloud_oss_bucket.default.bucket
57+
oss_endpoint = alicloud_oss_bucket.default.extranet_endpoint
58+
protocol = "NFS"
59+
remote_sync = true
60+
polling_interval = 4500
61+
fe_limit = 0
62+
backend_limit = 0
63+
cache_mode = "Cache"
64+
squash = "none"
65+
lag_period = 5
66+
}
67+
68+
resource "alicloud_cloud_storage_gateway_express_sync" "default" {
69+
bucket_name = alicloud_cloud_storage_gateway_gateway_file_share.default.oss_bucket_name
70+
bucket_region = data.alicloud_regions.default.regions.0.id
71+
description = var.name
72+
express_sync_name = var.name
73+
}
74+
75+
resource "alicloud_cloud_storage_gateway_express_sync_share_attachment" "default" {
76+
express_sync_id = alicloud_cloud_storage_gateway_express_sync.default.id
77+
gateway_id = alicloud_cloud_storage_gateway_gateway.default.id
78+
share_name = alicloud_cloud_storage_gateway_gateway_file_share.default.gateway_file_share_name
79+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
terraform {
2+
required_providers {
3+
alicloud = {
4+
source = "aliyun/alicloud"
5+
}
6+
}
7+
}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Introduction
3+
4+
This example is used to create a `alicloud_cloud_storage_gateway_gateway_block_volume` resource.
5+
6+
## Providers
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | n/a |
11+
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
12+
13+
## Resources
14+
15+
| Name | Type |
16+
|------|------|
17+
| [alicloud_cloud_storage_gateway_gateway.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway) | resource |
18+
| [alicloud_cloud_storage_gateway_gateway_block_volume.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway_block_volume) | resource |
19+
| [alicloud_cloud_storage_gateway_gateway_cache_disk.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway_cache_disk) | resource |
20+
| [alicloud_cloud_storage_gateway_storage_bundle.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_storage_bundle) | resource |
21+
| [alicloud_oss_bucket.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/oss_bucket) | resource |
22+
| [alicloud_vpc.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/vpc) | resource |
23+
| [alicloud_vswitch.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/vswitch) | resource |
24+
| [random_uuid.default](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource |
25+
| [alicloud_cloud_storage_gateway_stocks.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/data-sources/cloud_storage_gateway_stocks) | data source |
26+
27+
## Inputs
28+
29+
| Name | Description | Type | Default | Required |
30+
|------|-------------|------|---------|:--------:|
31+
| <a name="input_name"></a> [name](#input\_name) | n/a | `string` | `"tf-example"` | no |
32+
<!-- END_TF_DOCS -->
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
variable "name" {
2+
default = "tf-example"
3+
}
4+
5+
resource "random_uuid" "default" {
6+
}
7+
resource "alicloud_cloud_storage_gateway_storage_bundle" "default" {
8+
storage_bundle_name = substr("tf-example-${replace(random_uuid.default.result, "-", "")}", 0, 16)
9+
}
10+
11+
resource "alicloud_oss_bucket" "default" {
12+
bucket = substr("tf-example-${replace(random_uuid.default.result, "-", "")}", 0, 16)
13+
acl = "public-read-write"
14+
}
15+
16+
resource "alicloud_vpc" "default" {
17+
vpc_name = var.name
18+
cidr_block = "172.16.0.0/12"
19+
}
20+
data "alicloud_cloud_storage_gateway_stocks" "default" {
21+
gateway_class = "Standard"
22+
}
23+
resource "alicloud_vswitch" "default" {
24+
vpc_id = alicloud_vpc.default.id
25+
cidr_block = "172.16.0.0/21"
26+
zone_id = data.alicloud_cloud_storage_gateway_stocks.default.stocks.0.zone_id
27+
vswitch_name = var.name
28+
}
29+
30+
resource "alicloud_cloud_storage_gateway_gateway" "default" {
31+
gateway_name = var.name
32+
description = var.name
33+
gateway_class = "Standard"
34+
type = "Iscsi"
35+
payment_type = "PayAsYouGo"
36+
vswitch_id = alicloud_vswitch.default.id
37+
release_after_expiration = true
38+
public_network_bandwidth = 40
39+
storage_bundle_id = alicloud_cloud_storage_gateway_storage_bundle.default.id
40+
location = "Cloud"
41+
}
42+
43+
resource "alicloud_cloud_storage_gateway_gateway_cache_disk" "default" {
44+
cache_disk_category = "cloud_efficiency"
45+
gateway_id = alicloud_cloud_storage_gateway_gateway.default.id
46+
cache_disk_size_in_gb = 50
47+
}
48+
49+
resource "alicloud_cloud_storage_gateway_gateway_block_volume" "default" {
50+
cache_mode = "Cache"
51+
chap_enabled = false
52+
chunk_size = "8192"
53+
gateway_block_volume_name = "example"
54+
gateway_id = alicloud_cloud_storage_gateway_gateway.default.id
55+
local_path = alicloud_cloud_storage_gateway_gateway_cache_disk.default.local_file_path
56+
oss_bucket_name = alicloud_oss_bucket.default.bucket
57+
oss_bucket_ssl = true
58+
oss_endpoint = alicloud_oss_bucket.default.extranet_endpoint
59+
protocol = "iSCSI"
60+
size = 100
61+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
terraform {
2+
required_providers {
3+
alicloud = {
4+
source = "aliyun/alicloud"
5+
}
6+
}
7+
}
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Introduction
3+
4+
This example is used to create a `alicloud_cloud_storage_gateway_gateway_cache_disk` resource.
5+
6+
## Providers
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="provider_alicloud"></a> [alicloud](#provider\_alicloud) | n/a |
11+
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
12+
13+
## Resources
14+
15+
| Name | Type |
16+
|------|------|
17+
| [alicloud_cloud_storage_gateway_gateway.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway) | resource |
18+
| [alicloud_cloud_storage_gateway_gateway_cache_disk.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_gateway_cache_disk) | resource |
19+
| [alicloud_cloud_storage_gateway_storage_bundle.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/cloud_storage_gateway_storage_bundle) | resource |
20+
| [alicloud_vpc.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/vpc) | resource |
21+
| [alicloud_vswitch.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/resources/vswitch) | resource |
22+
| [random_uuid.default](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/uuid) | resource |
23+
| [alicloud_cloud_storage_gateway_stocks.default](https://registry.terraform.io/providers/aliyun/alicloud/latest/docs/data-sources/cloud_storage_gateway_stocks) | data source |
24+
25+
## Inputs
26+
27+
| Name | Description | Type | Default | Required |
28+
|------|-------------|------|---------|:--------:|
29+
| <a name="input_name"></a> [name](#input\_name) | n/a | `string` | `"tf-example"` | no |
30+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)