Release 0.21.2 (#115)

* Enabled Firmware Update (FOTA) v3 in Debian BYOC dockerimage

* Added support to demonstrate updating a component COMP_1 other than MAIN

* Fixed FOTA over CoAP

* Re-register after update to reach desired state in server

* Dockerfile BYOC and Dev: enable core dump

* Updated mbed-cloud-client 4.13.3

* Added documentation

* Added connectivity issue troubleshooting steps

---------

Co-authored-by: Yash Goyal <yash.goyal@izumanetworks.com>
Co-authored-by: Travis McCollum <travis.mccollum+github@gmail.com>

Author: doctordaemon

.dockerignore

@@ -1,2 +1,5 @@
-build
 .git
+build/
+*.o
+*.log
+edge-tool-c

.gitignore

@@ -18,6 +18,14 @@ generated
 compilation_info.txt
 config/edge_version_info.h
 release_whitelist_remove_intermediate_files
+mcc_config*
+edge_configuration/*.c
+edge_configuration/*.der
+edge_configuration/*.pem
+edge_configuration/*.cnf
+edge_configuration/*.srl
+edge_configuration/*.yaml
+edge_configuration/*.txt
 
 ### C ###
 # Object files
@@ -125,4 +133,10 @@ edge-tool/dist
 edge-tool/edge-tool
 
 # Python virtualenv
-venv
+venv
+
+docs/internal.md
+*.log
+*.img
+*.dtb
+*.zip

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog for Edge
 
+## Release 0.21.2
+
+### New Features
+
+* Register a default component COMP_1 when FOTA is enabled using flags `-DFOTA_ENABLE=ON -DFIRMWARE_UPDATE=ON -DFOTA_COMBINED_IMAGE_SUPPORT=ON`.
+* Added default firmware install `fota_update_activate.sh` and verify `fota_update_verify.sh` scripts to demonstarted edge-core FOTA feature.
+* Added documentation `./docs/create_manifest_v3.md` and `./docs/prepare_fota_component_update.md`.
+* Updated `Dockerfile.debian.byoc` to enabled FOTA feature.
+* Docker Support: Added new Dockerfiles to build a lightweight, Debian-based `edge-core` Docker image for different modes:
+  * Dockerfile.debian.dev: DEVELOPER_MODE
+  * Dockerfile.debian.byoc: BYOC_MODE (Bring Your Own Certificate/Configuration)
+  * Dockerfile.debian.prod: PRODUCTION_MODE (provisioning requires use of Izuma's factory tooling)
+
+### Improvements
+
+* Upgraded `libevent` to version 2.1.12
+
 ## Release 0.21.1
 
 * Update mbed-cloud-client to version [4.13.2](https://github.com/PelionIoT/mbed-cloud-client/blob/4.13.2/CHANGELOG.md).

Dockerfile.debian.byoc

@@ -0,0 +1,76 @@
+# Stage 1: Build the application
+FROM debian:bookworm-slim AS builder
+
+ARG fota_linux_storage_dir=/opt/izuma
+
+# Set the working directory
+WORKDIR /usr/src/app/mbed-edge
+
+# Install dependencies in a single step to reduce layers
+RUN apt-get update && \
+    DEBIAN_FRONTEND="noninteractive" apt-get install -y --no-install-recommends \
+    tzdata build-essential libc6-dev cmake libcurl4-openssl-dev libssl-dev \
+    python3 python3-pip pkg-config git && \
+    rm -rf /var/lib/apt/lists/*
+
+# Copy source files after dependencies are installed
+COPY . .
+
+# Return to main project and ensure it links with libbsd
+WORKDIR /usr/src/app/mbed-edge
+RUN mkdir -p build && cd build && \
+    cmake -DBYOC_MODE=ON \
+          -DFIRMWARE_UPDATE=ON \
+          -DTRACE_LEVEL=DEBUG \
+          -DFOTA_ENABLE=ON \
+          -DFOTA_COMBINED_IMAGE_SUPPORT=ON \
+          -DPLATFORM_TARGET=x86_x64_NativeLinux_mbedtls \
+          -DFOTA_LINUX_STORAGE_DIR=${fota_linux_storage_dir} \
+          -DFOTA_SCRIPT_DIR=\"/opt/izuma\" \
+          -DFOTA_INSTALL_SCRIPT=\"fota_update_activate.sh\" \
+          -DFOTA_VERIFY_SCRIPT=\"fota_update_verify.sh\" \
+          .. && \
+    make -j$(nproc)
+
+# Stage 2: Create a minimal runtime image
+FROM debian:bookworm-slim
+
+# Set working directory
+WORKDIR /usr/src/app/mbed-edge
+
+ARG fota_linux_storage_dir=/opt/izuma
+ENV FOTA_LINUX_STORAGE_DIR=${fota_linux_storage_dir}
+
+# Install only the required runtime dependencies
+RUN apt-get update && \
+    DEBIAN_FRONTEND="noninteractive" apt-get install -y --no-install-recommends \
+    tzdata libc6 libcurl4 \
+    vim \
+    iptables \
+    iputils-ping \
+    net-tools \
+    dnsutils \
+    traceroute \
+    curl \
+    wget \
+    tcpdump \
+    socat \
+    telnet \
+    nmap \
+    gdb \
+    libc6-dbg \
+    coreutils \
+    procps && \
+    rm -rf /var/lib/apt/lists/*
+
+RUN mkdir -p /opt/izuma
+
+# Copy only the built binary from the builder stage
+COPY --from=builder /usr/src/app/mbed-edge/build/ /usr/src/app/mbed-edge/build/
+COPY --from=builder /usr/src/app/mbed-edge/fota/MAIN "${FOTA_LINUX_STORAGE_DIR}/MAIN"
+COPY --from=builder /usr/src/app/mbed-edge/fota/COMP_1 "${FOTA_LINUX_STORAGE_DIR}/COMP_1"
+COPY --from=builder /usr/src/app/mbed-edge/start.sh /start.sh
+RUN chmod +x /start.sh
+
+ENTRYPOINT ["/start.sh"]
+CMD []

Dockerfile.debian.dev

@@ -3,14 +3,16 @@ FROM debian:bookworm-slim AS builder
 
 ARG developer_certificate=./config/mbed_cloud_dev_credentials.c
 ARG update_certificate=./config/update_default_resources.c
+ARG fota_linux_storage_dir=/opt/izuma
 
 # Set the working directory
 WORKDIR /usr/src/app/mbed-edge
 
 # Install dependencies in a single step to reduce layers
 RUN apt-get update && \
     DEBIAN_FRONTEND="noninteractive" apt-get install -y --no-install-recommends \
-    tzdata build-essential libc6-dev cmake && \
+    tzdata build-essential libc6-dev cmake libcurl4-openssl-dev libssl-dev \
+    python3 python3-pip pkg-config git && \
     rm -rf /var/lib/apt/lists/*
 
 # Copy source files after dependencies are installed
@@ -19,22 +21,57 @@ COPY . .
 # Return to main project and ensure it links with libbsd
 WORKDIR /usr/src/app/mbed-edge
 RUN mkdir -p build && cd build && \
-    cmake -DDEVELOPER_MODE=ON -DFIRMWARE_UPDATE=ON .. && \
-    make
+    cmake -DDEVELOPER_MODE=ON \
+        -DFACTORY_MODE=OFF \
+        -DBYOC_MODE=OFF \
+        -DFIRMWARE_UPDATE=ON \
+        -DTRACE_LEVEL=DEBUG \
+        -DFOTA_ENABLE=ON \
+        -DFOTA_COMBINED_IMAGE_SUPPORT=ON \
+        -DPLATFORM_TARGET=x86_x64_NativeLinux_mbedtls \
+        -DFOTA_LINUX_STORAGE_DIR=${fota_linux_storage_dir} \
+        .. && \
+    make -j$(nproc)
 
 # Stage 2: Create a minimal runtime image
 FROM debian:bookworm-slim
 
 # Set working directory
 WORKDIR /usr/src/app/mbed-edge
 
+ARG fota_linux_storage_dir=/opt/izuma
+ENV FOTA_LINUX_STORAGE_DIR=${fota_linux_storage_dir}
+
 # Install only the required runtime dependencies
 RUN apt-get update && \
     DEBIAN_FRONTEND="noninteractive" apt-get install -y --no-install-recommends \
-    tzdata libc6 && \
+    tzdata libc6 libcurl4 \
+    vim \
+    iptables \
+    iputils-ping \
+    net-tools \
+    dnsutils \
+    traceroute \
+    curl \
+    wget \
+    tcpdump \
+    socat \
+    telnet \
+    nmap \
+    gdb \
+    libc6-dbg \
+    coreutils \
+    procps && \
     rm -rf /var/lib/apt/lists/*
 
+RUN mkdir -p /opt/izuma
+
 # Copy only the built binary from the builder stage
 COPY --from=builder /usr/src/app/mbed-edge/build/ /usr/src/app/mbed-edge/build/
+COPY --from=builder /usr/src/app/mbed-edge/fota/MAIN "${FOTA_LINUX_STORAGE_DIR}/MAIN"
+COPY --from=builder /usr/src/app/mbed-edge/fota/COMP_1 "${FOTA_LINUX_STORAGE_DIR}/COMP_1"
+COPY --from=builder /usr/src/app/mbed-edge/start.sh /start.sh
+RUN chmod +x /start.sh
 
-CMD [ "./build/bin/edge-core", "--http-port", "8080", "--edge-pt-domain-socket", "/tmp/edge.sock" ]
+ENTRYPOINT ["/start.sh"]
+CMD []

Dockerfile.debian.prod

@@ -1,13 +1,16 @@
 # Stage 1: Build the application
 FROM debian:bookworm-slim AS builder
 
+ARG fota_linux_storage_dir=/opt/izuma
+
 # Set the working directory
 WORKDIR /usr/src/app/mbed-edge
 
 # Install dependencies in a single step to reduce layers
 RUN apt-get update && \
     DEBIAN_FRONTEND="noninteractive" apt-get install -y --no-install-recommends \
-    tzdata build-essential libc6-dev cmake && \
+    tzdata build-essential libc6-dev cmake libcurl4-openssl-dev libssl-dev \
+    python3 python3-pip pkg-config git && \
     rm -rf /var/lib/apt/lists/*
 
 # Copy source files after dependencies are installed
@@ -16,12 +19,23 @@ COPY . .
 # Return to main project and ensure it links with libbsd
 WORKDIR /usr/src/app/mbed-edge
 RUN mkdir -p build && cd build && \
-    cmake -DFACTORY_MODE=ON -DDEVELOPER_MODE=OFF -DFIRMWARE_UPDATE=ON .. && \
-    make
+    cmake -DFACTORY_MODE=ON \
+        -DDEVELOPER_MODE=OFF \
+        -DFIRMWARE_UPDATE=ON \
+        -DTRACE_LEVEL=DEBUG \
+        -DFOTA_ENABLE=ON \
+        -DFOTA_COMBINED_IMAGE_SUPPORT=ON \
+        -DPLATFORM_TARGET=x86_x64_NativeLinux_mbedtls \
+        -DFOTA_LINUX_STORAGE_DIR=${fota_linux_storage_dir} \
+        .. && \
+    make -j$(nproc)
 
 # Stage 2: Create a minimal runtime image
 FROM debian:bookworm-slim
 
+ARG fota_linux_storage_dir=/opt/izuma
+ENV FOTA_LINUX_STORAGE_DIR=${fota_linux_storage_dir}
+
 # Set working directory
 WORKDIR /usr/src/app/mbed-edge
 
@@ -31,7 +45,11 @@ RUN apt-get update && \
     tzdata libc6 && \
     rm -rf /var/lib/apt/lists/*
 
+RUN mkdir -p /opt/izuma
+
 # Copy only the built binary from the builder stage
 COPY --from=builder /usr/src/app/mbed-edge/build/ /usr/src/app/mbed-edge/build/
+COPY --from=builder /usr/src/app/mbed-edge/fota/MAIN "${FOTA_LINUX_STORAGE_DIR}/MAIN"
+COPY --from=builder /usr/src/app/mbed-edge/fota/COMP_1 "${FOTA_LINUX_STORAGE_DIR}/COMP_1"
 
 CMD [ "./build/bin/edge-core", "--http-port", "8080", "--edge-pt-domain-socket", "/tmp/edge.sock" ]

Dockerfile.edge-core-builder

@@ -0,0 +1,33 @@
+FROM ubuntu:22.04
+
+# Set environment variables
+ENV DEBIAN_FRONTEND=noninteractive \
+    TZ=Etc/UTC
+
+# Install required tools and dependencies
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    cmake \
+    python3 \
+    python3-pip \
+    git \
+    curl \
+    wget \
+    unzip \
+    ninja-build \
+    pkg-config \
+    libssl-dev \
+    python3-pycryptodome \
+    python3-venv \
+    ca-certificates \
+    libcurl4-openssl-dev \
+    libglib2.0-dev \
+    libjson-c-dev \
+    libc6-dev \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# Create a working directory
+WORKDIR /workspace
+
+# Default command: open bash
+CMD ["/bin/bash"]