agent

package

v0.29.0 Latest Latest Go to latest Published: Dec 21, 2023 License: MPL-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/orb-community/orb

Links

Open Source Insights

README ¶

Orb Agent

Agent - Fleet Synchronization Steps

Success Communication Sequence Diagram

  sequenceDiagram
    Agent->>Fleet: subscribe
    Agent->>Fleet: sendCapabilities
    Agent->>+Fleet: sendGroupMembershipReq 
    Fleet-->>-Agent: sendGroupMembership with GroupIds
    Agent-->>Fleet: Heartbeat
    Agent-->>+Fleet: sendAgentPoliciesReq
    Fleet-->>-Agent: agentPolicies with Policies
    Agent-->>Fleet: Heartbeat

Fail Communication Sequence Diagram

  sequenceDiagram
    Agent->>Fleet: subscribe
    Agent->>Fleet: sendCapabilities
    Agent->>+Fleet: sendGroupMembershipReq 
    Agent-->>Fleet: Heartbeat
    Agent-->>+Fleet: sendAgentPoliciesReq
    Fleet-->>-Agent: agentPolicies with Policies
    Agent-->>Fleet: Heartbeat

Agent is still without Groups and Policies

With Re-Request Mechanism, general idea

sequenceDiagram
    Agent-)Fleet: subscribe
    Agent-)Fleet: sendCapabilities
    Agent-)Fleet: sendGroupMembershipReq
    activate Fleet
    Agent->>Timer: starts wait timer for response
    activate Timer
    Timer-xAgent: timer runs out
    Agent-)Fleet: sendGroupMembershipReq
    Fleet--)Agent: sendGroupMembership with GroupIds
    deactivate Fleet
    Agent-->>Timer: marks as success
    deactivate Timer
    Agent-->>Fleet: Heartbeat
    Agent-->>Fleet: sendAgentPoliciesReq
    activate Fleet
    Agent->>Timer: starts wait timer for response
    activate Timer
    Fleet-->>Agent: agentPolicies with Policies
    Agent->>Timer: marks as success
    deactivate Timer
    Agent-->>Fleet: Heartbeat

Documentation ¶

Index ¶

Constants
Variables
type Agent
- func New(logger *zap.Logger, c config.Config) (Agent, error)
type GroupInfo

Constants ¶

View Source

const HeartbeatFreq = 50 * time.Second

HeartbeatFreq how often to heartbeat

View Source

const RestartTimeMin = 5 * time.Minute

RestartTimeMin minimum time to wait between restarts

Variables ¶

View Source

var (
	ErrMqttConnection = errors.New("failed to connect to a broker")
)

Functions ¶

This section is empty.

Types ¶

type Agent ¶

type Agent interface {
	Start(ctx context.Context, cancelFunc context.CancelFunc) error
	Stop(ctx context.Context)
	RestartAll(ctx context.Context, reason string) error
	RestartBackend(ctx context.Context, backend string, reason string) error
}

func New ¶

func New(logger *zap.Logger, c config.Config) (Agent, error)

type GroupInfo ¶

type GroupInfo struct {
	Name      string
	ChannelID string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
backend
diode
otel
pktvisor
cloud_config
config
otel
otlpmqttexporter Package otlpmqttexporter exports data by using the OTLP format to an MQTT endpoint.	Package otlpmqttexporter exports data by using the OTLP format to an MQTT endpoint.
policies
policyMgr

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