GRE tunnel developer documentation - #3715
Open
ipspace wants to merge 1 commit into
Open
Conversation
Deploying netlab with
|
| Latest commit: |
8bfc59d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b0ef9235.netlab.pages.dev |
| Branch Preview URL: | https://dev-tunnel-gre.netlab.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds configuration-template developer documentation for the tunnel.gre extra plugin, describing the GRE tunnel data model, transformation behavior, and example templates, and wires it into the config-dev documentation ToC.
Changes:
- Added new developer documentation page for GRE tunnels (
tunnel.greplugin), including data model and template examples. - Added the new page to
docs/dev/config/index.mdso it appears in the configuration developer docs ToC.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/dev/config/tunnel.gre.md | New developer documentation for GRE tunnel configuration templates, including attributes, transforms, and examples. |
| docs/dev/config/index.md | Adds the GRE tunnel doc page to the config developer docs index/ToC. |
Comments suppressed due to low confidence (2)
docs/dev/config/tunnel.gre.md:68
- The GRE plugin pre_transform hook sets
link.type = 'tunnel'; it does not directly setintf.type. The interface type becomestunnellater during link/interface transformation, so this bullet is slightly inaccurate.
* **type** set to `tunnel` during `pre_transform`.
docs/dev/config/tunnel.gre.md:128
_tunnel.set_tunnel_type(topology)setstype: tunnelon any link that has atunnel.modeattribute (regardless of the specific mode value), so this description is narrower than the actual behavior.
1. **`_tunnel.set_tunnel_type(topology)`** -- marks all links with `tunnel.mode: gre` as `type: tunnel`.
Comment on lines
+50
to
+53
| 4. If `tunnel.source.link.name` is set, the interface name must match. | ||
| 5. If `tunnel.source.link.role` is set, the interface or its link role must match. | ||
| 6. If `tunnel.af` is set, only interfaces with a numbered address in that address family are considered. | ||
| 7. Otherwise, only interfaces with at least one numbered IPv4 or IPv6 address are considered. |
| * **type** (string) -- source interface type. Currently, only `loopback` is supported as a valid value. | ||
| * **link.name** (string) -- select the source interface by its link name. | ||
| * **link.role** (string) -- select the source interface by its link role. | ||
| * **ifindex** (integer) -- specify the source interface ifindex directly (rarely needed). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.