providers

type CloudConfigOptions struct {
	ClusterID      string
	PrivateIPv4    string
	SshKeys        []string
	RebootStrategy string
}

type CloudProvider interface {
	ShowRegions() error
	ShowImages() error
	ShowKeys() error
	ShowInstanceTypes() error

	// Apply defaults for the given options
	ClusterDefaults(options ClusterInfo) ClusterInfo

	// Apply defaults for the given options
	CreateInstanceDefaults(options CreateInstanceOptions) CreateInstanceOptions

	// Apply defaults for the given options
	CreateClusterDefaults(options CreateClusterOptions) CreateClusterOptions

	// Create a machine instance
	CreateInstance(log *logging.Logger, options CreateInstanceOptions, dnsProvider DnsProvider) (ClusterInstance, error)

	// Create an entire cluster
	CreateCluster(log *logging.Logger, options CreateClusterOptions, dnsProvider DnsProvider) error

	// Get names of instances of a cluster
	GetInstances(info ClusterInfo) (ClusterInstanceList, error)

	// Remove all instances of a cluster
	DeleteCluster(info ClusterInfo, dnsProvider DnsProvider) error

	// Remove a single instance of a cluster
	DeleteInstance(info ClusterInstanceInfo, dnsProvider DnsProvider) error

	// Perform a reboot of the given instance
	RebootInstance(instance ClusterInstance) error

	// Update the instances of the cluster to all new services & formats
	UpdateCluster(log *logging.Logger, info ClusterInfo, dnsProvider DnsProvider) error

	ShowDomainRecords(domain string) error
}

type ClusterInfo struct {
	ID     string // /etc/pulcy/cluster-id, used for vault-monkey authentication
	Domain string // Domain postfix (e.g. pulcy.com)
	Name   string // Name of the cluster
}

type ClusterInstance struct {
	ID               string // Provider specific ID of the server (only used by provider, can be empty)
	Name             string // Name of the instance as known by the provider
	ClusterIP        string // IPv4 address of the instance used for all private communication in the cluster
	LoadBalancerIPv4 string // IPv4 address of the instance on which the load-balancer is listening (can be empty)
	LoadBalancerIPv6 string // IPv6 address of the instance on which the load-balancer is listening (can be empty)
	IsGateway        bool   // If set, this instance can be used as a gateway by instances that have not direct IPv4 internet connection
	LoadBalancerDNS  string // Provider hosted public DNS name of the instance on which the load-balancer is listening (can be empty)
	ClusterDevice    string // Device name of the nic that is configured for the ClusterIP
	PrivateIP        string // IP address of the instance's private network (can be same as ClusterIP)
	PrivateNetwork   net.IPNet
	PrivateDNS       string   // Provider hosted private DNS name of the instance's private network
	UserName         string   // Account name used to SSH into this instance. (empty defaults to 'core')
	OS               OSName   // Name of the OS on the instance
	Extra            []string // Extra informational data
	EtcdProxy        *bool
}

type ClusterInstanceInfo struct {
	ClusterInfo
	Prefix string // Prefix on the instance name
}

type ClusterInstanceList []ClusterInstance

type ClusterMember struct {
	ClusterID     string // ID of the cluster this is a member of (/etc/pulcu/cluster-id)
	MachineID     string // ID of the machine (/etc/machine-id)
	ClusterIP     string // IP address of the instance used for all private communication in the cluster
	PrivateHostIP string // IP address of the host on the private network (can be ClusterIP)
	EtcdProxy     bool   // If set, this member is an ETCD proxy
}

type ClusterMemberList []ClusterMember

type CreateClusterOptions struct {
	ClusterInfo
	InstanceConfig
	SSHKeyNames             []string // List of names of SSH keys to install on each instance
	SSHKeyGithubAccount     string   // Github account name used to fetch SSH keys
	RegisterInstance        bool     // If set, the instances will be registered with their instance name in DNS
	InstanceCount           int      // Number of instances to start
	GluonImage              string   // Docker image containing gluon
	RebootStrategy          string
	PrivateRegistryUrl      string // URL of private docker registry
	PrivateRegistryUserName string // Username of private docker registry
	PrivateRegistryPassword string // Password of private docker registry
	VaultAddress            string // URL of the vault
	VaultCertificatePath    string // Path of the vault ca-cert file
	VaultServerKeyPath      string // Path of the vault ca-cert key file
	VaultServerKeyCommand   string // Shell command that outputs a PEM-encoded CA key to use to as the Vault server SSL certificate key
	TincCIDR                string // CIDR for the TINC network inside the cluster (e.g. 192.168.35.0/24)
	HttpProxy               string // Address of the http proxy to use (if any)
	WeavePassword           string // Encryption password of weave network
	EnableFleet             bool   // Install fleet on the cluster
	EnableKubernetes        bool   // Install kubernetes on the cluster
	// contains filtered or unexported fields
}

type CreateInstanceOptions struct {
	ClusterInfo
	InstanceConfig
	ClusterName             string   // Full name of the cluster e.g. "dev1.example.com"
	InstanceName            string   // Name of the instance e.g. "abc123.dev1.example.com"
	InstanceIndex           int      // 0,... used for odd/even metadata
	RegisterInstance        bool     // If set, the instance will be register with its instance name in DNS
	RoleCore                bool     // If set, this instance will get `core=true` metadata
	RoleLoadBalancer        bool     // If set, this instance will get `lb=true` metadata and the instance will be registered under the cluster name in DNS
	RoleVault               bool     // If set, this instance will get `vault=true` metadata and a `vault` role.
	RoleWorker              bool     // If set, this instance will get `worker=true` metadata
	SSHKeyNames             []string // List of names of SSH keys to install
	SSHKeyGithubAccount     string   // Github account name used to fetch SSH keys
	GluonImage              string   // Docker image containing gluon
	GluonEnv                string   // Content of gluon.env
	RebootStrategy          string
	PrivateRegistryUrl      string // URL of private docker registry
	PrivateRegistryUserName string // Username of private docker registry
	PrivateRegistryPassword string // Password of private docker registry
	EtcdProxy               bool   // If set, this instance will be an ETCD proxy
	VaultAddress            string // URL of the vault
	VaultCertificatePath    string // Path of the vault ca-cert file

	VaultServerKeyPath    string // Path of the vault ca-cert key file
	VaultServerKeyCommand string // Shell command that outputs a PEM-encoded CA key to use to as the Vault server SSL certificate key

	TincCIDR  string // CIDR for the TINC network inside the cluster (e.g. 192.168.35.0/24)
	TincIpv4  string // IP addres of tun0 (tinc) on this instance
	HttpProxy string // Address of the http proxy to use (if any)
	WeaveEnv  string // Content of weave.env
	WeaveSeed string // Content of weave-seed
	// contains filtered or unexported fields
}

type DnsProvider interface {
	ShowDomainRecords(domain string) error
	CreateDnsRecord(domain, recordTpe, name, data string) error
	DeleteDnsRecord(domain, recordType, name, data string) error
}

type InitialSetupOptions struct {
	ClusterMembers   ClusterMemberList
	FleetMetadata    string
	EtcdClusterState string
}

type InstanceConfig struct {
	ImageID      string // ID of the image to install on each instance
	RegionID     string // ID of the region to run all instances in
	TypeID       string // ID of the type of each instance
	MinOSVersion string
	NoPublicIPv4 bool // If set, this instance will be created without a public IPv4 address
}

type InstanceConnection interface {
	SSHClient

	// Sync the filesystems on the instance
	Sync(log *logging.Logger) error

	// Exec executes a command on the instance
	Exec(log *logging.Logger, command string) (string, error)

	// EnableService calls `systemctl enable <name>`
	EnableService(log *logging.Logger, name string) error
	// RunScript uploads a script with given content and executes it
	RunScript(log *logging.Logger, scriptContent, scriptPath string) error

	GetClusterID(log *logging.Logger) (string, error)

	GetGluonEnv(log *logging.Logger) (string, error)

	GetMachineID(log *logging.Logger) (string, error)

	GetVaultCrt(log *logging.Logger) (string, error)

	GetVaultAddr(log *logging.Logger) (string, error)

	GetWeaveEnv(log *logging.Logger) (string, error)

	GetWeaveSeed(log *logging.Logger) (string, error)

	GetOSRelease(log *logging.Logger) (semver.Version, error)

	// IsEtcdProxyFromService queries the ETCD2 service on the instance to look for an ETCD_PROXY variable.
	IsEtcdProxyFromService(log *logging.Logger) (bool, error)

	// AddEtcdMember calls etcdctl to add a member to ETCD
	AddEtcdMember(log *logging.Logger, name, clusterIP string) error

	// RemoveEtcdMember calls etcdctl to remove a member from ETCD
	RemoveEtcdMember(log *logging.Logger, name, clusterIP string) error
}

type OSName string

type SSHClient interface {
	io.Closer
	Run(log *logging.Logger, command, stdin string, quiet bool) (string, error)
}

type VaultProvider interface {
	AddMachine(clusterId, machineId string) error
	RemoveMachine(machineId string) error
}

type VaultProviderConfig struct {
	VaultAddr         string // URL of the vault
	VaultCACert       string // Path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate
	VaultCAKey        string // Path to a PEM-encoded CA key file to use to verify the Vault server SSL certificate (vault servers only)
	VaultCAKeyCommand string // Shell command that outputs a PEM-encoded CA key to use to as the Vault server SSL certificate key
	VaultCAPath       string // Path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate
	GithubToken       string
}