runtime

Documentation

Index

• Constants
• func ApplicationWorkingDir(dirType ...ApplicationDirType) string
• func BrokerURL() string
• func BuildForkParams(cmd string) []string
• func ConfigIsLocalFile() bool
• func ConfigURL() string
• func DefaultAdvertiseAddress() string
• func DiscoveryURL() string
• func ForkContext(ctx, parent context.Context) context.Context
• func GetBool(key string) bool
• func GetHostname() string
• func GetString(key string) string
• func GetStringSlice(key string) []string
• func GrpcBindAddress() string
• func GrpcDiscoveryBindAddress() string
• func GrpcExternalPort() string
• func HasCapacity(c string) bool
• func HttpBindAddress() string
• func HttpServerType() string
• func Init(ctx context.Context, typ string)
• func InitGlobalConnConsumers(ctx context.Context, typ string)
• func IsFork() bool
• func IsGrpcScheme(u string) bool
• func IsRequired(name string, tags ...string) bool
• func IsSet(key string) bool
• func KeyringURL() string
• func LastInitType() string
• func LogJSON() bool
• func LogLevel() string
• func LogToFile() bool
• func MatchDependencies(ctx context.Context, rr map[string]string) error
• func MetricsEnabled() bool
• func MustServiceDataDir(serviceName string) string
• func NeedsGrpcDiscoveryConn() bool
• func PprofEnabled() bool
• func ProcessStartTags() []string
• func Register(typ string, y ...func(ctx context.Context))
• func RegisterContextInjector(injector ContextInjector)
• func RegisterDependencyMatcher(key string, f func(context.Context, string) error)
• func RegisterGlobalConnConsumer(typ string, y ...func(ctx context.Context))
• func RegisterPreRun(preRun func(runtime Runtime))
• func RegistryURL() string
• func ServiceDataDir(serviceName string) (string, error)
• func SetArgs(aa []string)
• func SetDefault(key string, value interface{})
• func SetRuntime(runtime Runtime)
• func VaultURL(withMaster string) string
• type ApplicationDirType
• type ContextInjector
• type Runtime

Constants

const (
	KeyDiscovery    = "discovery"
	KeyRegistry     = "registry"
	KeyBroker       = "broker"
	KeyConfig       = "config"
	KeyVault        = "vault"
	KeyKeyring      = "keyring"
	KeyFork         = "fork"
	KeyForkLegacy   = "is_fork"
	KeyArgTags      = "tags"
	KeyArgExclude   = "exclude"
	KeyNodeCapacity = "cap"

	KeyAdvertiseAddress  = "advertise_address"
	KeyBindHost          = "bind_address"
	KeyGrpcDiscoveryPort = "grpc_discovery_port"
	KeyGrpcPort          = "grpc_port"
	KeyHttpPort          = "http_port"
	KeyGrpcExternal      = "grpc_external"
	KeyHealthCheckPort   = "healthcheck"

	KeySiteBind               = "site_bind"
	KeySiteExternal           = "site_external"
	KeySiteNoTLS              = "site_no_tls"
	KeySiteTlsCertFile        = "site_tls_cert_file"
	KeySiteTlsKeyFile         = "site_tls_key_file"
	KeySiteLetsEncryptEmail   = "site_le_email"
	KeySiteLetsEncryptAgree   = "site_le_agree"
	KeySiteLetsEncryptStaging = "site_le_staging"

	// Legacy versions without "site_" prefix
	KeySiteBindL               = "bind"
	KeySiteExternalL           = "external"
	KeySiteNoTLSL              = "no_tls"
	KeySiteTlsCertFileL        = "tls_cert_file"
	KeySiteTlsKeyFileL         = "tls_key_file"
	KeySiteLetsEncryptEmailL   = "le_email"
	KeySiteLetsEncryptAgreeL   = "le_agree"
	KeySiteLetsEncryptStagingL = "le_staging"

	KeyInstallCli       = "install_cli"
	KeyInstallYaml      = "install_yaml"
	KeyInstallJson      = "install_json"
	KeyInstallExitAfter = "exit_after_install"

	KeyInstallCliLegacy  = "cli"
	KeyInstallYamlLegacy = "yaml"
	KeyInstallJsonLegacy = "json"

	KeyLog       = "log"
	KeyLogJson   = "log_json"
	KeyLogToFile = "log_to_file"

	KeyEnableMetrics = "enable_metrics"
	KeyEnablePprof   = "enable_pprof"

	KeyHttpServer    = "http"
	HttpServerCaddy  = "caddy"
	HttpServerNative = "http"

	DefaultGrpcPort        = "8001"
	DefaultDiscoveryPort   = "8002"
	DefaultBindingSitePort = "8080"
	DefaultHttpPort        = "0"

	DefaultConfigFileName  = "pydio.json"
	DefaultVaultFileName   = "pydio-vault.json"
	DefaultKeyringFileName = "cells-vault-key"
)

const (
	NodeMetaPID          = "PID"
	NodeMetaParentPID    = "parentPID"
	NodeMetaMetrics      = "metrics"
	NodeMetaStartTag     = "start"
	NodeMetaForkStartTag = "forkStartTag"
	NodeMetaHostName     = "hostname"
	NodeMetaCapacities   = "capacities"
)

Functions

func ApplicationWorkingDir

func ApplicationWorkingDir(dirType ...ApplicationDirType) string

ApplicationWorkingDir creates a local file to store pydio system data

func BrokerURL

func BrokerURL() string

BrokerURL returns the scheme://address url for Broker

func BuildForkParams

func BuildForkParams(cmd string) []string

BuildForkParams creates --key=value arguments from runtime parameters

func ConfigIsLocalFile

func ConfigIsLocalFile() bool

ConfigIsLocalFile checks if ConfigURL scheme is file

func ConfigURL

func ConfigURL() string

ConfigURL returns the scheme://address url for Config

func DefaultAdvertiseAddress

func DefaultAdvertiseAddress() string

DefaultAdvertiseAddress reads or compute the address advertised to clients

func DiscoveryURL

func DiscoveryURL() string

DiscoveryURL returns the scheme://address url for Registry

func ForkContext

func ForkContext(ctx, parent context.Context) context.Context

ForkContext copies all necessary dependencies using the internal ContextInjector registry

func GetBool

func GetBool(key string) bool

GetBool gets a key as boolean from global runtime

func GetHostname

func GetHostname() string

GetHostname wraps os.Hostname, could be overwritten by env or parameter.

func GetString

func GetString(key string) string

GetString gets a key from global runtime

func GetStringSlice

func GetStringSlice(key string) []string

GetStringSlice gets a slice from global runtime.

func GrpcBindAddress

func GrpcBindAddress() string

GrpcBindAddress returns the KeyBindHost:KeyGrpcPort URL

func GrpcDiscoveryBindAddress

func GrpcDiscoveryBindAddress() string

GrpcDiscoveryBindAddress returns the KeyBindHost:KeyGrpcDiscoveryPort URL

func GrpcExternalPort

func GrpcExternalPort() string

GrpcExternalPort returns optional GRPC port to be used for external binding

func HasCapacity

func HasCapacity(c string) bool

HasCapacity checks if a specific capacity is registered for the current process

func HttpBindAddress

func HttpBindAddress() string

HttpBindAddress returns the KeyBindHost:KeyHttpPort URL

func HttpServerType

func HttpServerType() string

HttpServerType returns one of HttpServerCaddy or HttpServerCore

func Init

func Init(ctx context.Context, typ string)

func InitGlobalConnConsumers

func InitGlobalConnConsumers(ctx context.Context, typ string)

func IsFork

func IsFork() bool

IsFork checks if the runtime is originally a fork of a different process

func IsGrpcScheme

func IsGrpcScheme(u string) bool

func IsRequired

func IsRequired(name string, tags ...string) bool

IsRequired checks arguments, --tags and --exclude against a service name

func IsSet

func IsSet(key string) bool

IsSet check existence of a key in runtime

func KeyringURL

func KeyringURL() string

func LastInitType

func LastInitType() string

func LogJSON

func LogJSON() bool

LogJSON returns the --log_json value

func LogLevel

func LogLevel() string

LogLevel returns the --log value

func LogToFile

func LogToFile() bool

LogToFile returns the --log_to_file value

func MatchDependencies

func MatchDependencies(ctx context.Context, rr map[string]string) error

MatchDependencies checks a list of known keys for specific runtime parameters. It is typically used to detect current-process aspects

func MetricsEnabled

func MetricsEnabled() bool

MetricsEnabled returns if the metrics should be published or not

func MustServiceDataDir

func MustServiceDataDir(serviceName string) string

MustServiceDataDir returns the applicationdir/services/serviceName and ignore error it if it does not exists

func NeedsGrpcDiscoveryConn

func NeedsGrpcDiscoveryConn() bool

func PprofEnabled

func PprofEnabled() bool

PprofEnabled returns if an http endpoint should be published for debug/pprof

func ProcessStartTags

func ProcessStartTags() []string

ProcessStartTags returns a list of tags to be used for identifying processes

func Register

func Register(typ string, y ...func(ctx context.Context))

func RegisterContextInjector

func RegisterContextInjector(injector ContextInjector)

RegisterContextInjector appends a ContextInjector to the internal registry

func RegisterDependencyMatcher

func RegisterDependencyMatcher(key string, f func(context.Context, string) error)

RegisterDependencyMatcher adds a key-based dependency matcher to internal registry.

func RegisterGlobalConnConsumer

func RegisterGlobalConnConsumer(typ string, y ...func(ctx context.Context))

func RegisterPreRun

func RegisterPreRun(preRun func(runtime Runtime))

func RegistryURL

func RegistryURL() string

RegistryURL returns the scheme://address url for Registry

func ServiceDataDir

func ServiceDataDir(serviceName string) (string, error)

ServiceDataDir returns the applicationdir/services/serviceName and creates it if it does not exists

func SetArgs

func SetArgs(aa []string)

SetArgs copies command arguments to internal value

func SetDefault

func SetDefault(key string, value interface{})

SetDefault updates global runtime

func SetRuntime

func SetRuntime(runtime Runtime)

SetRuntime sets internal global Runtime

func VaultURL

func VaultURL(withMaster string) string

Types

type ApplicationDirType

type ApplicationDirType int

const (
	ApplicationDirData ApplicationDirType = iota
	ApplicationDirLogs
	ApplicationDirServices
)

type ContextInjector

type ContextInjector func(ctx, parent context.Context) context.Context

type Runtime

type Runtime interface {
	GetBool(key string) bool
	GetString(key string) string
	GetStringSlice(key string) []string
	IsSet(key string) bool
	SetDefault(key string, value interface{})
}