install

type AgentConfig struct {
	log.FieldLogger
	rpcserver.Credentials
	*rpcserver.ReconnectStrategy
	CloudProvider string
	// AdvertiseAddr is the IP address to advertise
	AdvertiseAddr string
	// ServerAddr specifies the address of the agent server
	ServerAddr string
	// RuntimeConfig specifies runtime configuration
	pb.RuntimeConfig
	// WatchCh specifies the channel to receive peer reconnect updates
	WatchCh chan rpcserver.WatchEvent
	// StopHandler specifies an optional handler for when the agent is stopped.
	// completed indicates whether this is the result of a successfully completed operation
	StopHandler func(ctx context.Context, completed bool) error
	// AbortHandler specifies an optional handler for abort requests
	AbortHandler func(context.Context) error
}

type Config struct {
	// FieldLogger is used for logging
	log.FieldLogger
	// Printer specifies the output sink for progress messages
	utils.Printer
	// AdvertiseAddr is advertise address of this server
	AdvertiseAddr string
	// Token specifies the agent validation token used during the operation
	Token storage.InstallToken
	// CloudProvider is optional cloud provider
	CloudProvider string
	// StateDir is directory with local installer state
	StateDir string
	// WriteStateDir is installer write layer
	WriteStateDir string
	// UserLogFile is the log file where user-facing operation logs go
	UserLogFile string
	// SiteDomain is the name of the cluster
	SiteDomain string
	// Flavor is installation flavor
	Flavor schema.Flavor
	// DisabledWebUI specifies whether OpsCenter and WebInstallWizard are disabled
	DisabledWebUI bool
	// Role is server role
	Role string
	// App is the application being installed
	App app.Application
	// RuntimeResources specifies optional Kubernetes resources to create
	RuntimeResources []runtime.Object
	// ClusterResources specifies optional cluster resources to create
	// TODO(dmitri): externalize the ClusterConfiguration resource and create
	// default provider-specific cloud-config on Gravity side
	ClusterResources []storage.UnknownResource
	// SystemDevice is a device for gravity data
	SystemDevice string
	// Mounts is a list of mount points (name -> source pairs)
	Mounts map[string]string
	// DNSOverrides contains installer node DNS overrides
	DNSOverrides storage.DNSOverrides
	// VxlanPort is the overlay network port
	VxlanPort int
	// DNSConfig overrides the local cluster DNS configuration
	DNSConfig storage.DNSConfig
	// Docker specifies docker configuration
	Docker storage.DockerConfig
	// Insecure allows to turn off cert validation
	Insecure bool
	// Process is the gravity process running inside the installer
	Process process.GravityProcess
	// LocalPackages is the machine-local package service
	LocalPackages *localpack.PackageServer
	// LocalApps is the machine-local application service
	LocalApps app.Applications
	// LocalBackend is the machine-local backend
	LocalBackend storage.LocalBackend
	// ServiceUser specifies the user to use as a service user in planet
	// and for unprivileged kubernetes services
	ServiceUser systeminfo.User
	// GCENodeTags specifies additional VM instance tags on GCE
	GCENodeTags []string
	// LocalClusterClient is a factory for creating client to the installed cluster
	LocalClusterClient func(...httplib.ClientOption) (*opsclient.Client, error)
	// Operator specifies the wizard's operator service
	Operator ops.Operator
	// Apps specifies the wizard's application service
	Apps app.Applications
	// Packages specifies the wizard's package service
	Packages pack.PackageService
	// LocalAgent specifies whether the installer will also run an agent
	LocalAgent bool
	// Values are helm values in marshaled yaml format
	Values []byte
	// SELinux specifies whether the installer runs with SELinux support.
	// This makes the installer run in its own domain
	SELinux bool
}

type Engine interface {
	// Execute executes the steps to install a cluster.
	// If the method returns with an error, the installer will continue
	// running until it receives a shutdown signal.
	//
	// The method is expected to be re-entrant as the service might be re-started
	// multiple times before the operation is complete.
	//
	// installer is the reference to the installer.
	// config specifies the configuration for the operation
	Execute(ctx context.Context, installer Interface, config Config) (dispatcher.Status, error)
}

type ExecResult struct {
	// CompletionEvent specifies the optional completion
	// event to send to a client
	CompletionEvent *dispatcher.Event
	// Error specifies the optional execution error
	Error error
}

type FSMConfig struct {
	// OperationKey is the install operation key
	OperationKey ops.SiteOperationKey
	// Packages is authenticated installer pack client
	Packages pack.PackageService
	// Apps is authenticated installer apps client
	Apps app.Applications
	// Operator is authenticated installer ops client
	Operator ops.Operator
	// LocalClusterClient is a factory for creating a client to the installed cluster.
	LocalClusterClient func(...httplib.ClientOption) (*opsclient.Client, error)
	// LocalPackages is the machine-local pack service
	LocalPackages *localpack.PackageServer
	// LocalApps is the machine-local apps service
	LocalApps app.Applications
	// LocalBackend is the machine-local backend
	LocalBackend storage.LocalBackend
	// Spec is the FSM spec
	Spec fsm.FSMSpecFunc
	// Credentials is the credentials for gRPC agents
	Credentials credentials.TransportCredentials
	// Insecure allows to turn off cert validation in dev mode
	Insecure bool
	// UserLogFile is the user-friendly install log file
	UserLogFile string
	// ReportProgress controls whether engine should report progress to Operator
	ReportProgress bool
	// DNSConfig specifies the DNS configuration to use
	DNSConfig storage.DNSConfig
}

type FSMSpecFunc func(FSMConfig) fsm.FSMSpecFunc

type Installer struct {
	// FieldLogger specifies the installer's logger
	log.FieldLogger
	// contains filtered or unexported fields
}

type Interface interface {
	engine.ClusterFactory
	// ExecuteOperation executes the specified operation to completion
	ExecuteOperation(ops.SiteOperationKey) error
	// NotifyOperationAvailable is invoked by the engine to notify the server
	// that the operation has been created
	NotifyOperationAvailable(ops.SiteOperation) error
	// CompleteOperation executes additional steps common to all workflows after the
	// installation has completed
	CompleteOperation(operation ops.SiteOperation) error
	// CompleteFinalInstallStep marks the final install step as completed unless
	// the application has a custom install step. In case of the custom step,
	// the user completes the final installer step
	CompleteFinalInstallStep(key ops.SiteOperationKey, delay time.Duration) error
	// PrintStep publishes a progress entry described with (format, args)
	PrintStep(format string, args ...interface{})
}

type PlanBuilder struct {
	// Cluster is the cluster being installed
	Cluster storage.Site
	// Operation is the operation the builder is for
	Operation ops.SiteOperation
	// Application is the app being installed
	Application app.Application
	// Runtime is the Runtime of the app being installed
	Runtime app.Application
	// TeleportPackage is the runtime teleport package
	TeleportPackage loc.Locator
	// RBACPackage is the runtime rbac app package
	RBACPackage loc.Locator
	// GravitySitePackage is the gravity-site app package
	GravitySitePackage loc.Locator
	// GravityPackage is the gravity binary package
	GravityPackage loc.Locator
	// DNSAppPackage is the dns-app app package
	DNSAppPackage loc.Locator
	// Masters is the list of master nodes
	Masters []storage.Server
	// Nodes is the list of regular nodes
	Nodes []storage.Server
	// Master is one of the master nodes
	Master storage.Server
	// AdminAgent is the cluster agent with admin privileges
	AdminAgent storage.LoginEntry
	// RegularAgent is the cluster agent with non-admin privileges
	RegularAgent storage.LoginEntry
	// ServiceUser is the cluster system user
	ServiceUser storage.OSUser

	// InstallerTrustedCluster represents the trusted cluster for installer process
	InstallerTrustedCluster storage.TrustedCluster
	// PersistentStorage is persistent storage resource optionally provided by
	// user at install time.
	PersistentStorage storage.PersistentStorage
	// contains filtered or unexported fields
}

type PlanBuilderGetter interface {
	// GetPlanBuilder returns a new plan builder for the specified cluster and operation
	GetPlanBuilder(operator ops.Operator, cluster ops.Site, operation ops.SiteOperation) (*PlanBuilder, error)
}

type PlanSuite struct {
	// contains filtered or unexported fields
}

type Planner struct {
	PlanBuilderGetter
	// contains filtered or unexported fields
}

type ProcessConfig struct {
	// AdvertiseAddr specifies the advertise address for the wizard process
	AdvertiseAddr string
	// StateDir specifies the read-only state directory for the wizard process
	StateDir string
	// WriteStateDir specifies the state directory for the wizard process
	WriteStateDir string
	// ServiceUser specifies the service user selected for the operation
	ServiceUser systeminfo.User
	// ClusterName specifies the name of the cluster to create
	ClusterName string
	// Devmode specifies whether the development mode is on
	Devmode bool
	// LogFile specifies the path to the operation log file
	LogFile string
	// Token specifies the token the wizard will use to authenticate joining agents.
	Token string
}

type ProgressPoller struct {
	log.FieldLogger
	Operator     ops.Operator
	OperationKey ops.SiteOperationKey
	Dispatcher   eventDispatcher
}

type RuntimeConfig struct {
	// Config is the main configuration for the installer
	Config
	// FSMFactory specifies the state machine factory to use
	FSMFactory engine.FSMFactory
	// ClusterFactory specifies the cluster request factory to use
	ClusterFactory engine.ClusterFactory
	// Planner specifies the plan generator
	Planner engine.Planner
	// Engine specifies the installer flow engine
	Engine Engine
}