cmdbase

package

v1.0.0 Latest Latest Go to latest Published: Aug 21, 2026 License: AGPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/abundo/factum2

Links

Open Source Insights

Documentation ¶

Index ¶

func SetupCLI()
func SetupLog(c CommonParams) error
func ShowConfig() boa.CmdIfc
func ShowConfigAgent(fetchRemote ...func(*util.ConfigFactum) (any, error)) boa.CmdIfc
type CommonParams
type Params
type ParamsAgent

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func SetupCLI ¶

func SetupCLI()

func SetupLog ¶

func SetupLog(c CommonParams) error

func ShowConfig ¶

func ShowConfig() boa.CmdIfc

func ShowConfigAgent ¶

func ShowConfigAgent(fetchRemote ...func(*util.ConfigFactum) (any, error)) boa.CmdIfc

ShowConfigAgent is the show-config subcommand for binaries that embed ParamsAgent (factum/worker sections only) rather than the full Params - keeps show-config's required flags matching what the binary's other subcommands actually need.

fetchRemote is optional: services that pull their database-backed settings from the primary over REST (dns, icinga, librenms, oxidized) pass their FetchRemoteConfig, and its result is printed after the local config. A fetch failure is logged and the command still exits 0 - show-config should always report what it can, even with the primary unreachable, rather than have the whole command fail from a single missing section.

Types ¶

type CommonParams ¶

type CommonParams struct {
	Debug    bool   `short:"d" optional:"true" descr:"Enable verbose debug logging" `
	Loglevel string `short:"l" descr:"Set log level" alts:"error,warn,info,debug" default:"info" strict:"true"`
}

type Params ¶

type Params struct {
	ConfigFile string          `short:"f" configfile:"true" optional:"false" default:"/etc/factum2/factum2.yaml"`
	Config     util.ConfigRoot `yaml:",inline"`
	CommonParams
}

type ParamsAgent ¶

type ParamsAgent struct {
	ConfigFile string               `short:"f" configfile:"true" optional:"false" default:"/etc/factum2/factum2-worker.yaml"`
	Config     util.ConfigAgentRoot `yaml:",inline"`
	CommonParams
}

Source Files ¶

View all Source files

cmd_base.go

Directories ¶

Path	Synopsis
becs
device-sync
dns
driver
factum
icinga
icinga-notifications factum-icinga-notifications is the Icinga2 NotificationCommand invoked directly by icinga2 whenever a host/service alarm fires.	factum-icinga-notifications is the Icinga2 NotificationCommand invoked directly by icinga2 whenever a host/service alarm fires.
librenms
lime
netbox
oxidized
web Web backend for factumn2	Web backend for factumn2
worker

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL