Search Service Configuration

Introduction

The Infinite Scale Search services provides a …​

Services are under development because of the beta badge 1 stage of Infinite Scale. Their service, environment variables and configuration may change. Forgive us if there are mistakes or information is missing. Feel free to report issues and we’ll take care of them as soon as possible on github. You want to fix them yourself? We’d appreciate that even more.

Configuration

Environment Variables

The search extension is configured via the following environment variables:

Environment variables for the search extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
SEARCH_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
SEARCH_TRACING_TYPE

string

The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.

OCIS_TRACING_ENDPOINT
SEARCH_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
SEARCH_TRACING_COLLECTOR

string

The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.

OCIS_LOG_LEVEL
SEARCH_LOG_LEVEL

string

The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".

OCIS_LOG_PRETTY
SEARCH_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
SEARCH_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
SEARCH_LOG_FILE

string

The path to the log file. Activates logging to this file if set.

SEARCH_DEBUG_ADDR

string

127.0.0.1:9224

Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.

SEARCH_DEBUG_TOKEN

string

Token to secure the metrics endpoint

SEARCH_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

SEARCH_DEBUG_ZPAGES

bool

false

Enables zpages, which can be used for collecting and viewing in-memory traces.

SEARCH_GRPC_ADDR

string

127.0.0.1:9220

The bind address of the GRPC service.

SEARCH_DATA_PATH

string

~/.ocis/search

Path for the search persistence directory.

REVA_GATEWAY

string

127.0.0.1:9142

The CS3 gateway endpoint.

SEARCH_EVENTS_ENDPOINT

string

127.0.0.1:9233

the address of the streaming service

SEARCH_EVENTS_CLUSTER

string

ocis-cluster

the clusterID of the streaming service. Mandatory when using nats

SEARCH_EVENTS_GROUP

string

search

the customergroup of the service. One group will only get one copy of an event

OCIS_MACHINE_AUTH_API_KEY
SEARCH_MACHINE_AUTH_API_KEY

string

Machine auth API key used for accessing the 'auth-machine' service to impersonate users.

Since Version: + added, - deprecated

YAML Example

# Autogenerated
# Filename: search-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9224
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9220
data_path: ~/.ocis/search
reva:
  address: 127.0.0.1:9142
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
  group: search
machine_auth_api_key: ""