Codespaces p2

.devcontainer/Dockerfile

@@ -0,0 +1,42 @@
+FROM mcr.microsoft.com/devcontainers/python:3.11-bookworm
+
+RUN echo "deb [trusted=yes] https://netdevops.fury.site/apt/ /" | \
+    tee -a /etc/apt/sources.list.d/netdevops.list
+
+# install containerlab and tools
+RUN apt update && \
+    apt install -y --no-install-recommends containerlab \
+    btop \
+    gh \
+    iputils-ping \
+    tcpdump \
+    iproute2 \
+    qemu-kvm \
+    dnsutils \
+    telnet
+
+# Install gNMIc
+RUN bash -c "$(curl -sL https://get-gnmic.openconfig.net)"
+
+# Add empty docker config files to avoid clab warnings for root user
+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
+
+# vscode user is created in the MS devcontainer image
+USER vscode
+
+ENV PATH="$PATH:/home/vscode/.local/bin"
+
+# Create ssh key for vscode user to enable passwordless ssh to devices
+RUN ssh-keygen -t ecdsa -b 256 -N "" -f ~/.ssh/id_ecdsa && \
+    mkdir -p /home/vscode/.docker && \
+    echo "{}" > /home/vscode/.docker/config.json
+
+COPY --chown=vscode:vscode --chmod=700 . /netobs
+
+RUN pip install --upgrade pip && \
+    cd /netobs && \
+    pip install . && \
+    rm -r /netobs/*

.devcontainer/batteries-included/devcontainer.json

@@ -0,0 +1,9 @@
+{
+    "image": "ghcr.io/network-observability/netobs-devcontainer:dev",
+    "hostRequirements": {
+        "cpus": 4,
+        "memory": "8gb",
+        "storage": "32gb"
+    },
+    "postStartCommand": "netobs lab prepare --scenario batteries-included"
+}

.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+    "build": {
+        "dockerfile": "./Dockerfile",
+        "context": ".."
+    },
+    "features": {
+        "ghcr.io/devcontainers/features/docker-in-docker:2": {
+            "version": "latest",
+            "dockerDashComposeVersion": "none"
+        },
+        "ghcr.io/devcontainers/features/sshd:1": {
+            "version": "latest"
+        }
+    },
+    "postCreateCommand": "cp example.env .env && netobs docker build"
+}

.github/workflows/devcontainer-build.yml

@@ -3,30 +3,39 @@ name: Build and Push Dev Container
 on:
   push:
     branches:
-      - main
+      - df/gh-actions
 
 jobs:
   netobs-devcontainer:
+    # permissions: write-all
     runs-on: ubuntu-22.04
 
     steps:
     - name: Checkout code
       uses: actions/checkout@v4
 
-    # - name: Set up Docker Buildx
-    #   uses: docker/setup-buildx-action@v3
+    - name: local test
+      run: |
+        echo "Hello, World!"
+        ls -al
+        echo $PWD
+        ls -al /home/runner/work/network-observability-lab/network-observability-lab/.devcontainer/devcontainer.json
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
 
     - name: Log into registry ghcr.io
       uses: docker/login-action@v3
       with:
         registry: ghcr.io
-        username: ${{ github.repository_owner }}
+        username: ${{ github.actor }}
         password: ${{ secrets.GH_TOKEN }}
 
     - name: Build and push devcontainer image
       uses: devcontainers/[email protected]
       with:
-        imageName: ghcr.io/network-observability-lab/netobs-devcontainer
-        # cacheFrom: ghcr.io/network-observability-lab/netobs-devcontainer
+        imageName: ghcr.io/network-observability/netobs-devcontainer
+        imageTag: latest
+        # cacheFrom: ghcr.io/network-observability/netobs-devcontainer
         # tags: yourusername/yourrepository:tag  # Replace with your Docker image tag
         push: always

.gitignore

@@ -312,4 +312,7 @@ terraform.tfstate
 terraform.tfstate.backup
 local
 
-*keep_api_key
+*keep_api_key
+
+# Dev Containers
+.devcontainer/dev

README.md

@@ -1,3 +1,4 @@
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/network-observability/network-observability-lab?quickstart=1&devcontainer_path=.devcontainer%2Fbatteries-included%2Fdevcontainer.json)
 # Network Observability Lab
 
 This repository contains the resources for building and managing an observability stack within a network lab environment, specifically designed for the "Modern Network Observability" book. It includes scripts, configuration files, and documentation to set up and operate various observability tools like Prometheus, Grafana Loki, and others, helping you implement and learn about network observability practices in a practical, hands-on manner.

example.env

@@ -2,14 +2,9 @@
 # NetObs utility
 ########################################
 LAB_SCENARIO=batteries-included
-LAB_SUDO=false
-# Replace CEOS_IMAGE with your own ceos image version
-CEOS_IMAGE=ceos:4.31.2F
-
-########################################
-# Terraform
-########################################
-TF_VAR_digitalocean_token="your_token"
+LAB_SUDO=true
+# Replace if needed CEOS_IMAGE with your own ceos image version
+# CEOS_IMAGE=ceos:4.31.2F
 
 ########################################
 # Network Agent (Telegraf)

netobs/main.py

@@ -446,6 +446,32 @@ def containerlab_inspect(
 # --------------------------------------#
 
 
+@docker_app.command(rich_help_panel="Docker Stack Management", name="build")
+def docker_build(
+    scenario: Annotated[NetObsScenarios, typer.Option(help="Scenario to execute command", envvar="LAB_SCENARIO")],
+    services: Annotated[list[str], typer.Option(help="Service(s) to build")] = [],
+    verbose: Annotated[bool, typer.Option(help="Verbose mode")] = False,
+):
+    """Build necessary containers.
+
+    [u]Example:[/u]
+
+    To build all services:
+        [i]netobs docker build --scenario batteries-included[/i]
+
+    To build a specific service:
+        [i]netobs docker build telegraf-01 --scenario batteries-included[/i]
+    """
+    console.log(f"Building service(s): [orange1 i]{services}", style="info")
+    run_docker_compose_cmd(
+        action="build",
+        filename=Path(f"./chapters/{scenario.value}/docker-compose.yml"),
+        services=services if services else [],
+        verbose=verbose,
+        task_name="build stack",
+    )
+
+
 @docker_app.command(rich_help_panel="Docker Stack Management", name="exec")
 def docker_exec(
     service: Annotated[str, typer.Argument(help="Service to execute command")],

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "netobs"
-version = "0.0.12"
+version = "0.0.13"
 description = "Utilities and Management Tools for Network Observability Book"
 requires-python = ">=3.9"
 license = {text = "MIT"}
@@ -38,7 +38,7 @@ readme = {file = ["README.md"]}
 
 [tool.black]
 line-length = 120
-target-version = ['py39', 'py310']
+target-version = ['py39', 'py310', 'py311']
 include = '\.pyi?$'
 exclude = '''
 (