Gateway Service Configuration

Introduction

The Infinite Scale Gateway service is responsible for passing requests to the storage providers. Other services never talk to the storage providers directly but will always send their requests via the `gateway` service.

Default Values

  • Gateway listens on port 9142 by default.

Caching

The gateway service can use a configured store via the global OCIS_CACHE_STORE environment variable.

Note that for each global environment variable, a service-based one might be available additionally. For precedences see Environment Variable Notes. Check the configuration section below. Supported stores are:

Store Type Description

memory

Basic in-memory store and the default.

redis-sentinel

Stores data in a configured Redis Sentinel cluster.

nats-js-kv

Stores data using key-value-store feature of NATS JetStream

noop

Stores nothing. Useful for testing. Not recommended in production environments.

ocmem

(deprecated) Advanced in-memory store allowing max size.

redis

(deprecated) Stores data in a configured Redis cluster.

etcd

(deprecated) Stores data in a configured etcd cluster.

nats-js

(deprecated) Stores data using the key-value-store feature of NATS JetStream.

Other store types may work but are currently not supported.

The gateway service can only be scaled if not using the memory store and the stores are configured identically over all instances!
If you have used one of the deprecated stores of a former version, you should reconfigure to use one of the supported ones as the deprecated stores will be removed in a later version.
Store specific notes
  • When using redis-sentinel:
    The Redis master to use is configured via e.g. OCIS_CACHE_STORE_NODES in the form of <sentinel-host>:<sentinel-port>/<redis-master> like 10.10.0.200:26379/mymaster.

  • When using nats-js-kv:

    • It is recommended to set OCIS_CACHE_STORE_NODES to the same value as OCIS_EVENTS_ENDPOINT. That way the cache uses the same nats instance as the event bus.

    • Authentication can be added, if configured, via OCIS_CACHE_AUTH_USERNAME and OCIS_CACHE_AUTH_PASSWORD.

    • It is possible to set OCIS_CACHE_DISABLE_PERSISTENCE to instruct nats to not persist cache data on disc.

Configuration

Environment Variables

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

  • master

Environment variables for the gateway service
Name Type Default Value Description

OCIS_TRACING_ENABLED
GATEWAY_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
GATEWAY_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
GATEWAY_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
GATEWAY_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
GATEWAY_LOG_LEVEL

string

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

OCIS_LOG_PRETTY
GATEWAY_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
GATEWAY_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
GATEWAY_LOG_FILE

string

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

GATEWAY_DEBUG_ADDR

string

127.0.0.1:9143

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

GATEWAY_DEBUG_TOKEN

string

Token to secure the metrics endpoint.

GATEWAY_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling.

GATEWAY_DEBUG_ZPAGES

bool

false

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

OCIS_GATEWAY_GRPC_ADDR
GATEWAY_GRPC_ADDR

string

127.0.0.1:9142

The bind address of the GRPC service.

GATEWAY_GRPC_PROTOCOL

string

tcp

The transport protocol of the GRPC service.

OCIS_JWT_SECRET
GATEWAY_JWT_SECRET

string

The secret to mint and validate jwt tokens.

OCIS_REVA_GATEWAY

string

com.owncloud.api.gateway

The CS3 gateway endpoint.

OCIS_GRPC_CLIENT_TLS_MODE

string

TLS mode for grpc connection to the go-micro based grpc services. Possible values are 'off', 'insecure' and 'on'. 'off': disables transport security for the clients. 'insecure' allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). 'on' enables transport security, including server certificate verification.

OCIS_GRPC_CLIENT_TLS_CACERT

string

Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.

GATEWAY_SKIP_USER_GROUPS_IN_TOKEN

bool

false

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

GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT

bool

true

Commit shares to storage grants. This grants access to shared resources for the share receiver directly on the storage.

GATEWAY_SHARE_FOLDER_NAME

string

Shares

Name of the share folder in users' home space.

GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN

bool

true

Disable creation of the home space on login.

OCIS_TRANSFER_SECRET

string

The storage transfer secret.

GATEWAY_TRANSFER_EXPIRES

int

86400

Expiry for the gateway tokens.

OCIS_CACHE_STORE
GATEWAY_PROVIDER_CACHE_STORE

string

noop

The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details.

OCIS_CACHE_STORE_NODES
GATEWAY_PROVIDER_CACHE_STORE_NODES

[]string

[127.0.0.1:9233]

A list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details.

OCIS_CACHE_DATABASE

string

cache-providers

The database name the configured store should use.

OCIS_CACHE_TTL
GATEWAY_PROVIDER_CACHE_TTL

Duration

5m0s

Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details.

OCIS_CACHE_SIZE
GATEWAY_PROVIDER_CACHE_SIZE

int

0

The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default.

OCIS_CACHE_DISABLE_PERSISTENCE
GATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE

bool

false

Disables persistence of the provider cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false.

OCIS_CACHE_AUTH_USERNAME
GATEWAY_PROVIDER_CACHE_AUTH_USERNAME

string

The username to use for authentication. Only applies when store type 'nats-js-kv' is configured.

OCIS_CACHE_AUTH_PASSWORD
GATEWAY_PROVIDER_CACHE_AUTH_PASSWORD

string

The password to use for authentication. Only applies when store type 'nats-js-kv' is configured.

OCIS_CACHE_STORE
GATEWAY_CREATE_HOME_CACHE_STORE

string

memory

The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details.

OCIS_CACHE_STORE_NODES
GATEWAY_CREATE_HOME_CACHE_STORE_NODES

[]string

[127.0.0.1:9233]

A list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details.

OCIS_CACHE_DATABASE

string

cache-createhome

The database name the configured store should use.

OCIS_CACHE_TTL
GATEWAY_CREATE_HOME_CACHE_TTL

Duration

5m0s

Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details.

OCIS_CACHE_SIZE
GATEWAY_CREATE_HOME_CACHE_SIZE

int

0

The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512 which is derived from the ocmem package though not exclicitely set as default.

OCIS_CACHE_DISABLE_PERSISTENCE
GATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE

bool

false

Disables persistence of the create home cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false.

OCIS_CACHE_AUTH_USERNAME
GATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME

string

The username to use for authentication. Only applies when store type 'nats-js-kv' is configured.

OCIS_CACHE_AUTH_PASSWORD
GATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD

string

The password to use for authentication. Only applies when store type 'nats-js-kv' is configured.

OCIS_URL
GATEWAY_FRONTEND_PUBLIC_URL

string

https://localhost:9200

The public facing URL of the oCIS frontend.

GATEWAY_STORAGE_REGISTRY_DRIVER

string

spaces

The driver name of the storage registry to use.

GATEWAY_STORAGE_REGISTRY_RULES

[]string

[]

The rules for the storage registry. See the Environment Variable Types description for more details.

GATEWAY_STORAGE_REGISTRY_CONFIG_JSON

string

Additional configuration for the storage registry in json format.

GATEWAY_STORAGE_USERS_MOUNT_ID

string

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.

YAML Example

  • master

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9143
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9142
  tls: null
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: com.owncloud.api.gateway
  tls:
    mode: ""
    cacert: ""
skip_user_groups_in_token: false
commit_share_to_storage_grant: true
share_folder_name: Shares
disable_home_creation_on_login: true
transfer_secret: ""
transfer_expires: 86400
cache:
  provider_cache_store: noop
  provider_cache_nodes:
  - 127.0.0.1:9233
  provider_cache_database: cache-providers
  provider_cache_ttl: 5m0s
  provider_cache_size: 0
  provider_cache_disable_persistence: false
  provider_cache_auth_username: ""
  provider_cache_auth_password: ""
  create_home_cache_store: memory
  create_home_cache_nodes:
  - 127.0.0.1:9233
  create_home_cache_database: cache-createhome
  create_home_cache_ttl: 5m0s
  create_home_cache_size: 0
  create_home_cache_disable_persistence: false
  create_home_cache_auth_username: ""
  create_home_cache_auth_password: ""
frontend_public_url: https://localhost:9200
storage_registry:
  driver: spaces
  rules: []
  json: ""
  storage_users_mount_id: ""