Skip to content

Commit 4a1ad22

Browse files
joshistejoshiste
committed
docs: document 'TCP Data Packets Only' option
1 parent 08bef62 commit 4a1ad22

File tree

2 files changed

+21
-19
lines changed
  • actions
    • com.steadybit.extension_container.network_delay
    • com.steadybit.extension_host.network_delay

2 files changed

+21
-19
lines changed

‎actions/com.steadybit.extension_container.network_delay/summary.mdx‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ _Note:_ If you are going to attack containers using network attacks, **all conta
1616

1717
# Parameters
1818

19-
| Parameter | Description | Default |
20-
|----------------------|---------------------------------------------------------------------------|---------|
21-
| Network Delay | How much should the traffic be delayed? | 500ms |
22-
| Jitter | Random +-30% jitter to network delay | true |
23-
| Fail on Host Network | Emit failure when the targeted container is using the host network | true |
24-
| Duration | How long should the traffic be affected? | 30s |
25-
| Hostname | Restrict to which hosts the traffic is reduced | |
26-
| IP Address | Restrict to which IP address the traffic is reduced | |
27-
| Network Interface | Target Network Interface which should be attacked. All if none specified. | |
28-
| Ports | Restrict to which ports the traffic is reduced | |
19+
| Parameter | Description | Default |
20+
|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
21+
| Network Delay | How much should the traffic be delayed? | 500ms |
22+
| Jitter | Random +-30% jitter to network delay | true |
23+
| Fail on Host Network | Emit failure when the targeted container is using the host network | true |
24+
| Duration | How long should the traffic be affected? | 30s |
25+
| Hostname | Restrict to which hosts the traffic is reduced | |
26+
| IP Address | Restrict to which IP address the traffic is reduced | |
27+
| Network Interface | Target Network Interface which should be attacked. All if none specified. | |
28+
| Ports | Restrict to which ports the traffic is reduced | |
29+
| TCP Data Packets Only | `beta` Delay only TCP data packets (PSH flag heuristic). UDP is not delayed. When you observe the actual delay being a multiple of the configured delay, you might choose this option to avoid delaying the TCP handshake. | false |

‎actions/com.steadybit.extension_host.network_delay/summary.mdx‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,13 @@ In this example the traffic is delayed by 500ms. If you tap the wire (using tcpd
1818

1919
# Parameters
2020

21-
| Parameter | Description | Default |
22-
|-------------------|---------------------------------------------------------------------------|---------|
23-
| Duration | How long should the traffic be delayed? | 30s |
24-
| Hostname | Restrict to which hosts the traffic is delayed | |
25-
| IP Address | Restrict to which IP address the traffic is delayed | |
26-
| Network Delay | How much should the traffic be delayed? | 500ms |
27-
| Network Interface | Target Network Interface which should be attacked. All if none specified. | |
28-
| Port Number | Restrict to which port number the traffic is delayed | |
29-
| Jitter | Random +-30% jitter to network delay | true |
21+
| Parameter | Description | Default |
22+
|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
23+
| Duration | How long should the traffic be delayed? | 30s |
24+
| Hostname | Restrict to which hosts the traffic is delayed | |
25+
| IP Address | Restrict to which IP address the traffic is delayed | |
26+
| Network Delay | How much should the traffic be delayed? | 500ms |
27+
| Network Interface | Target Network Interface which should be attacked. All if none specified. | |
28+
| Port Number | Restrict to which port number the traffic is delayed | |
29+
| Jitter | Random +-30% jitter to network delay | true |
30+
| TCP Data Packets Only | `beta` Delay only TCP data packets (PSH flag heuristic). UDP is not delayed. When you observe the actual delay being a multiple of the configured delay, you might choose this option to avoid delaying the TCP handshake. | false |

0 commit comments

Comments
 (0)