Configuration

Server Configuration

Configuration file

After the installation, the configuration of gonetem-server is done with the file /etc/gonetem/config.yaml. Below, you will find the configuration by default :

listen: "localhost:10110"
tls:
  enabled: false
  ca: ""
  cert: ""
  key: ""
workdir: /tmp
docker:
  nodes:
    router:
      image: mroy31/gonetem-frr
    host:
      image: mroy31/gonetem-host
    server:
      image: mroy31/gonetem-server
    p4sw:
      image: mroy31/gonetem-bmv2
  extraNodes: []

Description of available options:

  • listen: ip address (or dns name) / port on which the server listen when launched

  • wordir: the directory used by the server to store open project folders (with topology/configurations)

  • tls.*: options to enable and confgure a secure gRPC connection betwwen the console and the server. See TLS/SSL configuration for more detail to secure this connection

  • docker.*: options for docker nodes. See Docker nodes configuration for detail to configure existing nodes and define new one

Pull docker images

Before using gonetem, you have to pull docker images built for it and available on docker hub. For that, you can use the following command after the launch of gonetem-server:

$ gonetem-console pull

Launch server

If you install gonetem manually, you have lo launch gonetem-server with the root right. It is required to execute docker or netlink actions. You can use the following command for example:

$ sudo gonetem-server

Below, you will find available arguments to launch gonetem-server

Usage of gonetem-server:
    -conf-file string
            Configuration path (default "/etc/gonetem/config.yaml")
    -log-file string
            Path of the log file (default: stdout)
    -verbose
            Display more messages

If you use debian package, gonetem-server is launch thanks to systemd.

MPLS support

gonetem supports MPLS. To work, you must enable MPLS features in linux kernel by loading the following modules :

  • mpls_iptunnel

  • mpls_router

Console Configuration

The first time you launch gonetem-console, a configuration file is created at this location: ~/.config/gonetem-console/console.yaml You can view the current configuration with the following command:

$ gonetem-console config show

For each parameter, you can modify the configuration with the command:

$ gonetem-console config set <param-key> <param-value>

For example, to use nano as topology editor, simply enter the command:

$ gonetem-console config set editor nano

For now, the following options are available:

  • server to set the server uri used for connection (default to localhost:10110)

  • editor to select the editor used to edit the topology file (default to vim)

  • terminal to set the command line used to launch a console, default to

xterm -xrm 'XTerm.vt100.allowTitleOps: false' -title {{.Name}} -e {{.Cmd}}

  • tls.[enabled|ca|cert|key] to enabled and set tls options. See TLS/SSL configuration for more detail to secure gRPC connection

For example, if you want to change the font family/size used by xterm, you can enter the following command:

gonetem-console config set terminal "xterm -fa 'Monospace' -fs 13 -xrm 'XTerm.vt100.allowTitleOps: false' -title {{.Name}} -e {{.Cmd}}"