install

type AgentConfig struct {
	// PackageAddr references the endpoint to bootstrap credentials from
	PackageAddr 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
}

type Config struct {
	// Context controls state of the installer, e.g. it can be cancelled
	Context context.Context
	// Cancel allows to cancel the context above
	Cancel context.CancelFunc
	// AdvertiseAddr is advertise address of this server
	AdvertiseAddr string
	// Token is install token
	Token string
	// 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
	// SystemLogFile is the log file for system logs
	SystemLogFile string
	// SiteDomain is the name of the cluster
	SiteDomain string
	// Flavor is installation flavor
	Flavor string
	// Role is server role
	Role string
	// AppPackage is the application being installed
	AppPackage *loc.Locator
	// Resources is a file with resource specs
	Resources []byte
	// EventsC is channel with events indicating install progress
	EventsC chan Event
	// SystemDevice is a device for gravity data
	SystemDevice string
	// DockerDevice is a device for docker
	DockerDevice string
	// Mounts is a list of mount points (name -> source pairs)
	Mounts map[string]string
	// DNSOverrides contains installer node DNS overrides
	DNSOverrides storage.DNSOverrides
	// Mode is the installation mode (wizard or CLI or via Ops Center)
	Mode string
	// PodCIDR is a pod network CIDR
	PodCIDR string
	// ServiceCIDR is a service network CIDR
	ServiceCIDR string
	// 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 pack.PackageService
	// LocalApps is the machine-local apps service
	LocalApps appservice.Applications
	// LocalBackend is the machine-local backend
	LocalBackend storage.Backend
	// Manual disables automatic phase execution when set to true
	Manual bool
	// ServiceUser specifies the user to use as a service user in planet
	// and for unprivileged kubernetes services
	ServiceUser systeminfo.User
	// GCENodeTags defines the VM instance tags on GCE
	GCENodeTags []string
	// NewProcess is used to launch gravity API server process
	NewProcess process.NewGravityProcess
	// Silent allows installer to output its progress
	localenv.Silent
}

type Engine interface {
	// NewClusterRequest constructs a request to create a new cluster
	NewClusterRequest() ops.NewSiteRequest
	// GetOperationPlan builds a plan for the provided operation
	GetOperationPlan(ops.Site, ops.SiteOperation) (*storage.OperationPlan, error)
	// GetFSM returns the installer FSM engine
	GetFSM() (*fsm.FSM, error)
	// OnPlanComplete is called when install plan finishes execution
	OnPlanComplete(fsm *fsm.FSM, fsmErr error)
	// Cleanup performs post-installation cleanups
	Cleanup(ops.ProgressEntry) error
}

type Event struct {
	Progress *ops.ProgressEntry
	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
	// LocalPackages is the machine-local pack service
	LocalPackages pack.PackageService
	// LocalApps is the machine-local apps service
	LocalApps app.Applications
	// LocalBackend is the machine-local backend
	LocalBackend storage.Backend
	// RemoteOpsURL is an optional URL of the remote Ops Center
	RemoteOpsURL string
	// RemoteOpsToken is the auth token for the above Ops Center
	RemoteOpsToken string
	// 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 Hook struct {
	// contains filtered or unexported fields
}

type Installer struct {
	// Config is the installer configuration
	Config
	// FieldLogger is used for structured logging
	log.FieldLogger
	// AccountID is the wizard system account ID
	AccountID string
	// AppPackage is the application being installed
	AppPackage loc.Locator
	// Token is the generated unique install token
	Token storage.InstallToken
	// Operator is the ops service authenticated with wizard process
	Operator ops.Operator
	// Apps is the app service authenticated with wizard process
	Apps appservice.Applications
	// Packages is the pack service authenticated with wizard process
	Packages pack.PackageService
	// OperationKey is the key of the running operation
	OperationKey ops.SiteOperationKey
	// Cluster is the cluster that is being installed
	Cluster *ops.Site
	// contains filtered or unexported fields
}

type PlanBuilder struct {
	// 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
	// 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
	// DNSConfig specifies the custom cluster DNS configuration
	DNSConfig storage.DNSConfig
	// InstallerTrustedCluster represents the trusted cluster for installer process
	InstallerTrustedCluster storage.TrustedCluster
}