iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adds consistency to installation documentation (#1881) 

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
This commit is contained in:
kolchfa-aws 2022-11-16 10:29:30 -05:00 committed by GitHub
parent 0a8a81eff6
commit 736de2c6e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
_opensearch/install/rpm.md
View File

@ -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

14
_opensearch/install/tar.md
View File

@ -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

2
_security-plugin/configuration/ldap.md
View File

@ -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:

2
_security-plugin/configuration/saml.md
View File

@ -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: