docker container won't run, requires init

[togakangaroo]

Summary

I'm running things exactly as in the readme. However when I run it on my project I get

$ docker run --rm -v $(pwd):/data -t ghcr.io/terraform-linters/tflint
Failed to initialize plugins; Plugin "aws" not found. Did you run "tflint --init"?

Note that my project is initialized, this seems to be coming from inside the container

Surprised to see this, I'd used tflint at a previous job and it always just ran fine. I wonder if it has to do with the fact that I'm on Linux now (previously I was on a mac).

Command

docker run --rm -v $(pwd):/data -t ghcr.io/terraform-linters/tflint

Terraform Configuration

terraform {
  required_version = ">= 1.9.0, < 2.0.0"
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 5.76.0"
    }
  }
}

TFLint Configuration

plugin "terraform" {
  enabled = true
  preset  = "recommended"
}

plugin "aws" {
    enabled = true
    version = "0.32.0"
    source  = "github.com/terraform-linters/tflint-ruleset-aws"
}

Output

Failed to initialize plugins; Plugin "aws" not found. Did you run "tflint --init"?

TFLint Version

latest in docker b44cd5c75e46

Terraform Version

Terraform v1.10.4

Operating System

• Linux
• macOS
• Windows

[togakangaroo]

note that I put backticks for codeblocks in the bug template and that initially gave very odd formatting this bug and I had to go back and edit it

[bendrucker]

Note that my project is initialized

Where? If you initialize plugins into your home directory, those won't be available to a container.

[bendrucker]

The readme is meant to be a basic example but initialization is still required for plugins. If you want to do that on your host and have the binaries available, you'll need to make sure you set your plugin dir to the working directory instead of home:

https://github.com/terraform-linters/tflint/blob/master/docs/user-guide/config.md#plugin_dir

And this will only work when the host architecture matches the container, which it does sound like is true in your case.

[wata727]

To be honest, I'm wondering what position should be taken for the official Docker image for the project.
Initially, TFLint was a standalone binary, so this approach worked well in most cases, but since moving to a plugin-based approach, it's become a bit tricky.
While I think Docker images are useful for testing multiple versions, it might be worth reconsidering how you use them.

[bendrucker]

I'd say it still serves a similar purpose to the hashicorp/terraform image. The added convenience is that you don't have to install TFLint into a container image. But it doesn't free you from the initialization step for plugins/modules.

[togakangaroo]

What do yall think about adding the way to install plugins and invoke to the README right near the docker one.

I can do a PR, this is what I'v been using

 docker run --rm -v $(pwd):/data -t --entrypoint /bin/sh ghcr.io/terraform-linters/tflint -c "tflint --init && tflint"

[bendrucker]

Yes, an example of how to using a shell to init and run would be good, PR welcome

[coolapso]

Would you be open to change the entrypoint to this instead?

ENTRYPOINT ["sh", "-c", "tflint --init && tflint"] ?

Guess this will cover the users with plugins and the ones without. I'll be happy to put up a PR

[bendrucker]

Unlikely. hashicorp/terraform has the same behavior. This works for a lot of cases but not everyone—it would be a breaking change.

[coolapso]

Understandable! here's a pr for the docs then: #2242

let me know if there's anything I need to change or anything else I should do :)