Skip to content

Commit 9ebbb1d

Browse files
poddmpoddm
committed
add documentation
1 parent 5516db9 commit 9ebbb1d

3 files changed

Lines changed: 292 additions & 0 deletions

File tree

‎website/docs/r/service_offering_constrained.html.markdown‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
page_title: "cloudstack_service_offering_constrained Resource"
3+
description: |-
4+
Provides a CloudStack Constrained Service Offering resource. This allows you to create and manage constrained compute offerings in CloudStack.
5+
---
6+
7+
# cloudstack_service_offering_constrained
8+
9+
Provides a CloudStack Constrained Service Offering resource. This resource allows you to create and manage service offerings with constrained CPU and memory parameters.
10+
11+
## Example Usage
12+
13+
```hcl
14+
resource "cloudstack_service_offering_constrained" "example" {
15+
display_text = "Example Constrained Offering"
16+
name = "example_constrained"
17+
18+
cpu_speed = 2500
19+
max_cpu_number = 10
20+
min_cpu_number = 2
21+
max_memory = 4096
22+
min_memory = 1024
23+
24+
host_tags = "tag1,tag2"
25+
network_rate = 1024
26+
deployment_planner = "UserDispersingPlanner"
27+
28+
dynamic_scaling_enabled = false
29+
is_volatile = false
30+
limit_cpu_use = false
31+
offer_ha = false
32+
zone_ids = ["zone-uuid"]
33+
34+
disk_offering {
35+
cache_mode = "none"
36+
disk_offering_strictness = true
37+
provisioning_type = "thin"
38+
storage_type = "local"
39+
}
40+
}
41+
```
42+
43+
## Argument Reference
44+
45+
The following arguments are supported:
46+
47+
- `display_text` (String, Required) - The display text of the service offering.
48+
- `name` (String, Required) - The name of the service offering.
49+
- `cpu_speed` (Int, Required) - CPU speed in MHz.
50+
- `max_cpu_number` (Int, Required) - Maximum number of CPUs.
51+
- `min_cpu_number` (Int, Required) - Minimum number of CPUs.
52+
- `max_memory` (Int, Required) - Maximum memory in MB.
53+
- `min_memory` (Int, Required) - Minimum memory in MB.
54+
- `deployment_planner` (String, Optional) - The deployment planner for the service offering.
55+
- `disk_offering_id` (String, Optional) - The ID of the disk offering.
56+
- `domain_ids` (Set of String, Optional) - The ID(s) of the containing domain(s), null for public offerings.
57+
- `dynamic_scaling_enabled` (Bool, Optional, Default: false) - Enable dynamic scaling of the service offering.
58+
- `host_tags` (String, Optional) - The host tag for this service offering.
59+
- `is_volatile` (Bool, Optional, Default: false) - Service offering is volatile.
60+
- `limit_cpu_use` (Bool, Optional, Default: false) - Restrict the CPU usage to committed service offering.
61+
- `network_rate` (Int, Optional) - Data transfer rate in megabits per second.
62+
- `offer_ha` (Bool, Optional, Default: false) - Enable HA for the service offering.
63+
- `zone_ids` (Set of String, Optional) - The ID(s) of the zone(s).
64+
65+
### Nested Blocks
66+
67+
#### `disk_offering` (Block, Optional)
68+
69+
- `cache_mode` (String, Required) - The cache mode to use for this disk offering. One of `none`, `writeback`, or `writethrough`.
70+
- `disk_offering_strictness` (Bool, Required) - True/False to indicate the strictness of the disk offering association with the compute offering.
71+
- `provisioning_type` (String, Required) - Provisioning type used to create volumes. Valid values are `thin`, `sparse`, `fat`.
72+
- `root_disk_size` (Int, Optional) - The root disk size in GB.
73+
- `storage_type` (String, Required) - The storage type of the service offering. Values are `local` and `shared`.
74+
- `storage_tags` (String, Optional) - The tags for the service offering.
75+
76+
#### `disk_hypervisor` (Block, Optional)
77+
78+
- `bytes_read_rate` (Int, Required) - IO requests read rate of the disk offering.
79+
- `bytes_read_rate_max` (Int, Required) - Burst requests read rate of the disk offering.
80+
- `bytes_read_rate_max_length` (Int, Required) - Length (in seconds) of the burst.
81+
- `bytes_write_rate` (Int, Required) - IO requests write rate of the disk offering.
82+
- `bytes_write_rate_max` (Int, Required) - Burst IO requests write rate of the disk offering.
83+
- `bytes_write_rate_max_length` (Int, Required) - Length (in seconds) of the burst.
84+
85+
#### `disk_storage` (Block, Optional)
86+
87+
- `customized_iops` (Bool, Optional) - True if disk offering uses custom IOPS, false otherwise.
88+
- `hypervisor_snapshot_reserve` (Int, Optional) - Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware).
89+
- `max_iops` (Int, Optional) - Max IOPS of the compute offering.
90+
- `min_iops` (Int, Optional) - Min IOPS of the compute offering.
91+
92+
## Attributes Reference
93+
94+
In addition to the arguments above, the following attributes are exported:
95+
96+
- `id` - The UUID of the service offering.

‎website/docs/r/service_offering_fixed.html.markdown‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
page_title: "cloudstack_service_offering_fixed Resource"
3+
sidebar_current: terraform-resource-service_offering_fixed
4+
description: |-
5+
Provides a CloudStack Service Offering (Fixed) resource. This resource allows you to create and manage fixed compute service offerings in CloudStack.
6+
---
7+
8+
# cloudstack_service_offering_fixed
9+
10+
Provides a CloudStack Service Offering (Fixed) resource. This resource allows you to create and manage fixed compute service offerings in CloudStack.
11+
12+
## Example Usage
13+
14+
```hcl
15+
resource "cloudstack_service_offering_fixed" "fixed1" {
16+
name = "fixed1"
17+
display_text = "fixed1"
18+
cpu_number = 2
19+
cpu_speed = 2000
20+
memory = 4096
21+
# Optional common attributes:
22+
# deployment_planner = "FirstFit"
23+
# disk_offering_id = "..."
24+
# domain_ids = ["...", "..."]
25+
# dynamic_scaling_enabled = false
26+
# host_tags = "..."
27+
# is_volatile = false
28+
# limit_cpu_use = false
29+
# network_rate = 1000
30+
# offer_ha = false
31+
# zone_ids = ["..."]
32+
# disk_offering { ... }
33+
# disk_hypervisor { ... }
34+
# disk_storage { ... }
35+
}
36+
```
37+
38+
## Argument Reference
39+
40+
The following arguments are supported:
41+
42+
- `name` (Required) - The name of the service offering.
43+
- `display_text` (Required) - The display text of the service offering.
44+
- `cpu_number` (Required) - Number of CPU cores.
45+
- `cpu_speed` (Required) - The CPU speed in MHz (not applicable to KVM).
46+
- `memory` (Required) - The total memory in MB.
47+
48+
### Common Attributes
49+
50+
- `deployment_planner` (Optional) - The deployment planner for the service offering.
51+
- `disk_offering_id` (Optional) - The ID of the disk offering.
52+
- `domain_ids` (Optional) - The ID(s) of the containing domain(s), null for public offerings.
53+
- `dynamic_scaling_enabled` (Optional, Computed) - Enable dynamic scaling of the service offering. Defaults to `false`.
54+
- `host_tags` (Optional) - The host tag for this service offering.
55+
- `id` (Computed) - The UUID of the service offering.
56+
- `is_volatile` (Optional, Computed) - Service offering is volatile. Defaults to `false`.
57+
- `limit_cpu_use` (Optional, Computed) - Restrict the CPU usage to committed service offering. Defaults to `false`.
58+
- `network_rate` (Optional) - Data transfer rate in megabits per second.
59+
- `offer_ha` (Optional, Computed) - The HA for the service offering. Defaults to `false`.
60+
- `zone_ids` (Optional) - The ID(s) of the zone(s).
61+
62+
### Nested Blocks
63+
64+
#### `disk_offering` (Optional)
65+
66+
- `cache_mode` (Required) - The cache mode to use for this disk offering. One of `none`, `writeback`, or `writethrough`.
67+
- `disk_offering_strictness` (Required) - True/False to indicate the strictness of the disk offering association.
68+
- `provisioning_type` (Required) - Provisioning type used to create volumes. Valid values: `thin`, `sparse`, `fat`.
69+
- `root_disk_size` (Optional) - The root disk size in GB.
70+
- `storage_type` (Required) - The storage type. Values: `local`, `shared`.
71+
- `storage_tags` (Optional) - The tags for the service offering.
72+
73+
#### `disk_hypervisor` (Optional)
74+
75+
- `bytes_read_rate` (Required) - IO requests read rate.
76+
- `bytes_read_rate_max` (Required) - Burst requests read rate.
77+
- `bytes_read_rate_max_length` (Required) - Length (in seconds) of the burst.
78+
- `bytes_write_rate` (Required) - IO requests write rate.
79+
- `bytes_write_rate_max` (Required) - Burst IO requests write rate.
80+
- `bytes_write_rate_max_length` (Required) - Length (in seconds) of the burst.
81+
82+
#### `disk_storage` (Optional)
83+
84+
- `customized_iops` (Optional) - True if disk offering uses custom IOPS.
85+
- `hypervisor_snapshot_reserve` (Optional) - Hypervisor snapshot reserve space as a percent of a volume.
86+
- `max_iops` (Optional) - Max IOPS of the compute offering.
87+
- `min_iops` (Optional) - Min IOPS of the compute offering.
88+
89+
## Attributes Reference
90+
91+
In addition to the arguments above, the following attributes are exported:
92+
93+
- `id` - The ID of the service offering.
94+
95+
## Import
96+
97+
Service offerings can be imported using the ID:
98+
99+
```sh
100+
terraform import cloudstack_service_offering_fixed.example <id>
101+
```

‎website/docs/r/service_offering_unconstrained.html.markdown‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
page_title: "cloudstack_service_offering_unconstrained Resource"
3+
sidebar_current: terraform-resource-service_offering_unconstrained
4+
description: |-
5+
Provides a CloudStack Service Offering (Unconstrained) resource. This resource allows you to create and manage unconstrained compute service offerings in CloudStack.
6+
---
7+
8+
# cloudstack_service_offering_unconstrained
9+
10+
Provides a CloudStack Service Offering (Unconstrained) resource. This resource allows you to create and manage unconstrained compute service offerings in CloudStack.
11+
12+
## Example Usage
13+
14+
```hcl
15+
resource "cloudstack_service_offering_unconstrained" "unconstrained1" {
16+
name = "unconstrained1"
17+
display_text = "unconstrained1"
18+
# Optional common attributes:
19+
# deployment_planner = "FirstFit"
20+
# disk_offering_id = "..."
21+
# domain_ids = ["...", "..."]
22+
# dynamic_scaling_enabled = false
23+
# host_tags = "..."
24+
# is_volatile = false
25+
# limit_cpu_use = false
26+
# network_rate = 1000
27+
# offer_ha = false
28+
# zone_ids = ["..."]
29+
# disk_offering { ... }
30+
# disk_hypervisor { ... }
31+
# disk_storage { ... }
32+
}
33+
```
34+
35+
## Argument Reference
36+
37+
The following arguments are supported:
38+
39+
- `name` (Required) - The name of the service offering.
40+
- `display_text` (Required) - The display text of the service offering.
41+
42+
### Common Attributes
43+
44+
- `deployment_planner` (Optional) - The deployment planner for the service offering.
45+
- `disk_offering_id` (Optional) - The ID of the disk offering.
46+
- `domain_ids` (Optional) - The ID(s) of the containing domain(s), null for public offerings.
47+
- `dynamic_scaling_enabled` (Optional, Computed) - Enable dynamic scaling of the service offering. Defaults to `false`.
48+
- `host_tags` (Optional) - The host tag for this service offering.
49+
- `id` (Computed) - The UUID of the service offering.
50+
- `is_volatile` (Optional, Computed) - Service offering is volatile. Defaults to `false`.
51+
- `limit_cpu_use` (Optional, Computed) - Restrict the CPU usage to committed service offering. Defaults to `false`.
52+
- `network_rate` (Optional) - Data transfer rate in megabits per second.
53+
- `offer_ha` (Optional, Computed) - The HA for the service offering. Defaults to `false`.
54+
- `zone_ids` (Optional) - The ID(s) of the zone(s).
55+
56+
### Nested Blocks
57+
58+
#### `disk_offering` (Optional)
59+
60+
- `cache_mode` (Required) - The cache mode to use for this disk offering. One of `none`, `writeback`, or `writethrough`.
61+
- `disk_offering_strictness` (Required) - True/False to indicate the strictness of the disk offering association.
62+
- `provisioning_type` (Required) - Provisioning type used to create volumes. Valid values: `thin`, `sparse`, `fat`.
63+
- `root_disk_size` (Optional) - The root disk size in GB.
64+
- `storage_type` (Required) - The storage type. Values: `local`, `shared`.
65+
- `storage_tags` (Optional) - The tags for the service offering.
66+
67+
#### `disk_hypervisor` (Optional)
68+
69+
- `bytes_read_rate` (Required) - IO requests read rate.
70+
- `bytes_read_rate_max` (Required) - Burst requests read rate.
71+
- `bytes_read_rate_max_length` (Required) - Length (in seconds) of the burst.
72+
- `bytes_write_rate` (Required) - IO requests write rate.
73+
- `bytes_write_rate_max` (Required) - Burst IO requests write rate.
74+
- `bytes_write_rate_max_length` (Required) - Length (in seconds) of the burst.
75+
76+
#### `disk_storage` (Optional)
77+
78+
- `customized_iops` (Optional) - True if disk offering uses custom IOPS.
79+
- `hypervisor_snapshot_reserve` (Optional) - Hypervisor snapshot reserve space as a percent of a volume.
80+
- `max_iops` (Optional) - Max IOPS of the compute offering.
81+
- `min_iops` (Optional) - Min IOPS of the compute offering.
82+
83+
## Attributes Reference
84+
85+
In addition to the arguments above, the following attributes are exported:
86+
87+
- `id` - The ID of the service offering.
88+
89+
## Import
90+
91+
Service offerings can be imported using the ID:
92+
93+
```sh
94+
terraform import cloudstack_service_offering_unconstrained.example <id>
95+
```

0 commit comments

Comments
 (0)