chore(docs): improve OpenSearch spelling (#140)

Signed-off-by: Eugene Tolbakov <[email protected]>
opensearch-project · Dec 22, 2023 · 15ede3a · 15ede3a
1 parent 0a0c87b
commit 15ede3a
Show file tree

Hide file tree

Showing 17 changed files with 39 additions and 39 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -88,7 +88,7 @@ jobs:
       run: |
         ./script/test-mod-tidy
         ./script/test-terraform-fmt
-    - name: Wait for Opensearch
+    - name: Wait for OpenSearch
       # ensure that OS has come up and is available
       run: |
         ./script/wait-for-endpoint --timeout=20 http://admin:admin@localhost:9200

diff --git a/README.md b/README.md
@@ -16,9 +16,9 @@ This is a terraform provider to provision OpenSearch resources.
 
 ### Compatibility
 
-This provider will target compatibility with major versions of Opensearch, each major version of this provider corresponding to the major version of Opensearch.
+This provider will target compatibility with major versions of OpenSearch, each major version of this provider corresponding to the major version of OpenSearch.
 
-| Opensearch version | Supported          |
+| OpenSearch version | Supported          |
 | -----------        | ---------          |
 | 2.x                | :white_check_mark: |
 
@@ -121,7 +121,7 @@ If you discover a potential security issue in this project we ask that you notif
 
 ## License
 
-This project is licensed under the [Apache v2.0 License](LICENSE.txt).
+This project is licensed under the [Apache v2.0 License](LICENSE).
 
 ## Copyright
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,24 +1,24 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "Opensearch Provider"
+page_title: "OpenSearch Provider"
 subcategory: ""
 description: |-
-  The provider is used to interact with the resources supported by Opensearch.
+  The provider is used to interact with the resources supported by OpenSearch.
 ---
 
-# Opensearch Provider
+# OpenSearch Provider
 
-The provider is used to interact with the resources supported by Opensearch.
+The provider is used to interact with the resources supported by OpenSearch.
 The provider needs to be configured with an endpoint URL before it can be
 used.
 
-AWS Opensearch Service domains and OpenSearch clusters deployed on Kubernetes
+AWS OpenSearch Service domains and OpenSearch clusters deployed on Kubernetes
 and other infrastructure are supported.
 
 Use the navigation to the left to read about the available resources.
 
 ```terraform
-# Configure the Opensearch provider
+# Configure the OpenSearch provider
 provider "opensearch" {
   url = "http://127.0.0.1:9200"
 }
@@ -58,18 +58,18 @@ EOF
 
 ### Required
 
-- `url` (String) Opensearch URL
+- `url` (String) OpenSearch URL
 
 ### Optional
 
-- `aws_access_key` (String) The access key for use with AWS opensearch Service domains
+- `aws_access_key` (String) The access key for use with AWS OpenSearch Service domains
 - `aws_assume_role_arn` (String) Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
 - `aws_assume_role_external_id` (String) External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
-- `aws_profile` (String) The AWS profile for use with AWS opensearch Service domains
-- `aws_region` (String) The AWS region for use in signing of AWS opensearch requests. Must be specified in order to use AWS URL signing with AWS OpenSearch endpoint exposed on a custom DNS domain.
-- `aws_secret_key` (String) The secret key for use with AWS opensearch Service domains
+- `aws_profile` (String) The AWS profile for use with AWS OpenSearch Service domains
+- `aws_region` (String) The AWS region for use in signing of AWS OpenSearch requests. Must be specified in order to use AWS URL signing with AWS OpenSearch endpoint exposed on a custom DNS domain.
+- `aws_secret_key` (String) The secret key for use with AWS OpenSearch Service domains
 - `aws_signature_service` (String) AWS service name used in the credential scope of signed requests to opensearch.
-- `aws_token` (String) The session token for use with AWS opensearch Service domains
+- `aws_token` (String) The session token for use with AWS OpenSearch Service domains
 - `cacert_file` (String) A Custom CA certificate
 - `client_cert_path` (String) A X509 certificate to connect to opensearch
 - `client_key_path` (String) A X509 key to connect to opensearch

diff --git a/docs/resources/cluster_settings.md b/docs/resources/cluster_settings.md
@@ -29,7 +29,7 @@ resource "opensearch_cluster_settings" "global" {
 - `cluster_blocks_read_only` (Boolean) Make the whole cluster read only and metadata is not allowed to be modified
 - `cluster_blocks_read_only_allow_delete` (Boolean) Make the whole cluster read only, but allows to delete indices to free up resources
 - `cluster_indices_close_enable` (Boolean) If false, you cannot close open indices
-- `cluster_info_update_interval` (String) A time string controlling how often Opensearch should check on disk usage for each node in the cluster
+- `cluster_info_update_interval` (String) A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
 - `cluster_max_shards_per_node` (Number) The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
 - `cluster_max_shards_per_node_frozen` (Number) The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
 - `cluster_no_master_block` (String) Specifies which operations are rejected when there is no active master in a cluster (all, write)

diff --git a/docs/resources/index_template.md b/docs/resources/index_template.md
@@ -3,12 +3,12 @@
 page_title: "opensearch_index_template Resource - terraform-provider-opensearch"
 subcategory: ""
 description: |-
-  Provides an Opensearch index template resource.
+  Provides an OpenSearch index template resource.
 ---
 
 # opensearch_index_template (Resource)
 
-Provides an Opensearch index template resource.
+Provides an OpenSearch index template resource.
 
 ## Example Usage
 

diff --git a/docs/resources/ingest_pipeline.md b/docs/resources/ingest_pipeline.md
@@ -3,12 +3,12 @@
 page_title: "opensearch_ingest_pipeline Resource - terraform-provider-opensearch"
 subcategory: ""
 description: |-
-  Provides an Opensearch ingest pipeline resource.
+  Provides an OpenSearch ingest pipeline resource.
 ---
 
 # opensearch_ingest_pipeline (Resource)
 
-Provides an Opensearch ingest pipeline resource.
+Provides an OpenSearch ingest pipeline resource.
 
 ## Example Usage
 

diff --git a/docs/resources/script.md b/docs/resources/script.md
@@ -3,12 +3,12 @@
 page_title: "opensearch_script Resource - terraform-provider-opensearch"
 subcategory: ""
 description: |-
-  Provides an Opensearch script resource.
+  Provides an OpenSearch script resource.
 ---
 
 # opensearch_script (Resource)
 
-Provides an Opensearch script resource.
+Provides an OpenSearch script resource.
 
 ## Example Usage
 

diff --git a/docs/resources/snapshot_repository.md b/docs/resources/snapshot_repository.md
@@ -3,12 +3,12 @@
 page_title: "opensearch_snapshot_repository Resource - terraform-provider-opensearch"
 subcategory: ""
 description: |-
-  Provides an Opensearch snapshot repository resource.
+  Provides an OpenSearch snapshot repository resource.
 ---
 
 # opensearch_snapshot_repository (Resource)
 
-Provides an Opensearch snapshot repository resource.
+Provides an OpenSearch snapshot repository resource.
 
 ## Example Usage
 

diff --git a/docs/resources/user.md b/docs/resources/user.md
@@ -55,7 +55,7 @@ resource "opensearch_roles_mapping" "reader" {
 - `attributes` (Map of String) A map of arbitrary key value string pairs stored alongside of users.
 - `backend_roles` (Set of String) A list of backend roles.
 - `description` (String) Description of the user.
-- `password` (String, Sensitive) The plain text password for the user, cannot be specified with `password_hash`. Some implementations may enforce a password policy. Invalid passwords may cause a non-descriptive HTTP 400 Bad Request error. For AWS Opensearch domains "password must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one digit, and one special character".
+- `password` (String, Sensitive) The plain text password for the user, cannot be specified with `password_hash`. Some implementations may enforce a password policy. Invalid passwords may cause a non-descriptive HTTP 400 Bad Request error. For AWS OpenSearch domains "password must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one digit, and one special character".
 - `password_hash` (String, Sensitive) The pre-hashed password for the user, cannot be specified with `password`.
 
 ### Read-Only

diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,4 +1,4 @@
-# Configure the Opensearch provider
+# Configure the OpenSearch provider
 provider "opensearch" {
   url = "http://127.0.0.1:9200"
 }

diff --git a/provider/resource_opensearch_cluster_settings.go b/provider/resource_opensearch_cluster_settings.go
@@ -113,7 +113,7 @@ func resourceOpensearchClusterSettings() *schema.Resource {
 			"cluster_info_update_interval": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "A time string controlling how often Opensearch should check on disk usage for each node in the cluster",
+				Description: "A time string controlling how often OpenSearch should check on disk usage for each node in the cluster",
 			},
 			"cluster_routing_allocation_allow_rebalance": {
 				Type:        schema.TypeString,

diff --git a/provider/resource_opensearch_ingest_pipeline.go b/provider/resource_opensearch_ingest_pipeline.go
@@ -11,7 +11,7 @@ import (
 
 func resourceOpensearchIngestPipeline() *schema.Resource {
 	return &schema.Resource{
-		Description: "Provides an Opensearch ingest pipeline resource.",
+		Description: "Provides an OpenSearch ingest pipeline resource.",
 		Create:      resourceOpensearchIngestPipelineCreate,
 		Read:        resourceOpensearchIngestPipelineRead,
 		Update:      resourceOpensearchIngestPipelineUpdate,

diff --git a/provider/resource_opensearch_script.go b/provider/resource_opensearch_script.go
@@ -33,7 +33,7 @@ var scriptSchema = map[string]*schema.Schema{
 
 func resourceOpensearchScript() *schema.Resource {
 	return &schema.Resource{
-		Description: "Provides an Opensearch script resource.",
+		Description: "Provides an OpenSearch script resource.",
 		Create:      resourceOpensearchScriptCreate,
 		Read:        resourceOpensearchScriptRead,
 		Update:      resourceOpensearchScriptUpdate,

diff --git a/provider/resource_opensearch_sm_policy.go b/provider/resource_opensearch_sm_policy.go
@@ -75,7 +75,7 @@ func resourceOpensearchSMPolicyCreate(d *schema.ResourceData, m interface{}) err
 	policyResponse, err := resourceOpensearchPostPutSMPolicy(d, m, "POST")
 
 	if err != nil {
-		log.Printf("[INFO] Failed to create OpensearchPolicy: %+v", err)
+		log.Printf("[INFO] Failed to create OpenSearchPolicy: %+v", err)
 		return err
 	}
 
@@ -88,7 +88,7 @@ func resourceOpensearchSMPolicyRead(d *schema.ResourceData, m interface{}) error
 
 	if err != nil {
 		if elastic7.IsNotFound(err) {
-			log.Printf("[WARN] Opensearch Policy (%s) not found, removing from state", d.Get("policy_name").(string))
+			log.Printf("[WARN] OpenSearch Policy (%s) not found, removing from state", d.Get("policy_name").(string))
 			d.SetId("")
 			return nil
 		}

diff --git a/provider/resource_opensearch_snapshot_repository.go b/provider/resource_opensearch_snapshot_repository.go
@@ -9,7 +9,7 @@ import (
 
 func resourceOpensearchSnapshotRepository() *schema.Resource {
 	return &schema.Resource{
-		Description: "Provides an Opensearch snapshot repository resource.",
+		Description: "Provides an OpenSearch snapshot repository resource.",
 		Create:      resourceOpensearchSnapshotRepositoryCreate,
 		Read:        resourceOpensearchSnapshotRepositoryRead,
 		Update:      resourceOpensearchSnapshotRepositoryUpdate,

diff --git a/provider/resource_opensearch_user.go b/provider/resource_opensearch_user.go
@@ -21,7 +21,7 @@ var openDistroUserSchema = map[string]*schema.Schema{
 		Required:    true,
 	},
 	"password": {
-		Description:   "The plain text password for the user, cannot be specified with `password_hash`. Some implementations may enforce a password policy. Invalid passwords may cause a non-descriptive HTTP 400 Bad Request error. For AWS Opensearch domains \"password must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one digit, and one special character\".",
+		Description:   "The plain text password for the user, cannot be specified with `password_hash`. Some implementations may enforce a password policy. Invalid passwords may cause a non-descriptive HTTP 400 Bad Request error. For AWS OpenSearch domains \"password must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one digit, and one special character\".",
 		Type:          schema.TypeString,
 		Optional:      true,
 		Sensitive:     true,

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -1,18 +1,18 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "Opensearch Provider"
+page_title: "OpenSearch Provider"
 subcategory: ""
 description: |-
-  The provider is used to interact with the resources supported by Opensearch.
+  The provider is used to interact with the resources supported by OpenSearch.
 ---
 
-# Opensearch Provider
+# OpenSearch Provider
 
-The provider is used to interact with the resources supported by Opensearch.
+The provider is used to interact with the resources supported by OpenSearch.
 The provider needs to be configured with an endpoint URL before it can be
 used.
 
-AWS Opensearch Service domains and OpenSearch clusters deployed on Kubernetes
+AWS OpenSearch Service domains and OpenSearch clusters deployed on Kubernetes
 and other infrastructure are supported.
 
 Use the navigation to the left to read about the available resources.