Store Service Configuration

Table of Contents

Introduction
Default Values
Configuration
- Environment Variables
- YAML Example

Introduction

The Infinite Scale Store service

The store service is marked for deprecation and will be removed in a later version. Its tasks will be taken over by other services.

Default Values

The store service listens on port 9460 by default.

Configuration

Environment Variables

The store service is configured via the following environment variables. Read the Environment Variable Types documentation for important details.

5.0.9

Deprecation notes for the store service
Deprecation Info	Deprecation Version	Removal Version
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0
The store service is optional and will be removed.	5.0	6.0.0

Environment variables for the store service
Name	Type	Default Value	Description
`OCIS_TRACING_ENABLED` `STORE_TRACING_ENABLED` Deprecation Note	bool	false	Activates tracing.
`OCIS_TRACING_TYPE` `STORE_TRACING_TYPE` Deprecation Note	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` `STORE_TRACING_ENDPOINT` Deprecation Note	string		The endpoint of the tracing agent.
`OCIS_TRACING_COLLECTOR` `STORE_TRACING_COLLECTOR` Deprecation Note	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` `STORE_LOG_LEVEL` Deprecation Note	string		The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
`OCIS_LOG_PRETTY` `STORE_LOG_PRETTY` Deprecation Note	bool	false	Activates pretty log output.
`OCIS_LOG_COLOR` `STORE_LOG_COLOR` Deprecation Note	bool	false	Activates colorized log output.
`OCIS_LOG_FILE` `STORE_LOG_FILE` Deprecation Note	string		The path to the log file. Activates logging to this file if set.
`STORE_DEBUG_ADDR` Deprecation Note	string	127.0.0.1:9464	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
`STORE_DEBUG_TOKEN` Deprecation Note	string		Token to secure the metrics endpoint.
`STORE_DEBUG_PPROF` Deprecation Note	bool	false	Enables pprof, which can be used for profiling.
`STORE_DEBUG_ZPAGES` Deprecation Note	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
`STORE_GRPC_ADDR` Deprecation Note	string	127.0.0.1:9460	The bind address of the GRPC service.
`STORE_DATA_PATH` Deprecation Note	string	/var/lib/ocis/store	The directory where the filesystem storage will store ocis settings. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/store.

YAML Example

Note the file shown below must be renamed and placed in the correct folder according to the Configuration File Naming conventions to be effective.
See the Notes for Environment Variables if you want to use environment variables in the yaml file.

5.0.9

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9464
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9460
  tls: null
grpc_client_tls: null
data_path: /var/lib/ocis/store