Settings Service Configuration

Table of Contents

Introduction
Default Values
Settings Managed
Caching
Settings Management
Settings Usage
Configuration
- Environment Variables
- YAML Example

Introduction

The Infinite Scale Settings service provides functionality for other services to register new settings as well as storing and retrieving the respective settings' values.

Default Values

Settings listens on port 9190 by default.

Settings Managed

The settings service is currently used for managing the:

users' profile settings like the language and the email notification settings,
possible user roles and their respective permissions,
assignment of roles to users.

As an example, user profile settings that can be changed in the Web UI must be persistent.

The settings service supports two different backends for persisting the data. The backend can be set via the SETTINGS_STORE_TYPE environment variable. Supported values are:

metadata: The default. This backend persists the settings data via the storage-system service.
filesystem: This backend persists the settings data in a directory on the local filesystem. The directory can be configured with SETTINGS_DATA_PATH. This backend is not suitable for running multiple intances of the settings service in a scale-out deployment and should be therefore considered deprecated.

Caching

When using SETTINGS_STORE_TYPE=metadata, the settings service caches the results of queries against the storage backend to provide faster responses. The content of this cache is independent of the cache used in the storage-system service as it caches directory listing and settings content stored in files.

The store used for the cache can be configured using the SETTINGS_CACHE_STORE environment variable. Possible stores are:

Store Type Description

Store Type	Description
`memory`	Basic in-memory store and the default.
`ocmem`	Advanced in-memory store allowing max size.
`redis`	Stores data in a configured Redis cluster.
`redis-sentinel`	Stores data in a configured Redis Sentinel cluster.
`etcd`	Stores data in a configured etcd cluster.
`nats-js`	Stores data using the key-value-store feature of NATS JetStream.
`noop`	Stores nothing. Useful for testing. Not recommended in production environments.

memory

Basic in-memory store and the default.

ocmem

Advanced in-memory store allowing max size.

redis

Stores data in a configured Redis cluster.

redis-sentinel

Stores data in a configured Redis Sentinel cluster.

etcd

Stores data in a configured etcd cluster.

nats-js

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

noop

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

Note that in-memory stores are by nature not reboot-persistent.
Though usually not necessary, a database name and a database table can be configured for event stores if the event store supports this. Generally not applicable for stores of type in-memory. These settings are blank by default which means that the standard settings of the configured store apply.
The settings service can be scaled if not using in-memory stores and the stores are configured identically over all instances.
When using redis-sentinel, the Redis master to use is configured via SETTINGS_CACHE_STORE_NODES in the form of <sentinel-host>:<sentinel-port>/<redis-master> like 10.10.0.200:26379/mymaster.

Settings Management

Infinite Scale services can register settings bundles with the settings service.

Settings Usage

Services can set or query Infinite Scale setting values of a user from settings bundles.

Configuration

Environment Variables

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

4.0.5

Environment variables for the settings service
Name	Type	Default Value	Description
`OCIS_TRACING_ENABLED` `SETTINGS_TRACING_ENABLED`	bool	false	Activates tracing.
`OCIS_TRACING_TYPE` `SETTINGS_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` `SETTINGS_TRACING_ENDPOINT`	string		The endpoint of the tracing agent.
`OCIS_TRACING_COLLECTOR` `SETTINGS_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` `SETTINGS_LOG_LEVEL`	string		The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
`OCIS_LOG_PRETTY` `SETTINGS_LOG_PRETTY`	bool	false	Activates pretty log output.
`OCIS_LOG_COLOR` `SETTINGS_LOG_COLOR`	bool	false	Activates colorized log output.
`OCIS_LOG_FILE` `SETTINGS_LOG_FILE`	string		The path to the log file. Activates logging to this file if set.
`SETTINGS_DEBUG_ADDR`	string	127.0.0.1:9194	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
`SETTINGS_DEBUG_TOKEN`	string		Token to secure the metrics endpoint.
`SETTINGS_DEBUG_PPROF`	bool	false	Enables pprof, which can be used for profiling.
`SETTINGS_DEBUG_ZPAGES`	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
`SETTINGS_HTTP_ADDR`	string	127.0.0.1:9190	The bind address of the HTTP service.
`OCIS_HTTP_TLS_ENABLED`	bool	false	Activates TLS for the http based services using the server certifcate and key configured via OCIS_HTTP_TLS_CERTIFICATE and OCIS_HTTP_TLS_KEY. If OCIS_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.
`OCIS_HTTP_TLS_CERTIFICATE`	string		Path/File name of the TLS server certificate (in PEM format) for the http services.
`OCIS_HTTP_TLS_KEY`	string		Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.
`SETTINGS_HTTP_ROOT`	string	/	Subdirectory that serves as the root for this HTTP service.
`OCIS_CORS_ALLOW_ORIGINS` `SETTINGS_CORS_ALLOW_ORIGINS`	[]string	[*]	A comma-separated list of allowed CORS origins. See following chapter for more details: Access-Control-Allow-Origin at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
`OCIS_CORS_ALLOW_METHODS` `SETTINGS_CORS_ALLOW_METHODS`	[]string	[GET POST PUT PATCH DELETE OPTIONS]	A comma-separated list of allowed CORS methods. See following chapter for more details: Access-Control-Request-Method at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method
`OCIS_CORS_ALLOW_HEADERS` `SETTINGS_CORS_ALLOW_HEADERS`	[]string	[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id]	A blank or comma-separated list of allowed CORS headers. See following chapter for more details: Access-Control-Request-Headers at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers.
`OCIS_CORS_ALLOW_CREDENTIALS` `SETTINGS_CORS_ALLOW_CREDENTIALS`	bool	true	Allow credentials for CORS.See following chapter for more details: Access-Control-Allow-Credentials at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.
`SETTINGS_GRPC_ADDR`	string	127.0.0.1:9191	The bind address of the GRPC service.
`SETTINGS_STORE_TYPE`	string	metadata	Store type configures the persistency driver. Supported values are 'metadata' and 'filesystem'. Note that the value 'filesystem' is considered deprecated.
`SETTINGS_DATA_PATH`	string	~/.ocis/settings	The directory where the filesystem storage will store ocis settings. If not defined, the root directory derives from $OCIS_BASE_DATA_PATH:/settings.
`STORAGE_GATEWAY_GRPC_ADDR`	string	com.owncloud.api.storage-system	GRPC address of the STORAGE-SYSTEM service.
`STORAGE_GRPC_ADDR`	string	com.owncloud.api.storage-system	GRPC address of the STORAGE-SYSTEM service.
`OCIS_SYSTEM_USER_ID` `SETTINGS_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_IDP` `SETTINGS_SYSTEM_USER_IDP`	string	internal	IDP of the oCIS STORAGE-SYSTEM system user.
`OCIS_SYSTEM_USER_API_KEY`	string		API key for the STORAGE-SYSTEM system user.
`OCIS_CACHE_STORE` `SETTINGS_CACHE_STORE`	string	memory	The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
`OCIS_CACHE_STORE_NODES` `SETTINGS_CACHE_STORE_NODES`	[]string	[]	A comma separated 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.
`OCIS_CACHE_DATABASE`	string	ocis	The database name the configured store should use.
`SETTINGS_FILE_CACHE_TABLE`	string	settings_files	The database table the store should use for the file cache.
`SETTINGS_DIRECTORY_CACHE_TABLE`	string	settings_dirs	The database table the store should use for the directory cache.
`OCIS_CACHE_TTL` `SETTINGS_CACHE_TTL`	Duration	10m0s	Default time to live for entries in the cache. Only applied when access tokens has no expiration. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '10m' (10 minutes).
`OCIS_CACHE_SIZE` `SETTINGS_CACHE_SIZE`	int	0	The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512.
`SETTINGS_BUNDLES_PATH`	string		The path to a JSON file with a list of bundles. If not defined, the default bundles will be loaded.
`OCIS_ADMIN_USER_ID` `SETTINGS_ADMIN_USER_ID`	string		ID of the user that should receive admin privileges. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand.
`OCIS_JWT_SECRET` `SETTINGS_JWT_SECRET`	string		The secret to mint and validate jwt tokens.
`SETTINGS_SETUP_DEFAULT_ASSIGNMENTS` `IDM_CREATE_DEMO_USERS`	bool	false	The default role assignments the demo users should be setup.

YAML Example

Note that the filename shown below has been chosen on purpose.
See the Configuration File Naming for details when setting up your own configuration.

4.0.5

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9194
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:9190
  tls:
    enabled: false
    cert: ""
    key: ""
  root: /
  cors:
    allow_origins:
    - '*'
    allow_methods:
    - GET
    - POST
    - PUT
    - PATCH
    - DELETE
    - OPTIONS
    allow_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    - X-Request-Id
    allow_credentials: true
grpc:
  addr: 127.0.0.1:9191
  tls: null
grpc_client_tls: null
store_type: metadata
data_path: ~/.ocis/settings
metadata_config:
  gateway_addr: com.owncloud.api.storage-system
  storage_addr: com.owncloud.api.storage-system
  system_user_id: ""
  system_user_idp: internal
  system_user_api_key: ""
  cache:
    store: memory
    addresses: []
    database: ocis
    files_table: settings_files
    directories_table: settings_dirs
    ttl: 10m0s
    size: 0
bundles_path: ""
admin_user_id: ""
token_manager:
  jwt_secret: ""
set_default_assignments: false