common: add include_deprecated option to filters

[lbajolet-hashicorp]

When getting the AMIs to build a new image on, we never included deprecated AMIs, as is the default when describing images on AWS.

However, the request does offer this option, so we add this to the options to pick from when getting the base AMI.

Closes #403

[Ckarles]

Thanks for the quick update!

Should there be an implementation on top of this to add explanatory warnings / errors which would help the maintenance and troubleshooting ?

For example:

• By default, filter with include_deprecated.
• If the image chosen is deprecated (.DeprecationTime < now()):
  • if not include_deprecated: return an error: "image was found for this filter, but deprecated, set include_deprecated to true"
  • if include_deprecated: display a warning: "found a deprecated image, this image will be considered valid because of include_deprecated=True"

wdyt ?

It would:

• Clarify why it cannot find the image (it can, it's just that it's deprecated and include_deprecated is not set)
• Give visibility that we are using deprecated images

[nywilken]

If the image chosen is deprecated (.DeprecationTime < now()):
if not include_deprecated: return an error: "image was found for this filter, but deprecated, set include_deprecated to true"
if include_deprecated: display a warning: "found a deprecated image, this image will be considered valid because of include_deprecated=True"

@Ckarles this is a nice idea. But it feels a little out of scope for the filter options and data source. Especially since we would have no idea if the image is deprecated without the user actually specifying include_deprecated. The Amazon API result set will not contain the deprecated image by default if you are not the owner. So include_deprecated is need to gain visibility. If you are the own of the ami then you will see them regardless and that is where I think the deprecation_time attributed could be useful. Refer to my comment below.

• include_deprecated to true"
• if include_deprecated: display a warning: "found a deprecated image, this image will be considered valid because of include_deprecated=True"

wdyt ?

It would:

• Clarify why it cannot find the image (it can, it's just that it's deprecated and include_deprecated is not set)
• Give visibility that we are using deprecated images

I see that the data source output does not include deprecation time in the response, which is something we should look to add in a future PR. If you want to open a PR for adding that output that would allow for users to check the deprecation time within the HCL configuration template and fail the build.

I'm thinking that maybe something like the following would work

locals {
   ami_id = formatdate("YYYYMMDDhhmmss", data.amazon-ami.ubuntu.deprecation_time) > formatdate("YYYYMMDDhhmmss", timestamp()) ? data.amazon-ami.id : "deprecated ami selected change your filter"
}

source "amazon-ebs" "example" {
   source_ami = local.ami_id
}

[nywilken]

I left a question, possible suggestion, but this is otherwise good to me.