web

Documentation

Overview

Package web is a web dashboard

Index

• Variables
• func NewRPCHandler(r resolver.Resolver, c client.Client) handler.Handler
• func Run(ctx *cli.Context) error
• type WebResolver
  • func (r *WebResolver) Resolve(req *http.Request, opts ...res.ResolveOption) (*res.Endpoint, error)
  • func (r *WebResolver) String() string

Variables

var (
	Name      = "web"
	Address   = ":8082"
	Namespace = "micro"
	Resolver  = "path"
	LoginURL  = "/login"

	// Host name the web dashboard is served on
	Host, _ = os.Hostname()
	// Token cookie name
	TokenCookieName = "micro-token"
)

Meta Fields of micro web

var (
	Flags = []cli.Flag{
		&cli.StringFlag{
			Name:    "web_address",
			Usage:   "Set the web UI address e.g 0.0.0.0:8082",
			EnvVars: []string{"MICRO_WEB_ADDRESS"},
		},
		&cli.StringFlag{
			Name:    "namespace",
			Usage:   "Set the namespace used by the Web proxy e.g. com.example.web",
			EnvVars: []string{"MICRO_WEB_NAMESPACE"},
		},
		&cli.StringFlag{
			Name:    "resolver",
			Usage:   "Set the resolver to route to services e.g path, domain",
			EnvVars: []string{"MICRO_WEB_RESOLVER"},
		},
		&cli.StringFlag{
			Name:    "login_url",
			EnvVars: []string{"MICRO_WEB_LOGIN_URL"},
			Usage:   "The relative URL where a user can login",
		},
	}
)

Functions

func NewRPCHandler

func NewRPCHandler(r resolver.Resolver, c client.Client) handler.Handler

NewRPCHandler returns an initialized RPC handler

func Run

func Run(ctx *cli.Context) error

Types

type WebResolver

type WebResolver struct {
	// Options
	Options resolver.Options
	// selector to choose from a pool of nodes
	// Selector selector.Selector
	// router to lookup routes
	Router router.Router
}

func (*WebResolver) Resolve

func (r *WebResolver) Resolve(req *http.Request, opts ...res.ResolveOption) (*res.Endpoint, error)

Resolve replaces the values of Host, Path, Scheme to calla backend service It accounts for subdomains for service names based on namespace

func (*WebResolver) String

func (r *WebResolver) String() string