[BUG] Few of the examples mentioned against the terraform resources are incorrect

opensearch-project / terraform-provider-opensearch

Apache License 2.0

73 stars 56 forks source link

Closed premkirank closed 8 months ago

premkirank commented 10 months ago

Few of the examples provided against terraform resources like below, have some issues when we try to provision them using terraform apply
e.g opensearch_index - https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs/resources/index
Need to cross verify if examples mentioned against any other resources also have some issues and fix them

On your local file system, try to provision the resource using terraform apply and see if it is returning any errors related to that
e.g opensearch_index

peterzhuamazon commented 10 months ago

[Triage] @premkirank would you mind raise a PR for this issue? Thanks.

prudhvigodithi commented 10 months ago

Thanks @premkirank, We might need to run https://github.com/hashicorp/terraform-plugin-docs and test the generated documents, @premkirank what ever you mentioned in your description is coming from https://github.com/opensearch-project/terraform-provider-opensearch/blob/main/provider/resource_opensearch_index_test.go, can you please take a look to fix this? Thank you

premkirank commented 9 months ago

@prudhvigodithi

I tested the resource examples against the latest provider i.e. 2.1.0 (https://registry.terraform.io/providers/opensearch-project/opensearch/latest/docs) and noticed that the examples mentioned against the below resources failed due to various reasons like variables not being found etc

Also, do I need to create a separate issue to see if we can autogenerate examples for resources using any external library?