OCS Extension Configuration

Introduction

The Infinite Scale OCS extension provides …​

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

Environment variables for the ocs extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
OCS_TRACING_ENABLED

bool

false

OCIS_TRACING_TYPE
OCS_TRACING_TYPE

string

OCIS_TRACING_ENDPOINT
OCS_TRACING_ENDPOINT

string

OCIS_TRACING_COLLECTOR
OCS_TRACING_COLLECTOR

string

OCIS_LOG_LEVEL
OCS_LOG_LEVEL

string

OCIS_LOG_PRETTY
OCS_LOG_PRETTY

bool

false

OCIS_LOG_COLOR
OCS_LOG_COLOR

bool

false

OCIS_LOG_FILE
OCS_LOG_FILE

string

OCS_DEBUG_ADDR

string

127.0.0.1:9114

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

OCS_DEBUG_TOKEN

string

Token to secure the metrics endpoint

OCS_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

OCS_DEBUG_ZPAGES

bool

false

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

OCS_HTTP_ADDR

string

127.0.0.1:9110

OCS_HTTP_ROOT

string

/ocs

OCIS_JWT_SECRET
OCS_JWT_SECRET

string

REVA_GATEWAY

string

127.0.0.1:9142

OCIS_URL
OCIS_OIDC_ISSUER
OCS_IDM_ADDRESS

string

https://localhost:9200

OCS_ACCOUNT_BACKEND_TYPE

string

cs3

STORAGE_USERS_DRIVER
OCS_STORAGE_USERS_DRIVER

string

ocis

OCIS_MACHINE_AUTH_API_KEY
OCS_MACHINE_AUTH_API_KEY

string

Since Version: + added, - deprecated

YAML Example

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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9114
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:9110
  root: /ocs
  cors:
    allowed_origins:
    - '*'
    allowed_methods:
    - GET
    - POST
    - PUT
    - PATCH
    - DELETE
    - OPTIONS
    allowed_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    allowed_credentials: true
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
identity_management:
  address: https://localhost:9200
account_backend: cs3
storage_users_driver: ocis
machine_auth_api_key: ""