diff options
| author | Rick Elrod <rick@elrod.me> | 2023-05-24 20:27:55 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-24 20:27:55 +0200 |
| commit | bac124004fe80baf5462c80d39de2162d9937a32 (patch) | |
| tree | c7b290b582dbab79d1e23a1d5ef0fa68087b4a19 /docs | |
| parent | Spelling and codespelling corrections from community PR (diff) | |
| download | awx-bac124004fe80baf5462c80d39de2162d9937a32.tar.xz awx-bac124004fe80baf5462c80d39de2162d9937a32.zip | |
Rename heartbeet daemon to ws_heartbeat (#14041)
Signed-off-by: Rick Elrod <rick@elrod.me>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/websockets.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/websockets.md b/docs/websockets.md index 5c2e57a6a9..24128260b7 100644 --- a/docs/websockets.md +++ b/docs/websockets.md @@ -44,7 +44,7 @@ The notable modules for this component are: endpoint. This is a daemon. It formerly ran in each web container, but now runs in each task container instead. -* `awx/main/management/commands/run_heartbeet.py` - discussed below, used to +* `awx/main/management/commands/run_ws_heartbeat.py` - discussed below, used to send a heartbeat payload to pg_notify every few seconds, so that all task pods running `wsrelay.py` (above) know about each web pod. @@ -103,7 +103,7 @@ that care about them. ### The Heartbeet -There is also a "heartbeet" system (a play on "heartbeat"), that goes along with +There is also a "ws_heartbeat" system, that goes along with the above. Remember that `wsrelay` lives in each task pod, and there could be an arbitrary number of web and task pods (independent of each other). Because of this, `wsrelay` (on all task pods) needs to know which web pods are up and need @@ -111,7 +111,7 @@ to be connected to (on their "relay" endpoints). To accomplish this, we use pg_notify, since web and task pods are all able to connect to the database and we are safely able to use it as a central communication point. -In each web container, there is a process, `run_heartbeet.py` which will send +In each web container, there is a process, `run_ws_heartbeat.py` which will send out a heartbeat payload to pg_notify, every `settings.BROADCAST_WEBSOCKET_BEACON_FROM_WEB_RATE_SECONDS` seconds. This is done in a broadcast fashion to a specific pg_notify channel, and each `wsrelay` @@ -120,7 +120,7 @@ these messages. When `wsrelay` sees this heartbeat packet, it checks to see if the web node is known already. If not, it creates a connection to it, and adds it to its list of nodes to relay websocket messages to. -It can also handle web nodes going offline. If `run_heartbeet.py` detects +It can also handle web nodes going offline. If `run_ws_heartbeat.py` detects SIGTERM or SIGINT, it will send an "offline" heartbeat packet, and `wsrelay` will work to *remove* the web node from its list of active connections. |