Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(vpc_options): Improve description for public access #17

Conversation

dim-ops
Copy link
Contributor

@dim-ops dim-ops commented Jul 1, 2024

Description

It took me a while to realise that I had to leave the vpc_options variable = {} to deploy a public opensearch. I propose to provide a little more explanation

Motivation and Context

Making the creation of a public opensearch more explicit

Breaking Changes

None

How Has This Been Tested?

I ran pre-commit

@dim-ops dim-ops changed the title docs(vpc_options): imrpove description for public access docs(vpc_options): Improve description for public access Jul 1, 2024
@dim-ops dim-ops force-pushed the docs/improve-descriptions-vpc-options branch from 0458166 to 1eb40b2 Compare July 1, 2024 15:10
@bryantbiggs
Copy link
Member

thank you but I don't think that is appropriate here. this description is taken directly from the provider docs https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/opensearch_domain#vpc_options - we expose the configuration in the modules, but the variable descriptions are not intended to teach users how to configure the service to their use case

@bryantbiggs bryantbiggs closed this Jul 1, 2024
@dim-ops
Copy link
Contributor Author

dim-ops commented Jul 1, 2024

thank you but I don't think that is appropriate here. this description is taken directly from the provider docs https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/opensearch_domain#vpc_options - we expose the configuration in the modules, but the variable descriptions are not intended to teach users how to configure the service to their use case

On the serverless module there is at least example with AllowFromPublic.... As you wish

Copy link

github-actions bot commented Aug 1, 2024

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants