Removes bullet points and the term "guide" from quickstart.md (#2027)

* Incorporate changes to make numbered steps easier to navigate and removed guide from the title

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

* Rewording

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>

Signed-off-by: JeffH-AWS <jeffhuss@amazon.com>
This commit is contained in:
Jeff Huss 2022-11-23 13:52:48 -08:00 committed by GitHub
parent 0d488028c6
commit 4051de54af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,11 +1,11 @@
--- ---
layout: default layout: default
title: Quickstart guide title: Quickstart
parent: Install OpenSearch parent: Install OpenSearch
nav_order: 1 nav_order: 1
--- ---
# Quickstart guide # Quickstart
Get started using OpenSearch and OpenSearch Dashboards by deploying your containers with [Docker](https://www.docker.com/). Before proceeding, you need to [get Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://github.com/docker/compose) installed on your local machine. Get started using OpenSearch and OpenSearch Dashboards by deploying your containers with [Docker](https://www.docker.com/). Before proceeding, you need to [get Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://github.com/docker/compose) installed on your local machine.
@ -16,17 +16,15 @@ The Docker Compose commands used in this guide are written with a hyphen (for ex
You'll need a special file, called a Compose file, that Docker Compose uses to define and create the containers in your cluster. The OpenSearch Project provides a sample Compose file that you can use to get started. Learn more about working with Compose files by reviewing the official [Compose specification](https://docs.docker.com/compose/compose-file/). You'll need a special file, called a Compose file, that Docker Compose uses to define and create the containers in your cluster. The OpenSearch Project provides a sample Compose file that you can use to get started. Learn more about working with Compose files by reviewing the official [Compose specification](https://docs.docker.com/compose/compose-file/).
1. Before running OpenSearch on your machine, you should review and apply these [important system settings]({{site.url}}{{site.baseurl}}/opensearch/install/important-settings/). 1. Before running OpenSearch on your machine, you should disable memory paging and swapping performance on the host to improve performance and increase the number of memory maps available to OpenSearch. See [important system settings]({{site.url}}{{site.baseurl}}/opensearch/install/important-settings/) for more information.
- Disable memory paging and swapping performance on the host to improve performance.
```bash ```bash
# Disable memory paging and swapping.
sudo swapoff -a sudo swapoff -a
```
- Increase the number of memory maps available to OpenSearch. # Edit the sysctl config file that defines the host's max map count.
```bash
# Edit the sysctl config file.
sudo vi /etc/sysctl.conf sudo vi /etc/sysctl.conf
# Define the max map count. # Set max map count to the recommended value of 262144.
vm.max_map_count=262144 vm.max_map_count=262144
# Reload the kernel parameters. # Reload the kernel parameters.
@ -56,7 +54,7 @@ You'll need a special file, called a Compose file, that Docker Compose uses to d
```bash ```bash
curl https://localhost:9200 -ku admin:admin curl https://localhost:9200 -ku admin:admin
``` ```
- Sample response: Sample response:
```json ```json
{ {
"name" : "opensearch-node1", "name" : "opensearch-node1",
@ -76,8 +74,7 @@ You'll need a special file, called a Compose file, that Docker Compose uses to d
"tagline" : "The OpenSearch Project: https://opensearch.org/" "tagline" : "The OpenSearch Project: https://opensearch.org/"
} }
``` ```
1. Explore OpenSearch Dashboards by opening `http://localhost:5601/` in a web browser on the same host that is running your OpenSearch cluster. 1. Explore OpenSearch Dashboards by opening `http://localhost:5601/` in a web browser on the same host that is running your OpenSearch cluster. The default username is `admin` and the default password is `admin`.
- The default username is `admin` and the default password is `admin`.
## Create an index and field mappings using sample data ## Create an index and field mappings using sample data
@ -111,9 +108,8 @@ Create an index and define field mappings using a dataset provided by the OpenSe
```bash ```bash
curl -H 'Content-Type: application/json' -X GET "https://localhost:9200/ecommerce/_search?pretty=true" -ku admin:admin -d' {"query":{"match":{"customer_first_name":"Sonya"}}}' curl -H 'Content-Type: application/json' -X GET "https://localhost:9200/ecommerce/_search?pretty=true" -ku admin:admin -d' {"query":{"match":{"customer_first_name":"Sonya"}}}'
``` ```
- Add the query parameter `pretty=true` to OpenSearch API requests that return a JSON to see a more readable version of the response body. Otherwise, the response will be a flat JSON. For more information about `pretty` and other query parameters, see [Common REST parameters]({{site.url}}{{site.baseurl}}/opensearch/common-parameters/). Queries submitted to the OpenSearch REST API will generally return a flat JSON by default. For a human readable response body, use the query parameter `pretty=true`. For more information about `pretty` and other useful query parameters, see [Common REST parameters]({{site.url}}{{site.baseurl}}/opensearch/common-parameters/).
1. Access OpenSearch Dashboards by opening `http://localhost:5601/` in a web browser on the same host that is running your OpenSearch cluster. 1. Access OpenSearch Dashboards by opening `http://localhost:5601/` in a web browser on the same host that is running your OpenSearch cluster. The default username is `admin` and the default password is `admin`.
- The default username is `admin` and the default password is `admin`.
1. On the top menu bar, go to **Management > Dev Tools**. 1. On the top menu bar, go to **Management > Dev Tools**.
1. In the left pane of the console, enter the following: 1. In the left pane of the console, enter the following:
```json ```json