package
0.0.0-20230628214157-3bfe64699e82
Repository: https://github.com/gravitational/gravity.git
Documentation: pkg.go.dev
# Packages
Copyright 2019 Gravitational, Inc.
Copyright 2019 Gravitational, Inc.
Copyright 2019 Gravitational, Inc.
No description provided by the author
Copyright 2019 Gravitational, Inc.
No description provided by the author
Copyright 2019 Gravitational, Inc.
# Functions
ClientCredentials returns the contents of the default RPC credentials package.
DefaultFSMSpec returns a function that returns the default install FSM spec for the provided install FSM config.
EnsureServiceUserAndBinary ensures that the specified user exists on host (creating it if it does not).
ExecuteOperation executes the operation specified with machine to completion.
FetchCloudMetadata fetches the metadata for the specified cloud provider.
FormatAbortError formats the specified error for output by the installer client.
GetApp finds the user app in the provided service and returns it.
GetAppPackage finds the user app in the provided service and returns its locator.
GetOrCreateServiceUser returns the user to use for container services.
GetServerUpdateRequest returns a request to update servers in given operation's state based on specified list of servers.
GetServiceUser retrieves the service user by ID.
InitProcess initializes and starts a gravity process.
InstallBinary places the system binary into the proper binary directory depending on the distribution.
InstallBinaryInto installs this gravity binary into targetPath using given file options.nolint:revive // stable name.
InstallBinaryIntoDefaultLocation installs the gravity binary into one of the default locations based on the distribution.
LoadRPCCredentials loads and validates the contents of the default RPC credentials package.
New returns a new instance of the unstarted installer server.
NewAgent returns a new unstarted agent instance.
NewClusterFactory returns a factory for creating cluster requests.
NewFSM returns a new install FSM instance.
NewFSMConfig returns state machine configiration.
NewFSMFactory returns a new state machine factory.
NewPlanner returns a new instance of Planner with the specified builder getter.
NewProcessConfig creates a gravity process config from installer config.
ServerRequirements computes server requirements based on the selected flavor.
UpdateOperationState updates the operation data according to the agent report.
# Constants
NumParallel limits the number of parallel phases that can be run during install.
# Variables
FSMSpec is the install FSM spec.
# Structs
AgentConfig describes configuration for a stateless agent.
Config is installer configuration.
ExecResult describes the result of execution an operation (step).
FSMConfig is the install FSM config.
Installer manages the installation process.
PlanBuilder builds operation plan phases.
Planner builds an install operation plan.
No description provided by the author
ProcessConfig defines the configuration for generating process configuration.
ProgressPoller is a progress message poller.
RuntimeConfig specifies installer configuration not exposed to the engine.
# Interfaces
Engine implements the process of cluster installation.
Interface defines the interface of the installer as presented to engine.
PlanBuilderGetter is a factory for plan builders.
# Type aliases
FSMSpecFunc defines a function that returns install FSM spec based on the config.