platform

Documentation

Overview

Package platform provides abstraction for determining etcd initial cluster members

Index

• func Register(name string, factory Factory)
• type Factory
• type Platform
  • func Get(name string, configPath string) (Platform, error)

Functions

func Register

func Register(name string, factory Factory)

Register registers a cloudprovider.Factory by name. This is expected to happen during app startup.

Types

type Factory

type Factory func(config io.Reader) (Platform, error)

Factory produces a platform instance using the provided configuration

type Platform

type Platform interface {

	// ExpectedMembers returns a list of members that should form the cluster
	ExpectedMembers(memberFilter string, clientScheme string, clientPort int,
		serverScheme string, serverPort int) ([]client.Member, error)

	// LocalInstanceName returns the instance name for the local instance
	LocalInstanceName() string
}

Platform is an abstract pluggable interface for etcd initial state discovery

func Get

func Get(name string, configPath string) (Platform, error)

Get creates an instance of the named platform, or nil if the name is unknown. The error return is only used if the named platform was known but failed to initialize. The configPath parameter specifies the path of the configuration file for the platform, or empty for no configuation.