config

Documentation

Index

• Constants
• func GetLogger(flags *Flags) (log.Logger, error)
• func GetVcidFromServiceName(serviceName string) int64
• type DockerConfig
  • func (c *DockerConfig) FullImageName() string
• type DockerResources
• type DockerVolumes
• type FederationNode
• type Flags
• type KeyConfig
  • func NewKeysConfig(path string) (cfg KeyConfig, err error)
• type MutableNodeConfiguration
  • func NewStringConfigurationSource(input string, ethereumEndpoint string, keyConfigPath string, ...) (MutableNodeConfiguration, error)
  • func NewUrlConfigurationSource(url string, ethereumEndpoint string, keyConfigPath string, withNamespace bool) (MutableNodeConfiguration, error)
• type NodeAddress
  • func (n NodeAddress) ShortID() string
• type NodeConfiguration
  • func GetConfiguration(flags *Flags) (NodeConfiguration, error)
• type Peer
• type Resource
• type Service
• type Services
  • func (s Services) Management() *Service
  • func (s Services) Signer() *Service
• type VirtualChain
  • func (v *VirtualChain) GetContainerName() string
  • func (c *VirtualChain) GetSerializedConfig() []byte
• type VirtualChainConfig
• type VirtualChainId
  • func (id VirtualChainId) String() string

Constants

const DEFAULT_TRUNCATE_WINDOW = 7 * 24 * time.Hour // 1 week

const SIGNER = "signer"

Functions

func GetLogger

func GetLogger(flags *Flags) (log.Logger, error)

func GetVcidFromServiceName

func GetVcidFromServiceName(serviceName string) int64

Types

type DockerConfig

type DockerConfig struct {
	Image               string
	Tag                 string
	Pull                bool
	ContainerNamePrefix string
	Resources           DockerResources
	Volumes             DockerVolumes
}

func (*DockerConfig) FullImageName

func (c *DockerConfig) FullImageName() string

type DockerResources

type DockerResources struct {
	Limits       Resource
	Reservations Resource
}

type DockerVolumes

type DockerVolumes struct {
	Blocks int
	Logs   int
}

In Gb with defaults of 100 and 2

type FederationNode

type FederationNode struct {
	Address string `json:"address"`
	IP      string `json:"ip"`
	Port    int    `json:"port"`
}

type Flags

type Flags struct {
	ConfigUrl         string
	KeyPairConfigPath string

	SSLCertificatePath string
	SSLPrivateKeyPath  string

	PollingInterval       time.Duration
	Timeout               time.Duration
	MaxReloadTimeDelay    time.Duration
	BootstrapResetTimeout time.Duration

	EthereumEndpoint string

	LoggerHttpEndpoint string
	LogFilePath        string

	StatusFilePath  string
	MetricsFilePath string

	OrchestratorOptions string

	ManagementConfig string

	// Autoupdate
	AutoUpdate          bool
	ShutdownAfterUpdate bool
	BoyarBinaryPath     string

	// Testing only
	WithNamespace bool
}

type KeyConfig

type KeyConfig interface {
	Address() string
	PrivateKey() string

	JSON(addressOnly bool) []byte
}

func NewKeysConfig

func NewKeysConfig(path string) (cfg KeyConfig, err error)

type MutableNodeConfiguration

type MutableNodeConfiguration interface {
	NodeConfiguration

	SetEthereumEndpoint(ethereumEndpoint string) MutableNodeConfiguration
	SetOrchestratorOptions(options *adapter.OrchestratorOptions) MutableNodeConfiguration
	SetSSLOptions(options adapter.SSLOptions) MutableNodeConfiguration
	UpdateDefaultServiceConfig() MutableNodeConfiguration
}

func NewStringConfigurationSource

func NewStringConfigurationSource(input string, ethereumEndpoint string, keyConfigPath string, withNamespace bool) (MutableNodeConfiguration, error)

func NewUrlConfigurationSource

func NewUrlConfigurationSource(url string, ethereumEndpoint string, keyConfigPath string, withNamespace bool) (MutableNodeConfiguration, error)

type NodeAddress

type NodeAddress string

func (NodeAddress) ShortID

func (n NodeAddress) ShortID() string

type NodeConfiguration

type NodeConfiguration interface {
	FederationNodes() []*FederationNode
	Chains() []*VirtualChain
	OrchestratorOptions() *adapter.OrchestratorOptions
	KeyConfigPath() string
	KeyConfig() KeyConfig
	ReloadTimeDelay(maxDelay time.Duration) time.Duration
	EthereumEndpoint() string
	NodeAddress() NodeAddress
	SSLOptions() adapter.SSLOptions
	Services() Services

	NamespacedContainerName(name string) string

	VerifyConfig() error
	Hash() string
}

func GetConfiguration

func GetConfiguration(flags *Flags) (NodeConfiguration, error)

type Peer

type Peer struct {
	IP   string
	Port int
}

type Resource

type Resource struct {
	Memory int64
	CPUs   float64
}

type Service

type Service struct {
	InternalPort int
	ExternalPort int
	DockerConfig DockerConfig
	Config       map[string]interface{}
	Disabled     bool
	PurgeData    bool

	InjectNodePrivateKey  bool
	ExecutablePath        string
	AllowAccessToSigner   bool
	AllowAccessToServices bool

	MountNodeLogs bool
}

type Services

type Services map[string]*Service

func (Services) Management

func (s Services) Management() *Service

func (Services) Signer

func (s Services) Signer() *Service

type VirtualChain

type VirtualChain struct {
	Service
	Id               VirtualChainId
	InternalHttpPort int // FIXME should be deprecated as vchain specific
}

func (*VirtualChain) GetContainerName

func (v *VirtualChain) GetContainerName() string

func (*VirtualChain) GetSerializedConfig

func (c *VirtualChain) GetSerializedConfig() []byte

type VirtualChainConfig

type VirtualChainConfig struct {
	VirtualChain *VirtualChain
	Topology     []*FederationNode
	NodeAddress  NodeAddress

	KeyPairConfig []byte `json:"-"` // Prevents key leak via log
}

type VirtualChainId

type VirtualChainId uint32

func (VirtualChainId) String

func (id VirtualChainId) String() string