Modifying the OpenSearch Configuration File (Optional)

If you need to override the default values provided by the OpenSearch software, you can use the opensearch.yml file. Go to the OSK_HOME/config directory to locate the opensearch.yml file, and modify it in a text editor for your environment. It is probably a good idea to make a backup copy before modifying the file.

Note:

Because the OSK DPK setup script automates the configuration, modifying opensearch.yml should not normally be necessary.

• cluster.name — a unique name for the cluster.

  This parameter identifies the cluster for auto-discovery. Make sure the name is unique. Do not reuse the same cluster names in different environments, because you might end up with nodes joining the wrong cluster.

• node.name — any meaningful name, such as hostname, which would make it easy to identify where the node is running.

• path.data — the path to the location where you want to store the OpenSearch data.

  To include multiple paths, use commas to separate the paths.

• path.logs — the path to the location where you want to store the OpenSearch logs.

• bootstrap.memory_lock — if set to True, this parameter locks the memory when the OpenSearch instance is started.

  The recommendation is to set this to True.

• network.host — the IP address or hostname of the machine.

• http.port — the port where OpenSearch should listen for incoming requests.

  Set this property whether or not SSL is configured. OpenSearch can work either in https or http mode, but not in both modes at the same time.

• gateway.expected_nodes — the number of data or master nodes that are expected to be in the cluster.

  Recovery of local shards will start as soon as the expected number of nodes have joined the cluster.

  Note:

  This parameter may be specified in the opensearch.yml file as needed.

• gateway.recover_after_nodes — the number of data or master nodes required for recovery.

  Recovery will take place as long as this many data or master nodes have joined the cluster. Once the recover_after_time duration has passed, (the default is 5 minutes), recovery will start as long as the gateway.recover_after_nodes condition is met. Whenever you add a new user or role to OpenSearch, make sure that it is added to each of the nodes.

• node.max_local_storage_nodes — the number of nodes on a single system

  Enter “1” to disable multiple nodes on a single system.

• action.destructive_requires_name — When set to True, this will require explicit names when deleting indexes.

• orclssl.http.ssl — enable or disable https

  Accepts values true or false.

• orclssl.transport.ssl — enable or disable transport layer encryption

  Accepts values true or false.

• orclssl.keystore — path to the keystore

  The keystore file must be placed under OSK_HOME/config.

• orclssl.keystore_password — keystore password.

  Provide an encrypted password, which is obtained using the encryption mechanism in opensearchuser script.

  See Using the opensearchuser Script.

• orclssl.truststore — path to the truststore

  The truststore file must be placed under OSK_HOME/config.

• orclssl.truststore_password — truststore password

  Provide an encrypted password which is obtained using the encryption mechanism in opensearchuser script.

  See Using the opensearchuser Script.

• acl.cache.delete.interval — Interval to run the delete process to clear the ACL security values cache. By default it is 24h.

• acl.cache.delete.bulk_size — Number of deletions to run in one bulk delete request.

  By default it is 10000.