Storage-System Service Configuration

Introduction

The Infinite Scale Storage-System service provides …​

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 storage-system extension is configured via the following environment variables:

Environment variables for the storage-system extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
STORAGE_SYSTEM_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
STORAGE_SYSTEM_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
STORAGE_SYSTEM_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
STORAGE_SYSTEM_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
STORAGE_SYSTEM_LOG_LEVEL

string

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

OCIS_LOG_PRETTY
STORAGE_SYSTEM_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
STORAGE_SYSTEM_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
STORAGE_SYSTEM_LOG_FILE

string

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

STORAGE_SYSTEM_DEBUG_ADDR

string

127.0.0.1:9217

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

STORAGE_SYSTEM_DEBUG_TOKEN

string

Token to secure the metrics endpoint

STORAGE_SYSTEM_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

STORAGE_SYSTEM_DEBUG_ZPAGES

bool

false

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

STORAGE_SYSTEM_GRPC_ADDR

string

127.0.0.1:9215

The bind address of the GRPC service.

STORAGE_SYSTEM_GRPC_PROTOCOL

string

tcp

The transport protocol of the grpc service.

STORAGE_SYSTEM_HTTP_ADDR

string

127.0.0.1:9216

The bind address of the HTTP service.

STORAGE_SYSTEM_HTTP_PROTOCOL

string

tcp

The transport protocol of the http service.

STORAGE_SYSTEM_EVENTS_ENDPOINT

string

the address of the streaming service

STORAGE_SYSTEM_EVENTS_CLUSTER

string

the clusterID of the streaming service. Mandatory when using nats

OCIS_JWT_SECRET
STORAGE_SYSTEM_JWT_SECRET

string

The secret to mint and validate jwt tokens.

REVA_GATEWAY

string

127.0.0.1:9142

The CS3 gateway endpoint.

OCIS_SYSTEM_USER_ID

string

ID of the oCIS storage-system system user. Admins need to set the ID for the storage-system system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format.

OCIS_SYSTEM_USER_API_KEY

string

API key for the storage-system system user.

STORAGE_SYSTEM_SKIP_USER_GROUPS_IN_TOKEN

bool

false

Disables the loading of user’s group memberships from the reva access token.

STORAGE_SYSTEM_DRIVER

string

ocis

The driver which should be used by the service

STORAGE_SYSTEM_OCIS_ROOT

string

~/.ocis/storage/metadata

Path for the directory where the storage-system service stores it’s persistent data.

STORAGE_SYSTEM_DATA_SERVER_URL

string

http://localhost:9216/data

URL of the data server, needs to be reachable by services using this service.

Since Version: + added, - deprecated

YAML Example

# Autogenerated
# Filename: storage-system-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9217
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9215
  protocol: tcp
http:
  addr: 127.0.0.1:9216
  protocol: tcp
events:
  endpoint: ""
  cluster: ""
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
system_user_id: ""
system_user_api_key: ""
skip_user_groups_in_token: false
driver: ocis
drivers:
  ocis:
    root: ~/.ocis/storage/metadata
data_server_url: http://localhost:9216/data