process

Documentation

Index

• Constants
• Variables
• func Bind(cmd *cobra.Command, config interface{}, opts ...cfgstruct.BindOpt)
• func Ctx(cmd *cobra.Command) context.Context
• func Exec(cmd *cobra.Command)
• func InitMetrics(ctx context.Context, r *monkit.Registry, instanceID string) (err error)
• func InitMetricsWithCertPath(ctx context.Context, r *monkit.Registry, certPath string) error
• func SaveConfig(flagset *pflag.FlagSet, outfile string, overrides map[string]interface{}) error
• func SaveConfigWithAllDefaults(flagset *pflag.FlagSet, outfile string, overrides map[string]interface{}) error

Constants

const DefaultCfgFilename = "config.yaml"

DefaultCfgFilename is the default filename used for storing a configuration.

Variables

var (
	// Error is a process error class
	Error = errs.Class("process error")
)

Functions

func Bind

func Bind(cmd *cobra.Command, config interface{}, opts ...cfgstruct.BindOpt)

Bind sets flags on a command that match the configuration struct 'config'. It ensures that the config has all of the values loaded into it when the command runs.

func Ctx

func Ctx(cmd *cobra.Command) context.Context

Ctx returns the appropriate context.Context for ExecuteWithConfig commands

func Exec

func Exec(cmd *cobra.Command)

Exec runs a Cobra command. If a "config" flag is defined it will be parsed and loaded using viper.

func InitMetrics

func InitMetrics(ctx context.Context, r *monkit.Registry, instanceID string) (err error)

InitMetrics initializes telemetry reporting. Makes a telemetry.Client and calls its Run() method in a goroutine.

func InitMetricsWithCertPath

func InitMetricsWithCertPath(ctx context.Context, r *monkit.Registry, certPath string) error

InitMetricsWithCertPath initializes telemetry reporting, using the node ID corresponding to the given certificate as the telemetry instance ID.

func SaveConfig

func SaveConfig(flagset *pflag.FlagSet, outfile string, overrides map[string]interface{}) error

SaveConfig will save only the user-specific flags with default values to outfile with specific values specified in 'overrides' overridden.

func SaveConfigWithAllDefaults

func SaveConfigWithAllDefaults(flagset *pflag.FlagSet, outfile string, overrides map[string]interface{}) error

SaveConfigWithAllDefaults will save all flags with default values to outfile with specific values specified in 'overrides' overridden.