cli

Documentation

Index

• Constants
• Variables
• func AddClusterFlags(root *cobra.Command)
• func AddServiceFlags(root *cobra.Command, name string)
• func JoinConsulPeers(api *consul.Client, service string, selfAddress string, selfPort int, ...) error
• func Version() string
• type Context
  • func Bootstrap(cmd *cobra.Command) *Context
  • func (ctx *Context) AddService(cmd *cobra.Command, name string, ...)
  • func (ctx *Context) Run() error
• type HealthReport
• type Service
• type ServiceHealthReport

Constants

const (
	FLAG_NAME_CLUSTER            = "cluster"
	FLAG_NAME_SERVICE            = "service"
	FLAG_NAME_SERVICE_GOSSIP     = "gossip"
	FLAG_NAME_SERVICE_GOSSIP_RPC = "gossip_rpc"
)

Variables

var BuiltVersion = "snapshot"

Functions

func AddClusterFlags

func AddClusterFlags(root *cobra.Command)

func AddServiceFlags

func AddServiceFlags(root *cobra.Command, name string)

func JoinConsulPeers

func JoinConsulPeers(api *consul.Client, service string, selfAddress string, selfPort int, mesh cluster.Mesh, logger *zap.Logger) error

func Version

func Version() string

Version returns the version variable, overriden at build

Types

type Context

type Context struct {
	ID          string
	Logger      *zap.Logger
	Discovery   cluster.DiscoveryLayer
	MeshNetConf *network.Configuration
	Services    []*serviceRunConfig
}

func Bootstrap

func Bootstrap(cmd *cobra.Command) *Context

func (*Context) AddService

func (ctx *Context) AddService(cmd *cobra.Command, name string, f func(id string, logger *zap.Logger, mesh cluster.DiscoveryLayer) Service)

func (*Context) Run

func (ctx *Context) Run() error

type HealthReport

type HealthReport struct {
	Timestamp    time.Time             `json:"timestamp"`
	GlobalHealth string                `json:"global_health"`
	Services     []ServiceHealthReport `json:"services"`
}

type Service

type Service interface {
	Serve(port int) net.Listener
	Shutdown()
	JoinServiceLayer(string, *zap.Logger, cluster.ServiceConfig, cluster.ServiceConfig, cluster.DiscoveryLayer)
	Health() string
}

type ServiceHealthReport

type ServiceHealthReport struct {
	ServiceName string `json:"service_name"`
	Health      string `json:"health"`
}