opensearch-project / terraform-provider-opensearch

https://registry.terraform.io/providers/opensearch-project/opensearch
Apache License 2.0
73 stars 56 forks source link

Improved documentation around argument default values and basic auth example #107

Closed Sovietaced closed 3 months ago

Sovietaced commented 10 months ago

It was surprisingly challenging for me to get going with basic auth. The default values of the arguments are not configured and it was not clear that I would have to explicitly disabling request signing in order to get basic auth to work (was receiving 403s).

peterzhuamazon commented 10 months ago

[Triage] Adding @prudhvigodithi to get more information on this.

prudhvigodithi commented 10 months ago

Hey @Sovietaced thanks for the feedback, can you please open a PR to fix this? Thank you

Sovietaced commented 10 months ago

Hey @Sovietaced thanks for the feedback, can you please open a PR to fix this?

Thank you

Yeah sure. Gimme a week.

Sovietaced commented 10 months ago

Given that this project uses terraform-plugin-docs to manage its documentation, it appears that the behavior to document the default value is not yet supported unfortunately. https://github.com/hashicorp/terraform-plugin-docs/issues/65

Feels absurd to me that the issue has been laying around for 2 years so I'll just work on adding a basic auth example :(

Sovietaced commented 10 months ago

Ready for review: https://github.com/opensearch-project/terraform-provider-opensearch/pull/114

prudhvigodithi commented 10 months ago

Thanks @Sovietaced I have assigned this issue to you.