diff options
| author |   Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2021-10-08 14:05:35 +0200 |
|---|---|---|
| committer |   Dave Wallace <dwallacelf@gmail.com> | 2021-10-13 23:22:20 +0000 |
| commit | f47122e07e1ecd0151902a3cabe46c60a99bee8e (patch) | |
| tree | 0c28c0eca2cb17050d6f31fd8f0ca8f78299bf0d /src/plugins/srv6-ad-flow | |
| parent | 1e4281223ab4d655b54496ae13fbdb68f867e351 (diff) | |
docs: convert plugins doc md->rst
Type: improvement
Change-Id: I7e821cce1feae229e1be4baeed249b9cca658135
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'src/plugins/srv6-ad-flow')
| -rw-r--r-- | src/plugins/srv6-ad-flow/ad_flow_plugin_doc.md | 25 | ||||
| -rw-r--r-- | src/plugins/srv6-ad-flow/ad_flow_plugin_doc.rst | 31 |
2 files changed, 31 insertions, 25 deletions
diff --git a/src/plugins/srv6-ad-flow/ad_flow_plugin_doc.md b/src/plugins/srv6-ad-flow/ad_flow_plugin_doc.md deleted file mode 100644 index 1f58fc2b663..00000000000 --- a/src/plugins/srv6-ad-flow/ad_flow_plugin_doc.md +++ /dev/null @@ -1,25 +0,0 @@ -# SRv6 endpoint to SR-unaware appliance via per-flow dynamic proxy {#srv6_ad_flow_plugin_doc} - -## Overview - -TBD - -## CLI configuration - -The following command instantiates a new End.AD.Flow segment that sends the inner -packets on interface `IFACE-OUT` towards an appliance at address `S-ADDR` and -restores the encapsulation headers of the packets coming back on interface -`IFACE-IN`. - -``` -sr localsid address SID behavior end.ad.flow nh S-ADDR oif IFACE-OUT iif IFACE-IN -``` - -For example, the below command configures the SID `1::A1` with an End.AD.Flow -function for sending traffic on interface `GigabitEthernet0/8/0` to the -appliance at address `A1::`, and receiving it back on interface -`GigabitEthernet0/9/0`. - -``` -sr localsid address 1::A1 behavior end.ad.flow nh A1:: oif GigabitEthernet0/8/0 iif GigabitEthernet0/9/0 -``` diff --git a/src/plugins/srv6-ad-flow/ad_flow_plugin_doc.rst b/src/plugins/srv6-ad-flow/ad_flow_plugin_doc.rst new file mode 100644 index 00000000000..7e628742f84 --- /dev/null +++ b/src/plugins/srv6-ad-flow/ad_flow_plugin_doc.rst @@ -0,0 +1,31 @@ +SRv6 per-flow dynamic proxy +=========================== + +This document describes SRv6 endpoint to SR-unaware appliance via +per-flow dynamic proxy + +Overview +-------- + +TBD + +CLI configuration +----------------- + +The following command instantiates a new End.AD.Flow segment that sends +the inner packets on interface ``IFACE-OUT`` towards an appliance at +address ``S-ADDR`` and restores the encapsulation headers of the packets +coming back on interface ``IFACE-IN``. + +:: + + sr localsid address SID behavior end.ad.flow nh S-ADDR oif IFACE-OUT iif IFACE-IN + +For example, the below command configures the SID ``1::A1`` with an +End.AD.Flow function for sending traffic on interface +``GigabitEthernet0/8/0`` to the appliance at address ``A1::``, and +receiving it back on interface ``GigabitEthernet0/9/0``. + +:: + + sr localsid address 1::A1 behavior end.ad.flow nh A1:: oif GigabitEthernet0/8/0 iif GigabitEthernet0/9/0 |