cmd

Documentation

Index

• Variables
• func Execute()
• type CLMimicryOverride
• type CannonOverride
• type CannonOverrideConfig
• type DiscoveryOverride
• type MimicryOverride
• type RelayMonitorOverride
• type SentryOverride
• type ServerOverride
• type ServerOverrideConfig

Variables

var CLMimicryOverrides = []CLMimicryOverride{
	{
		EnvVar: "METRICS_ADDR",
		Flag:   "metrics-addr",
		FlagHelper: func(cmd *cobra.Command) {
			cmd.Flags().String(metricsAddrFlag, "", `metrics address (env: METRICS_ADDR). If set, overrides the metrics address in the config file.`)
		},
		Setter: func(cmd *cobra.Command, overrides *clmimicry.Override) error {
			val := ""

			if cmd.Flags().Changed(metricsAddrFlag) {
				val = cmd.Flags().Lookup(metricsAddrFlag).Value.String()
			}

			if os.Getenv("METRICS_ADDR") != "" {
				val = os.Getenv("METRICS_ADDR")
			}

			if val == "" {
				return nil
			}

			overrides.MetricsAddr.Enabled = true
			overrides.MetricsAddr.Value = val

			return nil
		},
	},
}

var CannonOverrides = []CannonOverride{
	createCannonOverride(CannonOverrideConfig{
		FlagName:    "cannon-xatu-output-authorization",
		EnvName:     "CANNON_XATU_OUTPUT_AUTHORIZATION",
		Description: "sets the authorization secret for all xatu outputs",
		OverrideFunc: func(val string, overrides *cannon.Override) {
			overrides.XatuOutputAuth.Enabled = true
			overrides.XatuOutputAuth.Value = val
		},
	}),
	createCannonOverride(CannonOverrideConfig{
		FlagName:    "cannon-xatu-coordinator-authorization",
		EnvName:     "CANNON_XATU_COORDINATOR_AUTHORIZATION",
		Description: "sets the authorization secret for the xatu coordinator",
		OverrideFunc: func(val string, overrides *cannon.Override) {
			overrides.XatuCoordinatorAuth.Enabled = true
			overrides.XatuCoordinatorAuth.Value = val
		},
	}),
	createCannonOverride(CannonOverrideConfig{
		FlagName:    "cannon-beacon-node-url",
		EnvName:     "CANNON_BEACON_NODE_URL",
		Description: "sets the beacon node url",
		OverrideFunc: func(val string, overrides *cannon.Override) {
			overrides.BeaconNodeURL.Enabled = true
			overrides.BeaconNodeURL.Value = val
		},
	}),
	createCannonOverride(CannonOverrideConfig{
		FlagName:    "cannon-beacon-node-authorization-header",
		EnvName:     "CANNON_BEACON_NODE_AUTHORIZATION_HEADER",
		Description: "sets the beacon node authorization header",
		OverrideFunc: func(val string, overrides *cannon.Override) {
			overrides.BeaconNodeAuthorizationHeader.Enabled = true
			overrides.BeaconNodeAuthorizationHeader.Value = val
		},
	}),
	createCannonOverride(CannonOverrideConfig{
		FlagName:    "cannon-network-name",
		EnvName:     "CANNON_NETWORK_NAME",
		Description: "sets the network name",
		OverrideFunc: func(val string, overrides *cannon.Override) {
			overrides.NetworkName.Enabled = true
			overrides.NetworkName.Value = val
		},
	}),
	createCannonOverride(CannonOverrideConfig{
		FlagName:    "metrics-addr",
		EnvName:     "METRICS_ADDR",
		Description: "sets the metrics address",
		OverrideFunc: func(val string, overrides *cannon.Override) {
			overrides.MetricsAddr.Enabled = true
			overrides.MetricsAddr.Value = val
		},
	}),
}

var DiscoveryOverrides = []DiscoveryOverride{
	{
		EnvVar: "METRICS_ADDR",
		Flag:   "metrics-addr",
		FlagHelper: func(cmd *cobra.Command) {
			cmd.Flags().String(metricsAddrFlag, "", `metrics address (env: METRICS_ADDR). If set, overrides the metrics address in the config file.`)
		},
		Setter: func(cmd *cobra.Command, overrides *discovery.Override) error {
			val := ""

			if cmd.Flags().Changed(metricsAddrFlag) {
				val = cmd.Flags().Lookup(metricsAddrFlag).Value.String()
			}

			if os.Getenv("METRICS_ADDR") != "" {
				val = os.Getenv("METRICS_ADDR")
			}

			if val == "" {
				return nil
			}

			overrides.MetricsAddr.Enabled = true
			overrides.MetricsAddr.Value = val

			return nil
		},
	},
}

var MimicryOverrides = []MimicryOverride{
	{
		EnvVar: "METRICS_ADDR",
		Flag:   "metrics-addr",
		FlagHelper: func(cmd *cobra.Command) {
			cmd.Flags().String(metricsAddrFlag, "", `metrics address (env: METRICS_ADDR). If set, overrides the metrics address in the config file.`)
		},
		Setter: func(cmd *cobra.Command, overrides *mimicry.Override) error {
			val := ""

			if cmd.Flags().Changed(metricsAddrFlag) {
				val = cmd.Flags().Lookup(metricsAddrFlag).Value.String()
			}

			if os.Getenv("METRICS_ADDR") != "" {
				val = os.Getenv("METRICS_ADDR")
			}

			if val == "" {
				return nil
			}

			overrides.MetricsAddr.Enabled = true
			overrides.MetricsAddr.Value = val

			return nil
		},
	},
}

var RelayMonitorOverrides = []RelayMonitorOverride{
	{
		EnvVar: "METRICS_ADDR",
		Flag:   "metrics-addr",
		FlagHelper: func(cmd *cobra.Command) {
			cmd.Flags().String(metricsAddrFlag, "", `metrics address (env: METRICS_ADDR). If set, overrides the metrics address in the config file.`)
		},
		Setter: func(cmd *cobra.Command, overrides *relaymonitor.Override) error {
			val := ""

			if cmd.Flags().Changed(metricsAddrFlag) {
				val = cmd.Flags().Lookup(metricsAddrFlag).Value.String()
			}

			if os.Getenv("METRICS_ADDR") != "" {
				val = os.Getenv("METRICS_ADDR")
			}

			if val == "" {
				return nil
			}

			overrides.MetricsAddr.Enabled = true
			overrides.MetricsAddr.Value = val

			return nil
		},
	},
}

var SentryOverrides = []SentryOverride{
	{
		EnvVar: "OUTOUT_AUTHORIZATION",
		Flag:   authorizationFlag,
		FlagHelper: func(cmd *cobra.Command) {
			cmd.Flags().String(authorizationFlag, "", `event ingester authorization secret (env: OUTPUT_AUTHORIZATION). If set, overrides the secret in the config file, and adds the secret to all Xatu outputs.`)
		},
		Setter: func(cmd *cobra.Command, overrides *sentry.Override) error {
			val := ""

			if cmd.Flags().Changed(authorizationFlag) {
				val = cmd.Flags().Lookup(authorizationFlag).Value.String()
			}

			if os.Getenv("AUTHORIZATION") != "" {
				val = os.Getenv("AUTHORIZATION")
			}

			if val == "" {
				return nil
			}

			overrides.XatuOutputAuth.Enabled = true
			overrides.XatuOutputAuth.Value = val

			return nil
		},
	},
	{
		EnvVar: "PRESET",
		Flag:   "preset",
		FlagHelper: func(cmd *cobra.Command) {
			cmd.Flags().String(presetFlag, "", `configuration preset (env: PRESET). If set, overrides the configuration preset in the config file. See README.md for more information.`)
		},
		Setter: func(cmd *cobra.Command, overrides *sentry.Override) error {
			val := ""

			if cmd.Flags().Changed(presetFlag) {
				val = cmd.Flags().Lookup(presetFlag).Value.String()
			}

			if os.Getenv("PRESET") != "" {
				val = os.Getenv("PRESET")
			}

			if val == "" {
				return nil
			}

			overrides.Preset.Enabled = true
			overrides.Preset.Value = val

			return nil
		},
	},
	{
		EnvVar: "BEACON_NODE_URL",
		Flag:   "beacon-node-url",
		FlagHelper: func(cmd *cobra.Command) {
			cmd.Flags().String(beaconNodeURLFlag, "", `beacon node URL (env: BEACON_NODE_URL). If set, overrides the beacon node URL in the config file.`)
		},
		Setter: func(cmd *cobra.Command, overrides *sentry.Override) error {
			val := ""

			if cmd.Flags().Changed(beaconNodeURLFlag) {
				val = cmd.Flags().Lookup(beaconNodeURLFlag).Value.String()
			}

			if os.Getenv("BEACON_NODE_URL") != "" {
				val = os.Getenv("BEACON_NODE_URL")
			}

			if val == "" {
				return nil
			}

			overrides.BeaconNodeURL.Enabled = true
			overrides.BeaconNodeURL.Value = val

			return nil
		},
	},
	{
		EnvVar: "METRICS_ADDR",
		Flag:   "metrics-addr",
		FlagHelper: func(cmd *cobra.Command) {
			cmd.Flags().String(metricsAddrFlag, "", `metrics address (env: METRICS_ADDR). If set, overrides the metrics address in the config file.`)
		},
		Setter: func(cmd *cobra.Command, overrides *sentry.Override) error {
			val := ""

			if cmd.Flags().Changed(metricsAddrFlag) {
				val = cmd.Flags().Lookup(metricsAddrFlag).Value.String()
			}

			if os.Getenv("METRICS_ADDR") != "" {
				val = os.Getenv("METRICS_ADDR")
			}

			if val == "" {
				return nil
			}

			overrides.MetricsAddr.Enabled = true
			overrides.MetricsAddr.Value = val

			return nil
		},
	},
}

var ServerOverrides = []ServerOverride{
	createServerOverride(ServerOverrideConfig{
		FlagName:    "server-event-ingester-basic-auth-username",
		EnvName:     "SERVER_EVENT_INGESTER_BASIC_AUTH_USERNAME",
		Description: "sets the basic auth username for the event ingester",
		OverrideFunc: func(val string, overrides *server.Override) {
			overrides.EventIngesterBasicAuth.Username = val
		},
	}),
	createServerOverride(ServerOverrideConfig{
		FlagName:    "server-event-ingester-basic-auth-password",
		EnvName:     "SERVER_EVENT_INGESTER_BASIC_AUTH_PASSWORD",
		Description: "sets the basic auth password for the event ingester",
		OverrideFunc: func(val string, overrides *server.Override) {
			overrides.EventIngesterBasicAuth.Password = val
		},
	}),
	createServerOverride(ServerOverrideConfig{
		FlagName:    "server-coordinator-auth-secret",
		EnvName:     "SERVER_COORDINATOR_AUTH_SECRET",
		Description: "sets the auth secret for the coordinator",
		OverrideFunc: func(val string, overrides *server.Override) {
			overrides.CoordinatorAuth.AuthSecret = val
		},
	}),
	createServerOverride(ServerOverrideConfig{
		FlagName:    "metrics-addr",
		EnvName:     "METRICS_ADDR",
		Description: "sets the metrics address",
		OverrideFunc: func(val string, overrides *server.Override) {
			overrides.MetricsAddr.Enabled = true
			overrides.MetricsAddr.Value = val
		},
	}),
}

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type CLMimicryOverride

type CLMimicryOverride struct {
	EnvVar     string
	Flag       string
	FlagHelper func(cmd *cobra.Command)
	Setter     func(cmd *cobra.Command, overrides *clmimicry.Override) error
}

type CannonOverride

type CannonOverride struct {
	FlagHelper func(cmd *cobra.Command)
	Setter     func(cmd *cobra.Command, overrides *cannon.Override) error
}

type CannonOverrideConfig

type CannonOverrideConfig struct {
	FlagName     string
	EnvName      string
	Description  string
	OverrideFunc func(val string, overrides *cannon.Override)
}

type DiscoveryOverride

type DiscoveryOverride struct {
	EnvVar     string
	Flag       string
	FlagHelper func(cmd *cobra.Command)
	Setter     func(cmd *cobra.Command, overrides *discovery.Override) error
}

type MimicryOverride

type MimicryOverride struct {
	EnvVar     string
	Flag       string
	FlagHelper func(cmd *cobra.Command)
	Setter     func(cmd *cobra.Command, overrides *mimicry.Override) error
}

type RelayMonitorOverride

type RelayMonitorOverride struct {
	EnvVar     string
	Flag       string
	FlagHelper func(cmd *cobra.Command)
	Setter     func(cmd *cobra.Command, overrides *relaymonitor.Override) error
}

type SentryOverride

type SentryOverride struct {
	EnvVar     string
	Flag       string
	FlagHelper func(cmd *cobra.Command)
	Setter     func(cmd *cobra.Command, overrides *sentry.Override) error
}

type ServerOverride

type ServerOverride struct {
	FlagHelper func(cmd *cobra.Command)
	Setter     func(cmd *cobra.Command, overrides *server.Override) error
}

type ServerOverrideConfig

type ServerOverrideConfig struct {
	FlagName     string
	EnvName      string
	Description  string
	OverrideFunc func(val string, overrides *server.Override)
}