Skip to content

Commit

Permalink
Website update for main
Browse files Browse the repository at this point in the history
  • Loading branch information
antrea-bot committed Oct 26, 2023
1 parent e94fa2a commit a2840a2
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 1 deletion.
68 changes: 67 additions & 1 deletion content/docs/main/docs/api-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -10049,6 +10049,19 @@ <h3 id="crd.antrea.io/v1beta1.Egress">Egress
Cannot be set with ExternalIPPool.</p>
</td>
</tr>
<tr>
<td>
<code>bandwidth</code></br>
<em>
<a href="#crd.antrea.io/v1beta1.Bandwidth">
Bandwidth
</a>
</em>
</td>
<td>
<p>Bandwidth specifies the rate limit of north-south egress traffic of this Egress.</p>
</td>
</tr>
</table>
</td>
</tr>
Expand Down Expand Up @@ -10941,6 +10954,46 @@ <h3 id="crd.antrea.io/v1beta1.AppliedTo">AppliedTo
</tr>
</tbody>
</table>
<h3 id="crd.antrea.io/v1beta1.Bandwidth">Bandwidth
</h3>
<p>
(<em>Appears on:</em>
<a href="#crd.antrea.io/v1beta1.EgressSpec">EgressSpec</a>)
</p>
<p>
</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>rate</code></br>
<em>
string
</em>
</td>
<td>
<p>Rate specifies the maximum traffic rate. e.g. 300k, 10M</p>
</td>
</tr>
<tr>
<td>
<code>burst</code></br>
<em>
string
</em>
</td>
<td>
<p>Burst specifies the maximum burst size when traffic exceeds the rate. e.g. 300k, 10M</p>
</td>
</tr>
</tbody>
</table>
<h3 id="crd.antrea.io/v1beta1.ClusterGroupReference">ClusterGroupReference
(<code>string</code> alias)</p></h3>
<p>
Expand Down Expand Up @@ -11358,6 +11411,19 @@ <h3 id="crd.antrea.io/v1beta1.EgressSpec">EgressSpec
Cannot be set with ExternalIPPool.</p>
</td>
</tr>
<tr>
<td>
<code>bandwidth</code></br>
<em>
<a href="#crd.antrea.io/v1beta1.Bandwidth">
Bandwidth
</a>
</em>
</td>
<td>
<p>Bandwidth specifies the rate limit of north-south egress traffic of this Egress.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="crd.antrea.io/v1beta1.EgressStatus">EgressStatus
Expand Down Expand Up @@ -14508,5 +14574,5 @@ <h3 id="system.antrea.io/v1beta1.BundleStatus">BundleStatus
<hr/>
<p><em>
Generated with <code>gen-crd-api-reference-docs</code>
on git commit <code>d66de44</code>.
on git commit <code>ffc6495</code>.
</em></p>
41 changes: 41 additions & 0 deletions content/docs/main/docs/egress.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- [AppliedTo](#appliedto)
- [EgressIP](#egressip)
- [ExternalIPPool](#externalippool)
- [Bandwidth](#bandwidth)
- [The ExternalIPPool resource](#the-externalippool-resource)
- [IPRanges](#ipranges)
- [NodeSelector](#nodeselector)
Expand Down Expand Up @@ -127,6 +128,46 @@ The `externalIPPool` field specifies the name of the `ExternalIPPool` that the
be assigned to. It can be empty, which means users should assign the `egressIP`
to one Node manually.

### Bandwidth

The `bandwidth` field enables traffic shaping for an Egress, by limiting the
bandwidth for all egress traffic belonging to this Egress. `rate` specifies
the maximum transmission rate. `burst` specifies the maximum burst size when
traffic exceeds the rate. The user-provided values for `rate` and `burst` must
follow the Kubernetes [Quantity](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/) format,
e.g. 300k, 100M, 2G. All backend workloads selected by a rate-limited Egress share the
same bandwidth while sending egress traffic via this Egress. If these limits are exceeded,
the traffic will be dropped.

**Note**: Traffic shaping is currently in alpha version. To use this feature, users should
enable the `EgressTrafficShaping` feature gate. Each Egress IP can be applied one bandwidth only.
If multiple Egresses use the same IP but configure different bandwidths, the effective
bandwidth will be selected randomly from the set of configured bandwidths. The effective use of the `bandwidth`
function requires the OVS datapath to support meters.

An Egress with traffic shaping example:

```yaml
apiVersion: crd.antrea.io/v1beta1
kind: Egress
metadata:
name: egress-prod-web
spec:
appliedTo:
namespaceSelector:
matchLabels:
env: prod
podSelector:
matchLabels:
role: web
egressIP: 10.10.0.8
bandwidth:
rate: 800M
burst: 2G
status:
egressNode: node01
```

## The ExternalIPPool resource

ExternalIPPool defines one or multiple IP ranges that can be used in the
Expand Down
11 changes: 11 additions & 0 deletions content/docs/main/docs/feature-gates.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ edit the Agent configuration in the
| `SupportBundleCollection` | Agent + Controller | `false` | Alpha | v1.10 | N/A | N/A | Yes | |
| `L7NetworkPolicy` | Agent + Controller | `false` | Alpha | v1.10 | N/A | N/A | Yes | |
| `AdminNetworkPolicy` | Controller | `false` | Alpha | v1.13 | N/A | N/A | Yes | |
| `EgressTrafficShaping` | Agent | `false` | Alpha | v1.14 | N/A | N/A | Yes | OVS meters should be supported |

## Description and Requirements of Features

Expand Down Expand Up @@ -402,3 +403,13 @@ this [document](antrea-l7-network-policy.md#prerequisites) for more information

The `AdminNetworkPolicy` API (which currently includes the AdminNetworkPolicy and BaselineAdminNetworkPolicy objects)
complements the Antrea-native policies and help cluster administrators to set security postures in a portable manner.

### EgressTrafficShaping

The `EgressTrafficShaping` feature gate of Antrea Agent enables traffic shaping of Egress, which could limit the
bandwidth for all egress traffic belonging to an Egress. Refer to this [document](egress.md#trafficshaping)

#### Requirements for this Feature

This feature leverages OVS meters to do the actual rate-limiting, therefore this feature requires OVS meters
to be supported in the datapath.

0 comments on commit a2840a2

Please sign in to comment.