Network Topology#
Workflows → NTNetwork Topologies
Documentation coming soon!
Custom Resource Definition#
To browse the Custom Resource Definition go to crd.eda.dev.
NetworkTopology
SPEC
-
Configure dry run mode and prompts for topology operations.
-
Enabling the Dry Run will run the transaction with the calculated changes to the topology resources in the dry run mode and pause the workflow awaiting users confirmation.
default: false -
Prompts can be configured to request user confirmation before creating, replacing, or deleting topology resources, regardless if Dry Run is enabled or not. This can be configured per operation type (BeforeCreate, BeforeReplace, BeforeDelete).
-
-
Define the link parameters that are meant to be inherited by the topology links referencing the template. These parameters can be overridden at the link level.
-
-
Breakout endpoints propertiesfor the link
-
-
Enable or disable VLAN tagging on Interfaces created by the TopoLink.
default: "Null"enum: "Null", "Dot1q" -
The name of the TopoLinkTemplate.
-
Speed of the link.
enum: "800G", "400G", "200G", +8 more -
Specify the type of link. If type is set to edge, topology information for the remote device can be set; when doing so the Remote Node can be set as the hostname of the remote device and Remote Interface as the remote interface name in the device specific format, e.g. eth0.
enum: "Edge", "InterSwitch", "Loopback"
-
-
Define the set of topology links to be created/replaced/deleted. A link can reference a link template to inherit its parameters.
-
-
Enable or disable VLAN tagging on Interfaces created by the TopoLink
enum: "Null", "Dot1q" -
Define the set of physical links making up this TopoLink.
-
-
Sim endpoint of the link.
-
The SimNode to which the interface will be mapped. This is the name of the SimNode as it is defined in the SimTopology.
-
The name of the interface to present to the SimNode to which the interface will be mapped. If not provided the interface name will be generated starting with "eth1", "eth2", ... . This is the interface name as it will appear in the SimNode.
-
-
Speed of the link.
enum: "800G", "400G", "200G", +8 more -
Specify the type of link. If type is set to edge, topology information for the remote device can be set; when doing so the Remote Node can be set as the hostname of the remote device and Remote Interface as the remote interface name in the device specific format, e.g. eth0.
enum: "Edge", "InterSwitch", "Loopback"
-
-
The name of the TopoLink
-
Reference to a template to use for this TopoLink.
-
-
Define the node parameters that are meant to be inherited by the topology nodes referencing the template. These parameters can be overridden at the node level.
-
-
List of components within the TopoNode. Used to define the type and location of linecards, fabrics (SFM), media adapter cards (MDA) and control cards (CPM).
-
-
The kind of Component, e.g. lineCard.
enum: "controlCard", "lineCard", "fabric", +5 more -
The slot this Component resides in, unset for Components that do not have a slot or ID. e.g. 1 would denote the linecard slot 1, 1/1 would denote linecard slot 1 mda slot 1.
-
Denotes the type of hardware being provisioned, e.g. xcm-x20.
-
-
-
Reference to a ConfigMap containing a license for the TopoNode. Overrides the license set in the referenced NodeProfile, if present.
-
The name of the TopoNodeTemplate.
-
Reference to a NodeProfile to use with this TopoNode.
-
Platform type of this TopoNode, e.g. 7220 IXR-D3L.
-
List of satellite nodes to be inherited by nodes using this template.
-
-
Components for the satellite node.
-
-
The kind of Component, e.g. lineCard.
enum: "controlCard", "lineCard", "fabric", +5 more -
The slot this Component resides in, unset for Components that do not have a slot or ID. e.g. 1 would denote the linecard slot 1, 1/1 would denote linecard slot 1 mda slot 1.
-
Denotes the type of hardware being provisioned, e.g. xcm-x20.
-
-
-
ID of the satellite node.
-
MAC Address of the satellite node.
-
Platform of the satellite node.
-
Port template to be used for the satellite node.
-
Satellite profile to be used for the satellite node.
-
Type of the satellite node.
-
-
-
-
Define the set of topology nodes to be created/replaced/deleted. A node can reference a node template to inherit its parameters.
-
-
List of components within the TopoNode. Used to define the type and location of linecards, fabrics (SFM), media adapter cards (MDA) and control cards (CPM).
-
-
The kind of Component, e.g. lineCard.
enum: "controlCard", "lineCard", "fabric", +5 more -
The slot this Component resides in, unset for Components that do not have a slot or ID. e.g. 1 would denote the linecard slot 1, 1/1 would denote linecard slot 1 mda slot 1.
-
Denotes the type of hardware being provisioned, e.g. xcm-x20.
-
-
-
Reference to a ConfigMap containing a license for the TopoNode. Overrides the license set in the referenced NodeProfile, if present.
-
MAC address to associate with this TopoNode. Typically the chassis MAC address, optionally sent by a node in DHCP requests. Not required when a TopoNode is not being bootstrapped by EDA, or is simulated through CX.
-
The name of the TopoNode
-
Reference to a NodeProfile to use with this TopoNode.
-
Options relating to NPP interactions with the node.
-
The mode in which this TopoNode is functioning. "normal" (the default) indicates that NPP is expecting an endpoint to exist, and will accept and confirm changes only if the endpoint accepts them. "maintenance" indicates that no changes will be accepted for the TopoNode, irrespective if the endpoint is up and reachable. The exception is if an upgrade is occuring, in which case changes will be accepted. "null" indicates that changes will be accepted from CRs and no NPP will be spun up. NPP validation will not occur. This may be useful in playground mode to avoid spinning up of 1000s of NPPs. "emulate" indicates that changes will be accepted at the NPP level, without pushing them to a endpoint. NPP validation still occurs. If no IP address is present, we also run in emulate mode. "monitor" indicates that state will be collectd but config will not be pushed to a endpoint. NPP validation still occurs.
default: "normal"enum: "normal", "maintenance", "null", +2 more
-
-
Indicates if this TopoNode has been bootstrapped or is reachable via configured credentials. Set by BootstrapServer when it completes onboarding functions for a given TopoNode. Most applications ignore TopoNodes that have not been onboarded yet.
default: false -
Operating system running on this TopoNode, e.g. srl.
enum: "srl", "sros", "eos", +3 more -
Platform type of this TopoNode, e.g. 7220 IXR-D3L.
-
Production address of this TopoNode - this is the address the real, production instance of this TopoNode uses. If left blank, an address will be allocated from the management IP pool specified in the referenced NodeProfile. If this TopoNode is not bootstrapped by EDA this field must be provided.
-
The IPv4 production address
-
The IPv6 production address
-
-
List of satellite nodes to be inherited by this TopoNode.
-
-
Components for the satellite node.
-
-
The kind of Component, e.g. lineCard.
enum: "controlCard", "lineCard", "fabric", +5 more -
The slot this Component resides in, unset for Components that do not have a slot or ID. e.g. 1 would denote the linecard slot 1, 1/1 would denote linecard slot 1 mda slot 1.
-
Denotes the type of hardware being provisioned, e.g. xcm-x20.
-
-
-
ID of the satellite node.
-
MAC Address of the satellite node.
-
Platform of the satellite node.
-
Port template to be used for the satellite node.
-
Satellite profile to be used for the satellite node.
-
Type of the satellite node.
-
-
-
Serial number of this TopoNode, optionally sent by a node in DHCP requests. Not required when a TopoNode is not being bootstrapped by EDA, or is simulated through CX.
-
Deprecated: Name of the Interface resource representing the primary loopback on the TopoNode, this field will be removed in the future version.
-
Reference to a template to use for this TopoNode.
-
Sets the software version of this TopoNode, e.g. 24.7.1 (for srl), or 24.7.r1 (for sros).
-
-
Operation to be performed on the Topology. Create - creates the topology resources based on the provided specifications. Replace - replaces the resources matched by name with the provided specifications. ReplaceAll - first removes all existing topology resources and then creates new ones based on the provided specifications. Delete - deletes the resources matched by name. DeleteAll - deletes all topology resources found in the namespace. Reconcile - reconciles the topology resources based on the provided specifications. One of Create, Replace, ReplaceAll, Delete, DeleteAll, Reconcile.
default: "Reconcile"enum: "Create", "Replace", "ReplaceAll", +3 more -
http(s) location of the topology input in YAML format to deploy. Providing the remote location will discard any topology resources provided in the spec of the workflow.
-
Define the satellite port templates that are meant to be inherited by the satellite nodes referencing the template. These parameters can be overridden at the satellite node level.
-
Satellite Port Templates
-
List of connector components within the SatellitePortTemplate. Used to define the type and location of connectors.
-
-
The kind of Component, e.g. lineCard.
enum: "controlCard", "lineCard", "fabric", +5 more -
The slot this Component resides in, unset for Components that do not have a slot or ID. e.g. 1 would denote the linecard slot 1, 1/1 would denote linecard slot 1 mda slot 1.
-
Denotes the type of hardware being provisioned, e.g. xcm-x20.
-
-
-
The name of the SatellitePortTemplate.
-
-
-
Specify simulation topology configuration.
-
Define the simulation node (sim node) parameters that are meant to be inherited by the simulation nodes referencing the template. These parameters can be overridden at the sim node level.
-
-
The image to use for this SimNode. This is the full path to the image as it would be provided to the container runtime.
-
Reference to a Secret to use when pulling the image for this simNode.
-
The name of the template.
-
Type defines what is type of this SimNode.
enum: "Linux", "TestMan", "SrlTest"
-
-
Define the sim node to be created/replaced/deleted. A sim node can reference a sim node template to inherit its parameters.
-
-
The image to use for this SimNode. This is the full path to the image as it would be provided to the container runtime.
-
Reference to a Secret to use when pulling the image for this simNode
-
The name of the SimNode. This is the name that will be used to reference the SimNode in the SimTopology.
-
Reference to a template to use for this SimNode.
-
Type defines what is type of this SimNode
enum: "Linux", "TestMan", "SrlTest"
-
-
Define the simulation topology to be created/replaced/deleted by providing the list of nodes/interfaces and their corresponding sim nodes/sim node interfaces.
-
-
Normalized name of an interface/port. This is the normalized name of the interface in the TopoNode, for example 'ethernet-1-1'. The value of "*" indicates all interfaces on the TopoNode/s.
-
The TopoNode on which interfaces will be mapped to a SimNode. You may use the value "*" to indicate all TopoNodes.
-
The SimNode to which the interface will be mapped. This is the name of the SimNode as it is defined in the SimTopology.
-
The name of the interface to present to the SimNode to which the interface will be mapped. If not provided the interface name will be generated starting with "eth1", "eth2",... This is the interface name as it will appear in the SimNode.
-
-
-
STATUS
NetworkTopologyStatus defines the observed state of NetworkTopology
-
Human-readable message providing additional context about the operation result
-
Detailed breakdown of resources processed during the operation
-
Total duration of the topology operation
-
Total number of resources processed across all types
-
Overall result of the topology operation
enum: "Success", "Failed"