mirrors/haproxy
1
0
Fork 0
mirror of https://git.haproxy.org/git/haproxy.git/ synced 2025-08-06 15:17:01 +02:00
Code Issues Projects Releases Wiki Activity

DOC: spoe: Update SPOE documentation to reflect recent changes

Browse Source
This commit is contained in:
Christopher Faulet 2017-02-27 21:59:39 +01:00 committed by Willy Tarreau
parent 2eca6b50a7
commit d1307cea84
1 changed files with 96 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
doc/SPOE.txt
View File

@ -1,7 +1,7 @@
----------------------------------------------- -----------------------------------------------
Stream Processing Offload Engine (SPOE) Stream Processing Offload Engine (SPOE)
Version 1.0 Version 1.1
( Last update: 2016-11-07 ) ( Last update: 2017-02-27 )
----------------------------------------------- -----------------------------------------------
Author : Christopher Faulet Author : Christopher Faulet
Contact : cfaulet at haproxy dot com Contact : cfaulet at haproxy dot com
@ -31,7 +31,7 @@ SUMMARY
3.2.9. Frame: AGENT-DISCONNECT 3.2.9. Frame: AGENT-DISCONNECT
3.3. Events & messages 3.3. Events & messages
3.4. Actions 3.4. Actions
3.5. Error & timeouts 3.5. Errors & timeouts
0. Terms 0. Terms
@ -41,7 +41,7 @@ SUMMARY
A SPOE is a filter talking to servers managed ba a SPOA to offload the A SPOE is a filter talking to servers managed ba a SPOA to offload the
stream processing. An engine is attached to a proxy. A proxy can have stream processing. An engine is attached to a proxy. A proxy can have
several engine. Each engine is linked to an agent and only one. several engines. Each engine is linked to an agent and only one.
* SPOA : Stream Processing Offload Agent. * SPOA : Stream Processing Offload Agent.
@ -114,7 +114,7 @@ If you specify an engine name on the SPOE filter line, then you need to define
scope in the SPOE configuration with the same name. You can have several SPOE scope in the SPOE configuration with the same name. You can have several SPOE
scope in the same file. In each scope, you must define one and only one scope in the same file. In each scope, you must define one and only one
"spoe-agent" section to configure the SPOA linked to your SPOE and several "spoe-agent" section to configure the SPOA linked to your SPOE and several
"spoe-message" sections to describe messages sent to servers mananger by your "spoe-message" sections to describe messages sent to servers mananged by your
SPOA. SPOA.
A SPOE scope starts with this kind of line : A SPOE scope starts with this kind of line :
@ -158,7 +158,11 @@ spoe-agent <name>
following keywords are supported : following keywords are supported :
- maxconnrate - maxconnrate
- maxerrrate - maxerrrate
- max-frame-size
- messages - messages
- [no] option async
- [no] option pipelining
- [no] option send-frag-payload
- option continue-on-error - option continue-on-error
- option set-on-error - option set-on-error
- option var-prefix - option var-prefix
@ -178,6 +182,12 @@ maxerrrate <number>
its processing if the maximum is reached. its processing if the maximum is reached.
max-frame-size <number>
Set the maximum allowed size for frames exchanged between HAProxy and SPOA.
It must be in the range [256, tune.bufsize-4] (4 bytes are reserved for the
frame length). By default, it is set to (tune.bufsize-4).
messages <msg-name> ... messages <msg-name> ...
Declare the list of SPOE messages that an agent will handle. Declare the list of SPOE messages that an agent will handle.
@ -191,6 +201,12 @@ messages <msg-name> ...
See also: "spoe-message" section. See also: "spoe-message" section.
option async
no option async
Enable or disable the support of asynchronus exchanges between HAProxy and
SPOA. By default, this option is enabled.
option continue-on-error option continue-on-error
Do not stop the events processing when an error occurred on a stream. Do not stop the events processing when an error occurred on a stream.
@ -204,6 +220,18 @@ option continue-on-error
be ignored. be ignored.
option pipelining
no option pipelining
Enable or disable the support of pipelined exchanges between HAProxy and
SPOA. By default, this option is enabled.
option send-frag-payload
no option send-frag-payload
Enable or disable the sending of fragmented payload to SPOA. By default, this
option is enabled.
option set-on-error <var name> option set-on-error <var name>
Define the variable to set when an error occurred during an event processing. Define the variable to set when an error occurred during an event processing.
@ -226,6 +254,11 @@ option set-on-error <var name>
* 2 an error was triggered during the ressources allocation. * 2 an error was triggered during the ressources allocation.
* 3 the frame payload exceeds the frame size and it cannot be
fragmented.
* 4 the fragmentation of a payload is aborted.
* 255 an unknown error occurred during the event processing. * 255 an unknown error occurred during the event processing.
* 256+N a SPOP error occurred during the event processing (see section * 256+N a SPOP error occurred during the event processing (see section
@ -483,16 +516,24 @@ actions.
KV-NAME : <STRING> KV-NAME : <STRING>
KV-VALUE : <TYPED-DATA> KV-VALUE : <TYPED-DATA>
FLAGS : 0 1-31 FLAGS : 0 1 2-31
+---+-----------+ +---+---+----------+
| F| | | | A | |
| I| RESERVED | | F | B | |
| N| | | I | O | RESERVED |
+--+------------+ | N | R | |
| | T | |
+---+---+----------+
FIN: Indicates that this is the final payload fragment. The first fragment FIN: Indicates that this is the final payload fragment. The first fragment
may also be the final fragment. may also be the final fragment.
ABORT: Indicates that the processing of the current frame must be
cancelled. This bit should be set on frames with a fragmented
payload. It can be ignore for frames with an unfragemnted
payload. When it is set, the FIN bit must also be set.
Frames cannot exceed a maximum size negociated between HAProxy and agents Frames cannot exceed a maximum size negociated between HAProxy and agents
during the HELLO handshake. Most of time, payload will be small enough to send during the HELLO handshake. Most of time, payload will be small enough to send
it in one frame. But when supported by the peer, it will be possible to it in one frame. But when supported by the peer, it will be possible to
@ -504,14 +545,14 @@ HAProxy or the opposite). The following rules apply to fragmentation:
* A fragemented payload consists of several frames with the FIN bit clear and * A fragemented payload consists of several frames with the FIN bit clear and
terminated by a single frame with the FIN bit set. All these frames must terminated by a single frame with the FIN bit set. All these frames must
share the same STREAM-ID and FRAME-ID. And, of course, the FRAME-TYPE must share the same STREAM-ID and FRAME-ID. The first frame must set the right
be the same. FRAME-TYPE (e.g, NOTIFY). The following frames must have an unset type (0).
Beside the support of fragmented payload by a peer, some payload must not be Beside the support of fragmented payload by a peer, some payload must not be
fragmented. See below for details. fragmented. See below for details.
IMPORTANT : The maximum size supported by peers for a frame must be greater or IMPORTANT : The maximum size supported by peers for a frame must be greater
equal to 256 bytes. than or equal to 256 bytes.
3.2.1. Frame capabilities 3.2.1. Frame capabilities
-------------------------- --------------------------
@ -545,6 +586,9 @@ Here are types of frame supported by SPOE. Frames sent by HAProxy come first,
then frames sent by agents : then frames sent by agents :
TYPE | ID | DESCRIPTION TYPE | ID | DESCRIPTION
-----------------------------+-----+-------------------------------------
UNSET | 0 | Used for all frames but the first when a
| | payload is fragmented.
-----------------------------+-----+------------------------------------- -----------------------------+-----+-------------------------------------
HAPROXY-HELLO | 1 | Sent by HAProxy when it opens a HAPROXY-HELLO | 1 | Sent by HAProxy when it opens a
| | connection on an agent. | | connection on an agent.
@ -619,7 +663,7 @@ Unknown frames may be silently skipped.
| <-------------------------- | | <-------------------------- |
| | | |
* Notify / Ack exchange: * Notify / Ack exchange (unfragmented payload):
HAPROXY AGENT SRV HAPROXY AGENT SRV
| NOTIFY | | NOTIFY |
@ -629,6 +673,37 @@ Unknown frames may be silently skipped.
| <-------------------------- | | <-------------------------- |
| | | |
* Notify / Ack exchange (fragmented payload):
HAPROXY AGENT SRV
| NOTIFY (frag 1) |
| --------------------------> |
| |
| UNSET (frag 2) |
| --------------------------> |
| ... |
| UNSET (frag N) |
| --------------------------> |
| |
| ACK |
| <-------------------------- |
| |
* Aborted fragmentation of a NOTIFY frame:
HAPROXY AGENT SRV
| ... |
| UNSET (frag X) |
| --------------------------> |
| |
| ACK/ABORT |
| <-------------------------- |
| |
| UNSET (frag X+1) |
| -----------X |
| |
| |
* Connection closed by haproxy: * Connection closed by haproxy:
HAPROXY AGENT SRV HAPROXY AGENT SRV
@ -890,7 +965,7 @@ NOTE: Name of the variables will be automatically prefixed by HAProxy to avoid
name clashes with other variables used in HAProxy. Moreover, unknown name clashes with other variables used in HAProxy. Moreover, unknown
variable will be silently ignored. variable will be silently ignored.
3.5. Error & timeouts 3.5. Errors & timeouts
---------------------- ----------------------
Here is the list of all known errors: Here is the list of all known errors:
@ -907,6 +982,10 @@ Here is the list of all known errors:
7 | capabilities value not found 7 | capabilities value not found
8 | unsupported version 8 | unsupported version
9 | max-frame-size too big or too small 9 | max-frame-size too big or too small
10 | payload fragmentation is not supported
11 | invalid interlaced frames
12 | frame-id not found (it does not match any referenced frame)
13 | resource allocation error
99 | an unknown error occurrde 99 | an unknown error occurrde
----------------+-------------------------------------------------------- ----------------+--------------------------------------------------------