Filter data source (feature request)

[lhagemann]

Terraform allows for the filtering of data sources: https://www.terraform.io/docs/configuration/data-sources.html

The baremetal provider does not support this feature.

$ terraform apply
1 error(s) occurred:

* data.baremetal_core_subnets.filter_fails: : invalid or unknown key: filter

Being able to limit the scope of the response from a data source would make the resulting information much more valuable.

Some of the underlying resources already support a version of filtering which is implemented in the data source resource, such as images. But others, such as subnets, do not.

A simple example demonstrating expected usage, which results in the error above, is attached.

filter_data_source.tf.txt

[lhagemann]

Another example of a necessary filter is being able to return instances that are in a certain state:
I expected the bm_core_instances datasource to return the active instances, but recognize now that the multiple states are relevant. I would not have expected 'TERMINaTED' to returned tho.

But, again, a way to filter the datasource is crucial to the usefullness of the datasource.

> data.baremetal_core_instances.s.instances[0]
{
  availability_domain = ASru:PHX-AD-1  compartment_id = ocid1.compartment.oc1..aaaaaaaa3tkq43gsvglgkyyvvrcwwztrcz54wzqgfgdinbv2p7zaazzfiria  display_name = hivecast_0  id = ocid1.instance.oc1.phx.abyhqljtuxpvevtn5enhswscvjsj65aabwhq2cqryjjlrjbhv3k5njpfrmda  image = ocid1.image.oc1.phx.aaaaaaaay27pdopotkapf2ahjlsn2wxndui5hn5w37hd2wss4ses4ol5xs6a  ipxe_script = #!ipxe    set keep-san 1  set target-path iqn.2015-02.oracle.boot:uefi  set root-path iscsi:169.254.0.2::::${target-path}  sanhook ${root-path} || echo could not attach ${root-path}  set uefi-filename \EFI\ubuntu\grubx64.efi    sanboot || echo "Installing..."    initrd http://s3.amazonaws.com/hivecast-initrd/initrd  kernel http://s3.amazonaws.com/hivecast-initrd/kernel \      BOOTIF=${net0/mac} \      console=tty0 \      console=ttyS0,9600 \      initrd=initrd \      ip=dhcp \      ipxe_console_device=ttyS0 \      ipxe_console_speed=9600 \      ipxe_console_unit=0 \      ipxe_dhcp=1 \      ipxe_disk_device=/dev/sda \      ipxe_environment=bmc_metal \      ipxe_mac=${net0/mac} \      iscsi_initiator=iqn.2015-02.oracle.boot:instance \      iscsi_target_ip=169.254.0.2 \      iscsi_target_name=iqn.2015-02.oracle.boot:uefi \      nofb \      nomodeset \      reboot=pci \      video=vesafb:off    boot  metadata = {}  region = phx  shape = BM.Standard1.36  state = TERMINATED  time_created = 2017-07-19 13:26:42.145 +0000 UTC}
> data.baremetal_core_instances.s.instances
[
  {    availability_domain = ASru:PHX-AD-1  compartment_id = ocid1.compartment.oc1..aaaaaaaa3tkq43gsvglgkyyvvrcwwztrcz54wzqgfgdinbv2p7zaazzfiria  display_name = hivecast_0  id = ocid1.instance.oc1.phx.abyhqljtuxpvevtn5enhswscvjsj65aabwhq2cqryjjlrjbhv3k5njpfrmda  image = ocid1.image.oc1.phx.aaaaaaaay27pdopotkapf2ahjlsn2wxndui5hn5w37hd2wss4ses4ol5xs6a  ipxe_script = #!ipxe    set keep-san 1  set target-path iqn.2015-02.oracle.boot:uefi  set root-path iscsi:169.254.0.2::::${target-path}  sanhook ${root-path} || echo could not attach ${root-path}  set uefi-filename \EFI\ubuntu\grubx64.efi    sanboot || echo "Installing..."    initrd http://s3.amazonaws.com/hivecast-initrd/initrd  kernel http://s3.amazonaws.com/hivecast-initrd/kernel \      BOOTIF=${net0/mac} \      console=tty0 \      console=ttyS0,9600 \      initrd=initrd \      ip=dhcp \      ipxe_console_device=ttyS0 \      ipxe_console_speed=9600 \      ipxe_console_unit=0 \      ipxe_dhcp=1 \      ipxe_disk_device=/dev/sda \      ipxe_environment=bmc_metal \      ipxe_mac=${net0/mac} \      iscsi_initiator=iqn.2015-02.oracle.boot:instance \      iscsi_target_ip=169.254.0.2 \      iscsi_target_name=iqn.2015-02.oracle.boot:uefi \      nofb \      nomodeset \      reboot=pci \      video=vesafb:off    boot  metadata = {}  region = phx  shape = BM.Standard1.36  state = TERMINATED  time_created = 2017-07-19 13:26:42.145 +0000 UTC},
  {    availability_domain = ASru:PHX-AD-1  compartment_id = ocid1.compartment.oc1..aaaaaaaa3tkq43gsvglgkyyvvrcwwztrcz54wzqgfgdinbv2p7zaazzfiria  display_name = hivecast_ad1_01  id = ocid1.instance.oc1.phx.abyhqljtcdsbp3vvvd4hzsrasuv3gwkgdosmhaolot3jwigxrmsqpaiqhoha  image = ocid1.image.oc1.phx.aaaaaaaay27pdopotkapf2ahjlsn2wxndui5hn5w37hd2wss4ses4ol5xs6a  ipxe_script = #!ipxe    set keep-san 1  set target-path iqn.2015-02.oracle.boot:uefi  set root-path iscsi:169.254.0.2::::${target-path}  sanhook ${root-path} || echo could not attach ${root-path}  set uefi-filename \EFI\ubuntu\grubx64.efi    sanboot || echo "Installing..."    initrd http://s3.amazonaws.com/hivecast-initrd/initrd  kernel http://s3.amazonaws.com/hivecast-initrd/kernel \      BOOTIF=${net0/mac} \      console=tty0 \      console=ttyS0,9600 \      initrd=initrd \      ip=dhcp \      ipxe_console_device=ttyS0 \      ipxe_console_speed=9600 \      ipxe_console_unit=0 \      ipxe_dhcp=1 \      ipxe_disk_device=/dev/sda \      ipxe_environment=bmc_metal \      ipxe_mac=${net0/mac} \      iscsi_initiator=iqn.2015-02.oracle.boot:instance \      iscsi_target_ip=169.254.0.2 \      iscsi_target_name=iqn.2015-02.oracle.boot:uefi \      nofb \      nomodeset \      reboot=pci \      video=vesafb:off    boot  metadata = {}  region = phx  shape = VM.Standard1.16  state = RUNNING  time_created = 2017-07-27 15:23:47.807 +0000 UTC}
]

Usage case:

resource "baremetal_core_volume_attachment" "HCBlock0Attach" {
  count           = "${var.hc_instance_count}"
  attachment_type = "iscsi"
  compartment_id  = "${var.compartment_ocid}"
  instance_id     = "${lookup(data.baremetal_core_instances.s.instances[0], "id")}"
  volume_id       = "${lookup(data.baremetal_core_volumes.cv.volumes[0], "id")}"
}

Which unfortunately results in an attempt to attach a volume to a terminated instance:

-/+ baremetal_core_volume_attachment.HCBlock0Attach
    attachment_type:     "iscsi" => "iscsi"
    availability_domain: "ASru:PHX-AD-1" => "<computed>"
    chap_secret:         "" => "<computed>"
    chap_username:       "" => "<computed>"
    compartment_id:      "ocid1.compartment.oc1..aaaaaaaa3tkq43gsvglgkyyvvrcwwztrcz54wzqgfgdinbv2p7zaazzfiria" => "ocid1.compartment.oc1..aaaaaaaa3tkq43gsvglgkyyvvrcwwztrcz54wzqgfgdinbv2p7zaazzfiria"
    display_name:        "" => "<computed>"
    instance_id:         "ocid1.instance.oc1.phx.abyhqljtcdsbp3vvvd4hzsrasuv3gwkgdosmhaolot3jwigxrmsqpaiqhoha" => "ocid1.instance.oc1.phx.abyhqljtuxpvevtn5enhswscvjsj65aabwhq2cqryjjlrjbhv3k5njpfrmda" (forces new resource)
    ipv4:                "169.254.2.2" => "<computed>"
    iqn:                 "iqn.2015-12.com.oracleiaas:881c7bc2-8b88-4b2c-8651-3c222c13dab4" => "<computed>"
    port:                "3260" => "<computed>"
    state:               "ATTACHED" => "<computed>"
    time_created:        "2017-07-27 15:25:29.557 +0000 UTC" => "<computed>"
    volume_id:           "ocid1.volume.oc1.phx.abyhqljtsym3eb5g5bdjfz5vadzt4tj2bpv3z7unzzanxfzzlrml6eeoua3a" => "ocid1.volume.oc1.phx.abyhqljtsym3eb5g5bdjfz5vadzt4tj2bpv3z7unzzanxfzzlrml6eeoua3a"


{
  availability_domain = ASru:PHX-AD-1  compartment_id = ocid1.compartment.oc1..aaaaaaaa3tkq43gsvglgkyyvvrcwwztrcz54wzqgfgdinbv2p7zaazzfiria  display_name = hivecast_0  id = ocid1.instance.oc1.phx.abyhqljtuxpvevtn5enhswscvjsj65aabwhq2cqryjjlrjbhv3k5njpfrmda  image = ocid1.image.oc1.phx.aaaaaaaay27pdopotkapf2ahjlsn2wxndui5hn5w37hd2wss4ses4ol5xs6a  ipxe_script = #!ipxe    set keep-san 1  set target-path iqn.2015-02.oracle.boot:uefi  set root-path iscsi:169.254.0.2::::${target-path}  sanhook ${root-path} || echo could not attach ${root-path}  set uefi-filename \EFI\ubuntu\grubx64.efi    sanboot || echo "Installing..."    initrd http://s3.amazonaws.com/hivecast-initrd/initrd  kernel http://s3.amazonaws.com/hivecast-initrd/kernel \      BOOTIF=${net0/mac} \      console=tty0 \      console=ttyS0,9600 \      initrd=initrd \      ip=dhcp \      ipxe_console_device=ttyS0 \      ipxe_console_speed=9600 \      ipxe_console_unit=0 \      ipxe_dhcp=1 \      ipxe_disk_device=/dev/sda \      ipxe_environment=bmc_metal \      ipxe_mac=${net0/mac} \      iscsi_initiator=iqn.2015-02.oracle.boot:instance \      iscsi_target_ip=169.254.0.2 \      iscsi_target_name=iqn.2015-02.oracle.boot:uefi \      nofb \      nomodeset \      reboot=pci \      video=vesafb:off    boot  metadata = {}  region = phx  shape = BM.Standard1.36  state = TERMINATED  time_created = 2017-07-19 13:26:42.145 +0000 UTC

[codycushing]

Supported in 2.0.3 for applicable data sources

[pixelicous]

@codycushing How do we request this is added to more resources? i want to filter out azure images based on tags

[codycushing]

Hi there, filters are preset on image data sources. The limitation at the moment is that we have not added tag comprehension to resources. Supporting tags high in our backlog.

A possible workaround for you would be to use existing filters with an exclusive type regex to filter against something like display names.

[pixelicous]

@codycushing is this azurerm provider related or terraform in general

[pixelicous]

@codycushing also, on top of the above.. if the filter does not support tags, filtering by name, or referencing the name in the datasource is exactly the same thing, kind of beats the purpose..