backy

Sep 9, 2023

Changes in this version

type BackyOptionFunc

+ func SetCmdsToSearch(cmds []string) BackyOptionFunc

+ func SetListsToSearch(lists []string) BackyOptionFunc

type Command

+ ScriptEnvFile string

type ConfigOpts

+ CmdConfigLists map[string]*CmdList

+ Cmds map[string]*Command

+ Hosts map[string]*Host

+ List ListConfig

+ Logger zerolog.Logger

+ NotificationConf *Notifications

+ func (config *ConfigOpts) ExecuteCmds(opts *ConfigOpts)

+ func (opts *ConfigOpts) ListConfiguration()

+ func (opts *ConfigOpts) RunListConfig(cron string)

+ func (opts *ConfigOpts) SetupNotify()

+ type ListConfig struct

+ Commands []string

+ Hosts []string

+ Lists []string

+ type MailConfig struct

+ Host string

+ Password string

+ Port string

+ SenderAddress string

+ To []string

+ Username string

+ type MatrixStruct struct

+ AccessToken string

+ Homeserver string

+ Roomid id.RoomID

+ UserId id.UserID

+ type Notifications struct

+ MailConfig map[string]MailConfig

+ MatrixConfig map[string]MatrixStruct

Jul 2, 2023

Changes in this version

+ var PrivateKeyExtraInfoErr = errors.New(...)

+ func GetVaultKey(str string, opts *ConfigOpts, log zerolog.Logger) string

type CmdList

+ GetOutput bool

type Command

+ GetOutput bool

+ Type string

+ type ConfigFile struct

+ CmdConfigLists map[string]*CmdList

+ Cmds map[string]*Command

+ Hosts map[string]*Host

+ Logger zerolog.Logger

+ Notifications map[string]*NotificationsConfig

+ func (backyConfig *ConfigFile) SetupNotify()

+ func (config *ConfigFile) ExecuteCmds(opts *ConfigOpts)

+ func (config *ConfigFile) RunListConfig(cron string, opts *ConfigOpts)

+ type ConfigOpts struct

+ BackyLogLvl *string

+ ConfigFile *ConfigFile

+ ConfigFilePath string

+ DB *mongo.Database

+ VaultKeys []*VaultKey

+ func (c *ConfigOpts) AddViper(v *viper.Viper) BackyOptionFunc

+ func (c *ConfigOpts) LogLvl(level string) BackyOptionFunc

+ func (opts *ConfigOpts) Cron()

+ func (opts *ConfigOpts) InitConfig()

+ func (opts *ConfigOpts) InitMongo()

+ type VaultConfig struct

+ Address string

+ Enabled string

+ Keys []*VaultKey

+ Token string

+ type VaultKey struct

+ MountPath string

+ Name string

+ Path string

+ ValueType string

Feb 12, 2023

Changes in this version

type Host

+ ProxyJump string

+ SshClient *ssh.Client

+ func (remoteConfig *Host) GetProxyJumpConfig(hosts map[string]*Host) error

+ func (remoteConfig *Host) GetProxyJumpFromConfig(hosts map[string]*Host) error

+ func (remoteHost *Host) CombineHostNameWithPort()

+ func (remoteHost *Host) GetHostName()

+ func (remoteHost *Host) GetPort()

+ func (remoteHost *Host) GetPrivateKeyFileFromConfig()

Feb 2, 2023

Changes in this version

+ var ErrPrivateKeyFileFailedToOpen = errors.New("Private key file failed to open.")

+ var TS = strings.TrimSpace

+ func CheckConfigValues(config *viper.Viper)

+ func GetKnownHosts(khPath string) (string, error)

+ func GetPassword(key string) (string, error)

+ func GetPrivateKeyPassword(key string) (string, error)

+ func IsCmdStdOutEnabled() bool

+ func IsTerminalActive() bool

+ func SetupCommandsNotifiers(backyConfig BackyConfigFile, ids ...string)

type BackyConfigFile

+ func ReadConfig(opts *BackyConfigOpts) *BackyConfigFile

+ func (backyConfig *BackyConfigFile) SetupNotify()

+ func (conf *BackyConfigFile) Cron()

+ func (config *BackyConfigFile) ExecuteCmds()

type BackyConfigOpts

+ DB *mongo.Database

+ func (c *BackyConfigOpts) AddViper(v *viper.Viper) BackyOptionFunc

+ func (opts *BackyConfigOpts) InitConfig()

+ func (opts *BackyConfigOpts) InitMongo()

type BackyOptionFunc

+ func AddCommandLists(lists []string) BackyOptionFunc

+ func AddCommands(commands []string) BackyOptionFunc

+ func UseCron() BackyOptionFunc

+ type CmdConfigSchema struct

+ CmdList []string

+ ID primitive.ObjectID

+ Name string

+ type CmdList struct

+ Cron string

+ Name string

+ Notifications []string

+ NotifyConfig *notify.Notify

+ Order []string

type CmdOutput

+ Err error

+ Output bytes.Buffer

+ type CmdSchema struct

+ Args []string

+ Cmd string

+ Dir string

+ Host string

+ ID primitive.ObjectID

type Command

+ Args []string

type Host

+ ClientConfig *ssh.ClientConfig

+ JumpHost string

+ KnownHostsFile string

+ Password string

+ ProxyHost *Host

+ SSHConfigFile sshConfigFile

+ UseConfigFiles bool

+ func (remoteHost *Host) ConnectThroughBastion() (*ssh.Client, error)

+ func (remoteHost *Host) GetAuthMethods() error

+ func (remoteHost *Host) GetHostNameWithPort()

+ func (remoteHost *Host) GetPrivateKeyFromConfig()

+ func (remoteHost *Host) GetSshUserFromConfig()

+ type Schemas struct

Jan 18, 2023

Changes in this version

+ var Sprintf = fmt.Sprintf

+ func CheckForConfigValues(config *viper.Viper)

+ type BackyCommandOutput interface

+ Error func() error

+ GetOutput func() CmdOutput

+ type BackyConfigFile struct

+ CmdConfigLists map[string]*CmdConfig

+ Cmds map[string]Command

+ Hosts map[string]Host

+ Logger zerolog.Logger

+ Notifications map[string]*NotificationsConfig

+ func NewConfig() *BackyConfigFile

+ func ReadAndParseConfigFile(configFile string) *BackyConfigFile

+ func (config *BackyConfigFile) RunBackyConfig()

+ type BackyConfigOpts struct

+ BackyLogLvl *string

+ ConfigFile *BackyConfigFile

+ ConfigFilePath string

+ func NewOpts(configFilePath string, opts ...BackyOptionFunc) *BackyConfigOpts

+ func (c *BackyConfigOpts) GetConfig()

+ func (c *BackyConfigOpts) LogLvl(level string) BackyOptionFunc

+ type BackyOptionFunc func(*BackyConfigOpts)

+ type CmdConfig struct

+ Notifications []string

+ NotificationsConfig map[string]*NotificationsConfig

+ Order []string

+ type CmdOutput struct

+ StdErr []byte

+ StdOut []byte

+ type Command struct

+ Cmd string

+ CmdArgs []string

+ Dir *string

+ Env string

+ Environment []string

+ Host *string

+ Output BackyCommandOutput

+ RemoteHost Host

+ Shell string

+ func (command *Command) RunCmd(log *zerolog.Logger)

+ type Host struct

+ ConfigFilePath string

+ Empty bool

+ Host string

+ HostName string

+ Port uint16

+ PrivateKeyPassword string

+ PrivateKeyPath string

+ UseConfigFile bool

+ User string

+ func (remoteConfig *Host) ConnectToSSHHost(log *zerolog.Logger) (*ssh.Client, error)

+ type NotificationsConfig struct

+ Config *viper.Viper

+ Enabled bool