Skip to content

docs: Clarify Complete Example and Inputs #30

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 6 commits into from
Closed

docs: Clarify Complete Example and Inputs #30

wants to merge 6 commits into from

Conversation

younsl
Copy link

@younsl younsl commented Oct 25, 2024

Description

No code changes, only update docs and complete examples.

Motivation and Context

  • Clarify complete example
  • Update engine_version and off_peak_window_options input in docs

Breaking Changes

How Has This Been Tested?

  • I have updated at least one of the examples/* to demonstrate and validate my change(s)
  • I have tested and validated these changes using one or more of the provided examples/* projects
  • I have executed pre-commit run -a on my pull request
$ pre-commit run -a
Terraform validate.......................................................Passed
check for merge conflicts................................................Passed
fix end of files.........................................................Passed
trim trailing whitespace.................................................Passed

younsl added 6 commits October 25, 2024 08:56
@younsl
chore: Add off_peak_window_options value for exmaple
626c3e4 
Signed-off-by: younsl <[email protected]>
@younsl
chore: Add multi_az_with_standby_enabled value for example
b241b46 
* To help users understand, an example setting for the multi_az_with_standby_enabled value is explicitly declared.

Signed-off-by: younsl <[email protected]>
@younsl
docs: Add explanatory values and update config examples
f6f7d02 
* Included multi-AZ standby and dedicated master node settings for clarity.

* Provided a link to AWS documentation for additional context on off-peak windows.

* Sort cluster_config values
@younsl
docs(opensearch): Clarify engine version examples in input documentation
30439ae
@younsl
style: Lint terraform fmt
69b5d98 
* Using pre-commit run -a before submit PR
@younsl
style: Lint terraform fmt
3cf9c43 
* Apply linting in example written by markdown.
@bryantbiggs
Copy link
Member

why?

@younsl
Copy link
Author

younsl commented Oct 25, 2024

@bryantbiggs To make it easier for Terraform users to work with the module.

@bryantbiggs
Copy link
Member

How so?

@younsl
Copy link
Author

younsl commented Oct 25, 2024

How so?

  • Added example values to the complete example and provided additional context in the input documentation to enhance user understanding.

Based on my user experience (using this module v1.4.0), the input descriptions were relatively lacking compared to the OpenSearch Terraform module maintained by CloudPosse, and the absence of many example values made it inconvenient.

Additionally, the fact that snapshot_options is not supported by this module v1.4.0 falls under a similar context.

@bryantbiggs
Copy link
Member

thank you but unfortunately, this is what the documented variables are for. examples just demonstrate various configurations but they are not exhaustive. The documented inputs are there to show users what values the module accepts as inputs, not the examples https://github.com/terraform-aws-modules/terraform-aws-opensearch/blob/master/README.md#inputs

@github-actions GitHub Actions
Copy link

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 Nov 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@younsl @bryantbiggs