Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

allow for SR OS configuration persistency #249

Merged
merged 2 commits into from
Jan 28, 2021
Merged

allow for SR OS configuration persistency #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8da6b5
added support for vr-sros config statement
hellt Jan 27, 2021
4c0b734
added doc note about sr os config
hellt Jan 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 19 additions & 20 deletions clab/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@ const (
var kinds = []string{"srl", "ceos", "crpd", "sonic-vs", "vr-sros", "vr-vmx", "vr-xrv", "linux", "bridge"}

var defaultConfigTemplates = map[string]string{
"srl": "/etc/containerlab/templates/srl/srlconfig.tpl",
"ceos": "/etc/containerlab/templates/arista/ceos.cfg.tpl",
"crpd": "/etc/containerlab/templates/crpd/juniper.conf",
"srl": "/etc/containerlab/templates/srl/srlconfig.tpl",
"ceos": "/etc/containerlab/templates/arista/ceos.cfg.tpl",
"crpd": "/etc/containerlab/templates/crpd/juniper.conf",
"vr-sros": "",
}

var srlTypes = map[string]string{
Expand Down Expand Up @@ -264,19 +265,17 @@ func (c *CLab) typeInit(nodeCfg *NodeConfig, kind string) string {
return ""
}

func (c *CLab) configInitialization(nodeCfg *NodeConfig, kind string) string {
if nodeCfg.Config != "" {
func (c *CLab) configInit(nodeCfg *NodeConfig, kind string) string {
switch {
case nodeCfg.Config != "":
return nodeCfg.Config
}
if kindConfig, ok := c.Config.Topology.Kinds[kind]; ok {
if kindConfig.Config != "" {
return kindConfig.Config
}
}
if c.Config.Topology.Defaults.Config != "" {
case c.Config.Topology.Kinds[kind].Config != "":
return c.Config.Topology.Kinds[kind].Config
case c.Config.Topology.Defaults.Config != "":
return c.Config.Topology.Defaults.Config
default:
return defaultConfigTemplates[kind]
}
return defaultConfigTemplates[kind]
}

func (c *CLab) imageInitialization(nodeCfg *NodeConfig, kind string) string {
Expand Down Expand Up @@ -391,7 +390,7 @@ func (c *CLab) NewNode(nodeName string, nodeCfg NodeConfig, idx int) error {
switch node.Kind {
case "ceos":
// initialize the global parameters with defaults, can be overwritten later
node.Config = c.configInitialization(&nodeCfg, node.Kind)
node.Config = c.configInit(&nodeCfg, node.Kind)
node.Image = c.imageInitialization(&nodeCfg, node.Kind)
node.Position = c.positionInitialization(&nodeCfg, node.Kind)

Expand Down Expand Up @@ -420,7 +419,7 @@ func (c *CLab) NewNode(nodeName string, nodeCfg NodeConfig, idx int) error {

case "srl":
// initialize the global parameters with defaults, can be overwritten later
node.Config = c.configInitialization(&nodeCfg, node.Kind)
node.Config = c.configInit(&nodeCfg, node.Kind)

lp, err := c.licenseInit(&nodeCfg, node)
if err != nil {
Expand Down Expand Up @@ -485,7 +484,7 @@ func (c *CLab) NewNode(nodeName string, nodeCfg NodeConfig, idx int) error {
node.Binds = append(node.Binds, fmt.Sprint(topoPath, ":/tmp/topology.yml:ro"))

case "crpd":
node.Config = c.configInitialization(&nodeCfg, node.Kind)
node.Config = c.configInit(&nodeCfg, node.Kind)
node.Image = c.imageInitialization(&nodeCfg, node.Kind)
node.Group = c.groupInitialization(&nodeCfg, node.Kind)
node.Position = c.positionInitialization(&nodeCfg, node.Kind)
Expand All @@ -509,7 +508,7 @@ func (c *CLab) NewNode(nodeName string, nodeCfg NodeConfig, idx int) error {
node.Binds = append(node.Binds, fmt.Sprint(path.Join(node.LabDir, "config/sshd_config"), ":/etc/ssh/sshd_config"))

case "sonic-vs":
node.Config = c.configInitialization(&nodeCfg, node.Kind)
node.Config = c.configInit(&nodeCfg, node.Kind)
node.Image = c.imageInitialization(&nodeCfg, node.Kind)
node.Group = c.groupInitialization(&nodeCfg, node.Kind)
node.Position = c.positionInitialization(&nodeCfg, node.Kind)
Expand All @@ -519,7 +518,7 @@ func (c *CLab) NewNode(nodeName string, nodeCfg NodeConfig, idx int) error {
node.Entrypoint = "/bin/bash"

case "vr-sros":
node.Config = c.configInitialization(&nodeCfg, node.Kind)
node.Config = c.configInit(&nodeCfg, node.Kind)
node.Image = c.imageInitialization(&nodeCfg, node.Kind)
node.Group = c.groupInitialization(&nodeCfg, node.Kind)
node.Position = c.positionInitialization(&nodeCfg, node.Kind)
Expand Down Expand Up @@ -548,7 +547,7 @@ func (c *CLab) NewNode(nodeName string, nodeCfg NodeConfig, idx int) error {
// mount tftpboot dir
node.Binds = append(node.Binds, fmt.Sprint(path.Join(node.LabDir, "tftpboot"), ":/tftpboot"))

node.Cmd = fmt.Sprintf("--num-nics %s --connection-mode %s --hostname %s --variant %s", node.Env["NUM_NICS"], node.Env["CONNECTION_MODE"], node.ShortName, node.NodeType)
node.Cmd = fmt.Sprintf("--trace --num-nics %s --connection-mode %s --hostname %s --variant %s", node.Env["NUM_NICS"], node.Env["CONNECTION_MODE"], node.ShortName, node.NodeType)

case "vr-vmx":
node.Image = c.imageInitialization(&nodeCfg, node.Kind)
Expand Down Expand Up @@ -583,7 +582,7 @@ func (c *CLab) NewNode(nodeName string, nodeCfg NodeConfig, idx int) error {
node.Cmd = fmt.Sprintf("--username %s --password %s --hostname %s --connection-mode %s --trace", node.Env["USERNAME"], node.Env["PASSWORD"], node.ShortName, node.Env["CONNECTION_MODE"])

case "alpine", "linux":
node.Config = c.configInitialization(&nodeCfg, node.Kind)
node.Config = c.configInit(&nodeCfg, node.Kind)
node.Image = c.imageInitialization(&nodeCfg, node.Kind)
node.Group = c.groupInitialization(&nodeCfg, node.Kind)
node.Position = c.positionInitialization(&nodeCfg, node.Kind)
Expand Down
10 changes: 10 additions & 0 deletions clab/file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,16 @@ func (c *CLab) CreateNodeDirStructure(node *Node) (err error) {
return fmt.Errorf("file copy [src %s -> dst %s] failed %v", src, dst, err)
}
log.Debugf("CopyFile src %s -> dst %s succeeded", src, dst)

cfg := path.Join(node.LabDir, "tftpboot", "config.txt")
if node.Config != "" {
err = node.generateConfig(cfg)
if err != nil {
log.Errorf("node=%s, failed to generate config: %v", node.ShortName, err)
}
} else {
log.Debugf("Config file exists for node %s", node.ShortName)
}
}
case "bridge":
default:
Expand Down
14 changes: 14 additions & 0 deletions docs/manual/kinds/vr-sros.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,20 @@ Data interfaces `eth1+` needs to be configured with IP addressing manually using
### Node configuration
vr-sros nodes come up with a basic "blank" configuration where only the card/mda are provisioned, as well as the management interfaces such as Netconf, SNMP, gNMI.

#### User defined config
It is possible to make SR OS nodes to boot up with a user-defined config instead of a built-in one. With a [`config`](../nodes.md#config) property of the node/kind a user sets the path to the config file that will be mounted to a container and used as a startup config:

```yaml
name: sros_lab
topology:
nodes:
sros:
kind: vr-sros
config: myconfig.txt
```

With such topology file containerlab is instructed to take a file `myconfig.txt` from the current working directory, copy it to the lab directory for that specific node under the `/tftpboot/config.txt` name and mount that dir to the container. This will result in this config to act as a startup config for the node.

### License
Path to a valid license must be provided for all vr-sros nodes with a [`license`](../nodes.md#license) directive.

Expand Down