Skip to content

config-engine-ui.md

Latest commit

 

History

History
113 lines (74 loc) · 3.41 KB

config-engine-ui.md

File metadata and controls

113 lines (74 loc) · 3.41 KB
Raw

Config Engine User Interface

The web user interface allows you to visualize your topology, inspect magic variables and transmit commands directly from your favorite web browser.

Labctl companion file

When you serve a topology, all the frontend settings, lab layout, label templates and more wil be saved in the same folder as the topology file. The companion file will be created automatically when required and a running server will persist frontend changes in this file.

Topology filename Companion filename
<name>.clab.yml <name>.laabctl.yml

::: warning You should not change the companion file when the server is running, since a running server may overwrite your changes.

Always shut down the server before editing the companion file. :::

Today only suggested commands options>commands cannot be edited from the frontend.

Topology view

The topology view should show up immediately.

Labels

You can create layers of labels.

Inspect variables

The Config Engine UI can show you the magic variables that will be used to render a template. From here you can test these variables on templates.

<script setup> import MagicVars from '../.vitepress/components/magic_vars_ui.vue'; </script> 
 nodes:
  R4:
    kind: nokia-srsim
    config:
      vars:
        clab_system_ip: 192.0.2.4/32
        ipv4_sid_label: 14004
        isis_iid:
          - 1

Execute commands

You can execute "commit", "compare" and "send" commands directly from the UI - you use exactly the same syntax as from the commandline.

Config Engine related flags used on the commandline to serve the frontend

Flag Required Description
--topo -t ✔ the topology file
--template-paths -p ✔ paths to search for templates (in order)

Flags available from within the UI to execute config commands

Flag Description
--template-list -l ✔ template names to render
--filter -f nodes to include

Examples

compare -l bgp -f R1

will compare the template named bgp__<role>.tmpl ONLY to node R1

commit -l bgp

will commit the template named bgp__<role>.tmpl to all nodes in the topology

send -l show-route-table -f R1,R2

will send the template show-route-table_<role>.tmpl to node R1 and R2 only

Suggested commands

You can add suggested commands to the project's README.md file. They will be displayed on the Config Engine 📖 screen.

You can use Markdown links with config commands, for example:

  • [compare -l ports](config:)
  • [commit -l ports](config:)
  • [send -l show-route-table](config:)

You can also use path links to highlight paths on the topology

  • [path 1](path:9,4,3,10)
  • [path 2](path:9,4,11,12,10)
  • [0,1,2,3,4,5,6,7,8,9,10,11,12](path:)

When you use empty config: or path: URLs in the markdown links, the links's Text will be used. That means these links are the same:

  • [compare -l ports](config:) == [compare -l ports](config:compare -l ports)