chore: add a build tag to disable containerd plugin import

pgimalac · pgimalac · commit dca769485cc5 · 2024-12-31T13:39:34.000+01:00
Signed-off-by: Pierre Gimalac &lt;pierre.gimalac@datadoghq.com&gt;
diff --git a/BUILDING.md b/BUILDING.md
@@ -122,6 +122,7 @@ make generate
 >   * `no_zfs`: A build tag disables building the ZFS snapshot driver.
 > * platform
 >   * `no_systemd`: disables any systemd specific code
+>   * `no_dynamic_plugins`: A build tag disables dynamic plugins.
 >
 > For example, adding `BUILDTAGS=no_btrfs` to your environment before calling the **binaries**
 > Makefile target will disable the btrfs driver within the containerd Go build.
diff --git a/cmd/containerd/server/server.go b/cmd/containerd/server/server.go
@@ -51,7 +51,6 @@ import (
 	ssapi "github.com/containerd/containerd/api/services/snapshots/v1"
 	"github.com/containerd/platforms"
 	"github.com/containerd/plugin"
-	"github.com/containerd/plugin/dynamic"
 	"github.com/containerd/plugin/registry"
 
 	srvconfig "github.com/containerd/containerd/v2/cmd/containerd/server/config"
@@ -476,7 +475,7 @@ func LoadPlugins(ctx context.Context, config *srvconfig.Config) ([]plugin.Regist
 	if path == "" {
 		path = filepath.Join(config.Root, "plugins")
 	}
-	if count, err := dynamic.Load(path); err != nil {
+	if count, err := loadDynamic(path); err != nil {
 		return nil, err
 	} else if count > 0 || config.PluginDir != "" { //nolint:staticcheck
 		config.PluginDir = path //nolint:staticcheck
diff --git a/cmd/containerd/server/server_no_plugins.go b/cmd/containerd/server/server_no_plugins.go
@@ -0,0 +1,24 @@
+//go:build no_dynamic_plugins
+
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package server
+
+func loadDynamic(string) (loaded int, _ error) {
+	// dynamic plugins disabled through no_dynamic_plugins build-tag
+	return 0, nil
+}
diff --git a/cmd/containerd/server/server_plugins.go b/cmd/containerd/server/server_plugins.go
@@ -0,0 +1,25 @@
+//go:build !no_dynamic_plugins
+
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package server
+
+import "github.com/containerd/plugin/dynamic"
+
+func loadDynamic(path string) (loaded int, _ error) {
+	return dynamic.Load(path)
+}

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,7 @@ make generate`
`122`	`122`	> * `no_zfs`: A build tag disables building the ZFS snapshot driver.
`123`	`123`	`> * platform`
`124`	`124`	> * `no_systemd`: disables any systemd specific code
	`125`	+> * `no_dynamic_plugins`: A build tag disables dynamic plugins.
`125`	`126`	`>`
`126`	`127`	> For example, adding `BUILDTAGS=no_btrfs` to your environment before calling the binaries
`127`	`128`	`> Makefile target will disable the btrfs driver within the containerd Go build.`