aws-ia / terraform-aws-eks-blueprints-addons

Terraform module which provisions addons on Amazon EKS clusters
https://aws-ia.github.io/terraform-aws-eks-blueprints-addons/main/
Apache License 2.0
235 stars 109 forks source link

fargate_fluentbit_cw_log_group retention incorrectly documented #392

Open pricealexandra opened 2 months ago

pricealexandra commented 2 months ago

Description

In the docs here it shows retention_in_days for the fargate_fluentbit_cw_log_group configuration. It seems like in the code it's expected to be just retention instead, and that was the only way we got the configuration to work.

Is it intended to be retention or retention_in_days? We'd be happy to open a PR to correct either the documentation or the code, depending on what the answer is.

Versions

Terraform v1.8.2 on darwin_arm64

Reproduction Code [Required]

Works:

  fargate_fluentbit_cw_log_group = {
    retention = 7
  }

Does not work, but is documented:

  fargate_fluentbit_cw_log_group = {
    retention_in_days = 7
  }

Steps to reproduce the behavior: see code above. reproduce issue by applying.

Expected behaviour

Either the docs say just retention which works, or the code is updated to use retention_in_days to match the documentation.

Actual behaviour

The documented retention feature does not work because it has the wrong name.

danielthieleog commented 1 month ago

I prefer to adapt the documentation so as not to break existing code. Similar to "Fargate FluentBit" the documentation for "AWS for Fluent Bit" already contains retention.

github-actions[bot] commented 5 days ago

This issue has been automatically marked as stale because it has been open 30 days with no activity. Remove stale label or comment or this issue will be closed in 10 days