hostgacommunicator

Documentation

Index

• Constants
• type DownloadConfigError
  • func (e *DownloadConfigError) Error() string
• type DownloadPackageError
  • func (e *DownloadPackageError) Error() string
• type HostGaCommunicator
  • func (*HostGaCommunicator) DownloadConfig(el *logging.ExtensionLogger, appName string, dst string) error
  • func (*HostGaCommunicator) DownloadPackage(el *logging.ExtensionLogger, appName string, dst string) error
  • func (*HostGaCommunicator) GetVMAppInfo(el *logging.ExtensionLogger, appName string) (*VMAppMetadata, error)
• type HostGaCommunicatorError
  • func (hostGaCommunicatorError HostGaCommunicatorError) ToString() string
• type HostGaCommunicatorGetVMAppInfoError
  • func (e *HostGaCommunicatorGetVMAppInfoError) Error() string
• type IHostGaCommunicator
• type VMAppMetadata
• type VMAppMetadataReceiver
  • func (receiver *VMAppMetadataReceiver) MapToVMAppMetadata() *VMAppMetadata

Constants

const HostGaMetadataErrorPrefix = "HostGaCommunicator GetVMAppInfo error"

const WireProtocolAddress = "AZURE_GUEST_AGENT_WIRE_PROTOCOL_ADDRESS"

Types

type DownloadConfigError

type DownloadConfigError struct {
	// contains filtered or unexported fields
}

func (*DownloadConfigError) Error

func (e *DownloadConfigError) Error() string

type DownloadPackageError

type DownloadPackageError struct {
	// contains filtered or unexported fields
}

func (*DownloadPackageError) Error

func (e *DownloadPackageError) Error() string

type HostGaCommunicator

type HostGaCommunicator struct{}

HostGaCommunicator provides methods for retrieving application metadata and packages from the HostGaPlugin

func (*HostGaCommunicator) DownloadConfig

func (*HostGaCommunicator) DownloadConfig(el *logging.ExtensionLogger, appName string, dst string) error

DownloadConfig downloads the application config through HostGaPlugin to the specified file. If the download fails, it automatically retrieves at the last received bytes and rebuilds the file from downloaded parts

func (*HostGaCommunicator) DownloadPackage

func (*HostGaCommunicator) DownloadPackage(el *logging.ExtensionLogger, appName string, dst string) error

DownloadPackage downloads the application package through HostGaPlugin to the specified file. If the download fails, it automatically retrieves at the last received bytes and rebuilds the file from downloaded parts

func (*HostGaCommunicator) GetVMAppInfo

func (*HostGaCommunicator) GetVMAppInfo(el *logging.ExtensionLogger, appName string) (*VMAppMetadata, error)

GetVMAppInfo returns the metadata for the application

type HostGaCommunicatorError

type HostGaCommunicatorError int

const (
	InitializationError HostGaCommunicatorError = iota
	MetadataRequestFailedWithRetries
	MetadataRequestFailedInvalidResponseBody
	DownloadPackageRequestFactoryError
	DownloadPackageFileError
	DownloadConfigRequestFactoryError
	DownloadConfigFileError
)

func (HostGaCommunicatorError) ToString

func (hostGaCommunicatorError HostGaCommunicatorError) ToString() string

type HostGaCommunicatorGetVMAppInfoError

type HostGaCommunicatorGetVMAppInfoError struct {
	// contains filtered or unexported fields
}

func (*HostGaCommunicatorGetVMAppInfoError) Error

func (e *HostGaCommunicatorGetVMAppInfoError) Error() string

type IHostGaCommunicator

type IHostGaCommunicator interface {
	DownloadPackage(el *logging.ExtensionLogger, appName string, dst string) error
	DownloadConfig(el *logging.ExtensionLogger, appName string, dst string) error
	GetVMAppInfo(el *logging.ExtensionLogger, appName string) (*VMAppMetadata, error)
}

type VMAppMetadata

type VMAppMetadata struct {
	ApplicationName    string `json:"name"`
	Version            string `json:"version"`
	InstallCommand     string `json:"install"`
	UpdateCommand      string `json:"update"`
	RemoveCommand      string `json:"remove"`
	DirectDownloadOnly bool   `json:"directOnly"`
	ConfigExists       bool
	PackageFileName    string `json:"packageFileName"`
	ConfigFileName     string `json:"configFileName"`
	RebootBehavior     string `json:"scriptBehaviorAfterReboot"`
}

VMAppMetadata contains the format of the metadata returned by HostGAPlugin

type VMAppMetadataReceiver

type VMAppMetadataReceiver struct {
	ApplicationName    string `json:"name"`
	Version            string `json:"version"`
	InstallCommand     string `json:"install"`
	UpdateCommand      string `json:"update"`
	RemoveCommand      string `json:"remove"`
	DirectDownloadOnly string `json:"directOnly"`
	Package            string `json:"package"`
	Config             string `json:"config"`
	PackageFileName    string `json:"packageFileName"`
	ConfigFileName     string `json:"configFileName"`
	RebootBehavior     string `json:"scriptBehaviorAfterReboot"`
}

func (*VMAppMetadataReceiver) MapToVMAppMetadata

func (receiver *VMAppMetadataReceiver) MapToVMAppMetadata() *VMAppMetadata