config

Documentation

Index

• func GetEnv(cfg *Config) []string
• func StructMappings(cfg *Config) []shared.EnvBinding
• type CORS
• type Config
  • func DefaultConfig() *Config
  • func New() *Config
• type Debug
• type HTTP
• type IdentityManagement
• type Reva
• type Service
• type TokenManager
• type Tracing

Functions

func GetEnv

func GetEnv(cfg *Config) []string

GetEnv fetches a list of known env variables for this extension. It is to be used by gookit, as it provides a list with all the environment variables an extension supports.

func StructMappings

func StructMappings(cfg *Config) []shared.EnvBinding

StructMappings binds a set of environment variables to a destination on cfg. Iterating over this set and editing the Destination value of a binding will alter the original value, as it is a pointer to its memory address. This lets us propagate changes easier.

Types

type CORS

type CORS struct {
	AllowedOrigins   []string `ocisConfig:"allowed_origins"`
	AllowedMethods   []string `ocisConfig:"allowed_methods"`
	AllowedHeaders   []string `ocisConfig:"allowed_headers"`
	AllowCredentials bool     `ocisConfig:"allow_credentials"`
}

CORS defines the available cors configuration.

type Config

type Config struct {
	*shared.Commons

	File               string             `ocisConfig:"file"`
	Log                *shared.Log        `ocisConfig:"log"`
	Debug              Debug              `ocisConfig:"debug"`
	HTTP               HTTP               `ocisConfig:"http"`
	Tracing            Tracing            `ocisConfig:"tracing"`
	TokenManager       TokenManager       `ocisConfig:"token_manager"`
	Service            Service            `ocisConfig:"service"`
	AccountBackend     string             `ocisConfig:"account_backend"`
	Reva               Reva               `ocisConfig:"reva"`
	StorageUsersDriver string             `ocisConfig:"storage_users_driver"`
	MachineAuthAPIKey  string             `ocisConfig:"machine_auth_api_key"`
	IdentityManagement IdentityManagement `ocisConfig:"identity_management"`

	Context    context.Context
	Supervised bool
}

Config combines all available configuration parts.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig provides default values for a config struct.

func New

func New() *Config

New initializes a new configuration with or without defaults.

type Debug

type Debug struct {
	Addr   string `ocisConfig:"addr"`
	Token  string `ocisConfig:"token"`
	Pprof  bool   `ocisConfig:"pprof"`
	Zpages bool   `ocisConfig:"zpages"`
}

Debug defines the available debug configuration.

type HTTP

type HTTP struct {
	Addr string `ocisConfig:"addr"`
	Root string `ocisConfig:"root"`
	CORS CORS   `ocisConfig:"cors"`
}

HTTP defines the available http configuration.

type IdentityManagement

type IdentityManagement struct {
	Address string `ocisConfig:"address"`
}

IdentityManagement keeps track of the OIDC address. This is because Reva requisite of uniqueness for users is based in the combination of IDP hostname + UserID. For more information see: https://github.com/cs3org/reva/blob/4fd0229f13fae5bc9684556a82dbbd0eced65ef9/pkg/storage/utils/decomposedfs/node/node.go#L856-L865

type Reva

type Reva struct {
	Address string `ocisConfig:"address"`
}

Reva defines all available REVA configuration.

type Service

type Service struct {
	Name      string `ocisConfig:"name"`
	Namespace string `ocisConfig:"namespace"`
	Version   string `ocisConfig:"version"`
}

Service defines the available service configuration.

type TokenManager

type TokenManager struct {
	JWTSecret string `ocisConfig:"jwt_secret"`
}

TokenManager is the config for using the reva token manager

type Tracing

type Tracing struct {
	Enabled   bool   `ocisConfig:"enabled"`
	Type      string `ocisConfig:"type"`
	Endpoint  string `ocisConfig:"endpoint"`
	Collector string `ocisConfig:"collector"`
	Service   string `ocisConfig:"service"`
}

Tracing defines the available tracing configuration.