OpenSearch

https://docs.opensearch.org/latest/
Admin
OpenSearch is a highly scalable and extensible open-source software suite for search, analytics,...
Tokens:5,024,844
Snippets:32,770
Trust Score:10
Update:55 minutes ago
Show doc for...
Tokens:
Raw
### Install the opensearch-ruby gem

Source: https://docs.opensearch.org/latest/clients/ruby/

Run this command to install the Ruby gem for the OpenSearch Ruby client.

```bash
gem install opensearch-ruby
```

--------------------------------

### OpenSearch response example

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Example JSON response from the OpenSearch server, showing cluster name, version, and build details. Placeholder values like <version> are used.

```json
{
  "name" : "a937e018cee5",
  "cluster_name" : "docker-cluster",
  "cluster_uuid" : "GLAjAG6bTeWErFUy_d-CLw",
  "version" : {
    "distribution" : "opensearch",
    "number" : <version>,
    "build_type" : <build-type>,
    "build_hash" : <build-hash>,
    "build_date" : <build-date>,
    "build_snapshot" : false,
    "lucene_version" : <lucene-version>,
    "minimum_wire_compatibility_version" : "7.10.0",
    "minimum_index_compatibility_version" : "7.0.0"
  },
  "tagline" : "The OpenSearch Project: https://opensearch.org/"
}
```

--------------------------------

### Imports for connection examples

Source: https://docs.opensearch.org/latest/clients/rust/

Required imports for the connection examples on this page.

```rust
use opensearch::{
    http::transport::{SingleNodeConnectionPool, Transport, TransportBuilder},
    http::Url,
    OpenSearch,
};
```

--------------------------------

### Expected output of docker compose ps

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Example output showing the OpenSearch and Dashboards containers running.

```text
NAME                    IMAGE                                            COMMAND                  SERVICE                 CREATED          STATUS          PORTS
opensearch-dashboards   opensearchproject/opensearch-dashboards:latest   "./opensearch-dashbo…"   opensearch-dashboards   30 seconds ago   Up 30 seconds   0.0.0.0:5601->5601/tcp, [::]:5601->5601/tcp
opensearch-node1        opensearchproject/opensearch:latest              "./opensearch-docker…"   opensearch-node1        30 seconds ago   Up 30 seconds   0.0.0.0:9200->9200/tcp, [::]:9200->9200/tcp, 9300/tcp, 0.0.0.0:9600->9600/tcp, [::]:9600->9600/tcp, 9650/tcp
opensearch-node2        opensearchproject/opensearch:latest              "./opensearch-docker…"   opensearch-node2        30 seconds ago   Up 30 seconds   9200/tcp, 9300/tcp, 9600/tcp, 9650/tcp
```

--------------------------------

### Start the Docker Compose cluster

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Run this command in the directory containing your docker-compose.yml file to start the OpenSearch and OpenSearch Dashboards containers in detached mode.

```bash
 docker compose up -d
```

--------------------------------

### Sample program: create client, index, bulk, search, update, delete

Source: https://docs.opensearch.org/latest/clients/go/

Combines code from preceding sections. Connects to a cluster with the Security plugin enabled; change lines marked with `// Without security` to connect without it. For testing only: specifies credentials in code and disables certificate validation. In production, load credentials securely and validate certificates.

```go
package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	"strings"

	"github.com/opensearch-project/opensearch-go/v5"
	"github.com/opensearch-project/opensearch-go/v5/opensearchapi"
	"github.com/opensearch-project/opensearch-go/v5/opensearchutil"
)

type Student struct {
	FirstName string  `json:"firstName"`
	LastName  string  `json:"lastName"`
	GPA       float64 `json:"gpa"`
	GradDate  string  `json:"gradDate"`
}

func main() {
	if err := run(); err != nil {
		fmt.Println("Error:", err)
		os.Exit(1)
	}
}

func run() error {
	ctx := context.Background()

	client, err := opensearchapi.NewClient(opensearchapi.Config{
		Client: opensearch.Config{
			// Without security, use http://localhost:9200
			Addresses: []string{"https://localhost:9200"},
			// Without security, remove this line
			InsecureSkipVerify: true,
			// Without security, remove this line
			Username: "admin",
			// Without security, remove this line
			Password:             "<custom-admin-password>",
			DiscoverNodesOnStart: new(false),
		},
	})
	if err != nil {
		return err
	}

	// Create the index
	index := "students"
	fmt.Println("Creating index......")
	body := `{
	  "settings": {
	    "index": {
	      "number_of_shards": 1,
	      "number_of_replicas": 1
	    }
	  },
	  "mappings": {
	    "properties": {
	      "gradDate": { "type": "date", "format": "yyyy-MM-dd" }
	    }
	  }
	}`
	createResp, err := client.Indices.Create(ctx, opensearchapi.IndicesCreateReq{
		Index:      index,
		BodyReader: strings.NewReader(body),
	})
	if err != nil {
		return err
	}
	fmt.Println("Index created:", createResp.Index)

	// Index a document
	fmt.Println("\nIndexing one student......")
	student := Student{FirstName: "John", LastName: "Doe", GPA: 3.89, GradDate: "2022-05-15"}
	indexResp, err := client.Doc.Index(ctx, opensearchapi.IndexReq{
		Index:  index,
		ID:     "1",
		Body:   opensearchutil.NewJSONReader(student),
		Params: &opensearchapi.IndexParams{Refresh: "true"},
	})
	if err != nil {
		return err
	}
	fmt.Printf("Result: %s, id: %s, version: %d\n", indexResp.Result, indexResp.ID, indexResp.Version)

	// Bulk index documents
	fmt.Println("\nIndexing many students......")
	students := []struct {
		id      string
		student Student
	}{
		{"2", Student{FirstName: "Paulo", LastName: "Santos", GPA: 3.93, GradDate: "2021-05-20"}},
		{"3", Student{FirstName: "Shirley", LastName: "Rodriguez", GPA: 3.91, GradDate: "2019-05-10"}},
	}
	var bulkBody strings.Builder
	for _, s := range students {
		doc, err := json.Marshal(s.student)
		if err != nil {
			return err
		}
		fmt.Fprintf(&bulkBody, "{\"index\":{\"_id\":%q}}\n%s\n", s.id, doc)
	}
	bulkResp, err := client.Doc.Bulk(ctx, opensearchapi.BulkReq{
		Index:  index,
		Body:   strings.NewReader(bulkBody.String()),
		Params: &opensearchapi.BulkParams{Refresh: "true"},
	})
	if err != nil {
		return err
	}
	fmt.Println("Errors:", bulkResp.Errors)
	for _, item := range bulkResp.Items {
		fmt.Printf("  %s id: %s\n", *item.Index.Result, *item.Index.ID)
	}

	// Search for the document
	searchResp, err := client.Search(ctx, &opensearchapi.SearchReq{
		Indices: []string{index},
		Body:    strings.NewReader(`{"query": {"match": {"firstName": "John"}}}`),
	})
	if err != nil {
		return err
	}
	fmt.Println("Search hits:", searchResp.Hits.Total.Value)

	// Update a document
	updateResp, err := client.Doc.Update(ctx, opensearchapi.UpdateReq{
		Index:      index,
		ID:         "1",
		BodyReader: strings.NewReader(`{"doc": {"gpa": 3.92}}`),
	})
	if err != nil {
		return err
	}
	fmt.Println("Update result:", updateResp.Result)

	// Delete a document
	deleteResp, err := client.Doc.Delete(ctx, opensearchapi.DeleteReq{
		Index:  index,
		ID:     "3",
		Params: &opensearchapi.DeleteParams{Refresh: "true"},
	})
	if err != nil {
		return err
	}
	fmt.Println("Delete result:", deleteResp.Result)

	// Delete the index
	deleteIndexResp, err := client.Indices.Delete(ctx, &opensearchapi.IndicesDeleteReq{Indices: []string{index}})
	if err != nil {
		return err
	}
	fmt.Println("Index deleted:", deleteIndexResp.Acknowledged)

	return nil
}
```

--------------------------------

### Install opensearch-aws-sigv4 gem

Source: https://docs.opensearch.org/latest/clients/ruby/

Install the opensearch-aws-sigv4 gem to enable SigV4 authentication for Amazon OpenSearch Service.

```bash
gem install opensearch-aws-sigv4
```

--------------------------------

### Verify OpenSearch Benchmark Installation with --help

Source: https://docs.opensearch.org/latest/benchmark/quickstart/

Checks that OpenSearch Benchmark is installed and accessible by displaying its help information. The command 'opensearch-benchmark --help' shows usage, options, and subcommands. The expected output includes the tool's ASCII art banner and a list of available subcommands like 'run', 'list', 'info', and 'compare'.

```bash
opensearch-benchmark --help
```

```text
$ opensearch-benchmark --help
usage: opensearch-benchmark [-h] [--version] {run,list,info,create-workload,generate,compare,download,install,start,stop} ...

   ____                  _____                      __       ____                  __                         __
  / __ \____  ___  ____ / ___/___  ____ ___________/ /_     / __ )___  ____  _____/ /_  ____ ___  ____ ______/ /__
 / / / / __ \/ _ \/ __ \\__ \/ _ \/ __ `/ ___/ ___/ __ \   / __  / _ \/ __ \/ ___/ __ \/ __ `__ \/ __ `/ ___/ //_/
/ /_/ / /_/ /  __/ / / /__/ /  __/ /_/ / /  / /__/ / / /  / /_/ /  __/ / / / /__/ / / / / / / / / /_/ / /  / ,<
\____/ .___/\___/_/ /_/____/\___/\__,_/_/   \___/_/ /_/  /_____/\___/_/ /_/\___/_/ /_/_/ /_/ /_/\__,_/_/  /_/|_|
    /_/

 A benchmarking tool for OpenSearch

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

subcommands:
  {run,list,info,create-workload,generate,compare,download,install,start,stop}
    run        Run a benchmark
    list                List configuration options
    info                Show info about a workload
    create-workload     Create a Benchmark workload from existing data
    generate            Generate artifacts
    compare             Compare two test-runs
    download            Downloads an artifact
    install             Installs an OpenSearch node locally
    start               Starts an OpenSearch node locally
    stop                Stops an OpenSearch node locally

Find out more about Benchmark at https://opensearch.org/docs
```

--------------------------------

### Delete an index with client.indices.delete

Source: https://docs.opensearch.org/latest/clients/ruby/

Use the `indices.delete` method to delete an entire index. The example deletes the 'students' index.

```ruby
response = client.indices.delete(index: 'students')
```

--------------------------------

### Example response for installing multiple plugins

Source: https://docs.opensearch.org/latest/install-and-configure/plugins/

Shows a sample command that installs analysis-nori and repository-s3 in a single invocation.

```bash
$ sudo ./opensearch-plugin install analysis-nori repository-s3
```

--------------------------------

### Update a document with client.update and retrieve with client.get

Source: https://docs.opensearch.org/latest/clients/ruby/

Use the `update` method with a `doc` object to change fields, then retrieve the updated document with `get`. The example updates the `gpa` field of a student document.

```ruby
response = client.update(index: 'students', id: '1', body: { doc: { gpa: 3.92 } })
response = client.get(index: 'students', id: '1')
```

--------------------------------

### Add opensearch-ruby gem to Gemfile

Source: https://docs.opensearch.org/latest/clients/ruby/

Add this line to your Gemfile and run bundle install. Requires client version 3.4.0 or a later 3.x release.

```ruby
gem 'opensearch-ruby', '~> 3.4'
```

--------------------------------

### Download docker-compose.yml with wget

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Alternative method to download the sample Compose file.

```bash
wget https://raw.githubusercontent.com/opensearch-project/documentation-website/3.9/assets/examples/docker-compose.yml
```

--------------------------------

### Confirm containers are running

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Shows the status of the running containers.

```bash
docker compose ps
```

--------------------------------

### Output of client.cluster.health with logging

Source: https://docs.opensearch.org/latest/clients/ruby/

Example output showing the logged requests and responses when the client has log: true. Includes the cluster health response with status yellow.

```text
2026-09-30 12:29:58 -0400: GET http://localhost:9200/ [status:200, request:0.009s, query:n/a]
2026-09-30 12:29:58 -0400: < {
  "name" : "opensearch-node1",
  "cluster_name" : "opensearch-cluster",
  "cluster_uuid" : "uwutrwdfTVeh8rroYbZh4g",
  "version" : {
    "distribution" : "opensearch",
    "number" : "3.8.0",
    "build_type" : "tar",
    "build_hash" : "e5a3c5691be87af6c12dbe3e158c59c04ee72973",
    "build_date" : "2026-08-03T21:07:36.443334696Z",
    "build_snapshot" : false,
    "lucene_version" : "10.5.0",
    "minimum_wire_compatibility_version" : "2.19.0",
    "minimum_index_compatibility_version" : "2.0.0"
  },
  "tagline" : "The OpenSearch Project: https://opensearch.org/"
}

2026-09-30 12:29:58 -0400: GET http://localhost:9200/_cluster/health [status:200, request:0.007s, query:n/a]
2026-09-30 12:29:58 -0400: < {"cluster_name":"opensearch-cluster","status":"yellow","timed_out":false,"number_of_nodes":1,"number_of_data_nodes":1,"discovered_master":true,"discovered_cluster_manager":true,"active_primary_shards":57,"active_shards":57,"relocating_shards":0,"initializing_shards":0,"unassigned_shards":28,"delayed_unassigned_shards":0,"number_of_pending_tasks":0,"number_of_in_flight_fetch":0,"task_max_waiting_in_queue_millis":0,"active_shards_percent_as_number":67.05882352941175}
```

--------------------------------

### Add aws-auth feature and aws-config dependency to Cargo.toml

Source: https://docs.opensearch.org/latest/clients/rust/

Required setup for signing requests with AWS Signature Version 4. Add these dependencies to your Cargo.toml before using the AWS connection examples.

```toml
opensearch = { version = "2.4.0", features = ["aws-auth"] }
aws-config = "1"
```

--------------------------------

### Download docker-compose.yml with cURL

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Downloads the sample Compose file from the OpenSearch documentation-website repository.

```bash
curl -O https://raw.githubusercontent.com/opensearch-project/documentation-website/3.9/assets/examples/docker-compose.yml
```

--------------------------------

### Reload kernel parameters

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Apply the sysctl changes.

```bash
sudo sysctl -p
```

--------------------------------

### get

Source: https://docs.opensearch.org/latest/clients/ruby/

Retrieves a document by its index and ID. Used to fetch the updated document after an update operation.

```APIDOC
## get

### Description
Retrieves a document by its index and ID.

### Method
get

### Parameters
- **index** (string) - Required - The name of the index.
- **id** (string) - Required - The document ID.

### Request Example
```ruby
response = client.get(index: 'students', id: '1')
```

### Response
Returns the document.
```

--------------------------------

### Search all documents with match_all query

Source: https://docs.opensearch.org/latest/clients/ruby/

Uses the `search` method without a request body to perform a `match_all` query, returning all documents in the index. The example requires the `json` library and prints each document's `_source` field as JSON.

```ruby
require 'json'

response = client.search(index: 'students')
response['hits']['hits'].each { |hit| puts JSON.generate(hit['_source']) }

```

--------------------------------

### Install OpenSearch Benchmark from PyPi with pip3

Source: https://docs.opensearch.org/latest/benchmark/quickstart/

Installs the OpenSearch Benchmark tool using pip3. Run this command in your terminal to install the package from PyPi. After installation, verify the installation with the 'opensearch-benchmark --help' command.

```bash
pip3 install opensearch-benchmark
```

--------------------------------

### Bulk index documents with data key in action header

Source: https://docs.opensearch.org/latest/clients/ruby/

Alternative bulk indexing approach that combines the action header and document data in a single hash using the `data:` key. This indexes the same two documents as the previous example.

```ruby
actions = [
  { index: { _index: 'students', _id: '2', data: { firstName: 'Paulo', lastName: 'Santos', gpa: 3.93, gradDate: '2021-05-20' } } },
  { index: { _index: 'students', _id: '3', data: { firstName: 'Shirley', lastName: 'Rodriguez', gpa: 3.91, gradDate: '2019-05-10' } } }
]
response = client.bulk(body: actions, refresh: true)

```

--------------------------------

### Start OpenSearch from installation directory

Source: https://docs.opensearch.org/latest/install-and-configure/install-opensearch/tar/

Changes to the OpenSearch installation directory and starts the OpenSearch server using the bin/opensearch script.

```bash
cd /path/to/opensearch-3.9.0
./bin/opensearch
```

--------------------------------

### Install Symfony HTTP client

Source: https://docs.opensearch.org/latest/clients/php/

Installs the Symfony HTTP client, a PSR-18 HTTP client alternative to Guzzle.

```bash
composer require symfony/http-client
```

--------------------------------

### Install the OpenSearch Go client v5

Source: https://docs.opensearch.org/latest/clients/go/

Adds the OpenSearch Go client version 5 to the project. Version 5 is not compatible with code written for version 4.

```bash
go get github.com/opensearch-project/opensearch-go/v5
```

--------------------------------

### Sample program: OpenSearchClientExample

Source: https://docs.opensearch.org/latest/clients/java/

Combines code from preceding sections: creates a client, creates an index, indexes documents individually and in bulk, searches, updates, deletes a document, and deletes the index. Connects to a cluster with the Security plugin enabled; change lines marked with '// Without security' comments to connect without it. Requires a Student class and credentials matching your cluster. For testing only: specifies credentials in code and disables certificate validation for self-signed certificates; in production, load credentials securely and validate certificates.

```java
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLEngine;

import org.apache.hc.client5.http.auth.AuthScope;
import org.apache.hc.client5.http.auth.UsernamePasswordCredentials;
import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider;
import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager;
import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder;
import org.apache.hc.client5.http.ssl.ClientTlsStrategyBuilder;
import org.apache.hc.core5.function.Factory;
import org.apache.hc.core5.http.HttpHost;
import org.apache.hc.core5.http.nio.ssl.TlsStrategy;
import org.apache.hc.core5.reactor.ssl.TlsDetails;
import org.apache.hc.core5.ssl.SSLContextBuilder;
import org.opensearch.client.json.JsonData;
import org.opensearch.client.opensearch.OpenSearchClient;
import org.opensearch.client.opensearch._types.Refresh;
import org.opensearch.client.opensearch._types.SortOrder;
import org.opensearch.client.opensearch.core.IndexRequest;
import org.opensearch.client.opensearch.core.IndexResponse;
import org.opensearch.client.opensearch.core.SearchResponse;
import org.opensearch.client.opensearch.core.UpdateRequest;
import org.opensearch.client.opensearch.core.UpdateResponse;
import org.opensearch.client.opensearch.core.GetResponse;
import org.opensearch.client.opensearch.core.BulkRequest;
import org.opensearch.client.opensearch.core.BulkResponse;
import org.opensearch.client.opensearch.core.DeleteResponse;
import org.opensearch.client.opensearch.core.bulk.BulkOperation;
import org.opensearch.client.opensearch.core.bulk.IndexOperation;
import org.opensearch.client.opensearch.indices.*;
import org.opensearch.client.transport.OpenSearchTransport;
import org.opensearch.client.transport.httpclient5.ApacheHttpClient5TransportBuilder;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

public class OpenSearchClientExample {
  public static void main(String[] args) throws Exception {
    final HttpHost host = new HttpHost("https", "localhost", 9200); // Without security, use new HttpHost("http", "localhost", 9200)
    final BasicCredentialsProvider credentialsProvider = new BasicCredentialsProvider(); // Without security, remove this line
    // Without security, remove this line
    credentialsProvider.setCredentials(new AuthScope(host), new UsernamePasswordCredentials("admin", "<custom-admin-password>".toCharArray()));

    final SSLContext sslcontext = SSLContextBuilder.create()
      .loadTrustMaterial(null, (chains, authType) -> true)
      .build();

    final ApacheHttpClient5TransportBuilder builder = ApacheHttpClient5TransportBuilder.builder(host);
    builder.setHttpClientConfigCallback(httpClientBuilder -> {
      final TlsStrategy tlsStrategy = ClientTlsStrategyBuilder.create()
        .setSslContext(sslcontext)
        .setTlsDetailsFactory(new Factory<SSLEngine, TlsDetails>() {
          @Override
          public TlsDetails create(final SSLEngine sslEngine) {
            return new TlsDetails(sslEngine.getSession(), sslEngine.getApplicationProtocol());
          }
        })
        .build();
```

--------------------------------

### Install Guzzle HTTP client

Source: https://docs.opensearch.org/latest/clients/php/

Installs Guzzle, a PSR-18 HTTP client required by the OpenSearch PHP client.

```bash
composer require guzzlehttp/guzzle
```

--------------------------------

### Install a specific version of the PHP client

Source: https://docs.opensearch.org/latest/clients/php/

Installs a specific version of the opensearch-php package by appending the version to the package name.

```bash
composer require opensearch-project/opensearch-php:<version>
```

--------------------------------

### Start the Docker example

Source: https://docs.opensearch.org/latest/security/authentication-backends/saml/

Run docker compose up from the demo folder to start the OpenSearch, OpenSearch Dashboards, and SAML server nodes defined in docker-compose.yml.

```bash
$ docker compose up.
```

--------------------------------

### Create index with settings and mappings

Source: https://docs.opensearch.org/latest/clients/ruby/

Creates an index with one primary shard and one replica, explicitly mapping gradDate as a date in yyyy-MM-dd format. Other fields are mapped dynamically. Note: Amazon OpenSearch Serverless does not support the refresh parameter used in other examples.

```ruby
index_body = {
  settings: {
    index: {
      number_of_shards: 1,
      number_of_replicas: 1
    }
  },
  mappings: {
    properties: {
      gradDate: { type: 'date', format: 'yyyy-MM-dd' }
    }
  }
}
client.indices.create(index: 'students', body: index_body)
```

--------------------------------

### Example response: list all plugins

Source: https://docs.opensearch.org/latest/api-reference/cat/cat-plugins/

Sample output showing the name, component, and version columns for installed plugins.

```text
name                             component                            version
opensearch-node1 analysis-icu                         3.3.2
opensearch-node1 opensearch-alerting                  3.3.2.0
opensearch-node1 opensearch-anomaly-detection         3.3.2.0
opensearch-node1 opensearch-asynchronous-search       3.3.2.0
opensearch-node1 opensearch-cross-cluster-replication 3.3.2.0
opensearch-node1 opensearch-custom-codecs             3.3.2.0
opensearch-node1 opensearch-flow-framework            3.3.2.0
opensearch-node1 opensearch-geospatial                3.3.2.0
opensearch-node1 opensearch-index-management          3.3.2.0
opensearch-node1 opensearch-job-scheduler             3.3.2.0
opensearch-node1 opensearch-knn                       3.3.2.0
opensearch-node1 opensearch-ml                        3.3.2.0
opensearch-node1 opensearch-neural-search             3.3.2.0
opensearch-node1 opensearch-notifications             3.3.2.0
opensearch-node1 opensearch-observability             3.3.2.0
opensearch-node1 opensearch-security                  3.3.2.0
opensearch-node1 opensearch-sql                       3.3.2.0
```

--------------------------------

### Imports for OpenSearch Go client examples

Source: https://docs.opensearch.org/latest/clients/go/

Common imports used by the examples on this page, including the OpenSearch client, API, and utility packages.

```go
import (
	"context"
	"encoding/json"
	"fmt"
	"strings"

	"github.com/opensearch-project/opensearch-go/v5"
	"github.com/opensearch-project/opensearch-go/v5/opensearchapi"
	"github.com/opensearch-project/opensearch-go/v5/opensearchutil"
)
```

--------------------------------

### Start os-node-03 with OpenSearch 3.9.0

Source: https://docs.opensearch.org/latest/migrate-or-upgrade/rolling-upgrade/rolling-upgrade-lab/

Starts a new container named os-node-03 using the opensearchproject/opensearch:3.9.0 image and the same mapped volumes as the original container. The command maps ports, sets JVM options, disables demo config, and mounts configuration and security files.

```bash
docker run -d \
   -p 127.0.0.1:9203:9200 \
   -e "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" \
   -e "DISABLE_INSTALL_DEMO_CONFIG=true" \
   --ulimit nofile=65536:65536 --ulimit memlock=-1:-1 \
   -v data-03:/usr/share/opensearch/data \
   -v repo-01:/usr/share/opensearch/snapshots \
   -v ~/deploy/opensearch-03.yml:/usr/share/opensearch/config/opensearch.yml \
   -v ~/deploy/internal_users.yml:/usr/share/opensearch/config/opensearch-security/internal_users.yml \
   -v ~/deploy/root-ca.pem:/usr/share/opensearch/config/root-ca.pem \
   -v ~/deploy/admin.pem:/usr/share/opensearch/config/admin.pem \
   -v ~/deploy/admin-key.pem:/usr/share/opensearch/config/admin-key.pem \
   -v ~/deploy/os-node-03.pem:/usr/share/opensearch/config/os-node-03.pem \
   -v ~/deploy/os-node-03-key.pem:/usr/share/opensearch/config/os-node-03-key.pem \
   --network opensearch-dev-net \
   --ip 172.20.0.13 \
   --name os-node-03 \
   opensearchproject/opensearch:3.9.0
```

--------------------------------

### Install opensearch-dsl with pip

Source: https://docs.opensearch.org/latest/clients/python-high-level/

Install the deprecated high-level Python client package using pip. The package name is opensearch-dsl.

```bash
pip install opensearch-dsl
```

--------------------------------

### Verify OpenSearch is running

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Uses -k to disable hostname checking due to demo certificates and -u to pass the default username and password.

```bash
curl https://localhost:9200 -ku admin:<custom-admin-password>
```

--------------------------------

### Example response for opensearch-plugin list

Source: https://docs.opensearch.org/latest/install-and-configure/plugins/

Sample output showing installed plugins, including opensearch-alerting, opensearch-security, and opensearch-sql.

```bash
$ ./opensearch-plugin list
opensearch-alerting
opensearch-anomaly-detection
opensearch-asynchronous-search
opensearch-cross-cluster-replication
opensearch-geospatial
opensearch-index-management
opensearch-job-scheduler
opensearch-knn
opensearch-ml
opensearch-notifications
opensearch-notifications-core
opensearch-observability
opensearch-performance-analyzer
opensearch-reports-scheduler
opensearch-security
opensearch-sql
```

--------------------------------

### Start OpenSearch with Docker

Source: https://docs.opensearch.org/latest/getting-started/quickstart/

Pulls and runs the latest OpenSearch Docker image in a single-node container with security disabled. Exposes ports 9200 and 9600. Use for quick local testing.

```bash
docker pull opensearchproject/opensearch:latest && docker run -d -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" -e "DISABLE_SECURITY_PLUGIN=true" --name opensearch opensearchproject/opensearch:latest
```

--------------------------------

### Install opensearch-py with pip

Source: https://docs.opensearch.org/latest/clients/python-low-level/

Install the latest version of the OpenSearch Python client, opensearch-py 3.2.0, which requires Python 3.10 or later.

```bash
pip install opensearch-py
```

--------------------------------

### Example response for installing analysis-icu

Source: https://docs.opensearch.org/latest/install-and-configure/plugins/

Sample output showing successful installation of the analysis-icu plugin, including download progress and confirmation.

```bash
$ sudo ./opensearch-plugin install analysis-icu
-> Installing analysis-icu
-> Downloading analysis-icu from opensearch
[=================================================] 100%   
-> Installed analysis-icu with folder name analysis-icu
```

--------------------------------

### Get index mappings with get_mapping

Source: https://docs.opensearch.org/latest/clients/ruby/

Use the get_mapping method to verify an index's mappings. The index name is passed as the 'index' parameter.

```ruby
response = client.indices.get_mapping(index: 'students')
```

--------------------------------

### Start os-node-02 with OpenSearch 3.9.0

Source: https://docs.opensearch.org/latest/migrate-or-upgrade/rolling-upgrade/rolling-upgrade-lab/

Starts a new container named os-node-02 using the opensearchproject/opensearch:3.9.0 image and the same mapped volumes as the original container. The command maps ports, sets JVM options, disables demo config, and mounts configuration and security files.

```bash
docker run -d \
   -p 127.0.0.1:9202:9200 \
   -e "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m" \
   -e "DISABLE_INSTALL_DEMO_CONFIG=true" \
   --ulimit nofile=65536:65536 --ulimit memlock=-1:-1 \
   -v data-02:/usr/share/opensearch/data \
   -v repo-01:/usr/share/opensearch/snapshots \
   -v ~/deploy/opensearch-02.yml:/usr/share/opensearch/config/opensearch.yml \
   -v ~/deploy/internal_users.yml:/usr/share/opensearch/config/opensearch-security/internal_users.yml \
   -v ~/deploy/root-ca.pem:/usr/share/opensearch/config/root-ca.pem \
   -v ~/deploy/admin.pem:/usr/share/opensearch/config/admin.pem \
   -v ~/deploy/admin-key.pem:/usr/share/opensearch/config/admin-key.pem \
   -v ~/deploy/os-node-02.pem:/usr/share/opensearch/config/os-node-02.pem \
   -v ~/deploy/os-node-02-key.pem:/usr/share/opensearch/config/os-node-02-key.pem \
   --network opensearch-dev-net \
   --ip 172.20.0.12 \
   --name os-node-02 \
   opensearchproject/opensearch:3.9.0
```

--------------------------------

### indices.delete

Source: https://docs.opensearch.org/latest/clients/ruby/

Deletes an entire index. The method is called on the 'indices' namespace of the client.

```APIDOC
## indices.delete

### Description
Deletes an index.

### Method
indices.delete

### Parameters
- **index** (string) - Required - The name of the index to delete.

### Request Example
```ruby
response = client.indices.delete(index: 'students')
```

### Response
Returns the delete index response.
```

--------------------------------

### Start OpenSearch service with systemd

Source: https://docs.opensearch.org/latest/tuning-your-cluster/

Starts the OpenSearch service on all nodes after configuration. Requires systemd; tar archive installations do not create a service automatically and may need manual setup if 'Failed to start opensearch.service: Unit not found.' occurs.

```bash
sudo systemctl start opensearch.service
```
Tokens:
Raw