Fix links to "Topology Defaults" document

ipspace · ipspace · commit e4c93a6cc031 · 2025-01-15T09:15:21.000+01:00
diff --git a/docs/caveats.md b/docs/caveats.md
@@ -135,7 +135,7 @@ group_vars:
   netlab_ssh_args: "-o KexAlgorithms=+diffie-hellman-group-exchange-sha1 -o PubkeyAcceptedKeyTypes=ssh-rsa -o HostKeyAlgorithms=+ssh-rsa"
 ```
 
-You can change the additional SSH arguments with the node **netlab_ssh_args** parameter or with the **defaults.devices._device_.group_vars.netlab_ssh_args** [system default](defaults.md).
+You can change the additional SSH arguments with the node **netlab_ssh_args** parameter or with the **defaults.devices._device_.group_vars.netlab_ssh_args** [system default](topo-defaults).
 
 Additionally, you might have to execute `sudo update-crypto-policies --set LEGACY` on AlmaLinux/RHEL.
 
diff --git a/docs/customize.md b/docs/customize.md
@@ -3,7 +3,7 @@
 
 _netlab_ is designed to be highly extensible and customizable. Starting with the system settings, you can:
 
-* [Overwrite system defaults](defaults.md), either with user default files or in the lab topology.
+* [Overwrite system defaults](topo-defaults), either with user default files or in the lab topology.
 * Change the [default device images](default-device-image) to run a specific software version in your lab.
 * Change [system addressing pools](addressing.md) or define your own.
 
@@ -29,7 +29,7 @@ Finally, you might want to use external tools or devices not yet supported by _n
 * If you want to add unsupported devices to a lab but are willing to configure them manually, just [define them as _unknown_ devices](platform-unknown).
 * Adding [new functionality to an existing device](dev/device-features.md) or adding a new device to _netlab_ takes more effort. When adding a new device, it's easier to [define a new device](dev/device-box.md) and keep it _[unprovisioned](group-special-names)_ than going for a [full-blown implementation](dev/devices.md).
 
-Regardless of how far you're willing to go, we'd appreciate if you decided to [contribute your changes](dev/guidelines.md), but it's perfectly fine to keep them private. The best part: you don't have to modify the _netlab_ package to get the job done; you could use [user defaults](defaults.md) to define new stuff, and user-defined configuration templates (see above) to configure it.
+Regardless of how far you're willing to go, we'd appreciate if you decided to [contribute your changes](dev/guidelines.md), but it's perfectly fine to keep them private. The best part: you don't have to modify the _netlab_ package to get the job done; you could use [user defaults](defaults-user-file) to define new stuff, and user-defined configuration templates (see above) to configure it.
 
 ```eval_rst
 .. toctree::
diff --git a/docs/defaults.md b/docs/defaults.md
@@ -1,4 +1,4 @@
-(defaults)=
+(topo-defaults)=
 # Topology Defaults
 
 *netlab* has dozens of system defaults that specify:
diff --git a/docs/dev/config/deploy.md b/docs/dev/config/deploy.md
@@ -145,7 +145,7 @@ Unfortunately, the Nexus 9300v linecards become active almost a minute after com
 (change-search-paths)=
 ## Changing and Troubleshooting Search Paths
 
-The directory and filename search paths used by the **netlab initial** and **netlab config** commands are defined in the **paths** dictionary within the [system defaults](defaults). You can change these parameters or prepend/append another list to them:
+The directory and filename search paths used by the **netlab initial** and **netlab config** commands are defined in the **paths** dictionary within the [system defaults](topo-defaults). You can change these parameters or prepend/append another list to them:
 
 * To change a search path list, set the corresponding **defaults.paths** variable in lab topology or user defaults.
 * To prepend a list of path components to a search path list, set the **defaults.paths.prepend._path_name_** list.
diff --git a/docs/extools.md b/docs/extools.md
@@ -29,7 +29,7 @@ For the list of tool-specific parameters see the individual tool description.
 (tools-enable-default)=
 ## Enabling Tools in User Defaults
 
-You can change [user defaults](defaults.md) to start an external tool with every lab topology -- all you have to do is to set the **defaults.tools._toolname_.enabled** attribute to `True`.
+You can change [user defaults](defaults-user-file) to start an external tool with every lab topology -- all you have to do is to set the **defaults.tools._toolname_.enabled** attribute to `True`.
 
 For example, to use Graphite GUI with every lab you start, add the following line to `~/.netlab.yml` file:
 
diff --git a/docs/labs/clab.md b/docs/labs/clab.md
@@ -211,7 +211,7 @@ During the **netlab up** process, *containerlab* starts the containers and repor
 
 _vrnetlab_-based supported platforms go through an extra "_is the device ready_" check during the initial configuration process: _netlab_ tries to establish an SSH session with the device and execute a command. The SSH session is retried up to 20 times, and as each retry usually takes 30 seconds (due to TCP timeouts), **netlab initial** waits up to 10 minutes for a VM to become ready.
 
-If your virtual machines take even longer to boot, increase the number of retries. You can set the **netlab_check_retries** node variable to increase the number of retries for an individual node or set the **defaults.devices._device_.clab.group_vars.netlab_check_retries** variable to increase the number of retries for a specific device (see also [](defaults) and [](defaults-user-file))
+If your virtual machines take even longer to boot, increase the number of retries. You can set the **netlab_check_retries** node variable to increase the number of retries for an individual node or set the **defaults.devices._device_.clab.group_vars.netlab_check_retries** variable to increase the number of retries for a specific device (see also [](topo-defaults) and [](defaults-user-file))
 
 ## Advanced Topics
 
diff --git a/docs/links.md b/docs/links.md
@@ -199,8 +199,8 @@ Each link could have a **name** attribute. That attribute is copied into interfa
 
 ```{tip}
 * VLAN interfaces get interface names in the format `X -> [list]` where X is either the link or VLAN **‌name**, or VLAN description.
-* The maximum interface description length is 255 characters (limited by SNMP MIB-2) and can be changed with the `defaults.const.ifname.maxlength` [system parameter](defaults).
-* The interface description contains up to five neighbors. That limit can be changed with the `defaults.const.ifname.neighbors` [system parameter](defaults).
+* The maximum interface description length is 255 characters (limited by SNMP MIB-2) and can be changed with the `defaults.const.ifname.maxlength` [system parameter](topo-defaults).
+* The interface description contains up to five neighbors. That limit can be changed with the `defaults.const.ifname.neighbors` [system parameter](topo-defaults).
 ```
 
 ### Example
diff --git a/docs/modules.md b/docs/modules.md
@@ -139,7 +139,7 @@ Module parameters are dictionaries of values stored under the *module-name* key
 Node module parameters are adjusted based on topology parameters and default settings ([more details](dev/module-attributes.md)):
 
 * For every node, the topology-level settings for modules used by that node are merged with the node-level settings.
-* Node settings are further adjusted with device-specific settings and [global system defaults](defaults.md)
+* Node settings are further adjusted with device-specific settings and [global system defaults](topo-defaults)
 * Final node-level settings are saved into expanded topology file or Ansible inventory, and used by configuration templates.
 
 Link module parameters are not changed during the topology expansion. They are merged with interface data when individual interfaces are created during the topology transformation process. Interface module settings are later augmented with module-specific subset of node data (example: OSPF area).
diff --git a/docs/netlab/capture.md b/docs/netlab/capture.md
@@ -1,7 +1,7 @@
 (netlab-capture)=
 # Packet Capture
 
-The **netlab capture** command can be used to capture packets on [*libvirt* virtual machines](libvirt-capture) or [*containerlab*-created Docker containers](lab-clab). The default packet capturing program is `tcpdump`; you can change that with the [default settings](defaults).
+The **netlab capture** command can be used to capture packets on [*libvirt* virtual machines](libvirt-capture) or [*containerlab*-created Docker containers](lab-clab). The default packet capturing program is `tcpdump`; you can change that with the [default settings](topo-defaults).
 
 ```{warning}
 You cannot capture traffic on point-to-point links between *‌libvirt* virtual machines; you have to change them into Linux bridges ([more details](libvirt-capture)).
@@ -74,7 +74,7 @@ tcpdump: listening on swp1, link-type EN10MB (Ethernet), snapshot length 262144
 
 ## Changing the Packet-Capturing Utility
 
-**netlab capture** uses **tcpdump** as the default packet-capturing utility. You can change that with the **defaults.netlab.capture.command** parameter ([default changing details](defaults)). The command you specify must include the `{intf}` string at the point where the packet-capturing utility expects the interface name.
+**netlab capture** uses **tcpdump** as the default packet-capturing utility. You can change that with the **defaults.netlab.capture.command** parameter ([default changing details](topo-defaults)). The command you specify must include the `{intf}` string at the point where the packet-capturing utility expects the interface name.
 
 To change the default parameters passed to the packet-capturing utility, change the **defaults.netlab.capture.command_args** parameter.
 
diff --git a/docs/nodes.md b/docs/nodes.md
@@ -34,7 +34,7 @@ You cannot specify the device types or any other node attributes when using this
 The [topology transformation process](dev/transform.md) converts the **nodes** element specified as a list of strings into a dictionary of dictionaries before further processing.
 
 ```{tip}
-Node names can have up to 16 characters. To increase the maximum node name length, set the `defaults.const.MAX_NODE_ID_LENGTH` attribute (see also: [changing defaults](defaults.md)).
+Node names can have up to 16 characters. To increase the maximum node name length, set the `defaults.const.MAX_NODE_ID_LENGTH` attribute (see also: [changing defaults](topo-defaults)).
 ```
 
 ### Dictionary of Nodes
diff --git a/docs/outputs/d2.md b/docs/outputs/d2.md
@@ -15,7 +15,7 @@ The network topology graph description contains nodes and links but no placement
 
 ## Modifying Graph Attributes
 
-Graphing routines use **[default](defaults)** topology settings to modify the node- or link parameters of the generated D2 file:
+Graphing routines use **[default](topo-defaults)** topology settings to modify the node- or link parameters of the generated D2 file:
 
 * **outputs.d2.interface_labels** (default: False) -- Add IP addresses to links in **topology** graph. Results in a cluttered image.
 * **outputs.d2.groups** (default: None) -- use the specified list of groups (or all groups when set to *True*) to create graph clusters
diff --git a/docs/outputs/graph.md b/docs/outputs/graph.md
@@ -13,7 +13,7 @@ A single formatting modifier can be used to specify the graph type:
 
 ## Modifying Graph Attributes
 
-Graphing routines use **[default](defaults)** topology settings to modify the generated DOT file's node- or link parameters. You can change these defaults.
+Graphing routines use **[default](topo-defaults)** topology settings to modify the generated DOT file's node- or link parameters. You can change these defaults.
 
 * **outputs.graph.interface_labels** -- Add IP addresses to links in **topology** graph. Results in a cluttered image (but feel free to fix that and submit a pull request).
 * **outputs.graph.colors._object_** -- Specify background color for *as*, *node*, *stub* subnet, *ibgp* or *ebgp* session.
diff --git a/docs/platforms.md b/docs/platforms.md
@@ -53,7 +53,7 @@
 **Notes:**
 
 * Use the **[netlab show devices](netlab-show-devices)** command to display the list of supported devices and daemons.
-* You can specify the device type in the **device** property of the [node data](node-attributes) or the topology-wide **[defaults.device](defaults.md)** setting. See [lab topology overview](topology-overview.md) for more details.
+* You can specify the device type in the **device** property of the [node data](node-attributes) or the topology-wide **[defaults.device](default-device-type)** setting. See [lab topology overview](topology-overview.md) for more details.
 * If you want to use an unsupported device in a *netlab*-managed lab, use [an unknown device](platform-unknown) or [contribute a new device implementation](dev/devices.md).
 * The daemons run on top of Ubuntu Linux and use the same scripts as Linux for initial device configuration. See *linux* device for initial configuration capabilities.
 
diff --git a/docs/plugins.md b/docs/plugins.md
@@ -28,7 +28,7 @@ plugin: [ bgp.session ]
 module: [ ospf, bgp ]
 ```
 
-You can specify additional (system-wide) plugins in [system defaults](defaults.md) (**defaults.plugin**) or as a CLI parameter in **[netlab create](netlab/create.md)** or **[netlab up](netlab/up.md)** commands.
+You can specify additional (system-wide) plugins in [system defaults](topo-defaults) (**defaults.plugin**) or as a CLI parameter in **[netlab create](netlab/create.md)** or **[netlab up](netlab/up.md)** commands.
 
 Plugins can define their own _netlab_ attributes that you can use to configure plugin-provided functionality. For example, the [BGP sessions](plugins/bgp.session.md) plugin defines **bgp.password** attribute that can be used to enable MD5 authentication of EBGP sessions:
 
diff --git a/docs/plugins/multilab.md b/docs/plugins/multilab.md
@@ -13,7 +13,7 @@ The plugin has been tested with **[libvirt](../labs/libvirt.md)** and **[clab](.
 
 ```{warning}
 * While you can use the same topology file for multiple lab instances, you MUST run each lab instance in a different working directory.
-* The *‌multilab* plugin changes the lab topology parameters *‌after* the topology file, user- and system [defaults](defaults) have been processed. You cannot change a parameter controlled by the *‌multilab* plugin with a topology file setting; you must change the corresponding **defaults.multilab.change** parameter. See also [](multilab-behind-the-scenes)
+* The *‌multilab* plugin changes the lab topology parameters *‌after* the topology file, user- and system [defaults](topo-defaults) have been processed. You cannot change a parameter controlled by the *‌multilab* plugin with a topology file setting; you must change the corresponding **defaults.multilab.change** parameter. See also [](multilab-behind-the-scenes)
 ```
 
 ## Using the Plugin
diff --git a/docs/release/1.8.md b/docs/release/1.8.md
@@ -234,9 +234,9 @@ SROS:
 * [BGP configuration module](module-bgp) supports 4-octet BGP AS numbers and [large BGP communities](bgp-community-propagation).
 * [Validation plugins](validate-plugin) allow you to write more powerful validation tests without creating complex Jinja2 templates
 * [IBGP sessions](bgp-ibgp-sessions) to routing daemons running on Linux VMs or containers can be established with external-facing IP addresses (not just remote loopbacks).
-* You can set [_netlab_ defaults](defaults) from the [environment variables](defaults-env)
+* You can set [_netlab_ defaults](topo-defaults) from the [environment variables](defaults-env)
 * You can build Docker containers for the [supported daemons](platform-daemons) with the **[netlab clab build](netlab-clab-build)** command
-* [Configuration template search paths and filenames](dev-config-deploy-paths) are no longer hardcoded. Most can be configured in [system defaults](defaults) using **defaults.paths** dictionary.
+* [Configuration template search paths and filenames](dev-config-deploy-paths) are no longer hardcoded. Most can be configured in [system defaults](topo-defaults) using **defaults.paths** dictionary.
 
 **New devices and daemons:**
 
diff --git a/docs/topology-overview.md b/docs/topology-overview.md
@@ -4,7 +4,7 @@
 Topology description file is a YAML file with these top-level elements:
 
 **defaults** (optional)
-: Topology-wide defaults like default device type. Further default settings are taken from [user- or system-wide defaults](defaults.md).
+: Topology-wide defaults like default device type. Further default settings are taken from [user- or system-wide defaults](topo-defaults).
 
 **addressing** (optional)
 : [IPv4 and IPv6 pools](addressing.md) used to address management, loopback, LAN, P2P and stub interfaces
diff --git a/docs/topology-reference.md b/docs/topology-reference.md
@@ -33,7 +33,7 @@ Finally, you can set these topology-level parameters:
 **Notes:**
 
 * All elements apart from **nodes** are optional -- missing **links** element indicates a topology without inter-node links (just the management interfaces)
-* Default values of **defaults** and **addressing** elements are taken from [default settings](defaults.md).
+* Default values of **defaults** and **addressing** elements are taken from [default settings](topo-defaults).
 * List of modules is used to specify additional initial configuration elements (example: OSPF routing)
 * Default topology name is the directory name[^RBC].
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-(defaults)=`
	`1`	`+(topo-defaults)=`
`2`	`2`	`# Topology Defaults`
`3`	`3`
`4`	`4`	`netlab has dozens of system defaults that specify:`