Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

6.3.0 release documentation #676

Open
wants to merge 45 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
5729103
adding DNAT
Chr1st0ph3rTurn3r Feb 20, 2024
c532baf
adding Dynamic Source NAT info and reorganizing the NAT section of th…
Chr1st0ph3rTurn3r Feb 21, 2024
7c8c84a
updating CLI reference docs, and linking to them from NAT docs.
Chr1st0ph3rTurn3r Feb 21, 2024
e711c1c
fixing broken links
Chr1st0ph3rTurn3r Feb 21, 2024
4c4adc6
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Feb 22, 2024
040f663
updates per review
Chr1st0ph3rTurn3r Feb 26, 2024
6f47217
adding net interf traffic engineering info, breaking out all of TE to…
Chr1st0ph3rTurn3r Mar 5, 2024
ab545ac
adding content for Traffic engineering - improving existing content, …
Chr1st0ph3rTurn3r Mar 5, 2024
d38bde1
forgot the graphic that will need to be updated anyway.
Chr1st0ph3rTurn3r Mar 5, 2024
d4196e3
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Mar 6, 2024
ab8e876
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Mar 6, 2024
fabab2f
links and new screenshots
Chr1st0ph3rTurn3r Mar 7, 2024
7039d52
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Mar 11, 2024
8d5efbe
updates per scotts review - not complete yet - and attempt to fix bui…
Chr1st0ph3rTurn3r Mar 13, 2024
996e889
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Mar 18, 2024
c9d9e84
escaping the curly braces.
Chr1st0ph3rTurn3r Mar 18, 2024
9b80ac9
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Mar 18, 2024
b308df3
adding TE output, some of it anyway.
Chr1st0ph3rTurn3r Mar 18, 2024
6c1a072
adding TE show stats output, and fixing the files that I incorrectly …
Chr1st0ph3rTurn3r Mar 20, 2024
bf73d22
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Mar 20, 2024
13dd313
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Mar 22, 2024
330ab5e
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Mar 22, 2024
81adfd8
escaping curly braces
Chr1st0ph3rTurn3r Mar 22, 2024
7784635
escaping curly braces
Chr1st0ph3rTurn3r Mar 22, 2024
d1d2fc4
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Mar 22, 2024
3a9ffa5
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Mar 27, 2024
a9b5bfc
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Mar 27, 2024
97d8e61
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Apr 1, 2024
a4063f8
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Apr 1, 2024
7259a90
rewording to be more accurate
Chr1st0ph3rTurn3r Apr 2, 2024
9e1d248
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Apr 2, 2024
ddf2aaf
Merge branch 'master' into 6.3.0-traffic-engineering
Chr1st0ph3rTurn3r Apr 4, 2024
f60e701
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Apr 4, 2024
c465a5c
adding traffic engineering info to the main docs branch Merge branch…
Chr1st0ph3rTurn3r Apr 4, 2024
6e38852
adding release notes and some other edits.
Chr1st0ph3rTurn3r Apr 4, 2024
1f44728
adding new feature info to the release notes.
Chr1st0ph3rTurn3r Apr 4, 2024
00394a6
minor text edits
Chr1st0ph3rTurn3r Apr 10, 2024
7c932e7
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Apr 15, 2024
94101cf
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Apr 16, 2024
0c502ac
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Apr 29, 2024
9bc9fbb
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r Apr 29, 2024
d40a746
updating new features list, adding force-up for LACP
Chr1st0ph3rTurn3r Apr 30, 2024
ccf3664
disabling link checker for slow wireguard links
Chr1st0ph3rTurn3r May 1, 2024
6d5203a
updates to the new feature list and documentation.
Chr1st0ph3rTurn3r May 1, 2024
a7cea92
Merge branch 'master' into 6.3.0-release-documentation
Chr1st0ph3rTurn3r May 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/about_releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Version `6.1.0` introduces changes to the SSR software release model. Every six

| Version | Initial GA Version | First Release Shipping Date | Latest GA Version | End of Software Engineering support | End of Support |
| --| -- | -- | -- | -- | -- |
| Release 6.3 | [6.3.0](release_notes_128t_6.3.md) | May 9, 2024 | [6.3.0](release_notes_128t_6.3.md) | February 9, 2025 | August 9, 2025 |
| Release 6.2 | [6.2.0](release_notes_128t_6.2.md#release-620-39) | November 16, 2023 | [6.2.4](release_notes_128t_6.2.md#release-624-14r2) | August 16, 2024 | November 3, 2024 |
| Release 6.1 | [6.1.0](release_notes_128t_6.1.md#release-610-55) | April 14, 2023 | [6.1.8](release_notes_128t_6.1.md#release-618-15) | September 22, 2025 | June 22, 2026 |
| Release 5.6 | [5.6.7](release_notes_128t_5.6.md#release-567-4) | March 16, 2023 | [5.6.12](release_notes_128t_5.6.md#release-5612-1) | June 16, 2024 | December 16, 2024 |
Expand Down
46 changes: 42 additions & 4 deletions docs/bcp_per-adjacency_traffic_engineering.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Per Adjacency Traffic Engineering
sidebar_label: Per Adjacency Traffic Engineering
title: Adjacency Traffic Engineering
sidebar_label: Adjacency Traffic Engineering
---

Packet loss due to congestion in networks, particularly over WAN links, is inevitable. Depending on where drops occur, it can have a major impact on perceived quality of experience. Packet loss due to exceeding transmit caps between instances of SSR should be avoided. Per-adjacency traffic engineering can be enabled to regulate the upload and download rates between peers.
Adjacency traffic engineering can be enabled to regulate the upload and download rates between peers.

## Overview

Per-adjacency traffic engineering provides targeted traffic engineering for both directions on a bandwidth restricted link between two SSR instances. Traffic engineering on the device interface continues to be associated with the upload rate of a connected link; the `transmit-cap`. Traffic engineering at the adjacency level is associated with the download limit of the adjacent SSR instance; the `receive-cap`.
Adjacency traffic engineering provides targeted traffic engineering for both directions on a bandwidth restricted link between two SSR instances. While device interface traffic engineering is associated with the upload rate (`transmit-cap`) of a connected link, traffic engineering at the adjacency level is associated with the download limit of the adjacent SSR instance; the `receive-cap`.

For example, in the following hub and spoke diagram the Datacenter router has 5 adjacencies off of the individual device interface with a `transmit-cap` upload speed configured at 50Mb. The adjacent branch routers have 10Mb, 5Mb, 1Mb, 5Mb, and 2.5Mb configured as their device interface transmit caps. With such a large `transmit-cap` at the Datacenter, traffic rates exceeding the allowed download speeds (10Mb, 5Mb, 1Mb, 5Mb, and 2.5Mb) on each of the paths to the branch routers will result in traffic being dropped by the ISP.

Expand Down Expand Up @@ -64,10 +64,48 @@ network-interface foo
exit
exit
```

### Limitations

Traffic engineering includes a performance impact to the packet-per-second processing rate of the worker cores. When used in conjunction with other traffic engineering settings, performance is further impacted; each level of traffic engineering requires buffering for their scheduled objects.

### Gathering Statistics

To gather information about Per-Adjacency Traffic Engineering, query the following statistics using the `show stats traffic-eng device-interface peer-path` command within the CLI. These statistics are specific to the peer-path and provide insight into how the adjacency schedulers are operating.

```
admin@combo-east-a.combo-east# show stats traffic-eng device-interface peer-path
Tue 2024-03-19 13:39:58 UTC
Retrieving statistics...

Peer Path Traffic Engineering Stats
-----------------------------------

==================================================== ============== ============ ============== ============= ====== ==================
Metric Node Peer-name Peer-host Device-name Vlan Value
==================================================== ============== ============ ============== ============= ====== ==================
dequeue-cycle-count combo-east-a combo-west 172.16.102.2 11-red 0 7077545161474020
enqueue-cycle-count combo-east-a combo-west 172.16.102.2 11-red 0 7077545161474020
packets-queued combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class buffer-capacity-exceeded-bytes combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class buffer-capacity-exceeded-packets combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class dequeue-aqm-drop-bytes combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class dequeue-aqm-drop-packets combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class dequeue-max-latency-drop-bytes combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class dequeue-max-latency-drop-packets combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class dequeue-success-bytes combo-east-a combo-west 172.16.102.2 11-red 0 94918726
per-traffic-class dequeue-success-packets combo-east-a combo-west 172.16.102.2 11-red 0 244021
per-traffic-class schedule-failure-bandwidth combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class schedule-failure-bytes combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class schedule-failure-packets combo-east-a combo-west 172.16.102.2 11-red 0 0
per-traffic-class schedule-success-bandwidth combo-east-a combo-west 172.16.102.2 11-red 0 1201245
per-traffic-class schedule-success-bytes combo-east-a combo-west 172.16.102.2 11-red 0 94918726
per-traffic-class schedule-success-packets combo-east-a combo-west 172.16.102.2 11-red 0 244021
scheduler-reset combo-east-a combo-west 172.16.102.2 11-red 0 0
```

### Statistics Descriptions

- `enqueue-cycle-count`: The current enqueue cycle count in traffic engineering for this peer path.
- `dequeue-cycle-count`: The current dequeue cycle count in traffic engineering for this peer path.
- `packets-queued`: The current number of packets queued in traffic engineering for this peer path.
Expand Down