cmd

README

CMD

CMD is the init entrance for Stack APP

Most of its jobs are preparing configurations, setup components like client, server, and init the server

Config Load Order

• Config Option(Hard code)
  • stack.Config
• Config File:
  • stack.yml. If there is no stack.yml, config init will skip it. All options please see: stack.yml
  • yml files stored in same dir with the stack.yml, and you should set included for them in stack.yml.
  • we now suggest setting configs in yml, even though we support most type of config files eg. json, toml.
  • other config files setting at cmd by --config. eg: go run main.go --config=path/to/a.json.
• Environment Variables
  • we now support native Stack env for apps only, which means we can't inject user custom env into their options. so people should read env by themselves.
• CMD

Documentation

Overview

Package cmd is an interface for parsing the command line

Index

• Variables
• type Cmd
  • func NewCmd(opts ...Option) Cmd
• type Option
  • func Description(d string) Option
  • func Name(n string) Option
  • func Version(v string) Option
• type Options

Variables

var (
	DefaultFlags = []cli.Flag{
		cli.StringFlag{
			Name:   "client",
			EnvVar: "STACK_CLIENT",
			Usage:  "Client for stack; rpc",
			Alias:  "stack_client_protocol",
		},
		cli.StringFlag{
			Name:   "client_request_timeout",
			EnvVar: "STACK_CLIENT_REQUEST_TIMEOUT",
			Usage:  "Sets the client request timeout. e.g 500ms, 5s, 1m. Default: 5s",
			Alias:  "stack_client_request_timeout",
		},
		cli.IntFlag{
			Name:   "client_request_retries",
			EnvVar: "STACK_CLIENT_REQUEST_RETRIES",
			Value:  1,
			Usage:  "Sets the client retries. Default: 1",
			Alias:  "stack_client_request_retries",
		},
		cli.IntFlag{
			Name:   "client_pool_size",
			EnvVar: "STACK_CLIENT_POOL_SIZE",
			Usage:  "Sets the client connection pool size. Default: 1",
			Alias:  "stack_client_pool_size",
		},
		cli.StringFlag{
			Name:   "client_pool_ttl",
			EnvVar: "STACK_CLIENT_POOL_TTL",
			Usage:  "Sets the client connection pool ttl in seconds.",
			Alias:  "stack_client_pool_ttl",
		},
		cli.IntFlag{
			Name:   "server_registry_ttl",
			EnvVar: "STACK_SERVER_REGISTRY_TTL",
			Value:  60,
			Usage:  "Register TTL in seconds",
			Alias:  "stack_server_registry_ttl",
		},
		cli.IntFlag{
			Name:   "server_registry_interval",
			EnvVar: "STACK_SERVER_REGISTRY_INTERVAL",
			Value:  30,
			Usage:  "Register interval in seconds",
			Alias:  "stack_server_registry_interval",
		},
		cli.StringFlag{
			Name:   "server",
			EnvVar: "STACK_SERVER",
			Usage:  "Server for stack; rpc",
			Alias:  "stack_server_protocol",
		},
		cli.StringFlag{
			Name:   "server_name",
			EnvVar: "STACK_SERVER_NAME",
			Usage:  "Name of the server. stack.rpc.srv.example",
			Alias:  "stack_server_name",
		},
		cli.StringFlag{
			Name:   "server_version",
			EnvVar: "STACK_SERVER_VERSION",
			Usage:  "Version of the server. 1.1.0",
			Alias:  "stack_server_version",
		},
		cli.StringFlag{
			Name:   "server_id",
			EnvVar: "STACK_SERVER_ID",
			Usage:  "Id of the server. Auto-generated if not specified",
			Alias:  "stack_server_id",
		},
		cli.StringFlag{
			Name:   "server_address",
			EnvVar: "STACK_SERVER_ADDRESS",
			Usage:  "Bind address for the server. 127.0.0.1:8080",
			Alias:  "stack_server_address",
		},
		cli.StringFlag{
			Name:   "server_advertise",
			EnvVar: "STACK_SERVER_ADVERTISE",
			Usage:  "Used instead of the server_address when registering with discovery. 127.0.0.1:8080",
			Alias:  "stack_server_advertise",
		},
		cli.StringSliceFlag{
			Name:   "server_metadata",
			EnvVar: "STACK_SERVER_METADATA",
			Value:  &cli.StringSlice{},
			Usage:  "A list of key-value pairs defining metadata. version=1.0.0",
			Alias:  "stack_server_metadata",
		},
		cli.StringFlag{
			Name:   "broker",
			EnvVar: "STACK_BROKER",
			Usage:  "Broker for pub/sub. http, nats, rabbitmq",
			Alias:  "stack_broker_name",
		},
		cli.StringFlag{
			Name:   "broker_address",
			EnvVar: "STACK_BROKER_ADDRESS",
			Usage:  "Comma-separated list of broker addresses",
			Alias:  "stack_broker_address",
		},
		cli.StringFlag{
			Name:   "profile",
			Usage:  "Debug profiler for cpu and memory stats",
			EnvVar: "STACK_DEBUG_PROFILE",
			Alias:  "stack_profile",
		},
		cli.StringFlag{
			Name:   "registry",
			EnvVar: "STACK_REGISTRY",
			Usage:  "Registry for discovery. mdns",
			Alias:  "stack_registry_name",
		},
		cli.StringFlag{
			Name:   "registry_address",
			EnvVar: "STACK_REGISTRY_ADDRESS",
			Usage:  "Comma-separated list of registry addresses",
			Alias:  "stack_registry_address",
		},
		cli.StringFlag{
			Name:   "selector",
			EnvVar: "STACK_SELECTOR",
			Usage:  "Selector used to pick nodes for querying",
			Alias:  "stack_selector_name",
		},
		cli.StringFlag{
			Name:   "transport",
			EnvVar: "STACK_TRANSPORT",
			Usage:  "Transport mechanism used; http",
			Alias:  "stack_transport_name",
		},
		cli.StringFlag{
			Name:   "transport_address",
			EnvVar: "STACK_TRANSPORT_ADDRESS",
			Usage:  "Comma-separated list of transport addresses",
			Alias:  "stack_transport_address",
		},
		cli.StringFlag{
			Name:   "logger_level",
			EnvVar: "STACK_LOGGER_LEVEL",
			Usage:  "Logger Level; INFO",
			Alias:  "stack_logger_level",
		},
		&cli.StringFlag{
			Name:   "auth",
			EnvVar: "STACK_AUTH",
			Usage:  "Auth for role based access control, e.g. service",
			Alias:  "stack_auth_name",
		},
		&cli.StringFlag{
			Name:   "auth_enable",
			EnvVar: "STACK_AUTH_ENABLE",
			Usage:  "enable auth for role based access control, false",
			Alias:  "stack_auth_enable",
		},
		&cli.StringFlag{
			Name:   "auth_id",
			EnvVar: "STACK_AUTH_CREDENTIALS_ID",
			Usage:  "Account ID used for client authentication",
			Alias:  "stack_auth_credentials_id",
		},
		&cli.StringFlag{
			Name:   "auth_secret",
			EnvVar: "STACK_AUTH_CREDENTIALS_SECRET",
			Usage:  "Account secret used for client authentication",
			Alias:  "stack_auth_credentials_secret",
		},
		&cli.StringFlag{
			Name:   "auth_namespace",
			EnvVar: "STACK_AUTH_NAMESPACE",
			Usage:  "Namespace for the services auth account",
			Value:  "stack.rpc",
			Alias:  "stack_auth_namespace",
		},
		&cli.StringFlag{
			Name:   "auth_public_key",
			EnvVar: "STACK_AUTH_PUBLIC_KEY",
			Usage:  "Public key for JWT auth (base64 encoded PEM)",
			Alias:  "stack_auth_publicKey",
		},
		&cli.StringFlag{
			Name:   "auth_private_key",
			EnvVar: "STACK_AUTH_PRIVATE_KEY",
			Usage:  "Private key for JWT auth (base64 encoded PEM)",
			Alias:  "stack_auth_privateKey",
		},
		cli.StringFlag{
			Name:   "config",
			EnvVar: "STACK_CONFIG",
			Usage:  "config file",
			Alias:  "stack_config",
		},
	}
)

Types

type Cmd

type Cmd interface {
	// The cli app within this cmd
	App() *cli.App
	// Adds options, parses flags and initialise
	// exits on error
	Init(opts ...Option) error
	// Options set within this command
	Options() Options
}

func NewCmd

func NewCmd(opts ...Option) Cmd

type Option

type Option func(o *Options)

func Description

func Description(d string) Option

func Name

func Name(n string) Option

func Version

func Version(v string) Option

type Options

type Options struct {
	// For the Command Line itself
	Name        string
	Description string
	Version     string
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}