Merge branch 'main' into docs-publish

Author: hellt

.devcontainer/Dockerfile

@@ -42,6 +42,10 @@ RUN mkdir -p /root/.docker && echo "{}" > /root/.docker/config.json
 # Maintain SSH_AUTH_SOCK env var when using sudo
 RUN mkdir -p /etc/sudoers.d && echo 'Defaults env_keep += "SSH_AUTH_SOCK"' > /etc/sudoers.d/ssh_auth_sock
 
+# Add vscode user to clab_admins group so that it can run sudo-less clab commands
+# the group is created when clab is installed via the installation script
+RUN usermod -aG clab_admins vscode
+
 # Switch to the vscode user provided by the base image
 USER vscode
 

.devcontainer/docker-in-docker/devcontainer.json

@@ -52,7 +52,9 @@
                 "yzhang.markdown-all-in-one",
                 "davidanson.vscode-markdownlint",
                 // proto
-                "zxh404.vscode-proto3"
+                "zxh404.vscode-proto3",
+                // containerlab
+                "srl-labs.vscode-containerlab"
             ]
         }
     },

.devcontainer/docker-in-docker_slim/devcontainer.json

@@ -39,7 +39,9 @@
                 "redhat.vscode-yaml",
                 // markdown
                 "yzhang.markdown-all-in-one",
-                "davidanson.vscode-markdownlint"
+                "davidanson.vscode-markdownlint",
+                // containerlab
+                "srl-labs.vscode-containerlab"
             ]
         }
     },

.devcontainer/docker-outside-of-docker/devcontainer.json

@@ -58,7 +58,9 @@
                 "yzhang.markdown-all-in-one",
                 "davidanson.vscode-markdownlint",
                 // proto
-                "zxh404.vscode-proto3"
+                "zxh404.vscode-proto3",
+                // containerlab
+                "srl-labs.vscode-containerlab"
             ]
         }
     },

.devcontainer/docker-outside-of-docker_slim/devcontainer.json

@@ -48,7 +48,9 @@
                 "redhat.vscode-yaml",
                 // markdown
                 "yzhang.markdown-all-in-one",
-                "davidanson.vscode-markdownlint"
+                "davidanson.vscode-markdownlint",
+                // containerlab
+                "srl-labs.vscode-containerlab"
             ]
         }
     },

.devcontainer/slim.Dockerfile

@@ -38,6 +38,10 @@ RUN mkdir -p /root/.docker && echo "{}" > /root/.docker/config.json
 # Maintain SSH_AUTH_SOCK env var when using sudo
 RUN mkdir -p /etc/sudoers.d && echo 'Defaults env_keep += "SSH_AUTH_SOCK"' > /etc/sudoers.d/ssh_auth_sock
 
+# Add vscode user to clab_admins group so that it can run sudo-less clab commands
+# the group is created when clab is installed via the installation script
+RUN usermod -aG clab_admins vscode
+
 # Switch to the vscode user provided by the base image
 USER vscode
 

.github/workflows/cicd.yml

@@ -11,9 +11,9 @@ on:
   workflow_dispatch:
 
 env:
-  GO_VER: "1.22.6"
+  GO_VER: "1.22.11"
   CGO_ENABLED: 0
-  MKDOCS_INS_VER: 9.5.9-insiders-4.52.2-hellt
+  MKDOCS_INS_VER: 9.6.1-insiders-4.53.15-hellt
   GORELEASER_VER: v2.6.1
   PY_VER: "3.10"
 

.github/workflows/force-build.yml

@@ -7,7 +7,7 @@ on:
 
 # make sure those env vars are aligned with the ones in ci-cd.yml workflow
 env:
-  GO_VER: "1.22.6"
+  GO_VER: "1.22.11"
   CGO_ENABLED: 0
   MKDOCS_INS_VER: 9.5.9-insiders-4.52.2-hellt
   GORELEASER_VER: v2.0.1

.gitignore

@@ -46,4 +46,5 @@ tests/out
 
 
 # readd test labDir files
-!clab/test_data/clab-*
+!clab/test_data/clab-*
+__pycache__

Makefile

@@ -1,9 +1,9 @@
 BIN_DIR = $(CURDIR)/bin
 BINARY = $(BIN_DIR)/containerlab
-MKDOCS_VER = 9.5.9
+MKDOCS_VER = 9.6.1
 # insiders version/tag https://github.com/srl-labs/mkdocs-material-insiders/pkgs/container/mkdocs-material-insiders
 # make sure to also change the mkdocs version in actions' cicd.yml and force-build.yml files
-MKDOCS_INS_VER = 9.5.9-insiders-4.52.2-hellt
+MKDOCS_INS_VER = 9.6.1-insiders-4.53.15-hellt
 
 DATE := $(shell date)
 COMMIT_HASH := $(shell git rev-parse --short HEAD)
@@ -17,36 +17,52 @@ all: build
 build:
 	mkdir -p $(BIN_DIR)
 	CGO_ENABLED=0 go build -o $(BINARY) -ldflags="$(LDFLAGS)" main.go
+	sudo chown root:root $(BINARY)
+	sudo chmod 4755 $(BINARY)
 
 build-linux-arm64:
 	mkdir -p $(BIN_DIR)
 	GOOS=linux GOARCH=arm64 go build -o $(BINARY) -ldflags="$(LDFLAGS)" main.go
+	sudo chown root:root $(BINARY)
+	sudo chmod 4755 $(BINARY)
 
 build-linux-amd64:
 	mkdir -p $(BIN_DIR)
 	GOOS=linux GOARCH=amd64 go build -o $(BINARY) -ldflags="$(LDFLAGS)" main.go
+	sudo chown root:root $(BINARY)
+	sudo chmod 4755 $(BINARY)
 
 build-with-cover:
 	mkdir -p $(BIN_DIR)
 	go build -cover -o $(BINARY) -ldflags="$(LDFLAGS)" main.go
+	sudo chown root:root $(BINARY)
+	sudo chmod 4755 $(BINARY)
 
 build-debug:
 	mkdir -p $(BIN_DIR)
 	go build -o $(BINARY) -gcflags=all="-N -l" -race -cover main.go
+	sudo chown root:root $(BINARY)
+	sudo chmod 4755 $(BINARY)
 
 build-dlv-debug:
 	mkdir -p $(BIN_DIR)
 	go build -o $(BINARY) -gcflags=all="-N -l" main.go
+	sudo chown root:root $(BINARY)
+	sudo chmod 4755 $(BINARY)
 
 
 build-with-podman:
 	mkdir -p $(BIN_DIR)
 	CGO_ENABLED=0 go build -o $(BINARY) -ldflags="$(LDFLAGS)" -trimpath -tags "podman exclude_graphdriver_btrfs btrfs_noversion exclude_graphdriver_devicemapper exclude_graphdriver_overlay containers_image_openpgp" main.go
 	chmod a+x $(BINARY)
+	sudo chown root:root $(BINARY)
+	sudo chmod 4755 $(BINARY)
 
 build-with-podman-debug:
 	mkdir -p $(BIN_DIR)
 	CGO_ENABLED=1 go build -o $(BINARY) -gcflags=all="-N -l" -race -cover -trimpath -tags "podman exclude_graphdriver_btrfs btrfs_noversion exclude_graphdriver_devicemapper exclude_graphdriver_overlay containers_image_openpgp" main.go
+	sudo chown root:root $(BINARY)
+	sudo chmod 4755 $(BINARY)
 
 convert-coverage:
 	go tool covdata textfmt -i=/tmp/clab-tests/coverage -o coverage.out
@@ -128,20 +144,20 @@ htmltest:
 .PHONY: oci-push
 oci-push: build-with-podman
 	@echo
-	@echo "With the following pull command you get a containerlab binary at your working directory. To use this downloaded binary - ./containerlab deploy.... Make sure not forget to add ./ prefix in order to use the downloaded binary and not the globally installed containerlab!"
-	@echo 'If https proxy is configured in your environment, pass the proxies via --env HTTPS_PROXY="<proxy-address>" flag of the docker run command.'
 # push to ttl.sh
 #	docker run --rm -v $(CURDIR)/bin:/workspace ghcr.io/oras-project/oras:v1.1.0 push ttl.sh/clab-$(COMMIT_HASH):1d ./containerlab
 #	@echo "download with: docker run --rm -v \$$(pwd):/workspace ghcr.io/oras-project/oras:v1.1.0 pull ttl.sh/clab-$(COMMIT_HASH):1d"
 # push to ghcr.io
 	@echo ""
 	docker run --rm -v $(CURDIR)/bin:/workspace -v $${HOME}/.docker/config.json:/root/.docker/config.json ghcr.io/oras-project/oras:v1.1.0 push ghcr.io/srl-labs/clab-oci:$(COMMIT_HASH) ./containerlab
+	@echo "With the following pull command you get a containerlab binary at your working directory. To use this downloaded binary - ./containerlab deploy.... Make sure not forget to add ./ prefix in order to use the downloaded binary and not the globally installed containerlab!"
+	@echo 'If https proxy is configured in your environment, pass the proxies via --env HTTPS_PROXY="<proxy-address>" flag of the docker run command.'
 	@echo "download with: sudo docker run --rm -v \$$(pwd):/workspace ghcr.io/oras-project/oras:v1.1.0 pull ghcr.io/srl-labs/clab-oci:$(COMMIT_HASH)"
 
 oci-arm-push: build-linux-arm64
 	@echo
-	@echo "With the following pull command you get a containerlab binary at your working directory. To use this downloaded binary - do `chmod +x ./containerlab` and then `./containerlab deploy`. Make sure not forget to add ./ prefix in order to use the downloaded binary and not the globally installed containerlab!"
-	@echo 'If https proxy is configured in your environment, pass the proxies via --env HTTPS_PROXY="<proxy-address>" flag of the docker run command.'
 	@echo ""
 	docker run --rm -v $(CURDIR)/bin:/workspace -v $${HOME}/.docker/config.json:/root/.docker/config.json ghcr.io/oras-project/oras:v1.1.0 push ghcr.io/srl-labs/clab-oci:$(COMMIT_HASH) ./containerlab
+	@echo "With the following pull command you get a containerlab binary at your working directory. To use this downloaded binary - do `chmod +x ./containerlab` and then `./containerlab deploy`. Make sure not forget to add ./ prefix in order to use the downloaded binary and not the globally installed containerlab!"
+	@echo 'If https proxy is configured in your environment, pass the proxies via --env HTTPS_PROXY="<proxy-address>" flag of the docker run command.'
 	@echo "download with: sudo docker run --rm -v \$$(pwd):/workspace ghcr.io/oras-project/oras:v1.1.0 pull ghcr.io/srl-labs/clab-oci:$(COMMIT_HASH)"

README.md

@@ -3,9 +3,8 @@
 [![github release](https://img.shields.io/github/release/srl-labs/containerlab.svg?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://github.com/srl-labs/containerlab/releases/)
 [![Github all releases](https://img.shields.io/github/downloads/srl-labs/containerlab/total.svg?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://github.com/srl-labs/containerlab/releases/)
 [![Doc](https://img.shields.io/badge/Docs-containerlab.dev-blue?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://containerlab.dev)
-[![Twitter](https://img.shields.io/badge/follow-%40go_containerlab-1DA1F2?logo=twitter&style=flat-square&color=00c9ff&labelColor=bec8d2)](https://twitter.com/go_containerlab)
+[![Bluesky](https://img.shields.io/badge/follow-containerlab-1DA1F2?logo=bluesky&style=flat-square&color=00c9ff&labelColor=bec8d2)](https://bsky.app/profile/containerlab.dev)
 [![Discord](https://img.shields.io/discord/860500297297821756?style=flat-square&label=discord&logo=discord&color=00c9ff&labelColor=bec8d2)](https://discord.gg/vAyddtaEV9)
-[![Go Report](https://img.shields.io/badge/go%20report-A%2B-blue?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://goreportcard.com/report/github.com/srl-labs/containerlab)
 
 ---
 

clab/config.go

@@ -557,6 +557,7 @@ func (c *CLab) addDefaultLabels(n nodes.Node) {
 
 	cfg.Labels[labels.Containerlab] = c.Config.Name
 	cfg.Labels[labels.NodeName] = cfg.ShortName
+	cfg.Labels[labels.LongName] = cfg.LongName
 	cfg.Labels[labels.NodeKind] = cfg.Kind
 	cfg.Labels[labels.NodeType] = cfg.NodeType
 	cfg.Labels[labels.NodeGroup] = cfg.Group

clab/config_test.go

@@ -364,6 +364,7 @@ func TestLabelsInit(t *testing.T) {
 			want: map[string]string{
 				labels.Containerlab: "topo1",
 				labels.NodeName:     "node1",
+				labels.LongName:     "clab-topo1-node1",
 				labels.NodeKind:     "nokia_srlinux",
 				labels.NodeType:     "ixrd2l",
 				labels.NodeGroup:    "",
@@ -378,6 +379,7 @@ func TestLabelsInit(t *testing.T) {
 			want: map[string]string{
 				labels.Containerlab: "topo1",
 				labels.NodeName:     "node2",
+				labels.LongName:     "clab-topo1-node2",
 				labels.NodeKind:     "nokia_srlinux",
 				labels.NodeType:     "ixrd2l",
 				labels.NodeGroup:    "",
@@ -394,6 +396,7 @@ func TestLabelsInit(t *testing.T) {
 			want: map[string]string{
 				labels.Containerlab: "topo2",
 				labels.NodeName:     "node1",
+				labels.LongName:     "clab-topo2-node1",
 				labels.NodeKind:     "nokia_srlinux",
 				labels.NodeType:     "ixrd2l",
 				labels.NodeGroup:    "",
@@ -409,6 +412,7 @@ func TestLabelsInit(t *testing.T) {
 			want: map[string]string{
 				labels.Containerlab: "topo3",
 				labels.NodeName:     "node2",
+				labels.LongName:     "clab-topo3-node2",
 				labels.NodeKind:     "nokia_srlinux",
 				labels.NodeType:     "ixrd2l",
 				labels.NodeGroup:    "",

cmd/common/common.go

@@ -0,0 +1,28 @@
+package common
+
+import (
+	"time"
+)
+
+var (
+	Debug   bool
+	Timeout time.Duration
+)
+
+// path to the topology file.
+var Topo string
+
+var (
+	VarsFile string
+	Graph    bool
+	Runtime  string
+)
+
+// subset of nodes to work with.
+var NodeFilter []string
+
+// lab Name.
+var Name string
+
+// Use graceful shutdown.
+var Graceful bool

cmd/common/sudo.go

@@ -48,7 +48,7 @@ func CheckAndGetRootPrivs(_ *cobra.Command, _ []string) error {
 			}
 
 			if !slices.Contains(effUserGroupIDs, clabGroup.Gid) {
-				return fmt.Errorf("user '%v' is not part of containerlab admin group 'clab_admins' (GID %v), which is required to execute this command.\nTo add yourself to this group, run the following command:\n\t$ sudo gpasswd -a %v clab_admins",
+				return fmt.Errorf("user '%v' is not part of containerlab admin group 'clab_admins' (GID %v), which is required to execute this command.\nTo add yourself to this group, run the following command:\n\t$ sudo usermod -aG clab_admins %v",
 					currentEffUser.Username, clabGroup.Gid, currentEffUser.Username)
 			}
 

cmd/config.go

@@ -9,6 +9,7 @@ import (
 	"github.com/srl-labs/containerlab/clab"
 	"github.com/srl-labs/containerlab/clab/config"
 	"github.com/srl-labs/containerlab/clab/config/transport"
+	"github.com/srl-labs/containerlab/cmd/common"
 	"github.com/srl-labs/containerlab/nodes"
 
 	log "github.com/sirupsen/logrus"
@@ -59,10 +60,10 @@ func configRun(_ *cobra.Command, args []string) error {
 	config.DebugCount = debugCount
 
 	c, err := clab.NewContainerLab(
-		clab.WithTimeout(timeout),
-		clab.WithTopoPath(topo, varsFile),
-		clab.WithNodeFilter(nodeFilter),
-		clab.WithDebug(debug),
+		clab.WithTimeout(common.Timeout),
+		clab.WithTopoPath(common.Topo, common.VarsFile),
+		clab.WithNodeFilter(common.NodeFilter),
+		clab.WithDebug(common.Debug),
 	)
 	if err != nil {
 		return err
@@ -156,7 +157,7 @@ func init() {
 		"comma separated list of nodes to include")
 	configCmd.Flags().SortFlags = false
 
-	configCmd.Flags().StringSliceVarP(&nodeFilter, "node-filter", "", []string{},
+	configCmd.Flags().StringSliceVarP(&common.NodeFilter, "node-filter", "", []string{},
 		"comma separated list of nodes to include")
 
 	configCmd.AddCommand(configSendCmd)

cmd/config_template.go

@@ -4,6 +4,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/srl-labs/containerlab/clab"
 	"github.com/srl-labs/containerlab/clab/config"
+	"github.com/srl-labs/containerlab/cmd/common"
 )
 
 // Show the template variable s.
@@ -22,9 +23,9 @@ var configTemplateCmd = &cobra.Command{
 		config.DebugCount = debugCount
 
 		c, err := clab.NewContainerLab(
-			clab.WithTimeout(timeout),
-			clab.WithTopoPath(topo, varsFile),
-			clab.WithDebug(debug),
+			clab.WithTimeout(common.Timeout),
+			clab.WithTopoPath(common.Topo, common.VarsFile),
+			clab.WithDebug(common.Debug),
 		)
 		if err != nil {
 			return err