package
0.19.9-preview-3
Repository: https://github.com/arangodb-helper/arangodb.git
Documentation: pkg.go.dev
# Functions
No description provided by the author
No description provided by the author
CreateCertificate creates a self-signed certificate according to the given configuration.
CreateJwtToken calculates a JWT authorization token based on the given secret.
DatabaseVersion returns the version of the `arangod` binary.
No description provided by the author
No description provided by the author
GuessOwnAddress takes a "best guess" approach to find the IP address used to reach the host PC.
IsArangoErrorWithCodeAndNum returns true when the given raw content contains a valid arangodb error encoded as json with the given code and errorNum values.
IsLeadershipChallengeOngoingError returns true when given response content contains an arango error indicating an ongoing leadership challenge.
IsNoLeaderError returns true when given response content contains an arango error indicating an "I'm not the leader" error.
IsPortOpen checks if a TCP port is free to listen on.
No description provided by the author
IsSpecialUpgradeFrom3614 determines if special case for upgrade is required.
LoadKeyFile loads a SSL keyfile formatted for the arangod server.
NewDatabaseFeatures returns a new DatabaseFeatures based on the given version.
NewDockerRunner creates a runner that starts processes in a docker container.
NewProcessRunner creates a runner that starts processes on the local OS.
No description provided by the author
NewService creates a new Service instance from the given config.
NewUpgradeManager creates a new upgrade manager.
NewURLSchemes creates initialized schemes depending on isSecure flag.
ParseImagePullPolicy parses a string into an image pull policy.
ReadSetupConfig tries to read a setup.json config file and relaunch when that file exists and is valid.
No description provided by the author
RemoveSetupConfig tries to remove a setup.json config file.
No description provided by the author
No description provided by the author
WaitForFinishedJob waits for the job to be finished until context is canceled.
WaitUntilPortAvailable waits until a TCP port is free to listen on or a timeout occurs.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ImagePullPolicyAlways is a policy to always pull the image.
ImagePullPolicyIfNotPresent is a policy to only pull the image when it does not exist locally.
ImagePullPolicyNever is a policy to never pull the image.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
ActionResignLeadership describes action for the leadership resignation.
BootstrapConfig holds all configuration for a service that will not change through the lifetime of a cluster.
ClusterConfig contains all the information of a cluster from a starter's point of view.
Config holds all configuration for a single service.
CreateCertificateOptions configures how to create a certificate.
DatabaseFeatures provides information about the features provided by the database in a given version.
No description provided by the author
HelloRequest is the data structure send of the wire in a `/hello` POST request.
No description provided by the author
Peer contains all persistent settings of a starter.
No description provided by the author
No description provided by the author
Service implements the actual starter behavior of the ArangoDB starter.
SetupConfigFile is the JSON structure stored in the setup file of this process.
StatusItem contain a single point in time for a status feedback channel.
UpgradePlan is the JSON structure that describes a plan to upgrade a deployment to a new version.
UpgradePlanEntry is the JSON structure that describes a single entry in an upgrade plan.
URLSchemes contains URL schemes for browser & Arango Shell.
No description provided by the author
# Interfaces
ClientBuilder describes how to create connections to the specific instance of the cluster.
No description provided by the author
No description provided by the author
No description provided by the author
UpgradeManager is the API of a service used to control the upgrade process from 1 database version to the next.
UpgradeManagerContext holds methods used by the upgrade manager to control its context.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
State of the service.
UpgradeEntryType is a strongly typed upgrade plan item.