Oracle Cloud Infrastructure Documentation

Referencing Availability Domains

Use the Oracle Cloud Infrastructure Terraform provider to manage availability domains.

Regarding availability domains, we caution against a common pattern, as shown here:

// Get all availability domains for the region
data "oci_identity_availability_domains" "ads" {
  compartment_id = "${var.tenancy_ocid}"
}
  
// Then either use it to get a single AD name based on the index:
resource "oci_core_instance" "nat" {
  availability_domain = "${lookup(data.oci_identity_availability_domains.ads.availability_domains[var.nat_instance_ad],"name")}"
  ...
}
  
// Or iterate through all the ADs:
resource "oci_core_subnet" "nat" {
  count = "${length(data.oci_identity_availability_domains.ads.availability_domains)}"
  availability_domain = "${lookup(data.oci_identity_availability_domains.ad.availability_domains[count.index], "name")}"
  ...
}

The recommendation, then, is to explicitly list the availability domain names for the regions in your configuration. To do so, use a variable that you have defined as follows:

variable "ad_list" {
  type = list
}

You can then use the variable as shown here:

// Index:
resource "oci_core_instance" "nat" {
  availability_domain = "${var.ad_list[var.nat_instance_ad_index]}"
  ...
}
  
// Or iterate through all the ADs:
resource "oci_core_subnet" "nat" {
  count = "${length(var.ad_list)}"
  availability_domain = "${var.ad_list[count.index]}"
  ...
}

You can then set the ad_list variable directly by using the availability domain names for your tenant and region, as shown here:

variable "ad_list" {
  type = list
  default = ["kIdk:PHX-AD-1","kIdk:PHX-AD-2","kIdk:PHX-AD-3"]
}

The advantage of using this method is that it gives you control over your availability domain usage and prevents unexpected changes over time. However, this approach is problematic when configurations are shared between tenancies and regions, because availability domain names are tenancy- and region-specific.

A convenient alternative is to instead set the ad_list value by using the oci_identity_availability_domains data source. You should do this in the configuration, then pass them into the modules. This effectively centralizes the list of ADs, making it's easy to switch to an explicit list later, should that become necessary: Note that the modules themselves should not use the oci_identity_availability_domains data source. 

data "oci_identity_availability_domains" "ad" {
  compartment_id = "${var.tenancy_ocid}"
}
 
data "template_file" "ad_names" {
  count = "${length(data.oci_identity_availability_domains.ad.availability_domains)}"
  template = "${lookup(data.oci_identity_availability_domains.ad.availability_domains[count.index], "name")}"
}
  
module "ssm_network" {
  ad_list = "${data.template_file.ad_names.*.rendered}"
  ...
}

Regions with a Single Availability Domain

Some Oracle Cloud Infrastructure regions have a single availability domain. When writing configurations that use plural data sources, such as oci_identity_availability_domains, ensure that you account for a single domain if required by your region.

The following example uses the oci_identity_availability_domains data source when listing fault domains in a single-availability domain region. The availability_domains index must be 0. Any other index value is invalid in this region:

data "oci_identity_availability_domains" "AvailabilityDomains" {
    compartment_id = var.tenancy_ocid
}

data "oci_identity_fault_domains" "FaultDomains" {
    availability_domain = data.oci_identity_availability_domains.AvailabilityDomains.availability_domains[0]["name"]
    compartment_id = "${var.compartment_ocid}"
}

The full reference of the OCI Terraform provider's supported resources and data sources contains usage, argument, and attribute details. The full reference is available at docs.oracle.com and Terraform Registry.