Gateway
The 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.
The gateway service is using caching as it is highly frequented with the same requests. As of now it uses two different caches:
- the
provider cache
is caching requests to list or get storage providers. - the
create home cache
is caching requests to create personal spaces (as they only need to be executed once).
Both caches can be configured via the OCIS_CACHE_*
envvars (or GATEWAY_PROVIDER_CACHE_*
and GATEWAY_CREATE_HOME_CACHE_*
respectively). See the envvar section for details.
Use OCIS_CACHE_STORE
(GATEWAY_PROVIDER_CACHE_STORE
, GATEWAY_CREATE_HOME_CACHE_STORE
) to define the type of cache to use:
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 jetstreamnoop
: Stores nothing. Useful for testing. Not recommended in production environments.ocmem
: Advanced in-memory store allowing max size. (deprecated)redis
: Stores data in a configured Redis cluster. (deprecated)etcd
: Stores data in a configured etcd cluster. (deprecated)nats-js
: Stores data using object-store feature of nats jetstream (deprecated)
Other store types may work but are not supported currently.
Note: The service can only be scaled if not using memory
store and the stores are configured identically over all instances!
Note that if you have used one of the deprecated stores, you should reconfigure to 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>
like10.10.0.200:26379/mymaster
. - When using
nats-js-kv
it is recommended to setOCIS_CACHE_STORE_NODES
to the same value asOCIS_EVENTS_ENDPOINT
. That way the cache uses the same nats instance as the event bus. - When using the
nats-js-kv
store, it is possible to setOCIS_CACHE_DISABLE_PERSISTENCE
to instruct nats to not persist cache data on disc.
|
|
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 explicitly 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 explicitly 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. |