Skip to content

Commit

Permalink
Clarify what is Agent, especially when Supervisor is used (#117)
Browse files Browse the repository at this point in the history
Resolves #114
  • Loading branch information
tigrannajaryan authored Aug 24, 2022
1 parent bbabcbe commit 853ce4a
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,36 @@ the Agent to the Server and from the Server to the Agent.
The default URL path for the connection is /v1/opamp. The URL path MAY be
configurable on the Agent and on the Server.

One of the typical ways to implement OpAMP on the Agent side is by having a helping
Supervisor process, which controls the Agent process. The Supervisor is also
typically responsible for communicating with the OpAMP Server:

```
┌───────────────────┐
│ Supervisor │
│ │
│ ┌────────┤ ┌────────┐
│ │ OpAMP │ OpAMP │ OpAMP │
│ │ ├──────────►│ │
│ │ Client │ │ Server │
└────┬─────┴────────┘ └────────┘
┌──────────┐
│ │
│ Agent │
│ │
└──────────┘
```

The OpAMP specification does not require using a Supervisor and does not define how the
Supervisor and the Agent communicate.

In the rest of the OpAMP specification the term _Agent_ is used to refer to the entity
which implements the client portion of the OpAMP, regardless of whether or not a
Supervisor is part of that entity.

## WebSocket Transport

One of the supported transports for OpAMP protocol is
Expand Down

0 comments on commit 853ce4a

Please sign in to comment.