Improve documentation for HTTP basic authentication #114
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I am wondering if I should file a separate issue so that the provider is intelligent enough to disable request signing when it detects that HTTP basic auth credentials are configured. |
Signed-off-by: Jason Parraga <sovietaced@gmail.com>
Signed-off-by: Jason Parraga <sovietaced@gmail.com>
Sovietaced
commented
Oct 27, 2023
| @@ -56,6 +56,10 @@ EOF | |||
| <!-- schema generated by tfplugindocs --> | |||
| ## Schema | |||
|
|
|||
| ### Required | |||
There was a problem hiding this comment.
I am confused as to why someone had documented this as optional, considering the variable looks like it is required.
Sovietaced
requested review from
peterzhuamazon,
prudhvigodithi,
jackson-theisen and
phillbaker
as code owners
|
Please take a look at my comment here #117 (comment). |
prudhvigodithi
approved these changes
Nov 2, 2023
|
LGTM based on this comment #117 (comment), merging this PR, thanks @Sovietaced. |
afrodidact
pushed a commit
to afrodidact/terraform-provider-opensearch
that referenced
this pull request
Nov 7, 2023
…ct#114) * Update template Signed-off-by: Jason Parraga <sovietaced@gmail.com> * Generate docs using tfplugindocs Signed-off-by: Jason Parraga <sovietaced@gmail.com> --------- Signed-off-by: Jason Parraga <sovietaced@gmail.com> Signed-off-by: Aaron Miller <afrodidact@outlook.com>
afrodidact
pushed a commit
to afrodidact/terraform-provider-opensearch
that referenced
this pull request
Nov 7, 2023
…ct#114) * Update template Signed-off-by: Jason Parraga <sovietaced@gmail.com> * Generate docs using tfplugindocs Signed-off-by: Jason Parraga <sovietaced@gmail.com> --------- Signed-off-by: Jason Parraga <sovietaced@gmail.com>
afrodidact
added a commit
to afrodidact/terraform-provider-opensearch
that referenced
this pull request
Dec 11, 2023
Signed-off-by: Aaron Miller <afrodidact@outlook.com> Add anomaly detection (opensearch-project#105) * Add anomaly detection Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Add test for update Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Add audit config in anomaly detector test Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Format terraform in test Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> --------- Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> Signed-off-by: Aaron Miller <afrodidact@outlook.com> When the provider assumes a given role, don't use the default profile… (opensearch-project#87) * When the provider assumes a given role, don't use the default profile if the profile is not given, but allow aws-sdk-go to find the credentials using the default credential provider chain (opensearch-project#86) Signed-off-by: Massimo Battestini <massimob76@gmail.com> * Adds unit tests for AWS profile change (opensearch-project#86) Signed-off-by: Massimo Battestini <massimob76@gmail.com> --------- Signed-off-by: Massimo Battestini <massimob76@gmail.com> Signed-off-by: Aaron Miller <afrodidact@outlook.com> Add step to generate terraform provider documentation by running tfplugindocs (opensearch-project#120) Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> Signed-off-by: Aaron Miller <afrodidact@outlook.com> Improve documentation for HTTP basic authentication (opensearch-project#114) * Update template Signed-off-by: Jason Parraga <sovietaced@gmail.com> * Generate docs using tfplugindocs Signed-off-by: Jason Parraga <sovietaced@gmail.com> --------- Signed-off-by: Jason Parraga <sovietaced@gmail.com> Signed-off-by: Aaron Miller <afrodidact@outlook.com> fix complaints in errcheck linter Signed-off-by: Aaron Miller <afrodidact@outlook.com> Add proxy support (opensearch-project#95) * Add proxy support Add a new optional parameter to the provider configuration to allow for setting a proxy. Using a proxy can be an easier method for connecting to clusters within a VPC. Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com> * Add proxy support docs Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com> --------- Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com> Add anomaly detection (opensearch-project#105) * Add anomaly detection Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Add test for update Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Add audit config in anomaly detector test Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Format terraform in test Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> --------- Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> When the provider assumes a given role, don't use the default profile… (opensearch-project#87) * When the provider assumes a given role, don't use the default profile if the profile is not given, but allow aws-sdk-go to find the credentials using the default credential provider chain (opensearch-project#86) Signed-off-by: Massimo Battestini <massimob76@gmail.com> * Adds unit tests for AWS profile change (opensearch-project#86) Signed-off-by: Massimo Battestini <massimob76@gmail.com> --------- Signed-off-by: Massimo Battestini <massimob76@gmail.com> Add step to generate terraform provider documentation by running tfplugindocs (opensearch-project#120) Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> Improve documentation for HTTP basic authentication (opensearch-project#114) * Update template Signed-off-by: Jason Parraga <sovietaced@gmail.com> * Generate docs using tfplugindocs Signed-off-by: Jason Parraga <sovietaced@gmail.com> --------- Signed-off-by: Jason Parraga <sovietaced@gmail.com> Add proxy support (opensearch-project#95) * Add proxy support Add a new optional parameter to the provider configuration to allow for setting a proxy. Using a proxy can be an easier method for connecting to clusters within a VPC. Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com> * Add proxy support docs Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com> --------- Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com> Add anomaly detection (opensearch-project#105) * Add anomaly detection Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Add test for update Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Add audit config in anomaly detector test Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> * Format terraform in test Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> --------- Signed-off-by: Rupa Lahiri <rupacoach@gmail.com> Improve documentation for HTTP basic authentication (opensearch-project#114) * Update template Signed-off-by: Jason Parraga <sovietaced@gmail.com> * Generate docs using tfplugindocs Signed-off-by: Jason Parraga <sovietaced@gmail.com> --------- Signed-off-by: Jason Parraga <sovietaced@gmail.com> Add proxy support (opensearch-project#95) * Add proxy support Add a new optional parameter to the provider configuration to allow for setting a proxy. Using a proxy can be an easier method for connecting to clusters within a VPC. Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com> * Add proxy support docs Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com> --------- Signed-off-by: Tim Wisbauer <tim.wisbauer@contrastsecurity.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates the documentation with examples for configuring the provider to use HTTP basic authentication. I classified this under the "static credentials" section but I'm happy to reorganize things. The example is particularly useful because request signing is enabled by default and will result in mysterious HTTP 403 errors, ie
Issues Resolved
#107
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.