Skip to content

Commit 6ed920d

Browse files
AlirezaKmAlirezaKm
authored
Merge pull request #3 from arvancloud/adding-docs
adding documentation for resources/data-sources.
2 parents 2112eae + 78281e7 commit 6ed920d

35 files changed

+1083
-0
lines changed

‎docs/data-sources/iaas_abrak.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_abrak Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_abrak (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) name of abrak
21+
- `region` (String) region code
22+
23+
### Read-Only
24+
25+
- `ha_enabled` (Boolean)
26+
- `id` (String) The ID of this resource.
27+
28+

‎docs/data-sources/iaas_image.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_image Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_image (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) name of image
21+
- `region` (String) region code
22+
- `type` (String) type of image
23+
24+
### Read-Only
25+
26+
- `id` (String) The ID of this resource.
27+
28+

‎docs/data-sources/iaas_network.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_network Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_network (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) name of network
21+
- `region` (String) region code
22+
23+
### Read-Only
24+
25+
- `id` (String) The ID of this resource.
26+
27+

‎docs/data-sources/iaas_options.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_options Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_options (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `region` (String) region code
21+
22+
### Read-Only
23+
24+
- `id` (String) The ID of this resource.
25+
- `network_id` (String) UUID of network
26+
27+

‎docs/data-sources/iaas_quota.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_quota Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_quota (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `region` (String) region code
21+
22+
### Read-Only
23+
24+
- `id` (String) The ID of this resource.
25+
- `max_image_meta` (Number) maximum image meta
26+
- `max_personality` (Number) maximum personality
27+
- `max_security_group_rules` (Number) maximum security group rules
28+
- `max_security_groups` (Number) maximum security groups
29+
- `max_server_group_members` (Number) maximum server group members
30+
- `max_server_groups` (Number) maximum server groups
31+
- `max_server_meta` (Number) maximum server meta
32+
- `max_total_cores` (Number) maximum CPU cores
33+
- `max_total_floating_ips` (Number) maximum floating ips
34+
- `max_total_instances` (Number) maximum instances
35+
- `max_total_keypairs` (Number) maximum key-pairs
36+
- `max_total_ram_size` (Number) maximum RAM size
37+
- `total_cores_used` (Number) total CPU cores used
38+
- `total_floating_ip_used` (Number) total floating ips used
39+
- `total_instances_used` (Number) total instances used
40+
- `total_ram_used` (Number) total RAM used
41+
- `total_security_groups_used` (Number) total security groups used
42+
- `total_server_groups_used` (Number) total server groups used
43+
44+

‎docs/data-sources/iaas_security_group.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_security_group Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_security_group (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) name of security group
21+
- `region` (String) region code
22+
23+
### Read-Only
24+
25+
- `description` (String) description of security group
26+
- `id` (String) The ID of this resource.
27+
- `real_name` (String) real name of security group
28+
- `rules` (List of Object) real name of security group (see [below for nested schema](#nestedatt--rules))
29+
30+
<a id="nestedatt--rules"></a>
31+
### Nested Schema for `rules`
32+
33+
Read-Only:
34+
35+
- `description` (String)
36+
- `direction` (String)
37+
- `ip` (String)
38+
- `protocol` (String)
39+
40+

‎docs/data-sources/iaas_sshkey.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_sshkey Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_sshkey (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) name of ssh-key
21+
- `region` (String) region code
22+
23+
### Read-Only
24+
25+
- `created_at` (String) creation time of ssh-key
26+
- `fingerprint` (String) fingerprint of ssh-key
27+
- `id` (String) The ID of this resource.
28+
- `public_key` (String) public key
29+
30+

‎docs/data-sources/iaas_tag.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_tag Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_tag (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) name of tag
21+
- `region` (String) region code
22+
23+
### Read-Only
24+
25+
- `id` (String) The ID of this resource.
26+
27+

‎docs/data-sources/iaas_volume.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan_iaas_volume Data Source - terraform-provider-arvan"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan_iaas_volume (Data Source)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) name of volume
21+
- `region` (String) region code
22+
23+
### Read-Only
24+
25+
- `bootable` (String) volume is bootable or not
26+
- `created_at` (String) created_at of volume
27+
- `description` (String) description of volume
28+
- `id` (String) The ID of this resource.
29+
- `size` (Number) size of volume
30+
- `snapshot_id` (String) snapshot ID of volume
31+
- `source_volume_id` (String) source id of volume
32+
- `status` (String) status of volume
33+
- `volume_type_name` (String) type of volume
34+
35+

‎docs/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "arvan Provider"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# arvan Provider
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `api_key` (String, Sensitive) The API Key for API operations. You can retrieve this
21+
from the ArvanCloud dashboard.

0 commit comments

Comments
 (0)