Documentation
¶
Index ¶
- Variables
- func App() *cli.App
- func Init(opts ...Option) error
- type Cmd
- type Option
- func Auth(a *auth.Auth) Option
- func Broker(b *broker.Broker) Option
- func Client(c *client.Client) Option
- func Config(c *config.Config) Option
- func Description(d string) Option
- func Name(n string) Option
- func NewAuth(name string, t func(...auth.Option) auth.Auth) Option
- func NewBroker(name string, b func(...broker.Option) broker.Broker) Option
- func NewClient(name string, b func(...client.Option) client.Client) Option
- func NewRegistry(name string, r func(...registry.Option) registry.Registry) Option
- func NewRuntime(name string, r func(...runtime.Option) runtime.Runtime) Option
- func NewSelector(name string, s func(...selector.Option) selector.Selector) Option
- func NewServer(name string, s func(...server.Option) server.Server) Option
- func NewTracer(name string, t func(...trace.Option) trace.Tracer) Option
- func NewTransport(name string, t func(...transport.Option) transport.Transport) Option
- func Profile(p *profile.Profile) Option
- func Registry(r *registry.Registry) Option
- func Runtime(r *runtime.Runtime) Option
- func Selector(s *selector.Selector) Option
- func Server(s *server.Server) Option
- func Store(s *store.Store) Option
- func Tracer(t *trace.Tracer) Option
- func Transport(t *transport.Transport) Option
- func Version(v string) Option
- type Options
Constants ¶
This section is empty.
Variables ¶
View Source
var ( DefaultCmd = newCmd() DefaultFlags = []cli.Flag{ &cli.StringFlag{ Name: "client", EnvVars: []string{"VINE_CLIENT"}, Usage: "Client for vine; rpc", }, &cli.StringFlag{ Name: "client-request-timeout", EnvVars: []string{"VINE_CLIENT_REQUEST_TIMEOUT"}, Usage: "Sets the client request timeout. e.g 500ms, 5s, 1m. Default: 5s", }, &cli.IntFlag{ Name: "client-retries", EnvVars: []string{"VINE_CLIENT_RETIES"}, Value: client.DefaultRetries, Usage: "Sets the client retries. Default: 1", }, &cli.IntFlag{ Name: "client_pool_size", EnvVars: []string{"VINE_CLIENT_POOL_SIZE"}, Usage: "Sets the client connection pool size. Default: 1", }, &cli.StringFlag{ Name: "client-pool-ttl", EnvVars: []string{"VINE_CLIENT_POOL_TTL"}, Usage: "Sets the client connection pool ttl. e.g 500ms, 5s, 1m. Default: 1m", }, &cli.IntFlag{ Name: "register-ttl", EnvVars: []string{"VINE_REGISTER_TTL"}, Value: 60, Usage: "Register TTL in seconds", }, &cli.IntFlag{ Name: "register-interval", EnvVars: []string{"VINE_REGISTER_INTERVAL"}, Value: 30, Usage: "Register interval in seconds", }, &cli.StringFlag{ Name: "server", EnvVars: []string{"VINE_SERVER"}, Usage: "Server for vine; rpc", }, &cli.StringFlag{ Name: "server-name", EnvVars: []string{"VINE_SERVER_NAME"}, Usage: "Name of the server. go.vine.svc.example", }, &cli.StringFlag{ Name: "server-version", EnvVars: []string{"VINE_SERVER_VERSION"}, Usage: "Version of the server. 1.1.0", }, &cli.StringFlag{ Name: "server-id", EnvVars: []string{"VINE_SERVER_ID"}, Usage: "Id of the server. Auto-generated if not specified", }, &cli.StringFlag{ Name: "server-address", EnvVars: []string{"VINE_SERVER_ADDRESS"}, Usage: "Bind address for the server. 127.0.0.1:8080", }, &cli.StringFlag{ Name: "server-advertise", EnvVars: []string{"VINE_SERVER_ADVERTISE"}, Usage: "Use instead of the server-address when registering with discovery. 127.0.0.1:8080", }, &cli.StringSliceFlag{ Name: "server-metadata", EnvVars: []string{"VINE_SERVER_METADATA"}, Value: &cli.StringSlice{}, Usage: "A list of key-value pairs defining metadata. version=1.0.0", }, &cli.StringFlag{ Name: "broker", EnvVars: []string{"VINE_BROKER"}, Usage: "Broker for pub/sub. http, nats, rabbitmq", }, &cli.StringFlag{ Name: "broker-address", EnvVars: []string{"VINE_BROKER_ADDRESS"}, Usage: "Comma-separated list of broker addresses", }, &cli.StringFlag{ Name: "profile", Usage: "Debug profiler for cpu and memory stats", EnvVars: []string{"VINE_DEBUG_PROFILE"}, }, &cli.StringFlag{ Name: "registry", EnvVars: []string{"VINE_REGISTRY"}, Usage: "Registry for discovery. etcd, mdns", }, &cli.StringFlag{ Name: "registry-address", EnvVars: []string{"VINE_REGISTRY_ADDRESS"}, Usage: "Comma-separated list of registry addresses", }, &cli.StringFlag{ Name: "runtime", Usage: "Runtime for building and running services e.g local", EnvVars: []string{"VINE_RUNTIME"}, Value: "local", }, &cli.StringFlag{ Name: "runtime-source", Usage: "Runtime source for building and running services e.g github.com/lack-io/services", EnvVars: []string{"VINE_RUNTIME_SOURCE"}, Value: "github.com/lack-io/services", }, &cli.StringFlag{ Name: "selector", EnvVars: []string{"VINE_SELECTOR"}, Usage: "Selector used to pick nodes for querying", }, &cli.StringFlag{ Name: "store", EnvVars: []string{"VINE_STORE"}, Usage: "Store used for key-value storage", }, &cli.StringFlag{ Name: "store-address", EnvVars: []string{"VINE_STORE_ADDRESS"}, Usage: "Comma-separated list of store addresses", }, &cli.StringFlag{ Name: "store-database", EnvVars: []string{"VINE_STORE_DATABASE"}, Usage: "Database option for the underlying store", }, &cli.StringFlag{ Name: "store-table", EnvVars: []string{"VINE_STORE_TABLE"}, Usage: "Table option for the underlying store", }, &cli.StringFlag{ Name: "transport", EnvVars: []string{"VINE_TRANSPORT"}, Usage: "Transport mechanism used; http", }, &cli.StringFlag{ Name: "transport-address", EnvVars: []string{"VINE_TRANSPORT_ADDRESS"}, Usage: "Comma-separated list of transport addresses", }, &cli.StringFlag{ Name: "tracer", EnvVars: []string{"VINE_TRACER"}, Usage: "Tracer for distributed tracing, e.g. memory, jaeger", }, &cli.StringFlag{ Name: "tracer-address", EnvVars: []string{"VINE_TRACER_ADDRESS"}, Usage: "Comma-separated list of tracer addresses", }, &cli.StringFlag{ Name: "auth", EnvVars: []string{"VINE_AUTH"}, Usage: "Auth for role based access control, e.g. service", }, &cli.StringFlag{ Name: "auth-id", EnvVars: []string{"VINE_AUTH_ID"}, Usage: "Account ID used for client authentication", }, &cli.StringFlag{ Name: "auth-secret", EnvVars: []string{"VINE_AUTH_SECRET"}, Usage: "Account secret used for client authentication", }, &cli.StringFlag{ Name: "auth-namespace", EnvVars: []string{"VINE_AUTH_NAMESPACE"}, Usage: "Namespace for the services auth account", Value: "go.vine", }, &cli.StringFlag{ Name: "auth-public-key", EnvVars: []string{"VINE_AUTH_PUBLIC_KEY"}, Usage: "Public key for JWT auth (base64 encoded PEM)", }, &cli.StringFlag{ Name: "auth-private-key", EnvVars: []string{"VINE_AUTH_PRIVATE_KEY"}, Usage: "Private key for JWT auth (base64 encoded PEM)", }, &cli.StringFlag{ Name: "auth-provider", EnvVars: []string{"VINE_AUTH_PROVIDER"}, Usage: "Auth provider used to login user", }, &cli.StringFlag{ Name: "auth-provide-client-id", EnvVars: []string{"VINE_AUTH_PROVIDER_CLIENT_ID"}, Usage: "The client id to be used for oauth", }, &cli.StringFlag{ Name: "auth-provider-client-secret", EnvVars: []string{"VINE_AUTH_PROVIDER_CLIENT_SECRET"}, Usage: "The client secret to be used for oauth", }, &cli.StringFlag{ Name: "auth-provider-endpoint", EnvVars: []string{"VINE_AUTH_PROVIDER_ENDPOINT"}, Usage: "The endpoint to be used for oauth", }, &cli.StringFlag{ Name: "auth-provider-redirect", EnvVars: []string{"VINE_AUTH_PROVIDER_REDIRECT"}, Usage: "The redirect to be used for oauth", }, &cli.StringFlag{ Name: "auth-provider-scope", EnvVars: []string{"VINE_AUTH_PROVIDER_SCOPE"}, Usage: "The scope to be used for oauth", }, &cli.StringFlag{ Name: "config", EnvVars: []string{"VINE_CONFIG"}, Usage: "The source of the config to be used to get configuration", }, } DefaultBrokers = map[string]func(...broker.Option) broker.Broker{ "service": brokerSrv.NewBroker, "memory": memory.NewBroker, "http": brokerHttp.NewBroker, } DefaultClients = map[string]func(...client.Option) client.Client{ "mucp": cmucp.NewClient, "grpc": cgrpc.NewClient, } DefaultRegistries = map[string]func(...registry.Option) registry.Registry{ "etcd": etcd.NewRegistry, "service": regSrv.NewRegistry, "mdns": mdns.NewRegistry, "memory": rmem.NewRegistry, } DefaultSelectors = map[string]func(...selector.Option) selector.Selector{ "dns": dns.NewSelector, "static": static.NewSelector, } DefaultServers = map[string]func(...server.Option) server.Server{ "mucp": smucp.NewServer, "grpc": sgrpc.NewServer, } DefaultTransports = map[string]func(...transport.Option) transport.Transport{ "memory": tmem.NewTransport, "http": thttp.NewTransport, } DefaultRuntimes = map[string]func(...runtime.Option) runtime.Runtime{ "local": lRuntime.NewRuntime, "service": svcRuntime.NewRuntime, } DefaultStores = map[string]func(...store.Option) store.Store{ "file": fileStore.NewStore, "memory": memStore.NewStore, "service": svcStore.NewStore, } DefaultTracers = map[string]func(...trace.Option) trace.Tracer{ "memory": memTracer.NewTracer, } DefaultAuths = map[string]func(...auth.Option) auth.Auth{ "service": svcAuth.NewAuth, "jwt": jwtAuth.NewAuth, } DefaultAuthProviders = map[string]func(...provider.Option) provider.Provider{ "oauth": oauth.NewProvider, "basic": basic.NewProvider, } DefaultProfiles = map[string]func(...profile.Option) profile.Profile{ "http": http.NewProfile, "pprof": pprof.NewProfile, } DefaultConfigs = map[string]func(...config.Option) (config.Config, error){ "service": config.NewConfig, } )
Functions ¶
Types ¶
type Cmd ¶
type Option ¶
type Option func(o *Options)
func NewRegistry ¶
New registry func
func NewRuntime ¶
New runtime func
func NewSelector ¶
New selector func
func NewTransport ¶
New transport func
type Options ¶
type Options struct { // For the Command Line itself Name string Description string Version string // We need pointers to things so we can swap them out if needed. Broker *broker.Broker Registry *registry.Registry Selector *selector.Selector Transport *transport.Transport Config *config.Config Client *client.Client Server *server.Server Runtime *runtime.Runtime Store *store.Store Tracer *trace.Tracer Auth *auth.Auth Profile *profile.Profile Brokers map[string]func(...broker.Option) broker.Broker Configs map[string]func(...config.Option) (config.Config, error) Clients map[string]func(...client.Option) client.Client Registries map[string]func(...registry.Option) registry.Registry Selectors map[string]func(...selector.Option) selector.Selector Servers map[string]func(...server.Option) server.Server Transports map[string]func(...transport.Option) transport.Transport Runtimes map[string]func(...runtime.Option) runtime.Runtime Stores map[string]func(...store.Option) store.Store Tracers map[string]func(...trace.Option) trace.Tracer Auths map[string]func(...auth.Option) auth.Auth Profiles map[string]func(...profile.Option) profile.Profile // Other options for implementations of the interfaces // can be stored in a context Context context.Context }
func DefaultOptions ¶
func DefaultOptions() Options
Click to show internal directories.
Click to hide internal directories.