# opensearch

## Options

### services.opensearch.enable

Whether to enable OpenSearch.

*Type:* boolean

*Default:*

```nix
false
```

*Example:*

```nix
true
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix>

### services.opensearch.package

The OpenSearch package to use.

*Type:* package

*Default:*

```nix
pkgs.opensearch
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix>

### services.opensearch.extraCmdLineOptions

Extra command line options for the OpenSearch launcher.

*Type:* list of string

*Default:*

```nix
[ ]
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix>

### services.opensearch.extraJavaOptions

Extra command line options for Java.

*Type:* list of string

*Default:*

```nix
[ ]
```

*Example:*

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

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/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/cachix/devenv/blob/main/src/modules/services/opensearch.nix>

### services.opensearch.settings

OpenSearch configuration.

*Type:* open submodule of (YAML 1.1 value)

*Default:*

```nix
{ }
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix>

### services.opensearch.settings.“cluster.name”

The name of the cluster.

*Type:* string

*Default:*

```nix
"opensearch"
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix>

### services.opensearch.settings.“discovery.type”

The type of discovery to use.

*Type:* string

*Default:*

```nix
"single-node"
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/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:*

```nix
9200
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix>

### services.opensearch.settings.“network.host”

Which port this service should listen on.

*Type:* string

*Default:*

```nix
"127.0.0.1"
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix>

### services.opensearch.settings.“plugins.security.disabled”

Whether to disable the security plugin. When set to false, SSL configuration is required. To enable SSL, set `plugins.security.ssl.transport.keystore_filepath` or both `plugins.security.ssl.transport.server.pemcert_filepath` and `plugins.security.ssl.transport.client.pemcert_filepath`.

*Type:* boolean

*Default:*

```nix
true
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/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:*

```nix
9300
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix>