adapter

Documentation

Index

• Constants
• Variables
• func GetNestedLogsMountPath(simpleName string) string
• func GetNginxStatusMountPath(simpleName string) string
• func GetSysctls() map[string]string
• type AppConfig
• type ContainerStatus
• type DynamicManagementConfig
• type ExecutableImageOptions
• type Orchestrator
  • func NewDockerSwarm(options OrchestratorOptions, logger log.Logger) (Orchestrator, error)
• type OrchestratorMock
  • func (a *OrchestratorMock) Close() error
  • func (a *OrchestratorMock) GetOverlayNetwork(ctx context.Context, name string) (string, error)
  • func (a *OrchestratorMock) GetStatus(ctx context.Context, since time.Duration) (results []*ContainerStatus, err error)
  • func (a *OrchestratorMock) PullImage(ctx context.Context, imageName string) error
  • func (a *OrchestratorMock) PurgeServiceData(ctx context.Context, containerName string) error
  • func (a *OrchestratorMock) PurgeVirtualChainData(ctx context.Context, nodeAddress string, vcId uint32, containerName string) error
  • func (a *OrchestratorMock) RemoveService(ctx context.Context, containerName string) error
  • func (a *OrchestratorMock) RunReverseProxy(ctx context.Context, config *ReverseProxyConfig) error
  • func (a *OrchestratorMock) RunService(ctx context.Context, serviceConfig *ServiceConfig, appConfig *AppConfig) error
  • func (a *OrchestratorMock) RunVirtualChain(ctx context.Context, serviceConfig *ServiceConfig, appConfig *AppConfig) error
• type OrchestratorOptions
  • func (s OrchestratorOptions) MaxReloadTimedDelay() time.Duration
  • func (s OrchestratorOptions) MountType() mount.Type
• type ReverseProxyConfig
• type ReverseProxyConfigService
• type SSLOptions
• type ServiceConfig

Constants

const CPU_SHARES = 1000000000

const DEFAULT_EFS_PATH = "/var/efs/"

const DEFAULT_HTTP_PORT = uint32(80)

const DEFAULT_NGINX_CONFIG = `` /* 653-byte string literal not displayed */

const DEFAULT_SSL_PORT = uint32(443)

const DOCKER_API_VERSION = "1.40"

const ERROR_LOGS_OVERLAP_MARGIN = 1 * time.Second

const LOCAL_DRIVER = "local"

const MEGABYTE = 1024 * 1024

const NGINX_CONF = "nginx.conf"

const ORBS_BLOCKS_TARGET = "/usr/local/var/orbs"

const ORBS_CACHE_TARGET = "/opt/orbs/cache"

const ORBS_LOGS_TARGET = "/opt/orbs/logs"

const ORBS_STATUS_TARGET = "/opt/orbs/status"

const PROXY_CONTAINER_NAME = "http-api-reverse-proxy"

const REXRAY_EBS_DRIVER = "rexray/ebs"

const SERVICE_EXECUTABLE_PATH = "/opt/orbs/service"

const SHARED_PROXY_NETWORK = "http-proxy-overlay"

const SHARED_SERVICES_NETWORK = "services-overlay"

const SHARED_SIGNER_NETWORK = "signer-overlay"

const SSL_CERT = "ssl-cert"

const SSL_KEY = "ssl-key"

const VCHAINS_CONF = "vchains.conf"

Variables

var VIRTUAL_CHAIN_RESTART_DELAY = 20 * time.Minute

var VIRTUAL_CHAIN_RESTART_SUCCESS_WINDOW = 2 * time.Minute

Functions

func GetNestedLogsMountPath

func GetNestedLogsMountPath(simpleName string) string

func GetNginxStatusMountPath

func GetNginxStatusMountPath(simpleName string) string

func GetSysctls

func GetSysctls() map[string]string

Types

type AppConfig

type AppConfig struct {
	KeyPair []byte
	Network []byte
	Config  []byte
}

type ContainerStatus

type ContainerStatus struct {
	Name   string
	NodeID string
	State  string
	Error  string

	Logs string

	CreatedAt time.Time
}

type DynamicManagementConfig

type DynamicManagementConfig struct {
	Url string
}

type ExecutableImageOptions

type ExecutableImageOptions struct {
	Url    string
	Sha256 string
}

type Orchestrator

type Orchestrator interface {
	PullImage(ctx context.Context, imageName string) error

	RunVirtualChain(ctx context.Context, serviceConfig *ServiceConfig, appConfig *AppConfig) error
	RunReverseProxy(ctx context.Context, config *ReverseProxyConfig) error
	RunService(ctx context.Context, serviceConfig *ServiceConfig, appConfig *AppConfig) error

	RemoveService(ctx context.Context, containerName string) error

	GetOverlayNetwork(ctx context.Context, name string) (string, error)

	GetStatus(ctx context.Context, since time.Duration) ([]*ContainerStatus, error)

	PurgeServiceData(ctx context.Context, containerName string) error
	PurgeVirtualChainData(ctx context.Context, nodeAddress string, vcId uint32, containerName string) error

	io.Closer
}

func NewDockerSwarm

func NewDockerSwarm(options OrchestratorOptions, logger log.Logger) (Orchestrator, error)

type OrchestratorMock

type OrchestratorMock struct {
	mock.Mock
}

func (*OrchestratorMock) Close

func (a *OrchestratorMock) Close() error

func (*OrchestratorMock) GetOverlayNetwork

func (a *OrchestratorMock) GetOverlayNetwork(ctx context.Context, name string) (string, error)

func (*OrchestratorMock) GetStatus

func (a *OrchestratorMock) GetStatus(ctx context.Context, since time.Duration) (results []*ContainerStatus, err error)

func (*OrchestratorMock) PullImage

func (a *OrchestratorMock) PullImage(ctx context.Context, imageName string) error

func (*OrchestratorMock) PurgeServiceData

func (a *OrchestratorMock) PurgeServiceData(ctx context.Context, containerName string) error

func (*OrchestratorMock) PurgeVirtualChainData

func (a *OrchestratorMock) PurgeVirtualChainData(ctx context.Context, nodeAddress string, vcId uint32, containerName string) error

func (*OrchestratorMock) RemoveService

func (a *OrchestratorMock) RemoveService(ctx context.Context, containerName string) error

func (*OrchestratorMock) RunReverseProxy

func (a *OrchestratorMock) RunReverseProxy(ctx context.Context, config *ReverseProxyConfig) error

func (*OrchestratorMock) RunService

func (a *OrchestratorMock) RunService(ctx context.Context, serviceConfig *ServiceConfig, appConfig *AppConfig) error

func (*OrchestratorMock) RunVirtualChain

func (a *OrchestratorMock) RunVirtualChain(ctx context.Context, serviceConfig *ServiceConfig, appConfig *AppConfig) error

type OrchestratorOptions

type OrchestratorOptions struct {
	StorageDriver          string            `json:"storage-driver"`
	StorageMountType       string            `json:"storage-mount-type"`
	StorageOptions         map[string]string `json:"storage-options"`
	MaxReloadTimedDelayStr string            `json:"max-reload-time-delay"`

	DynamicManagementConfig DynamicManagementConfig

	ExecutableImage ExecutableImageOptions

	// Testing purposes
	HTTPPort uint32 `json:"http-port"`
	SSLPort  uint32 `json:"ssl-port"`
}

func (OrchestratorOptions) MaxReloadTimedDelay

func (s OrchestratorOptions) MaxReloadTimedDelay() time.Duration

func (OrchestratorOptions) MountType

func (s OrchestratorOptions) MountType() mount.Type

type ReverseProxyConfig

type ReverseProxyConfig struct {
	ContainerName string
	NodeAddress   string

	HTTPPort uint32
	SSLPort  uint32

	NginxConfig string

	Services []ReverseProxyConfigService

	SSLCertificate []byte
	SSLPrivateKey  []byte
}

type ReverseProxyConfigService

type ReverseProxyConfigService struct {
	Name        string
	ServiceName string
}

type SSLOptions

type SSLOptions struct {
	SSLCertificatePath string
	SSLPrivateKeyPath  string
}

type ServiceConfig

type ServiceConfig struct {
	// vchain only
	Id          uint32
	NodeAddress string
	Name        string

	// common
	ImageName      string
	ContainerName  string
	ExecutablePath string

	InternalPort int
	ExternalPort int

	AllowAccessToSigner     bool
	AllowAccessToServices   bool
	HTTPProxyNetworkEnabled bool

	LimitedMemory  int64
	LimitedCPU     float64
	ReservedMemory int64
	ReservedCPU    float64

	// logs service only
	LogsMountPointNames map[string]string // simple name -> namespaced name
}