Improve documentation for HTTP basic authentication (#114)

* Update template

Signed-off-by: Jason Parraga <[email protected]>

* Generate docs using tfplugindocs

Signed-off-by: Jason Parraga <[email protected]>

---------

Signed-off-by: Jason Parraga <[email protected]>

docs/data-sources/host.md

@@ -29,5 +29,3 @@ data "opensearch_host" "test" {
 
 - `id` (String) The ID of this resource.
 - `url` (String) the url of the active cluster
-
-

docs/index.md

@@ -56,6 +56,10 @@ EOF
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
+### Required
+
+- `url` (String) Opensearch URL
+
 ### Optional
 
 - `aws_access_key` (String) The access key for use with AWS opensearch Service domains
@@ -78,7 +82,6 @@ EOF
 - `sniff` (Boolean) Set the node sniffing option for the opensearch client. Client won't work with sniffing if nodes are not routable.
 - `token` (String) A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
 - `token_name` (String) The type of token, usually ApiKey or Bearer
-- `url` (String) Opensearch URL
 - `username` (String) Username to use to connect to opensearch using basic auth
 - `version_ping_timeout` (Number) Version ping timeout in seconds
 
@@ -97,7 +100,9 @@ If a [custom domain](https://docs.aws.amazon.com/opensearch-service/latest/devel
 
 #### Static credentials
 
-Static credentials can be provided by adding an `aws_access_key` and `aws_secret_key` in-line in the provider block. If applicable, you may also specify a `aws_token` value.
+##### IAM user management
+
+If your AWS OpenSearch domain uses IAM user management, static credentials can be provided by adding an `aws_access_key` and `aws_secret_key` in-line in the provider block. If applicable, you may also specify a `aws_token` value.
 
 Example usage:
 
@@ -110,6 +115,22 @@ provider "opensearch" {
 }
 ```
 
+##### HTTP basic auth
+
+If your AWS OpenSearch domain uses an internal user database, static credentials can be provided by adding a `username` and `password` in-line in the provider block. Note: You will need to explicitly disabled request signing.
+
+Example usage:
+
+```tf
+provider "opensearch" {
+    url               = "https://search-foo-bar-pqrhr4w3u4dzervg41frow4mmy.us-east-1.es.amazonaws.com"
+    username          = "ausername"
+    password          = "apassword"
+    # Must be disabled for basic auth
+    sign_aws_requests = false
+}
+```
+
 #### Assume role configuration
 
 You can instruct the provider to assume a role in AWS before interacting with the cluster by setting the `aws_assume_role_arn` variable.

docs/resources/anomaly_detection.md

@@ -78,5 +78,3 @@ EOF
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-
-

docs/resources/channel_configuration.md

@@ -22,5 +22,3 @@ Provides an OpenSearch channel configuration. Please refer to the OpenSearch cha
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-
-

docs/resources/cluster_settings.md

@@ -67,5 +67,3 @@ resource "opensearch_cluster_settings" "global" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-
-

docs/resources/dashboard_object.md

@@ -106,5 +106,3 @@ EOF
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-
-

docs/resources/data_stream.md

@@ -39,5 +39,3 @@ resource "opensearch_data_stream" "foo" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-
-

templates/index.md.tmpl

@@ -36,7 +36,9 @@ If a [custom domain](https://docs.aws.amazon.com/opensearch-service/latest/devel
 
 #### Static credentials
 
-Static credentials can be provided by adding an `aws_access_key` and `aws_secret_key` in-line in the provider block. If applicable, you may also specify a `aws_token` value.
+##### IAM user management
+
+If your AWS OpenSearch domain uses IAM user management, static credentials can be provided by adding an `aws_access_key` and `aws_secret_key` in-line in the provider block. If applicable, you may also specify a `aws_token` value.
 
 Example usage:
 
@@ -49,6 +51,22 @@ provider "opensearch" {
 }
 ```
 
+##### HTTP basic auth
+
+If your AWS OpenSearch domain uses an internal user database, static credentials can be provided by adding a `username` and `password` in-line in the provider block. Note: You will need to explicitly disabled request signing.
+
+Example usage:
+
+```tf
+provider "opensearch" {
+    url               = "https://search-foo-bar-pqrhr4w3u4dzervg41frow4mmy.us-east-1.es.amazonaws.com"
+    username          = "ausername"
+    password          = "apassword"
+    # Must be disabled for basic auth
+    sign_aws_requests = false
+}
+```
+
 #### Assume role configuration
 
 You can instruct the provider to assume a role in AWS before interacting with the cluster by setting the `aws_assume_role_arn` variable.