chore(k8smeta): simplify cmake scripts and use VCPKG for dependencies

irozzo-1A · irozzo-1A · commit 9b73fc00d02e · 2025-10-17T13:15:37.000+02:00
Simplify the cmake scripts by using `find_package` and VCPKG.
Also generate the gRPC files using `protobuf_generate` instead of using
a custom command.

Signed-off-by: Iacopo Rozzo &lt;iacopo@sysdig.com&gt;
diff --git a/.github/actions/install-vcpkg/action.yml b/.github/actions/install-vcpkg/action.yml
@@ -0,0 +1,42 @@
+name: 'install-vcpkg'
+description: 'Install vcpkg and make it available in PATH.'
+
+outputs:
+  vcpkg_root:
+    description: "VCPKG_ROOT"
+    value: ${{ steps.vcpkg.outputs.vcpkg_root }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: Store vcpkg version as local output
+      shell: bash
+      id: store
+      env:
+        VCPKG_VERSION: '2025.09.17'
+      run: |
+        echo "vcpkg_version=${VCPKG_VERSION}" >> "$GITHUB_OUTPUT"
+
+    - name: Download vcpkg
+      shell: bash
+      run: |
+        git clone https://github.com/microsoft/vcpkg.git --branch ${{ steps.store.outputs.vcpkg_version }} --single-branch
+
+    - name: Setup vcpkg
+      shell: bash
+      id: vcpkg
+      run: |
+        # Note, this is a workaround to avoid building debug versions that are not used in the build process
+        # TODO: Find a cleaner way to do this
+        find "$(pwd)/vcpkg/triplets/" -name "*.cmake" -type f -exec sh -c "echo \"set(VCPKG_BUILD_TYPE release)\" >> {}" \;
+        VCPKG_MAX_CONCURRENCY=6 ./vcpkg/bootstrap-vcpkg.sh
+        echo "$(pwd)/vcpkg" >> $GITHUB_PATH
+        echo "VCPKG_ROOT=$(pwd)/vcpkg" >> $GITHUB_ENV
+        # Set the maximum concurrency to 6 to avoid overwhelming the CI system
+        echo "VCPKG_MAX_CONCURRENCY=6" >> $GITHUB_ENV
+
+    - name: Set Outputs
+      id: store-outputs
+      shell: bash
+      run: |
+        echo "vcpkg_root=${VCPKG_ROOT}" >> $GITHUB_OUTPUT
diff --git a/.github/workflows/k8smeta-ci.yaml b/.github/workflows/k8smeta-ci.yaml
@@ -34,7 +34,13 @@ jobs:
         - name: Install deps ⛓️
           run: |
             sudo apt update -y
-            sudo apt install -y --no-install-recommends cmake build-essential autoconf libtool pkg-config
+            sudo apt install -y --no-install-recommends cmake build-essential autoconf libtool pkg-config zip unzip tar git wget
+
+        - name: Install vcpkg 📦
+          uses: ./.github/actions/install-vcpkg
+          with:
+            # Using a specific commit to avoid unexpected issues
+            vcpkg_version: 2025.09.17
 
         - name: Initialize CodeQL
           uses: github/codeql-action/init@64d10c13136e1c5bce3e5fbde8d4906eeaafc885 # v3.30.6
@@ -44,9 +50,8 @@ jobs:
         - name: Build k8s meta plugin 🏗️
           run: |
             cd plugins/k8smeta
-            mkdir build
-            cd build && cmake -DCMAKE_BUILD_TYPE=Release ../
-            make k8smeta -j6
+            cmake -B build --preset vcpkg-release
+            cmake --build build --target k8smeta -j$(nproc)
 
         - name: Perform CodeQL Analysis
           uses: github/codeql-action/analyze@64d10c13136e1c5bce3e5fbde8d4906eeaafc885 # v3.30.6
diff --git a/.github/workflows/reusable_build_packages.yaml b/.github/workflows/reusable_build_packages.yaml
@@ -26,7 +26,7 @@ jobs:
         run: |
           apt update
           apt install -y --no-install-recommends awscli build-essential autoconf libelf-dev libtool autotools-dev \
-            automake zip unzip ninja-build wget lsb-release software-properties-common gnupg
+            automake zip unzip tar git ninja-build wget lsb-release software-properties-common gnupg
 
       - name: Install updated clang version ⛓️
         run: |
@@ -61,6 +61,12 @@ jobs:
           fetch-depth: 0
           submodules: "recursive"
 
+      - name: Install vcpkg 📦
+        uses: ./.github/actions/install-vcpkg
+        with:
+          # Using a specific commit to avoid unexpected issues
+          vcpkg_version: 2025.09.17
+
       - name: Safe directory
         run: git config --global --add safe.directory $GITHUB_WORKSPACE
 
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 .vscode
 .DS_Store
 .idea
+.cache
 output/
 plugins/*/*.so
 plugins/*/lib*.h
diff --git a/plugins/k8smeta/CMakeLists.txt b/plugins/k8smeta/CMakeLists.txt
@@ -13,39 +13,49 @@ project(
 
 # dependencies
 include(FetchContent)
-include(grpc)
-include(spdlog)
 include(plugin-sdk-cpp)
 include(k8s-metacollector)
 
-set(PROTO_PATH "${K8S_METACOLLECTOR_DIR}/metadata/metadata.proto")
+find_package(protobuf CONFIG REQUIRED)
+find_package(gRPC REQUIRED)
+find_package(spdlog REQUIRED)
 
+set(PROTO_PATH "${K8S_METACOLLECTOR_DIR}/metadata/metadata.proto")
 get_filename_component(meta_proto "${PROTO_PATH}" ABSOLUTE)
 get_filename_component(meta_proto_path "${meta_proto}" PATH)
 
-# Generated sources
-set(PROTO_GENERATED_INCLUDE "${CMAKE_BINARY_DIR}/generated")
-if(NOT EXISTS "${PROTO_GENERATED_INCLUDE}")
-  file(MAKE_DIRECTORY "${PROTO_GENERATED_INCLUDE}")
-endif()
+set(PROTO_OUTPUT_DIR "${CMAKE_BINARY_DIR}/generated")
 
-set(meta_proto_srcs "${PROTO_GENERATED_INCLUDE}/metadata.pb.cc")
-set(meta_proto_hdrs "${PROTO_GENERATED_INCLUDE}/metadata.pb.h")
-set(meta_grpc_srcs "${PROTO_GENERATED_INCLUDE}/metadata.grpc.pb.cc")
-set(meta_grpc_hdrs "${PROTO_GENERATED_INCLUDE}/metadata.grpc.pb.h")
-add_custom_command(
-  OUTPUT "${meta_proto_srcs}" "${meta_proto_hdrs}" "${meta_grpc_srcs}"
-         "${meta_grpc_hdrs}"
-  COMMAND
-    ${_PROTOBUF_PROTOC} ARGS --grpc_out "${PROTO_GENERATED_INCLUDE}" --cpp_out
-    "${PROTO_GENERATED_INCLUDE}" -I "${meta_proto_path}"
-    --plugin=protoc-gen-grpc="${_GRPC_CPP_PLUGIN_EXECUTABLE}" "${meta_proto}"
-  DEPENDS "${meta_proto}")
+# generate the protobuf output directory
+file(MAKE_DIRECTORY "${PROTO_OUTPUT_DIR}")
+message(STATUS "Protobuf files will be generated in: ${PROTO_OUTPUT_DIR}")
 
 # project target
-file(GLOB_RECURSE K8S_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp")
-add_library(k8smeta SHARED ${K8S_SOURCES} ${meta_grpc_srcs} ${meta_grpc_hdrs}
-                           ${meta_proto_srcs} ${meta_proto_hdrs})
+add_library(k8smeta SHARED
+  src/plugin.cpp
+  src/grpc_client.cpp
+)
+
+# Set the output directory for protobuf generation
+set_target_properties(k8smeta PROPERTIES
+  PROTOC_OUT_DIR "${PROTO_OUTPUT_DIR}")
+
+# Generate protobuf files
+protobuf_generate(
+    TARGET k8smeta
+    PROTOS "${meta_proto}"
+    IMPORT_DIRS "${meta_proto_path}"
+    PROTOC_OUT_DIR "${PROTO_OUTPUT_DIR}")
+
+# Generate gRPC files
+protobuf_generate(
+    TARGET k8smeta
+    LANGUAGE grpc
+    GENERATE_EXTENSIONS .grpc.pb.h .grpc.pb.cc
+    PLUGIN "protoc-gen-grpc=$<TARGET_FILE:gRPC::grpc_cpp_plugin>"
+    PROTOS "${meta_proto}"
+    IMPORT_DIRS "${meta_proto_path}"
+    PROTOC_OUT_DIR "${PROTO_OUTPUT_DIR}")
 set_target_properties(k8smeta PROPERTIES CXX_EXTENSIONS OFF)
 
 # project compilation options
@@ -59,12 +69,12 @@ target_compile_features(k8smeta PUBLIC cxx_std_17)
 
 # project includes
 target_include_directories(
-  k8smeta PRIVATE "${PLUGIN_SDK_INLCUDE}" "${PROTO_GENERATED_INCLUDE}"
-                  "${SPDLOG_INLCUDE}")
+  k8smeta PRIVATE "${PLUGIN_SDK_INLCUDE}" "${PROTO_OUTPUT_DIR}")
 
 # project linked libraries
-target_link_libraries(k8smeta ${_REFLECTION} ${_GRPC_GRPCPP}
-                      ${_PROTOBUF_LIBPROTOBUF} re2::re2)
+target_link_libraries(k8smeta
+  spdlog::spdlog
+  gRPC::grpc++)
 
 # Testing
 if(BUILD_TESTS)
diff --git a/plugins/k8smeta/CMakePresets.json b/plugins/k8smeta/CMakePresets.json
@@ -0,0 +1,24 @@
+{
+  "version": 3,
+  "configurePresets": [
+    {
+      "name": "vcpkg-release",
+      "displayName": "VCPKG Release Configuration",
+      "description": "VCPKG release build configuration",
+      "generator": "Unix Makefiles",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
+        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
+      }
+    }
+  ],
+  "buildPresets": [
+    {
+      "name": "vcpkg-release",
+      "configurePreset": "vcpkg-release",
+      "displayName": "VCPKG Release Build",
+      "description": "Build with VCPKG release configuration"
+    }
+  ]
+}
diff --git a/plugins/k8smeta/Makefile b/plugins/k8smeta/Makefile
@@ -22,8 +22,9 @@ clean:
 	rm -rf build $(OUTPUT)
 
 # This Makefile requies CMake installed on the system
+.PHONY: $(OUTPUT)
 $(OUTPUT):
-	mkdir build && cd build && cmake -DCMAKE_BUILD_TYPE=Release ../ && make k8smeta -j6 && cp ./$(OUTPUT) ../$(OUTPUT)
+	cmake -B build --preset vcpkg-release && cmake --build build --target k8smeta -j$(nproc) && cp ./build/$(OUTPUT) ./$(OUTPUT)
 
 readme:
 	@$(READMETOOL) -p ./$(OUTPUT) -f README.md
diff --git a/plugins/k8smeta/README.md b/plugins/k8smeta/README.md
@@ -116,16 +116,30 @@ falco -c falco.yaml -r falco_rules.yaml
 
 ## Local development
 
+### Prerequisites
+
+#### Dependencies management
+
+The easiest way to install the required dependencies is to use [vcpkg](https://learn.microsoft.com/en-us/vcpkg/get_started/get-started?pivots=shell-bash).
+
+```bash
+git clone https://github.com/microsoft/vcpkg.git
+cd vcpkg
+./bootstrap-vcpkg.sh
+export VCPKG_ROOT="$(pwd)"
+export PATH=$VCPKG_ROOT:$PATH
+```
+
 ### Build and test
 
-Build the plugin on a fresh `Ubuntu 22.04` machine:
+Build the plugin on a `Ubuntu 22.04` machine:
 
 ```bash
 sudo apt update -y
 sudo apt install -y cmake build-essential autoconf libtool pkg-config
 git clone https://github.com/falcosecurity/plugins.git
 cd plugins/k8smeta
-cmake -S . -B build
+cmake -S . -B build --preset vcpkg-release
 cmake --build build --target k8smeta -j $(nproc)
 ```
 
diff --git a/plugins/k8smeta/cmake/modules/grpc.cmake b/plugins/k8smeta/cmake/modules/grpc.cmake
diff --git a/plugins/k8smeta/cmake/modules/spdlog.cmake b/plugins/k8smeta/cmake/modules/spdlog.cmake
diff --git a/plugins/k8smeta/vcpkg.json b/plugins/k8smeta/vcpkg.json
@@ -0,0 +1,16 @@
+{
+  "name": "k8smeta",
+  "version": "0.1.0",
+  "description": "Falco Kubernetes enrichment Plugin",
+  "dependencies": [
+    {
+      "name": "grpc",
+      "version>=": "1.44.0"
+    },
+    {
+      "name": "spdlog",
+      "version>=": "1.12.0"
+    }
+  ],
+  "builtin-baseline": "4334d8b4c8916018600212ab4dd4bbdc343065d1"
+}
