service

Nov 19, 2024

Changes in this version

type ClusterConfig

+ func (p *ClusterConfig) IsPortOffsetInUse() bool

type HelloRequest

+ func BuildHelloRequestFromPeer(p Peer) HelloRequest

Sep 26, 2024

Changes in this version

type ClusterConfig

+ func RegisterPeer(log zerolog.Logger, masterURL string, req HelloRequest) ClusterConfig

type HelloRequest

+ func BuildHelloRequest(id string, slavePort int, isSecure bool, config Config, bsCfg BootstrapConfig) HelloRequest

type Service

+ func (s *Service) GetHTTPServerPort() (containerPort, hostPort int, err error)

Apr 20, 2024

Changes in this version

type SetupConfigFile

+ func VerifySetupConfig(log zerolog.Logger, setupContent []byte) (SetupConfigFile, bool, error)

Mar 5, 2024

Changes in this version

type Config

+ SyncBinaryFoundErr error

type DatabaseFeatures

+ func (v DatabaseFeatures) SupportsArangoSync() bool

Jan 19, 2024

Changes in this version

+ func DatabaseVersion(ctx context.Context, log zerolog.Logger, arangodPath string, runner Runner) (driver.Version, bool, error)

type Config

+ DockerConfig DockerConfig

type DatabaseFeatures

+ func (v DatabaseFeatures) SupportsActiveFailover() bool

+ type DockerConfig struct

+ Endpoint string

+ GCDelay time.Duration

+ HostContainerName string

+ ImageArangoD string

+ ImageArangoSync string

+ ImagePullPolicy ImagePullPolicy

+ NetworkMode string

+ Privileged bool

+ TTY bool

+ User string

Sep 7, 2023

Changes in this version

+ func IsSpecialUpgradeFrom3614(v driver.Version) bool

type BootstrapConfig

+ RocksDBEncryptionKeyGenerator string

+ func (bsCfg *BootstrapConfig) LoadFromSetupConfig(cfg SetupConfigFile)

type ClusterConfig

+ PersistentOptions options.PersistentOptions

+ func (p *ClusterConfig) ForEachPeer(updateFunc func(p Peer) Peer)

type Config

+ Configuration *options.Configuration

type UpgradePlan

+ func (p UpgradePlan) Equals(other UpgradePlan) bool

Jul 14, 2021

Changes in this version

+ const AuthorizationHeader

+ const BearerPrefix

+ const DefaultMasterPort

+ const UpgradeEntryTypeAgent

+ const UpgradeEntryTypeCoordinator

+ const UpgradeEntryTypeDBServer

+ const UpgradeEntryTypeSingle

+ const UpgradeEntryTypeSyncMaster

+ const UpgradeEntryTypeSyncWorker

+ var ErrJobFailed = errors.New("job failed")

+ var ErrJobNotFound = errors.New("job not found")

+ var JobStateFailed = JobState("Failed")

+ var JobStateFinished = JobState("Finished")

+ var JobStatePending = JobState("Pending")

+ var JobStateToDo = JobState("ToDo")

+ func CreateCertificate(options CreateCertificateOptions, folder string) (string, error)

+ func CreateJwtToken(jwtSecret, user string) (string, error)

+ func FilterFiles(f []os.FileInfo, filter func(f os.FileInfo) bool) []os.FileInfo

+ func FilterOnlyFiles(f os.FileInfo) bool

+ func GuessOwnAddress() (string, error)

+ func IsArangoErrorWithCodeAndNum(aerr driver.ArangoError, code, errorNum int) bool

+ func IsLeadershipChallengeOngoingError(d driver.ArangoError) bool

+ func IsNoLeaderError(d driver.ArangoError) bool

+ func IsPortOpen(host string, port int) bool

+ func IsRedirect(err error) (string, bool)

+ func LoadKeyFile(keyFile string) (tls.Certificate, error)

+ func ReadSetupConfig(log zerolog.Logger, dataDir string, bsCfg BootstrapConfig) (BootstrapConfig, ClusterConfig, bool, error)

+ func RemoveSetupConfig(log zerolog.Logger, dataDir string) error

+ func Sha256sum(d []byte) string

+ func WaitForFinishedJob(progress actions.Progressor, ctx context.Context, jobID string, ...) error

+ func WaitUntilPortAvailable(host string, port int, timeout time.Duration) bool

+ type ActionResignLeadership struct

+ func (a *ActionResignLeadership) Condition(serverType definitions.ServerType) bool

+ func (a *ActionResignLeadership) Name() string

+ func (a *ActionResignLeadership) PreStop(ctx context.Context, progress actions.Progressor) error

+ func (a *ActionResignLeadership) Timeout() time.Duration

+ type BootstrapConfig struct

+ AgencySize int

+ ArangosyncMonitoringToken string

+ DataDir string

+ DisableIPv6 bool

+ ID string

+ JwtSecret string

+ Mode ServiceMode

+ RecoveryAgentID string

+ RocksDBEncryptionKeyFile string

+ ServerStorageEngine string

+ SslCAFile string

+ SslKeyFile string

+ StartAgent *bool

+ StartCoordinator *bool

+ StartDBserver *bool

+ StartLocalSlaves bool

+ StartResilientSingle *bool

+ StartSyncMaster *bool

+ StartSyncWorker *bool

+ func (bsCfg *BootstrapConfig) Initialize() error

+ func (bsCfg BootstrapConfig) CreateTLSConfig() (*tls.Config, error)

+ func (bsCfg BootstrapConfig) JWTFolderDir() string

+ func (bsCfg BootstrapConfig) JWTFolderDirFile(f string) string

+ func (bsCfg BootstrapConfig) PeersNeeded() int

+ type ClientBuilder interface

+ CreateClient func(endpoints []string, connectionType ConnectionType, ...) (driver.Client, error)

+ type ClusterConfig struct

+ AgencySize int

+ AllPeers []Peer

+ LastModified *time.Time

+ PortOffsetIncrement int

+ ServerStorageEngine string

+ func (p *ClusterConfig) AddPeer(newPeer Peer) bool

+ func (p *ClusterConfig) Initialize(initialPeer Peer, agencySize int, storageEngine string)

+ func (p *ClusterConfig) RemovePeerByID(id string) bool

+ func (p *ClusterConfig) UpdatePeerByID(update Peer) bool

+ func (p ClusterConfig) AllAgents() []Peer

+ func (p ClusterConfig) CreateAgencyAPI(clientBuilder ClientBuilder) (agency.Agency, error)

+ func (p ClusterConfig) CreateClusterAPI(ctx context.Context, clientBuilder ClientBuilder) (driver.Cluster, error)

+ func (p ClusterConfig) CreateCoordinatorsClient(jwtSecret string) (driver.Client, error)

+ func (p ClusterConfig) GetAgentEndpoints() ([]string, error)

+ func (p ClusterConfig) GetAllSingleEndpoints() ([]string, error)

+ func (p ClusterConfig) GetCoordinatorEndpoints() ([]string, error)

+ func (p ClusterConfig) GetDBServerEndpoints() ([]string, error)

+ func (p ClusterConfig) GetFreePortOffset(peerAddress string, basePort int, allPortOffsetsUnique bool) int

+ func (p ClusterConfig) GetPeerEndpoints() ([]string, error)

+ func (p ClusterConfig) GetResilientSingleEndpoints() ([]string, error)

+ func (p ClusterConfig) GetSingleEndpoints(all bool) ([]string, error)

+ func (p ClusterConfig) GetSyncMasterEndpoints() ([]string, error)

+ func (p ClusterConfig) HaveEnoughAgents() bool

+ func (p ClusterConfig) IDs() []string

+ func (p ClusterConfig) IsSecure() bool

+ func (p ClusterConfig) NextPortOffset(portOffset int) int

+ func (p ClusterConfig) PeerByAddressAndPort(address string, port int) (Peer, bool)

+ func (p ClusterConfig) PeerByID(id string) (Peer, bool)

+ type Config struct

+ AdvertisedEndpoint string

+ AllPortOffsetsUnique bool

+ ArangoSyncPath string

+ ArangodJSPath string

+ ArangodPath string

+ BindAddress string

+ DataDir string

+ DebugCluster bool

+ DockerArangoSyncImage string

+ DockerArangodImage string

+ DockerContainerName string

+ DockerEndpoint string

+ DockerGCDelay time.Duration

+ DockerImagePullPolicy ImagePullPolicy

+ DockerNetworkMode string

+ DockerPrivileged bool

+ DockerStarterImage string

+ DockerTTY bool

+ DockerUser string

+ InstanceUpTimeout time.Duration

+ LogDir string

+ LogRotateFilesToKeep int

+ LogRotateInterval time.Duration

+ MasterAddresses []string

+ MasterPort int

+ OwnAddress string

+ PassthroughOptions []PassthroughOption

+ ProjectBuild string

+ ProjectVersion string

+ RrPath string

+ RunningInDocker bool

+ ServerThreads int

+ SyncEnabled bool

+ SyncMQType string

+ SyncMasterClientCAFile string

+ SyncMasterJWTSecretFile string

+ SyncMasterKeyFile string

+ SyncMonitoringToken string

+ Verbose bool

+ func (c Config) CreateRunner(log zerolog.Logger) (Runner, Config, bool)

+ func (c Config) GetNetworkEnvironment(log zerolog.Logger) (Config, int, bool)

+ func (c Config) GuessOwnAddress(log zerolog.Logger, bsCfg BootstrapConfig) Config

+ func (c Config) UseDockerRunner() bool

+ type ConnectionType int

+ const ConnectionTypeAgency

+ const ConnectionTypeDatabase

+ type CreateCertificateOptions struct

+ Hosts []string

+ Organization string

+ ValidFor time.Duration

+ type DatabaseFeatures struct

+ Enterprise bool

+ Version driver.Version

+ func NewDatabaseFeatures(version driver.Version, enterprise bool) DatabaseFeatures

+ func (v DatabaseFeatures) DefaultStorageEngine() string

+ func (v DatabaseFeatures) GetJWTFolderOption() bool

+ func (v DatabaseFeatures) HasCopyInstallationFiles() bool

+ func (v DatabaseFeatures) HasJWTSecretFileOption() bool

+ func (v DatabaseFeatures) HasStorageEngineOption() bool

+ type HelloRequest struct

+ Agent *bool

+ Coordinator *bool

+ DBServer *bool

+ DataDir string

+ IsSecure bool

+ ResilientSingle *bool

+ SlaveAddress string

+ SlaveID string

+ SlavePort int

+ SyncMaster *bool

+ SyncWorker *bool

+ type ImagePullPolicy string

+ const ImagePullPolicyAlways

+ const ImagePullPolicyIfNotPresent

+ const ImagePullPolicyNever

+ func ParseImagePullPolicy(s, image string) (ImagePullPolicy, error)

+ type JobState string

+ type JobStatus struct

+ JobID string

+ Reason string

+ Server string

+ Type string

+ type PassthroughOption struct

+ Name string

+ Values struct{ ... }

+ func (o *PassthroughOption) FormattedOptionName() string

+ func (o *PassthroughOption) IsForbidden() bool

+ type Peer struct

+ Address string

+ DataDir string

+ HasAgentFlag bool

+ HasCoordinatorFlag *bool

+ HasDBServerFlag *bool

+ HasResilientSingleFlag bool

+ HasSyncMasterFlag bool

+ HasSyncWorkerFlag bool

+ ID string

+ IsSecure bool

+ Port int

+ PortOffset int

+ func NewPeer(id, address string, port, portOffset int, dataDir string, ...) Peer

+ func (p Peer) CreateAgentAPI(clientBuilder ClientBuilder) (driver.Client, error)

+ func (p Peer) CreateClient(clientBuilder ClientBuilder, t definitions.ServerType) (driver.Client, error)

+ func (p Peer) CreateCoordinatorAPI(clientBuilder ClientBuilder) (driver.Client, error)

+ func (p Peer) CreateDBServerAPI(clientBuilder ClientBuilder) (driver.Client, error)

+ func (p Peer) CreateStarterURL(relPath string) string

+ func (p Peer) HasAgent() bool

+ func (p Peer) HasCoordinator() bool

+ func (p Peer) HasDBServer() bool

+ func (p Peer) HasResilientSingle() bool

+ func (p Peer) HasSyncMaster() bool

+ func (p Peer) HasSyncWorker() bool

+ func (p Peer) PortRangeOverlaps(otherPort int, clusterConfig ClusterConfig) bool

+ type PermanentError struct

+ Err error

+ func (e *PermanentError) Error() string

+ type Process interface

+ Cleanup func() error

+ ContainerID func() string

+ ContainerIP func() string

+ GetLogger func(logger zerolog.Logger) zerolog.Logger

+ HostPort func(containerPort int) (int, error)

+ Hup func() error

+ Kill func() error

+ ProcessID func() int

+ Terminate func() error

+ Wait func() int

+ WaitCh func() <-chan struct{}

+ type ProcessWrapper interface

+ Process func() Process

+ Wait func(timeout time.Duration) bool

+ func NewProcessWrapper(s *runtimeServerManager, ctx context.Context, log zerolog.Logger, ...) ProcessWrapper

+ type RedirectError struct

+ Location string

+ func (e RedirectError) Error() string

+ type Runner interface

+ Cleanup func() error

+ CreateStartArangodbCommand func(myDataDir string, index int, masterIP, masterPort, starterImageName string, ...) string

+ GetContainerDir func(hostDir, defaultContainerDir string) string

+ GetRunningServer func(serverDir string) (Process, error)

+ Start func(ctx context.Context, processType definitions.ProcessType, command string, ...) (Process, error)

+ func NewDockerRunner(log zerolog.Logger, endpoint, arangodImage, arangoSyncImage string, ...) (Runner, error)

+ func NewProcessRunner(log zerolog.Logger) Runner

+ type Service struct

+ func NewService(ctx context.Context, log zerolog.Logger, logService logging.Service, ...) *Service

+ func (s *Service) ChangeState(newState State)

+ func (s *Service) ClusterConfig() (ClusterConfig, *Peer, ServiceMode)

+ func (s *Service) CreateClient(endpoints []string, connectionType ConnectionType, ...) (driver.Client, error)

+ func (s *Service) DatabaseFeatures() DatabaseFeatures

+ func (s *Service) DatabaseVersion(ctx context.Context) (driver.Version, bool, error)

+ func (s *Service) GetLocalFolder() string

+ func (s *Service) HandleGoodbye(id string, force bool) (peerRemoved bool, err error)

+ func (s *Service) HandleHello(ownAddress, remoteAddress string, req *HelloRequest, isUpdateRequest bool) (ClusterConfig, error)

+ func (s *Service) IsLocalSlave() bool

+ func (s *Service) IsRunningMaster() (isRunningMaster, isRunning bool, masterURL string)

+ func (s *Service) IsSecure() bool

+ func (s *Service) MasterChangedCallback()

+ func (s *Service) PerformRecovery(ctx context.Context, bsCfg BootstrapConfig) (BootstrapConfig, error)

+ func (s *Service) PrepareDatabaseServerRequestFunc() func(*http.Request) error

+ func (s *Service) RestartServer(serverType definitions.ServerType) error

+ func (s *Service) RotateLogFiles(ctx context.Context)

+ func (s *Service) Run(rootCtx context.Context, bsCfg BootstrapConfig, myPeers ClusterConfig, ...) error

+ func (s *Service) Stop()

+ func (s *Service) TestInstance(ctx context.Context, serverType definitions.ServerType, address string, ...) (up, correctRole bool, version, role, mode string, isLeader bool, ...)

+ func (s *Service) UpdateClusterConfig(newConfig ClusterConfig)

+ func (s *Service) UpgradeManager() UpgradeManager

+ type ServiceMode string

+ const ServiceModeActiveFailover

+ const ServiceModeCluster

+ const ServiceModeResilentSingle

+ const ServiceModeSingle

+ func (m ServiceMode) HasAgency() bool

+ func (m ServiceMode) IsActiveFailoverMode() bool

+ func (m ServiceMode) IsClusterMode() bool

+ func (m ServiceMode) IsSingleMode() bool

+ func (m ServiceMode) SupportsArangoSync() bool

+ func (m ServiceMode) SupportsRecovery() bool

+ type SetupConfigFile struct

+ ID string

+ JwtSecret string

+ Mode ServiceMode

+ Peers ClusterConfig

+ SslKeyFile string

+ StartLocalSlaves bool

+ Version string

+ type State int

+ func (s State) IsBootstrap() bool

+ func (s State) IsRunning() bool

+ type StatusItem struct

+ Duration time.Duration

+ PrevStatusCode int

+ StatusCode int

+ type URLSchemes struct

+ ArangoSH string

+ Arangod string

+ Browser string

+ func NewURLSchemes(isSecure bool) URLSchemes

+ type UpgradeEntryType string

+ type UpgradeManager interface

+ AbortDatabaseUpgrade func(ctx context.Context) error

+ IsServerUpgradeInProgress func(serverType definitions.ServerType) bool

+ RetryDatabaseUpgrade func(ctx context.Context) error

+ RunWatchUpgradePlan func(context.Context)

+ ServerDatabaseAutoUpgrade func(serverType definitions.ServerType) bool

+ ServerDatabaseAutoUpgradeStarter func(serverType definitions.ServerType)

+ StartDatabaseUpgrade func(ctx context.Context, forceMinorUpgrade bool) error

+ Status func(context.Context) (client.UpgradeStatus, error)

+ UpgradePlanChangedCallback func()

+ func NewUpgradeManager(log zerolog.Logger, upgradeManagerContext UpgradeManagerContext) UpgradeManager

+ type UpgradeManagerContext interface

+ ClusterConfig func() (ClusterConfig, *Peer, ServiceMode)

+ IsRunningMaster func() (isRunningMaster, isRunning bool, masterURL string)

+ RestartServer func(serverType definitions.ServerType) error

+ TestInstance func(ctx context.Context, serverType definitions.ServerType, address string, ...) (up, correctRole bool, version, role, mode string, isLeader bool, ...)

+ type UpgradePlan struct

+ CreatedAt time.Time

+ Entries []UpgradePlanEntry

+ Finished bool

+ FinishedEntries []UpgradePlanEntry

+ FromVersions []driver.Version

+ LastModifiedAt time.Time

+ Revision int

+ ToVersion driver.Version

+ func (p *UpgradePlan) ResetFailures()

+ func (p UpgradePlan) IsEmpty() bool

+ func (p UpgradePlan) IsFailed() bool

+ func (p UpgradePlan) IsReady() bool

+ type UpgradePlanEntry struct

+ Failures int

+ PeerID string

+ Reason string

+ Type UpgradeEntryType

+ WithoutResign bool

+ func (e UpgradePlanEntry) CreateStatusServer(upgradeManagerContext UpgradeManagerContext) (*client.UpgradeStatusServer, error)

+ type Volume struct

+ ContainerPath string

+ HostPath string

+ ReadOnly bool