updateagent

Documentation

Index

• Constants
• type ContainersUpdateAgentOpt
  • func WithConnectionAcknowledgeTimeout(acknowledgeTimeout time.Duration) ContainersUpdateAgentOpt
  • func WithConnectionBroker(broker string) ContainersUpdateAgentOpt
  • func WithConnectionClientPassword(password string) ContainersUpdateAgentOpt
  • func WithConnectionClientUsername(username string) ContainersUpdateAgentOpt
  • func WithConnectionConnectTimeout(connectTimeout time.Duration) ContainersUpdateAgentOpt
  • func WithConnectionDisconnectTimeout(disconnectTimeout time.Duration) ContainersUpdateAgentOpt
  • func WithConnectionKeepAlive(keepAlive time.Duration) ContainersUpdateAgentOpt
  • func WithConnectionSubscribeTimeout(subscribeTimeout time.Duration) ContainersUpdateAgentOpt
  • func WithConnectionUnsubscribeTimeout(unsubscribeTimeout time.Duration) ContainersUpdateAgentOpt
  • func WithDomainName(domain string) ContainersUpdateAgentOpt
  • func WithSystemContainers(systemContainers []string) ContainersUpdateAgentOpt
  • func WithTLSConfig(rootCA, clientCert, clientKey string) ContainersUpdateAgentOpt
  • func WithVerboseInventoryReport(verboseInventoryReport bool) ContainersUpdateAgentOpt
• type UpdateOperation

Constants

const (
	// ContainerUpdateAgentServiceLocalID is the ID of the local container update agent
	ContainerUpdateAgentServiceLocalID = "container-management.service.local.v1.service-container-update-agent"
)

Types

type ContainersUpdateAgentOpt

type ContainersUpdateAgentOpt func(updateAgentOptions *updateAgentOpts) error

ContainersUpdateAgentOpt represents the available configuration options for the Containers UpdateAgent service

func WithConnectionAcknowledgeTimeout

func WithConnectionAcknowledgeTimeout(acknowledgeTimeout time.Duration) ContainersUpdateAgentOpt

WithConnectionAcknowledgeTimeout configures the timeout for the acknowledge receival

func WithConnectionBroker

func WithConnectionBroker(broker string) ContainersUpdateAgentOpt

WithConnectionBroker configures the broker, where the connection will be established

func WithConnectionClientPassword

func WithConnectionClientPassword(password string) ContainersUpdateAgentOpt

WithConnectionClientPassword configures the client password used when establishing connection to the broker

func WithConnectionClientUsername

func WithConnectionClientUsername(username string) ContainersUpdateAgentOpt

WithConnectionClientUsername configures the client username used when establishing connection to the broker

func WithConnectionConnectTimeout

func WithConnectionConnectTimeout(connectTimeout time.Duration) ContainersUpdateAgentOpt

WithConnectionConnectTimeout configures the timeout before terminating the connect attempt

func WithConnectionDisconnectTimeout

func WithConnectionDisconnectTimeout(disconnectTimeout time.Duration) ContainersUpdateAgentOpt

WithConnectionDisconnectTimeout configures the duration of inactivity before disconnecting from the broker

func WithConnectionKeepAlive

func WithConnectionKeepAlive(keepAlive time.Duration) ContainersUpdateAgentOpt

WithConnectionKeepAlive configures the time between between each check for the connection presence

func WithConnectionSubscribeTimeout

func WithConnectionSubscribeTimeout(subscribeTimeout time.Duration) ContainersUpdateAgentOpt

WithConnectionSubscribeTimeout configures the timeout before terminating the subscribe attempt

func WithConnectionUnsubscribeTimeout

func WithConnectionUnsubscribeTimeout(unsubscribeTimeout time.Duration) ContainersUpdateAgentOpt

WithConnectionUnsubscribeTimeout configures the timeout before terminating the unsubscribe attempt

func WithDomainName

func WithDomainName(domain string) ContainersUpdateAgentOpt

WithDomainName configures the domain name for the containers update agent

func WithSystemContainers

func WithSystemContainers(systemContainers []string) ContainersUpdateAgentOpt

WithSystemContainers configures the list of system containers (names) that will not be processed by the containers update agent

func WithTLSConfig

func WithTLSConfig(rootCA, clientCert, clientKey string) ContainersUpdateAgentOpt

WithTLSConfig configures the CA certificate for TLS communication

func WithVerboseInventoryReport

func WithVerboseInventoryReport(verboseInventoryReport bool) ContainersUpdateAgentOpt

WithVerboseInventoryReport enables / disables verbose inventory reporting of current containers

type UpdateOperation

type UpdateOperation interface {
	GetActivityID() string
	Identify() error
	Execute(command types.CommandType, baseline string)
	Feedback(status types.StatusType, message string, baseline string)
}

UpdateOperation defines an interface for an update operation process