Skip to content

Commit 83b83e0

Browse files
ab-cs13ab-cs13
committed
added website documentation
1 parent c3ffbe0 commit 83b83e0

File tree

3 files changed

+262
-32
lines changed

3 files changed

+262
-32
lines changed

‎examples/odb/vm_cluster.tf‎

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,52 @@
1-
# Copyright © 2025, Oracle and/or its affiliates. All rights reserved.
1+
# Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
22

3-
resource "aws_odb_cloud_vm_cluster" "my_vmcluster_with_minimum_parameters" {
4-
display_name = "Ofake_my_vmc"
5-
cloud_exadata_infrastructure_id = "<aws_odb_cloud_exadata_infrastructure.test.id>"
3+
resource "aws_odb_cloud_vm_cluster" "with_minimum_parameter" {
4+
display_name = "my-exa-infra"
5+
cloud_exadata_infrastructure_id = "exa_gjrmtxl4qk"
66
cpu_core_count = 6
77
gi_version = "23.0.0.0"
88
hostname_prefix = "apollo12"
9-
ssh_public_keys = ["<public ssh keys>"]
10-
odb_network_id = "<aws_odb_network.test.id>"
9+
ssh_public_keys = ["public-ssh-key"]
10+
odb_network_id = "odbnet_3l9st3litg"
1111
is_local_backup_enabled = true
1212
is_sparse_diskgroup_enabled = true
1313
license_model = "LICENSE_INCLUDED"
1414
data_storage_size_in_tbs = 20.0
15-
db_servers = ["<my_deb_server>"] //db-servers
15+
db_servers = ["db-server-1", "db-server-2"]
1616
db_node_storage_size_in_gbs = 120.0
1717
memory_size_in_gbs = 60
18-
tags = {
19-
"env" = "dev"
18+
data_collection_options {
19+
is_diagnostics_events_enabled = false
20+
is_health_monitoring_enabled = false
21+
is_incident_logs_enabled = false
2022
}
2123
}
2224

2325

24-
resource "aws_odb_cloud_vm_cluster" "my_vmc_with_all_parameters" {
25-
display_name = "Ofake_my_vmc"
26-
cloud_exadata_infrastructure_id = "<aws_odb_cloud_exadata_infrastructure.test.id>"
27-
cpu_core_count = 6
28-
gi_version = "23.0.0.0"
29-
hostname_prefix = "apollo12"
30-
ssh_public_keys = ["<my_ssh_public_key>"]
31-
odb_network_id = "<aws_odb_network.test.id>"
32-
is_local_backup_enabled = true
33-
is_sparse_diskgroup_enabled = true
34-
license_model = "LICENSE_INCLUDED"
35-
data_storage_size_in_tbs = 20.0
36-
db_servers = ["<my_db_server>"]
37-
db_node_storage_size_in_gbs = 120.0
38-
memory_size_in_gbs = 60
39-
cluster_name = "julia-13"
40-
timezone = "UTC"
41-
scan_listener_port_tcp = 1521
42-
system_version = "23.1.26.0.0.250516"
26+
resource "aws_odb_cloud_vm_cluster" "with_all_parameters" {
27+
display_name = "my-vmc"
28+
cloud_exadata_infrastructure_id = "exa_gjrmtxl4qk"
29+
cpu_core_count = 6
30+
gi_version = "23.0.0.0"
31+
hostname_prefix = "apollo12"
32+
ssh_public_keys = ["my-ssh-key"]
33+
odb_network_id = "odbnet_3l9st3litg"
34+
is_local_backup_enabled = true
35+
is_sparse_diskgroup_enabled = true
36+
license_model = "LICENSE_INCLUDED"
37+
data_storage_size_in_tbs = 20.0
38+
db_servers = ["my-dbserver-1", "my-db-server-2"]
39+
db_node_storage_size_in_gbs = 120.0
40+
memory_size_in_gbs = 60
41+
cluster_name = "julia-13"
42+
timezone = "UTC"
43+
scan_listener_port_tcp = 1521
4344
tags = {
4445
"env" = "dev"
4546
}
46-
data_collection_options = {
47-
is_diagnostics_events_enabled = true
48-
is_health_monitoring_enabled = true
49-
is_incident_logs_enabled = true
47+
data_collection_options {
48+
is_diagnostics_events_enabled = true
49+
is_health_monitoring_enabled = true
50+
is_incident_logs_enabled = true
5051
}
5152
}

‎website/docs/d/odb_cloud_vm_cluster.html.markdown‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
subcategory: "Oracle Database@AWS"
3+
layout: "AWS: aws_odb_cloud_vm_cluster"
4+
page_title: "AWS: aws_odb_cloud_vm_cluster"
5+
description: |-
6+
Terraform data source for managing cloud vm cluster resource in AWS for Oracle Database@AWS.
7+
---
8+
9+
# Data Source: aws_odb_cloud_vm_cluster
10+
11+
Terraform data source for Exadata Infrastructure resource in AWS for Oracle Database@AWS.
12+
13+
You can find out more about Oracle Database@AWS from [User Guide](https://docs.aws.amazon.com/odb/latest/UserGuide/what-is-odb.html).
14+
15+
## Example Usage
16+
17+
### Basic Usage
18+
19+
```terraform
20+
data "aws_odb_db_servers_list" "example" {
21+
cloud_exadata_infrastructure_id = "example-id"
22+
}
23+
```
24+
25+
## Argument Reference
26+
27+
The following arguments are mandatory:
28+
29+
* `id` - (Required) The unique identifier of the Exadata infrastructure.
30+
31+
The following arguments are optional:
32+
33+
* `region` - (Optional) Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
34+
35+
## Attribute Reference
36+
37+
This data source exports the following attributes in addition to the arguments above:
38+
39+
* `arn` - The Amazon Resource Name (ARN) for the cloud vm cluster.
40+
* `cloud_exadata_infrastructure_id` - The ID of the Cloud Exadata Infrastructure.
41+
* `cluster_name` - The name of the Grid Infrastructure (GI) cluster.
42+
* `cpu_core_count` - The number of CPU cores enabled on the VM cluster.
43+
* `data_storage_size_in_tbs` - The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
44+
* `db_node_storage_size_in_gbs` - The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
45+
* `db_servers` - The list of database servers for the VM cluster.
46+
* `disk_redundancy` - The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
47+
* `display_name` - The display name of the VM cluster.
48+
* `domain` - The domain name of the VM cluster.
49+
* `gi_version` - The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
50+
* `hostname_prefix_computed` - The computed hostname prefix for the VM cluster.
51+
* `is_local_backup_enabled` - Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
52+
* `is_sparse_disk_group_enabled` - Indicates whether the VM cluster is configured with a sparse disk group.
53+
* `last_update_history_entry_id` - The Oracle Cloud ID (OCID) of the last maintenance update history entry.
54+
* `license_model` - The Oracle license model applied to the VM cluster.
55+
* `listener_port` - The port number configured for the listener on the VM cluster.
56+
* `memory_size_in_gbs` - The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
57+
* `node_count` - The number of nodes in the VM cluster.
58+
* `ocid` - The OCID of the VM cluster.
59+
* `oci_resource_anchor_name` - The name of the OCI Resource Anchor.
60+
* `oci_url` - The HTTPS link to the VM cluster in OCI.
61+
* `odb_network_id` - The ID of the ODB network.
62+
* `percent_progress` - The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
63+
* `scan_dns_name` - The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
64+
* `scan_dns_record_id` - The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
65+
* `scan_ip_ids` - The OCID of the SCAN IP addresses that are associated with the VM cluster.
66+
* `shape` - The hardware model name of the Exadata infrastructure that's running the VM cluster.
67+
* `ssh_public_keys` - The public key portion of one or more key pairs used for SSH access to the VM cluster.
68+
* `status` - The status of the VM cluster.
69+
* `status_reason` - Additional information about the status of the VM cluster.
70+
* `storage_size_in_gbs` - The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
71+
* `system_version` - The operating system version of the image chosen for the VM cluster.
72+
* `timezone` - The time zone of the VM cluster.
73+
* `vip_ids` - The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
74+
* `created_at` - The time when the VM cluster was created.
75+
* `compute_model` - The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
76+
* `data_collection_options` - The set of diagnostic collection options enabled for the VM cluster.
77+
* `iorm_config_cache` - The ExadataIormConfig cache details for the VM cluster.

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

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
---
2+
subcategory: "Oracle Database@AWS"
3+
layout: "AWS: aws_odb_cloud_vm_cluster"
4+
page_title: "AWS: aws_odb_cloud_vm_cluster"
5+
description: |-
6+
Terraform resource for managing cloud vm cluster resource in AWS for Oracle Database@AWS.
7+
---
8+
9+
# Resource: aws_odb_cloud_vm_cluster
10+
11+
Terraform data source for Exadata Infrastructure resource in AWS for Oracle Database@AWS.
12+
13+
You can find out more about Oracle Database@AWS from [User Guide](https://docs.aws.amazon.com/odb/latest/UserGuide/what-is-odb.html).
14+
15+
## Example Usage
16+
17+
### Basic Usage
18+
19+
```terraform
20+
resource "aws_odb_cloud_vm_cluster" "with_minimum_parameter" {
21+
display_name = "my-exa-infra"
22+
cloud_exadata_infrastructure_id = "exa_gjrmtxl4qk"
23+
cpu_core_count = 6
24+
gi_version = "23.0.0.0"
25+
hostname_prefix = "apollo12"
26+
ssh_public_keys = ["public-ssh-key"]
27+
odb_network_id = "odbnet_3l9st3litg"
28+
is_local_backup_enabled = true
29+
is_sparse_diskgroup_enabled = true
30+
license_model = "LICENSE_INCLUDED"
31+
data_storage_size_in_tbs = 20.0
32+
db_servers = ["db-server-1", "db-server-2"]
33+
db_node_storage_size_in_gbs = 120.0
34+
memory_size_in_gbs = 60
35+
data_collection_options {
36+
is_diagnostics_events_enabled = false
37+
is_health_monitoring_enabled = false
38+
is_incident_logs_enabled = false
39+
}
40+
}
41+
42+
43+
resource "aws_odb_cloud_vm_cluster" "with_all_parameters" {
44+
display_name = "my-vmc"
45+
cloud_exadata_infrastructure_id = "exa_gjrmtxl4qk"
46+
cpu_core_count = 6
47+
gi_version = "23.0.0.0"
48+
hostname_prefix = "apollo12"
49+
ssh_public_keys = ["my-ssh-key"]
50+
odb_network_id = "odbnet_3l9st3litg"
51+
is_local_backup_enabled = true
52+
is_sparse_diskgroup_enabled = true
53+
license_model = "LICENSE_INCLUDED"
54+
data_storage_size_in_tbs = 20.0
55+
db_servers = ["my-dbserver-1", "my-db-server-2"]
56+
db_node_storage_size_in_gbs = 120.0
57+
memory_size_in_gbs = 60
58+
cluster_name = "julia-13"
59+
timezone = "UTC"
60+
scan_listener_port_tcp = 1521
61+
tags = {
62+
"env" = "dev"
63+
}
64+
data_collection_options {
65+
is_diagnostics_events_enabled = true
66+
is_health_monitoring_enabled = true
67+
is_incident_logs_enabled = true
68+
}
69+
}
70+
```
71+
72+
## Argument Reference
73+
74+
The following arguments are required:
75+
76+
* `cloud_exadata_infrastructure_id` - (Required) The unique identifier of the Exadata infrastructure for this VM cluster. Changing this will create a new resource.
77+
* `cpu_core_count` - (Required) The number of CPU cores to enable on the VM cluster. Changing this will create a new resource.
78+
* `db_servers` - (Required) The list of database servers for the VM cluster. Changing this will create a new resource.
79+
* `display_name` - (Required) A user-friendly name for the VM cluster. Changing this will create a new resource.
80+
* `gi_version` - (Required) A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the ListGiVersions operation and specify the shape of the Exadata infrastructure. Example: 19.0.0.0 Changing this will create a new resource.
81+
* `hostname_prefix` - (Required) The host name prefix for the VM cluster. Constraints: - Can't be "localhost" or "hostname". - Can't contain "-version". - The maximum length of the combined hostname and domain is 63 characters. - The hostname must be unique within the subnet. Changing this will create a new resource.
82+
* `odb_network_id` - (Required) The unique identifier of the ODB network for the VM cluster. Changing this will create a new resource.
83+
* `ssh_public_keys` - (Required) The public key portion of one or more key pairs used for SSH access to the VM cluster. Changing this will create a new resource.
84+
* `data_collection_options` - (Required) The set of preferences for the various diagnostic collection options for the VM cluster.
85+
86+
The following arguments are optional:
87+
88+
* `cluster_name` - (Optional) The name of the Grid Infrastructure (GI) cluster. Changing this will create a new resource.
89+
* `data_storage_size_in_tbs` - (Optional) The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster. Changing this will create a new resource.
90+
* `db_node_storage_size_in_gbs` - (Optional) The amount of local node storage, in gigabytes (GBs), to allocate for the VM cluster. Changing this will create a new resource.
91+
* `is_local_backup_enabled` - (Optional) Specifies whether to enable database backups to local Exadata storage for the VM cluster. Changing this will create a new resource.
92+
* `is_sparse_diskgroup_enabled` - (Optional) Specifies whether to create a sparse disk group for the VM cluster. Changing this will create a new resource.
93+
* `license_model` - (Optional) The Oracle license model to apply to the VM cluster. Default: LICENSE_INCLUDED. Changing this will create a new resource.
94+
* `memory_size_in_gbs` - (Optional) The amount of memory, in gigabytes (GBs), to allocate for the VM cluster. Changing this will create a new resource.
95+
* `scan_listener_port_tcp` - (Optional) The port number for TCP connections to the single client access name (SCAN) listener. Valid values: 1024–8999, except 2484, 6100, 6200, 7060, 7070, 7085, and 7879. Default: 1521. Changing this will create a new resource.
96+
* `timezone` - (Optional) The configured time zone of the VM cluster. Changing this will create a new resource.
97+
* `region` - (Optional) Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
98+
* `tags` - (Optional) A map of tags to assign to the exadata infrastructure. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
99+
100+
## Attribute Reference
101+
102+
This data source exports the following attributes in addition to the arguments above:
103+
104+
* `arn` - The Amazon Resource Name (ARN) for the cloud vm cluster.
105+
* `disk_redundancy` - The type of redundancy for the VM cluster: NORMAL (2-way) or HIGH (3-way).
106+
* `AttrDomain` - The domain name associated with the VM cluster.
107+
* `hostname_prefix_computed` - The host name for the VM cluster. Constraints: - Can't be "localhost" or "hostname". - Can't contain "-version". - The maximum length of the combined hostname and domain is 63 characters. - The hostname must be unique within the subnet. This member is required. Changing this will create a new resource.
108+
* `iorm_config_cache` - The Exadata IORM (I/O Resource Manager) configuration cache details for the VM cluster.
109+
* `last_update_history_entry_id` - The OCID of the most recent maintenance update history entry.
110+
* `listener_port` - The listener port number configured on the VM cluster.
111+
* `node_count` - The total number of nodes in the VM cluster.
112+
* `ocid` - The OCID (Oracle Cloud Identifier) of the VM cluster.
113+
* `oci_resource_anchor_name` - The name of the OCI resource anchor associated with the VM cluster.
114+
* `oci_url` - The HTTPS link to the VM cluster resource in OCI.
115+
* `percent_progress` - The percentage of progress made on the current operation for the VM cluster.
116+
* `scan_dns_name` - The fully qualified domain name (FQDN) for the SCAN IP addresses associated with the VM cluster.
117+
* `scan_dns_record_id` - The OCID of the DNS record for the SCAN IPs linked to the VM cluster.
118+
* `scan_ip_ids` - The list of OCIDs for SCAN IP addresses associated with the VM cluster.
119+
* `shape` - The hardware model name of the Exadata infrastructure running the VM cluster.
120+
* `status` - The current lifecycle status of the VM cluster.
121+
* `status_reason` - Additional information regarding the current status of the VM cluster.
122+
* `storage_size_in_gbs` - The local node storage allocated to the VM cluster, in gigabytes (GB).
123+
* `system_version` - The operating system version of the image chosen for the VM cluster.
124+
* `vip_ids` - The virtual IP (VIP) addresses assigned to the VM cluster. CRS assigns one VIP per node for failover support.
125+
* `created_at` - The timestamp when the VM cluster was created.
126+
* `compute_model` - The compute model used when the instance is created or cloned — either ECPU or OCPU. ECPU is a virtualized compute unit; OCPU is a physical processor core with hyper-threading.
127+
* `tags_all` - The combined set of user-defined and provider-defined tags.
128+
129+
## Timeouts
130+
131+
[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts):
132+
133+
* `create` - (Default `24h`)
134+
* `update` - (Default `24h`)
135+
* `delete` - (Default `24h`)
136+
137+
## Import
138+
139+
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Ingestion Pipeline using the `id`. For example:
140+
141+
```terraform
142+
import {
143+
to = aws_odb_cloud_vm_cluster.example
144+
id = "example"
145+
}
146+
```
147+
148+
Using `terraform import`, import cloud vm cluster using the `id`. For example:
149+
150+
```console
151+
% terraform import aws_odb_cloud_vm_cluster.example example
152+
```

0 commit comments

Comments
 (0)