IDMPL-350 Improve example scripts to simplify smoke tests procedure

example/ingress-nginx/README.md

@@ -13,10 +13,11 @@ Add the `ingress-nginx` repository in your local Helm configuration:
 helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
 ```
 
-In Docker Desktop, go the 'Kubernetes' tab, and create a cluster. Then use it:
+Get a local Kubernetes cluster, then use it. For example, with Colima:
 
 ```shell
-kubectl config use-context docker-desktop
+colima start --cpu 4 --memory 16 --vm-type=vz --vz-rosetta --kubernetes
+kubectl config use-context colima
 ```
 
 Install `ingress-nginx` (with the Datadog module):

example/install_datadog_utils.sh

@@ -0,0 +1,49 @@
+#!/bin/sh
+# Shared utility functions for install_datadog.sh scripts.
+
+detect_arch() {
+  raw_arch="$(uname -m)"
+  case "$raw_arch" in
+      aarch64)
+        echo "arm64"
+        ;;
+      x86_64)
+        echo "amd64"
+        ;;
+      *)
+        >&2 echo "Platform ${raw_arch} is not supported."
+        exit 1
+        ;;
+  esac
+}
+
+get_latest_release() {
+  tag=$(curl --silent --fail "https://api.github.com/repos/$1/releases/latest" | jq --raw-output .tag_name)
+  if [ -z "$tag" ] || [ "$tag" = "null" ]; then
+    >&2 echo "Failed to fetch latest release tag for $1. Check network and GitHub API rate limits."
+    exit 1
+  fi
+  echo "$tag"
+}
+
+install_packages() {
+  # Install the requested list of packages.
+  # `apt-get` (Debian, Ubuntu), `apk` (Alpine), and `yum` (Amazon Linux) are supported.
+  if is_installed apt-get; then
+      apt-get update
+      DEBIAN_FRONTEND=noninteractive apt-get install -y "$@"
+  elif is_installed apk; then
+      apk update
+      apk add "$@"
+  elif is_installed yum; then
+      yum update -y
+      yum install -y "$@"
+  else
+      >&2 printf 'Did not find a supported package manager.\n'
+      exit 3
+  fi
+}
+
+is_installed() {
+  command -v "$1" > /dev/null 2>&1
+}

example/openresty/README.md

@@ -28,19 +28,13 @@ export DD_API_KEY=your_api_key_here
 bin/run
 ```
 
-You can also choose which OpenResty version to run with the RESTY_VERSION environment variable:
-
-```shell
-RESTY_VERSION=1.27.1.2 bin/run
-```
-
 Then, in another shell, make HTTP or gRPC calls to the `openresty` service using
 the included command line tools:
 
 ```shell
 bin/curl http://openresty/openresty
 
-openresty lua
+openresty lua generated content
 ```
 
 See [services/openresty/nginx.conf](services/openresty/nginx.conf) for the available routes.

example/openresty/bin/run

@@ -3,28 +3,57 @@ set -e
 
 cd "$(dirname "$0")"/..
 
-if [ -z "$RESTY_VERSION" ]; then
-    export RESTY_VERSION=1.29.2.1
-fi
+DEFAULT_OPENRESTY_VERSION=1.29.2.1
 
-if [ -z "$BASE_IMAGE" ]; then
-    BASE_IMAGE="openresty/openresty:${RESTY_VERSION}-alpine"
-    export BASE_IMAGE
-fi
+usage() {
+    echo "Usage: $0 [--openresty OpenResty_version] [--nginx-datadog Nginx_Datadog_version] [--no-cache]"
+    echo "  -h, --help"
+    echo "      show this help message"
+    echo "  --openresty OpenResty_version"
+    echo "      OpenResty version (default: $DEFAULT_OPENRESTY_VERSION)"
+    echo "  --nginx-datadog Nginx_Datadog_version"
+    echo "      Nginx Datadog release tag (example: 1.0.0, default: latest one)"
+    echo "  --no-cache"
+    echo "      disable cache when building Docker images"
+}
 
-# Fail fast in case the base image is not supported.
-# For now, we only support nginx, nginx-alpine, and amazonlinux images.
-case "$BASE_IMAGE" in
-    openresty/openresty:*) ;;
-    *)
-      >&2 echo 'BASE_IMAGE value "%s" is invalid.' "$BASE_IMAGE"
-      exit 1
-      ;;
-esac
+while [ $# -gt 0 ]; do
+    case "$1" in
+        -h|--help)
+            usage
+            exit 0
+            ;;
+        --openresty)
+            [ $# -ge 2 ] || { usage >&2; exit 1; }
+            OPENRESTY_VERSION="$2"
+            shift 2
+            ;;
+        --nginx-datadog)
+            [ $# -ge 2 ] || { usage >&2; exit 1; }
+            NGINX_DATADOG_VERSION="$2"
+            shift 2
+            ;;
+        --no-cache)
+            NO_CACHE=true
+            shift
+            ;;
+        *)
+            usage >&2
+            exit 1
+            ;;
+    esac
+done
+
+OPENRESTY_VERSION=${OPENRESTY_VERSION:-${DEFAULT_OPENRESTY_VERSION}}
+export OPENRESTY_VERSION
+export NGINX_DATADOG_VERSION
 
 if [ "$DD_API_KEY" = '' ]; then
     >&2 echo 'The environment variable DD_API_KEY must be set to a Datadog API key.'
     exit 1
 fi
 
+if [ -n "$NO_CACHE" ]; then
+    docker compose build --no-cache
+fi
 docker compose up --build --abort-on-container-exit --remove-orphans

example/openresty/docker-compose.yml

@@ -3,10 +3,11 @@ services:
   # `openresty` is an instance of openresty that has the Datadog tracing module loaded.
   openresty:
     build:
-      context: ./services/openresty
-      dockerfile: ./Dockerfile
+      context: ..
+      dockerfile: openresty/services/openresty/Dockerfile
       args:
-        BASE_IMAGE: ${BASE_IMAGE}
+        OPENRESTY_VERSION: ${OPENRESTY_VERSION:-}
+        NGINX_DATADOG_VERSION: ${NGINX_DATADOG_VERSION:-}
     environment:
       - DD_AGENT_HOST=agent
     depends_on:

example/openresty/services/openresty/Dockerfile

@@ -1,9 +1,20 @@
-# Build an nginx container that includes the module for Datadog tracing.
-ARG BASE_IMAGE
+# Build an Nginx container that includes the module for Datadog tracing.
+# The default value for BASE_IMAGE is to silent the InvalidDefaultArgInFrom
+#   warning. Actually BASE_IMAGE is set in docker-compose.yml.
+ARG OPENRESTY_VERSION=1.29.2.1
+ARG BASE_IMAGE=openresty/openresty:${OPENRESTY_VERSION}-alpine
 FROM ${BASE_IMAGE}
 
-COPY ngx_http_datadog_module.so* /usr/local/openresty/nginx/modules
-COPY ./nginx.conf /usr/local/openresty/nginx/conf/nginx.conf
+# Install the Datadog tracing module.
+ARG OPENRESTY_VERSION
+ENV OPENRESTY_VERSION=${OPENRESTY_VERSION}
+ARG NGINX_DATADOG_VERSION
+ENV NGINX_DATADOG_VERSION=${NGINX_DATADOG_VERSION}
+COPY ./install_datadog_utils.sh /tmp/
+COPY ./openresty/services/openresty/install_datadog.sh /tmp/
+RUN /tmp/install_datadog.sh
+
+COPY ./openresty/services/openresty/nginx.conf /usr/local/openresty/nginx/conf/nginx.conf
 
 ENTRYPOINT ["nginx"]
 CMD ["-g", "daemon off;"]

example/openresty/services/openresty/install_datadog.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+# Install the Nginx Datadog module.
+
+set -x
+set -e
+
+. /tmp/install_datadog_utils.sh
+
+arch=$(detect_arch)
+
+install_packages curl jq tar wget
+
+if [ -z "$OPENRESTY_VERSION" ]; then
+  >&2 echo 'OPENRESTY_VERSION must be set (e.g. "1.29.2.1").'
+  exit 1
+fi
+
+tarball="openresty-ngx_http_datadog_module-appsec-${arch}-${OPENRESTY_VERSION}.so.tgz"
+
+repository="DataDog/nginx-datadog"
+
+if [ -n "$NGINX_DATADOG_VERSION" ]; then
+  nginx_datadog_release_tag="v${NGINX_DATADOG_VERSION}"
+else
+  nginx_datadog_release_tag=$(get_latest_release "$repository")
+fi
+
+wget "https://github.com/$repository/releases/download/$nginx_datadog_release_tag/$tarball"
+tar -xzf "$tarball" -C /usr/local/openresty/nginx/modules
+rm "$tarball"

example/tracing/bin/run

@@ -3,8 +3,52 @@ set -e
 
 cd "$(dirname "$0")"/..
 
-BASE_IMAGE="${BASE_IMAGE:-nginx:1.29.7-alpine}"
+DEFAULT_NGINX_VERSION=1.29.7
+
+usage() {
+    echo "Usage: $0 [--nginx Nginx_version] [--nginx-datadog Nginx_Datadog_version] [--no-cache]"
+    echo "  -h, --help"
+    echo "      show this help message"
+    echo "  --nginx Nginx_version"
+    echo "      Nginx version (default: $DEFAULT_NGINX_VERSION)"
+    echo "  --nginx-datadog Nginx_Datadog_version"
+    echo "      Nginx Datadog release tag (example: 1.0.0, default: latest one)"
+    echo "  --no-cache"
+    echo "      disable cache when building Docker images"
+}
+
+while [ $# -gt 0 ]; do
+    case "$1" in
+        -h|--help)
+            usage
+            exit 0
+            ;;
+        --nginx)
+            [ $# -ge 2 ] || { usage >&2; exit 1; }
+            NGINX_VERSION="$2"
+            shift 2
+            ;;
+        --nginx-datadog)
+            [ $# -ge 2 ] || { usage >&2; exit 1; }
+            NGINX_DATADOG_VERSION="$2"
+            shift 2
+            ;;
+        --no-cache)
+            NO_CACHE=true
+            shift
+            ;;
+        *)
+            usage >&2
+            exit 1
+            ;;
+    esac
+done
+
+NGINX_VERSION=${NGINX_VERSION:-${DEFAULT_NGINX_VERSION}}
+export NGINX_VERSION
+BASE_IMAGE=${BASE_IMAGE:-nginx:${NGINX_VERSION}-alpine}
 export BASE_IMAGE
+export NGINX_DATADOG_VERSION
 
 # Fail fast in case the base image is not supported.
 # For now, we only support nginx, nginx-alpine, and amazonlinux images.
@@ -22,4 +66,7 @@ if [ "$DD_API_KEY" = '' ]; then
     exit 1
 fi
 
+if [ -n "$NO_CACHE" ]; then
+    docker compose build --no-cache
+fi
 docker compose up --build --abort-on-container-exit --remove-orphans

example/tracing/docker-compose.yml

@@ -3,10 +3,11 @@ services:
   # `nginx` is an instance of nginx that has the Datadog tracing module loaded.
   nginx:
     build:
-      context: ./services/nginx
-      dockerfile: ./Dockerfile
+      context: ..
+      dockerfile: tracing/services/nginx/Dockerfile
       args:
-        BASE_IMAGE: ${BASE_IMAGE}
+        BASE_IMAGE: ${BASE_IMAGE:-}
+        NGINX_DATADOG_VERSION: ${NGINX_DATADOG_VERSION:-}
     environment:
       - DD_AGENT_HOST=agent
     depends_on:

example/tracing/services/nginx/Dockerfile

@@ -1,16 +1,19 @@
-# Build an nginx container that includes the module for Datadog tracing.
+# Build an Nginx container that includes the module for Datadog tracing.
 # The default value for BASE_IMAGE is to silent the InvalidDefaultArgInFrom
 #   warning. Actually BASE_IMAGE is set in docker-compose.yml.
 ARG BASE_IMAGE=nginx:1.29.7-alpine
 FROM ${BASE_IMAGE}
 
 # Install the Datadog tracing module.
-COPY ./install_datadog.sh /tmp/
+COPY ./install_datadog_utils.sh /tmp/
+COPY ./tracing/services/nginx/install_datadog.sh /tmp/
 ARG BASE_IMAGE
 ENV BASE_IMAGE=${BASE_IMAGE}
+ARG NGINX_DATADOG_VERSION
+ENV NGINX_DATADOG_VERSION=${NGINX_DATADOG_VERSION}
 RUN /tmp/install_datadog.sh
 
-COPY ./nginx.conf /etc/nginx/nginx.conf
+COPY ./tracing/services/nginx/nginx.conf /etc/nginx/nginx.conf
 
 ENTRYPOINT ["nginx"]
 CMD ["-g", "daemon off;"]