Opensearch

`services.opensearch.dataDir`

Data directory for OpenSearch. If you change this, you need to manually create the directory. You also need to create the opensearch user and group, or change and to existing ones with access to the directory.

Type: path

Default

"/var/lib/opensearch"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.enable`

Whether to enable OpenSearch. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.extraCmdLineOptions`

Extra command line options for the OpenSearch launcher. Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.extraJavaOptions`

Extra command line options for Java. Type: list of string

Default

[ ]

Example

["-Djava.net.preferIPv4Stack=true"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.group`

The group OpenSearch runs as. Should be left at default unless you have very specific needs.

Type: string

Default

"opensearch"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.logging`

opensearch logging configuration. Type: string

Default

`#!nix '' logger.action.name = org.opensearch.action logger.action.level = info

appender.console.type = Console appender.console.name = console appender.console.layout.type = PatternLayout appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n

rootLogger.level = info rootLogger.appenderRef.console.ref = console ''`

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.package`

The OpenSearch package to use. Type: package

Default

pkgs.opensearch

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.restartIfChanged`

Automatically restart the service on config change. This can be set to false to defer restarts on a server or cluster. Please consider the security implications of inadvertently running an older version, and the possibility of unexpected behavior caused by inconsistent versions across a cluster when disabling this option.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.settings`

OpenSearch configuration.

Type: YAML value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.settings."cluster.name"`

The name of the cluster.

Type: string

Default

"opensearch"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.settings."discovery.type"`

The type of discovery to use.

Type: string

Default

"single-node"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.settings."http.port"`

The port to listen on for HTTP traffic.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

9200

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.settings."network.host"`

Which port this service should listen on.

Type: string

Default

"127.0.0.1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.settings."plugins.security.disabled"`

Whether to enable the security plugin, plugins.security.ssl.transport.keystore_filepath or plugins.security.ssl.transport.server.pemcert_filepath and plugins.security.ssl.transport.client.pemcert_filepath must be set for this plugin to be enabled.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.settings."transport.port"`

The port to listen on for transport traffic.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

9300

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix

`services.opensearch.user`

The user OpenSearch runs as. Should be left at default unless you have very specific needs.

Type: string

Default

"opensearch"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/search/opensearch.nix