Open apparentlymart opened 1 year ago
Hello I am looking for some good first issue , I am new at open source ,is that good for me?
@Jagannathmaity110 No, this needs to be solved internally. The provider teams (e.g. https://hashicorp.github.io/terraform-provider-aws/) are more suited to first issues. Thanks.
Terraform Version
I observed this in the Terraform v1.4.x documentation that was current at the time I opened this issue.
Affected Pages
Credentials Helpers
What is the docs issue?
When this page was originally written there was another page describing in general how Terraform CLI finds plugin executables, which the credentials helper page just linked to as an alternative to duplicating that information.
Unfortunately in the meantime Terraform's treatment of provider plugins has become significantly more sophisticated and complex, and our documentation elsewhere focused on how provider plugins work and no longer talk about the simpler mechanism that Terraform uses to find credentials helpers.
Specifically:
Proposal
Credentials helpers are pretty different in practice to provider plugins: they are always installed manually rather than automatically by
terraform init
, they are simple request-response programs using stdout/stdin rather than running a gRPC server, and they must be explicitly configured in the CLI configuration.Therefore I suggest that we just remove all of the attempted indirection here and document the installation method for credentials helpers directly on the Credentials Helpers page.
Specifically, I would consider changing the "How Terraform finds Credentials Helpers" section so that it ends by directly describing where Terraform CLI will search to find the credentials helpers:
The above is the essence of the content that was available on the page that was originally linked from the credentials helpers page when it was first written.
There is another section at the end of the page titled "Installing a credentials helper", which currently also links to the unhelpful loop of pages described above. I'm not sure we really need to separate "How Terraform finds" from "How to install", but if we do intend to keep both sections then we should perhaps make one link to the other within the same page, rather than linking out to external content that is no longer relevant.