conf

Documentation

Index

• Constants
• type API
• type APIAuth
• type APIAuthGitLab
• type APIAuthLDAP
• type Conf
  • func New(path string) (*Conf, error)
• type Coordinator
• type CoordinatorZK
• type Logging
• type LoggingSentry
• type Mesos
• type MesosAuth
• type MesosAuthBasic
• type Secrets
• type SecretsVault
• type Storage
• type StorageZK
• type ZKAuth
• type ZKAuthDigest

Constants

const (
	APIAuthBackendGitLab = "gitlab"
	APIAuthBackendNone   = "none"
	APIAuthBackendLDAP   = "ldap"
)

API server authz backends.

const (
	ZKAuthSchemeDigest = "digest"
	ZKAuthSchemeWorld  = "world"
)

ZooKeeper authn methods.

const (
	SecretsBackendVault = "vault"
	SecretsBackendNone  = "none"
)

Secrets backends.

const (
	MesosAuthTypeBasic = "basic"
	MesosAuthTypeNone  = "none"
)

Mesos authn schemes.

const (
	LoggingBackendNone   = "none"
	LoggingBackendSentry = "sentry"
)

Logging backends.

const (
	LoggingLevelDebug = "debug"
	LoggingLevelInfo  = "info"
	LoggingLevelWarn  = "warn"
	LoggingLevelError = "error"
)

Logging levels.

const CoordinatorBackendZK = "zookeeper"

CoordinatorBackendZK denotes ZooKeeper coordinator backend.

const StorageBackendZK = "zookeeper"

StorageBackendZK denotes ZooKeeper storage backend.

Types

type API

type API struct {
	Addr     string
	CertFile string
	KeyFile  string
	Auth     APIAuth
}

API defines API server options.

type APIAuth

type APIAuth struct {
	Backend string
	GitLab  APIAuthGitLab
	LDAP    APIAuthLDAP
}

APIAuth defines API server authz options.

type APIAuthGitLab

type APIAuthGitLab struct {
	Addr   string
	CACert string
}

APIAuthGitLab defines options of GitLab authz backend.

type APIAuthLDAP

type APIAuthLDAP struct {
	Addrs              []string
	UserDN             string
	UserAttr           string
	CACert             string
	UserACL            map[string]map[string]string
	GroupACL           map[string]map[string]string
	BindDN             string
	BindPassword       string
	Timeout            time.Duration
	GroupFilter        string
	GroupDN            string
	GroupAttr          string
	CaseSensitiveNames bool
}

APIAuthLDAP defines options of LDAP authz backend.

type Conf

type Conf struct {
	API         API
	Storage     Storage
	Coordinator Coordinator
	Secrets     Secrets
	Mesos       Mesos
	Logging     Logging
}

Conf defines server options.

func New

func New(path string) (*Conf, error)

New creates new configuration struct.

type Coordinator

type Coordinator struct {
	Backend   string
	ZooKeeper CoordinatorZK
}

Coordinator defines server coordinator options.

type CoordinatorZK

type CoordinatorZK struct {
	Dir         string
	Addrs       []string
	Timeout     time.Duration
	Auth        ZKAuth
	ElectionDir string
}

CoordinatorZK defines ZooKeeper coordinator backend options.

type Logging

type Logging struct {
	Level   string
	Backend string
	Sentry  LoggingSentry
}

Logging defines server logging options.

type LoggingSentry

type LoggingSentry struct {
	DSN    string
	CACert string
	Tags   map[string]string
}

LoggingSentry defines Sentry logging backend options.

type Mesos

type Mesos struct {
	Auth            MesosAuth
	Addrs           []string
	CACert          string
	Checkpoint      bool
	FailoverTimeout time.Duration
	Hostname        string
	User            string
	WebUIURL        string
	Principal       string
	Labels          map[string]string
	Roles           []string
	LogAllEvents    bool
}

Mesos defines Mesos-related options.

type MesosAuth

type MesosAuth struct {
	Type  string
	Basic MesosAuthBasic
}

MesosAuth defines Mesos authn options.

type MesosAuthBasic

type MesosAuthBasic struct {
	Username string
	Password string
}

MesosAuthBasic defines options of Mesos' basic authn method.

type Secrets

type Secrets struct {
	Backend string
	Vault   SecretsVault
}

Secrets defines server secrets options.

type SecretsVault

type SecretsVault struct {
	Token   string
	Addr    string
	Timeout time.Duration
	Root    string
	CACert  string
}

SecretsVault defines Vault secrets backend options.

type Storage

type Storage struct {
	Backend   string
	ZooKeeper StorageZK
}

Storage defines server storage options.

type StorageZK

type StorageZK struct {
	Dir     string
	Addrs   []string
	Timeout time.Duration
	Auth    ZKAuth
	TaskTTL time.Duration
}

StorageZK defines ZooKeeper storage backend options.

type ZKAuth

type ZKAuth struct {
	Scheme string
	Digest ZKAuthDigest
}

ZKAuth defines ZooKeeper authn options.

type ZKAuthDigest

type ZKAuthDigest struct {
	User     string
	Password string
}

ZKAuthDigest defines options of ZooKeeper's digest authn scheme.