Storage-Shares Service Configuration

Introduction

The Infinite Scale Storage-Shares 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-shares extension is configured via the following environment variables:

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

OCIS_TRACING_ENABLED
STORAGE_SHARES_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
STORAGE_SHARES_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_SHARES_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
STORAGE_SHARES_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_SHARES_LOG_LEVEL

string

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

OCIS_LOG_PRETTY
STORAGE_SHARES_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
STORAGE_SHARES_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
STORAGE_SHARES_LOG_FILE

string

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

STORAGE_SHARES_DEBUG_ADDR

string

127.0.0.1:9156

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

STORAGE_SHARES_DEBUG_TOKEN

string

Token to secure the metrics endpoint

STORAGE_SHARES_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

STORAGE_SHARES_DEBUG_ZPAGES

bool

false

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

STORAGE_SHARES_GRPC_ADDR

string

127.0.0.1:9154

The bind address of the GRPC service.

STORAGE_SHARES_GRPC_PROTOCOL

string

tcp

The transport protocol of the grpc service.

OCIS_JWT_SECRET
STORAGE_SHARES_JWT_SECRET

string

The secret to mint and validate jwt tokens.

REVA_GATEWAY

string

127.0.0.1:9142

The CS3 gateway endpoint.

STORAGE_SHARES_SKIP_USER_GROUPS_IN_TOKEN

bool

false

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

STORAGE_SHARES_MOUNT_ID

string

7639e57c-4433-4a12-8201-722fd0009154

Mount ID of this storage. Admins can set the ID for the storage in this config option manually which is then used to reference the storage. Any reasonable long string is possible, preferably this would be an UUIDv4 format.

STORAGE_SHARES_READ_ONLY

bool

false

Set this storage to be read-only.

STORAGE_SHARES_USER_SHARE_PROVIDER_ENDPOINT

string

localhost:9150

GRPC endpoint of the sharing extension.

Since Version: + added, - deprecated

YAML Example

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9156
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9154
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
skip_user_groups_in_token: false
mount_id: 7639e57c-4433-4a12-8201-722fd0009154
readonly: false
user_share_provider_endpoint: localhost:9150