smoke: add performance test

Makefile

@@ -133,6 +133,9 @@ coverage-codecov:
 smoke-only:
 	make -C smoke test
 
+smoke-performance:
+	make -C smoke test-performance
+
 smoke: release smoke-only
 
 docker-nydus-smoke:

misc/performance/containerd_config.toml

@@ -0,0 +1,17 @@
+version = 2
+root = "/var/lib/containerd"
+state = "/run/containerd"
+oom_score = 0
+
+[debug]
+  level = "debug"
+
+[plugins."io.containerd.grpc.v1.cri"]
+  [plugins."io.containerd.grpc.v1.cri".containerd]
+      snapshotter = "nydus"
+      disable_snapshot_annotations = false
+
+[proxy_plugins]
+  [proxy_plugins.nydus]
+      type = "snapshot"
+      address = "/run/containerd-nydus/containerd-nydus-grpc.sock"

misc/performance/nydus-snapshotter.service

@@ -0,0 +1,18 @@
+[Unit]
+Description=nydus snapshotter
+After=network.target
+Before=containerd.service
+
+[Service]
+Type=simple
+Environment=HOME=/root
+ExecStart=/usr/local/bin/containerd-nydus-grpc --config /etc/nydus/config.toml
+Restart=always
+RestartSec=1
+KillMode=process
+OOMScoreAdjust=-999
+StandardOutput=journal
+StandardError=journal
+
+[Install]
+WantedBy=multi-user.target

misc/performance/nydusd_config.json

@@ -0,0 +1,26 @@
+{
+    "device": {
+        "backend": {
+            "type": "registry",
+            "config": {
+                "scheme": "http",
+                "host": "localhost:5000"
+            }
+        },
+        "cache": {
+            "type": "blobcache",
+            "config": {
+                "work_dir": "/var/lib/containerd-nydus/cache"
+            }
+        }
+    },
+    "mode": "direct",
+    "digest_validate": false,
+    "enable_xattr": true,
+    "iostats_files": false,
+    "access_pattern": false,
+    "latest_read_files": false,
+    "fs_prefetch": {
+        "enable": false
+    }
+}

misc/performance/prepare.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+readonly SNAPSHOTTER_VERSION=0.13.3
+readonly NERDCTL_VERSION=1.7.0
+readonly CNI_PLUGINS_VERSION=1.3.0
+
+# setup nerdctl and nydusd env
+sudo install -D -m 755 contrib/nydusify/cmd/nydusify /usr/local/bin
+sudo install -D -m 755 target/release/nydusd target/release/nydus-image /usr/local/bin
+wget https://github.com/containerd/nydus-snapshotter/releases/download/v$SNAPSHOTTER_VERSION/nydus-snapshotter-v$SNAPSHOTTER_VERSION-x86_64.tgz
+tar zxvf nydus-snapshotter-v$SNAPSHOTTER_VERSION-x86_64.tgz
+sudo install -D -m 755 nydus-snapshotter/containerd-nydus-grpc /usr/local/bin
+sudo wget https://github.com/containerd/nerdctl/releases/download/v$NERDCTL_VERSION/nerdctl-$NERDCTL_VERSION-linux-amd64.tar.gz
+sudo tar -xzvf nerdctl-$NERDCTL_VERSION-linux-amd64.tar.gz -C /usr/local/bin
+sudo mkdir -p /opt/cni/bin
+sudo wget https://github.com/containernetworking/plugins/releases/download/v$CNI_PLUGINS_VERSION/cni-plugins-linux-amd64-v$CNI_PLUGINS_VERSION.tgz 
+sudo tar -xzvf cni-plugins-linux-amd64-v$CNI_PLUGINS_VERSION.tgz -C /opt/cni/bin
+sudo install -D misc/performance/containerd_config.toml /etc/containerd/config.toml
+sudo systemctl restart containerd
+sudo install -D misc/performance/nydusd_config.json /etc/nydus/nydusd-config.fusedev.json
+sudo install -D misc/performance/snapshotter_config.toml /etc/nydus/config.toml
+sudo install -D misc/performance/nydus-snapshotter.service /etc/systemd/system/nydus-snapshotter.service
+sudo systemctl start nydus-snapshotter

misc/performance/snapshotter_config.toml

@@ -0,0 +1,132 @@
+version = 1
+# Snapshotter's own home directory where it stores and creates necessary resources
+root = "/var/lib/containerd-nydus"
+# The snapshotter's GRPC server socket, containerd will connect to plugin on this socket
+address = "/run/containerd-nydus/containerd-nydus-grpc.sock"
+daemon_mode = "dedicated"
+# Whether snapshotter should try to clean up resources when it is closed
+cleanup_on_close = false
+
+[system]
+# Snapshotter's debug and trace HTTP server interface
+enable = true
+# Unix domain socket path where system controller is listening on
+address = "/run/containerd-nydus/system.sock"
+
+[system.debug]
+# Snapshotter can profile the CPU utilization of each nydusd daemon when it is being started.
+# This option specifies the profile duration when nydusd is downloading and uncomproessing data.
+daemon_cpu_profile_duration_secs = 5
+# Enable by assigning an address, empty indicates pprof server is disabled
+pprof_address = ""
+
+[daemon]
+# Specify a configuration file for nydusd
+nydusd_config = "/etc/nydus/nydusd-config.fusedev.json"
+nydusd_path = "/usr/local/bin/nydusd"
+nydusimage_path = "/usr/local/bin/nydus-image"
+# fusedev or fscache
+fs_driver = "fusedev"
+# How to process when daemon dies: "none", "restart" or "failover"
+recover_policy = "restart"
+# Nydusd worker thread number to handle FUSE or fscache requests, [0-1024].
+# Setting to 0 will use the default configuration of nydusd.
+threads_number = 4
+# Log rotation size for nydusd, in unit MB(megabytes)
+log_rotation_size = 100
+
+[cgroup]
+# Whether to use separate cgroup for nydusd.
+enable = true
+# The memory limit for nydusd cgroup, which contains all nydusd processes.
+# Percentage is supported as well, please ensure it is end with "%".
+# The default unit is bytes. Acceptable values include "209715200", "200MiB", "200Mi" and "10%".
+memory_limit = ""
+
+[log]
+# Print logs to stdout rather than logging files
+log_to_stdout = false
+# Snapshotter's log level
+level = "info"
+log_rotation_compress = true
+log_rotation_local_time = true
+# Max number of days to retain logs
+log_rotation_max_age = 7
+log_rotation_max_backups = 5
+# In unit MB(megabytes)
+log_rotation_max_size = 100
+
+[metrics]
+# Enable by assigning an address, empty indicates metrics server is disabled
+address = ":9110"
+
+[remote]
+convert_vpc_registry = false
+
+[remote.mirrors_config]
+# Snapshotter will overwrite daemon's mirrors configuration
+# if the values loaded from this driectory are not null before starting a daemon.
+# Set to "" or an empty directory to disable it.
+#dir = "/etc/nydus/certs.d"
+
+[remote.auth]
+# Fetch the private registry auth by listening to K8s API server
+enable_kubeconfig_keychain = false
+# synchronize `kubernetes.io/dockerconfigjson` secret from kubernetes API server with specified kubeconfig (default `$KUBECONFIG` or `~/.kube/config`)
+kubeconfig_path = ""
+# Fetch the private registry auth as CRI image service proxy
+enable_cri_keychain = false
+# the target image service when using image proxy
+#image_service_address = "/run/containerd/containerd.sock"
+
+[snapshot]
+# Let containerd use nydus-overlayfs mount helper
+enable_nydus_overlayfs = false
+# Insert Kata Virtual Volume option to `Mount.Options`
+enable_kata_volume = false
+# Whether to remove resources when a snapshot is removed
+sync_remove = false
+
+[cache_manager]
+# Disable or enable recyclebin
+disable = false
+# How long to keep deleted files in recyclebin
+gc_period = "24h"
+# Directory to host cached files
+cache_dir = ""
+
+[image]
+public_key_file = ""
+validate_signature = false
+
+# The configuraions for features that are not production ready
+[experimental]
+# Whether to enable stargz support
+enable_stargz = false
+# Whether to enable referrers support
+# The option enables trying to fetch the Nydus image associated with the OCI image and run it.
+# Also see https://github.com/opencontainers/distribution-spec/blob/main/spec.md#listing-referrers
+enable_referrer_detect = false
+# Whether to enable authentication support
+# The option enables nydus snapshot to provide backend information to nydusd.
+enable_backend_source = false
+[experimental.tarfs]
+# Whether to enable nydus tarfs mode. Tarfs is supported by:
+# - The EROFS filesystem driver since Linux 6.4
+# - Nydus Image Service release v2.3
+enable_tarfs = false
+# Mount rafs on host by loopdev and EROFS
+mount_tarfs_on_host = false
+# Only enable nydus tarfs mode for images with `tarfs hint` label when true
+tarfs_hint = false
+# Maximum of concurrence to converting OCIv1 images to tarfs, 0 means default
+max_concurrent_proc = 0
+# Mode to export tarfs images:
+# - "none" or "": do not export tarfs
+# - "layer_verity_only": only generate disk verity information for a layer blob
+# - "image_verity_only": only generate disk verity information for all blobs of an image
+# - "layer_block": generate a raw block disk image with tarfs for a layer
+# - "image_block": generate a raw block disk image with tarfs for an image
+# - "layer_block_with_verity": generate a raw block disk image with tarfs for a layer with dm-verity info
+# - "image_block_with_verity": generate a raw block disk image with tarfs for an image with dm-verity info
+export_mode = ""

smoke/Makefile

@@ -17,6 +17,12 @@ build:
 test: build
 	sudo -E ./smoke.test -test.v -test.timeout 10m -test.parallel=16 -test.run=$(TESTS)
 
+# PERFORMANCE_TEST_MODE=fs-version-5 \
+# PERFORMANCE_TEST_IMAGE=wordpress:latest \
+# make test-performance
+test-performance: build
+	PERFORMANCE_TEST=True;sudo -E ./smoke.test -test.v -test.timeout 10m -test.parallel=1 -test.run=TestPerformance
+
 # WORK_DIR=/tmp \
 # NYDUS_STABLE_VERSION=v2.2.3 \
 # NYDUS_STABLE_VERSION_EXPORT=v2_2_3 \

smoke/tests/performance_test.go

@@ -0,0 +1,101 @@
+// Copyright 2023 Nydus Developers. All rights reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package tests
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/dragonflyoss/image-service/smoke/tests/tool"
+	"github.com/dragonflyoss/image-service/smoke/tests/tool/test"
+	"github.com/google/uuid"
+)
+
+// Environment Requirement: Containerd, nerdctl >= 0.22, nydus-snapshoooter, nydusd, nydus-image and nydusify.
+// Prepare: setup nydus for containerd, reference: https://github.com/dragonflyoss/nydus/blob/master/docs/containerd-env-setup.md.
+
+type PerformanceTestSuite struct {
+	t                 *testing.T
+	testImage         string
+	testContainerName string
+}
+
+func (p *PerformanceTestSuite) TestPerformance(t *testing.T) {
+	ctx := tool.DefaultContext(p.t)
+	// choose test mode
+	mode := os.Getenv("PERFORMANCE_TEST_MODE")
+	if mode == "" {
+		mode = "fs-version-6"
+	}
+	switch mode {
+	case "fs-version-5":
+		ctx.Build.FSVersion = "5"
+	case "fs-version-6":
+		ctx.Build.FSVersion = "6"
+	case "zran":
+		ctx.Build.OCIRef = true
+	default:
+		p.t.Fatalf("PerformanceTest don't support %s mode", mode)
+	}
+	// choose test image
+	image := os.Getenv("PERFORMANCE_TEST_IMAGE")
+
+	if image == "" {
+		image = "wordpress:6.1.1"
+	} else {
+		if !tool.SupportContainerImage(tool.ImageRepo(p.t, image)) {
+			p.t.Fatalf("Unsupport image " + image)
+		}
+	}
+	// prepare test image
+	p.prepareTestImage(p.t, ctx, mode, image)
+
+	// run Contaienr
+	p.testContainerName = uuid.NewString()
+	tool.RunContainer(p.t, p.testImage, p.testContainerName, mode)
+	clearContainer(p.t, p.testImage, p.testContainerName)
+}
+
+func (p *PerformanceTestSuite) prepareTestImage(t *testing.T, ctx *tool.Context, mode string, image string) {
+	if p.testImage != "" {
+		return
+	}
+
+	ctx.PrepareWorkDir(t)
+	defer ctx.Destroy(t)
+	source := tool.PrepareImage(t, image)
+
+	// Prepare options
+	target := fmt.Sprintf("%s-nydus-%s", source, uuid.NewString())
+	fsVersion := fmt.Sprintf("--fs-version %s", ctx.Build.FSVersion)
+	logLevel := "--log-level warn"
+	if ctx.Binary.NydusifyOnlySupportV5 {
+		fsVersion = ""
+		logLevel = ""
+	}
+	enableOCIRef := ""
+	if ctx.Build.OCIRef {
+		enableOCIRef = "--oci-ref"
+	}
+
+	// Convert image
+	convertCmd := fmt.Sprintf("%s %s convert --source %s --target %s --nydus-image %s --work-dir %s %s %s",
+		ctx.Binary.Nydusify, logLevel, source, target, ctx.Binary.Builder, ctx.Env.WorkDir, fsVersion, enableOCIRef)
+	tool.RunWithoutOutput(t, convertCmd)
+	p.testImage = target
+}
+
+func clearContainer(t *testing.T, image string, containerName string) {
+	tool.RunWithoutOutput(t, fmt.Sprintf("sudo nerdctl --snapshotter nydus rm -f %s", containerName))
+	tool.RunWithoutOutput(t, fmt.Sprintf("sudo nerdctl --snapshotter nydus image rm %s", image))
+}
+
+func TestPerformance(t *testing.T) {
+	if os.Getenv("PERFORMANCE_TEST") == "" {
+		t.Skip("skipping performance test")
+	}
+	test.Run(t, &PerformanceTestSuite{t: t})
+}