From 736de2c6e482e84973149dd01fc33ff0e6195773 Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Wed, 16 Nov 2022 10:29:30 -0500 Subject: [PATCH] Adds consistency to installation documentation (#1881) Signed-off-by: Fanit Kolchina Signed-off-by: Fanit Kolchina --- _opensearch/install/rpm.md | 10 +++++----- _opensearch/install/tar.md | 14 +++++++------- _security-plugin/configuration/ldap.md | 2 +- _security-plugin/configuration/saml.md | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/_opensearch/install/rpm.md b/_opensearch/install/rpm.md index 39257696..3092a7ee 100644 --- a/_opensearch/install/rpm.md +++ b/_opensearch/install/rpm.md @@ -146,7 +146,7 @@ An OpenSearch node in its default configuration (with demo certificates and user {: .warning} 1. Send requests to the server to verify that OpenSearch is running. Note the use of the `--insecure` flag, which is required because the TLS certificates are self-signed. - - Send a request to port 9200. + - Send a request to port 9200: ```bash curl -X GET https://localhost:9200 -u 'admin:admin' --insecure ``` @@ -170,7 +170,7 @@ An OpenSearch node in its default configuration (with demo certificates and user "tagline" : "The OpenSearch Project: https://opensearch.org/" } ``` - - Query the plugins endpoint. + - Query the plugins endpoint: ```bash curl -X GET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure ``` @@ -202,7 +202,7 @@ Users who do not have prior experience with OpenSearch may want a list of recomm The following recommended settings will allow you to: - Bind OpenSearch to an IP or network interface on the host. -- Set initial and max JVM heap sizes. +- Set initial and maximum JVM heap sizes. - Define an environment variable that points to the bundled JDK. - Configure your own TLS certificates—no third-party certificate authority (CA) is required. - Create an admin user with a custom password. @@ -234,12 +234,12 @@ Before modifying any configuration files, it's always a good idea to save a back plugins.security.disabled: false ``` 1. Save your changes and close the file. -1. Specify initial and max JVM heap sizes. +1. Specify initial and maximum JVM heap sizes. 1. Open `jvm.options`. ```bash vi /etc/opensearch/jvm.options ``` - 1. Modify the values for initial and max heap sizes. As a starting point, you should set these values to half of the available system memory. For dedicated hosts this value can be increased based on your workflow requirements. + 1. Modify the values for initial and maximum heap sizes. As a starting point, you should set these values to half of the available system memory. For dedicated hosts this value can be increased based on your workflow requirements. - As an example, if the host machine has 8 GB of memory, then you might want to set the initial and maximum heap sizes to 4 GB: ```bash -Xms4g diff --git a/_opensearch/install/tar.md b/_opensearch/install/tar.md index b973c72f..45232156 100644 --- a/_opensearch/install/tar.md +++ b/_opensearch/install/tar.md @@ -84,7 +84,7 @@ An OpenSearch node configured by the demo security script is not suitable for a ### Option 1: Test your Opensearch settings with security enabled -1. Change to the top directory of your OpenSearch install. +1. Change to the top directory of your OpenSearch installation. ```bash cd /path/to/opensearch-{{site.opensearch_version}} ``` @@ -93,7 +93,7 @@ An OpenSearch node configured by the demo security script is not suitable for a ./opensearch-tar-install.sh ``` 1. Open another terminal session and send requests to the server to verify that OpenSearch is running. Note the use of the `--insecure` flag, which is required because the TLS certificates are self-signed. - - Send a request to port 9200. + - Send a request to port 9200: ```bash curl -X GET https://localhost:9200 -u 'admin:admin' --insecure ``` @@ -117,7 +117,7 @@ An OpenSearch node configured by the demo security script is not suitable for a "tagline" : "The OpenSearch Project: https://opensearch.org/" } ``` - - Query the plugins endpoint. + - Query the plugins endpoint: ```bash curl -X GET https://localhost:9200/_cat/plugins?v -u 'admin:admin' --insecure ``` @@ -149,7 +149,7 @@ An OpenSearch node configured by the demo security script is not suitable for a ```bash vi /path/to/opensearch-{{site.opensearch_version}}/config/opensearch.yml ``` -1. Add the following line to disable the security plugin. +1. Add the following line to disable the security plugin: ```bash plugins.security.disabled: true ``` @@ -211,7 +211,7 @@ Users who do not have prior experience with OpenSearch may want a list of recomm The following recommended settings will allow you to: - Bind OpenSearch to an IP or network interface on the host. -- Set initial and max JVM heap sizes. +- Set initial and maximum JVM heap sizes. - Define an environment variable that points to the bundled JDK. - Configure your own TLS certificates - no third-party certificate authority (CA) is required. - Create an admin user with a custom password. @@ -243,12 +243,12 @@ Before modifying any configuration files, it's always a good idea to save a back plugins.security.disabled: false ``` 1. Save your changes and close the file. -1. Specify initial and max JVM heap sizes. +1. Specify initial and maximum JVM heap sizes. 1. Open `jvm.options`. ```bash vi /path/to/opensearch-{{site.opensearch_version}}/config/jvm.options ``` - 1. Modify the values for initial and max heap sizes. As a starting point, you should set these values to half of the available system memory. For dedicated hosts this value can be increased based on your workflow requirements. + 1. Modify the values for initial and maximum heap sizes. As a starting point, you should set these values to half of the available system memory. For dedicated hosts this value can be increased based on your workflow requirements. - As an example, if the host machine has 8 GB of memory then you might want to set the initial and maximum heap sizes to 4 GB: ```bash -Xms4g diff --git a/_security-plugin/configuration/ldap.md b/_security-plugin/configuration/ldap.md index 398e350b..482ec435 100755 --- a/_security-plugin/configuration/ldap.md +++ b/_security-plugin/configuration/ldap.md @@ -16,7 +16,7 @@ In most cases, you want to configure both authentication and authorization. You We provide a fully functional example that can help you understand how to use an LDAP server for both authentication and authorization. -1. Download and unzip [the example ZIP file]({{site.url}}{{site.baseurl}}/assets/examples/ldap-example.zip). +1. Download and unzip [the example zip file]({{site.url}}{{site.baseurl}}/assets/examples/ldap-example.zip). 1. At the command line, run `docker-compose up`. 1. Review the files: diff --git a/_security-plugin/configuration/saml.md b/_security-plugin/configuration/saml.md index 83dfb4e1..03aee0ad 100755 --- a/_security-plugin/configuration/saml.md +++ b/_security-plugin/configuration/saml.md @@ -16,7 +16,7 @@ This profile is meant for use with web browsers. It is not a general-purpose way We provide a fully functional example that can help you understand how to use SAML with OpenSearch Dashboards. -1. Download and unzip [the example ZIP file]({{site.url}}{{site.baseurl}}/assets/examples/saml-example.zip). +1. Download and unzip [the example zip file]({{site.url}}{{site.baseurl}}/assets/examples/saml-example.zip). 1. At the command line, run `docker-compose up`. 1. Review the files: