configuration

Documentation

Overview

Package configuration contains functionalities for agent configuration operations.

Index

• func LoadConfiguration(p string) (*configpb.Configuration, error)
• func ValidateCredCfgGuest(remote, windows bool, guestCfg *GuestConfig, instanceID, instanceName string) error
• func ValidateCredCfgSQL(remote, windows bool, sqlCfg *SQLConfig, guestCfg *GuestConfig, ...) error
• type GuestConfig
  • func GuestConfigFromCredential(creCfg *configpb.CredentialConfiguration) *GuestConfig
• type SQLConfig
  • func SQLConfigFromCredential(creCfg *configpb.CredentialConfiguration) []*SQLConfig

Functions

func LoadConfiguration

func LoadConfiguration(p string) (*configpb.Configuration, error)

LoadConfiguration loads configuration from config file. Returns default configurations with error if reading configuration file has an error. Returns nil with error if the configuration file is in invalid format.

func ValidateCredCfgGuest

func ValidateCredCfgGuest(remote, windows bool, guestCfg *GuestConfig, instanceID, instanceName string) error

ValidateCredCfgGuest validates if the configuration file is valid for guest collection. If remote collection is enabled, the following fields must be provided: "server_name", "guest_user_name", "guest_secret_name", "instance_id", "instance_name"

func ValidateCredCfgSQL

func ValidateCredCfgSQL(remote, windows bool, sqlCfg *SQLConfig, guestCfg *GuestConfig, instanceID, instanceName string) error

ValidateCredCfgSQL validates if the configuration file is valid for SQL collection. Each CredentialConfiguration must provide valid "user_name", "secret_name" and "port_number". If remote collection is enabled, the following fields must be provided:

"host", "instance_id", "instance_name"

Types

type GuestConfig

type GuestConfig struct {
	ServerName             string
	GuestUserName          string
	GuestSecretName        string
	GuestPortNumber        int32
	LinuxRemote            bool
	LinuxSSHPrivateKeyPath string
}

GuestConfig .

func GuestConfigFromCredential

func GuestConfigFromCredential(creCfg *configpb.CredentialConfiguration) *GuestConfig

GuestConfigFromCredential returns config for guest OS collection.

type SQLConfig

type SQLConfig struct {
	Host       string
	Username   string
	SecretName string
	PortNumber int32
}

SQLConfig .

func SQLConfigFromCredential

func SQLConfigFromCredential(creCfg *configpb.CredentialConfiguration) []*SQLConfig

SQLConfigFromCredential returns config for SQL collection.