api,adaptation,stub: exchange version in registration.

Exchange NRI (golang module) version information during
plugin registration.

Signed-off-by: Krisztian Litkey <[email protected]>

Author: klihub

pkg/adaptation/adaptation.go

@@ -31,6 +31,7 @@ import (
 	"github.com/containerd/nri/pkg/api"
 	"github.com/containerd/nri/pkg/auth"
 	"github.com/containerd/nri/pkg/log"
+	"github.com/containerd/nri/pkg/utils"
 	validator "github.com/containerd/nri/plugins/default-validator/builtin"
 	"github.com/containerd/ttrpc"
 	"github.com/tetratelabs/wazero"
@@ -62,6 +63,7 @@ type Adaptation struct {
 	sync.Mutex
 	name        string
 	version     string
+	nriVersion  string
 	dropinPath  string
 	pluginPath  string
 	socketPath  string
@@ -190,6 +192,7 @@ func New(name, version string, syncFn SyncFn, updateFn UpdateFn, opts ...Option)
 	r := &Adaptation{
 		name:        name,
 		version:     version,
+		nriVersion:  utils.GetVersionFromBuildInfo(utils.NRIModulePath),
 		syncFn:      syncFn,
 		updateFn:    updateFn,
 		pluginPath:  DefaultPluginPath,

pkg/adaptation/plugin.go

@@ -540,7 +540,12 @@ func (p *plugin) RegisterPlugin(ctx context.Context, req *RegisterPluginRequest)
 		p.idx = req.PluginIdx
 	}
 
-	log.Infof(ctx, "plugin %q registered as %q", p.qualifiedName(), p.name())
+	nriVersion := "unknown"
+	if req.NRIVersion != "" {
+		nriVersion = req.NRIVersion
+	}
+	log.Infof(ctx, "plugin %q registered as %q (with NRI version %s)",
+		p.qualifiedName(), p.name(), nriVersion)
 
 	p.regC <- nil
 	return &RegisterPluginResponse{}, nil
@@ -567,6 +572,7 @@ func (p *plugin) configure(ctx context.Context, name, version, config string) (e
 		RuntimeVersion:      version,
 		RegistrationTimeout: getPluginRegistrationTimeout().Milliseconds(),
 		RequestTimeout:      getPluginRequestTimeout().Milliseconds(),
+		NRIVersion:          p.r.nriVersion,
 	}
 
 	rpl, err := p.impl.Configure(ctx, req)

pkg/api/api.pb.go

@@ -36,6 +36,8 @@ message RegisterPluginRequest {
     string plugin_name = 1;
     // Plugin invocation index. Plugins are called in ascending index order.
     string plugin_idx = 2;
+    // NRI (module) version used by plugin, if known.
+    string NRI_version = 3;
 }
 
 message UpdateContainersRequest {
@@ -145,6 +147,8 @@ message ConfigureRequest {
   int64 registration_timeout = 4;
   // Configured request processing timeout in milliseconds.
   int64 request_timeout = 5;
+  // Version of NRI used by the runtime.
+  string NRI_version = 6;
 }
 
 message ConfigureResponse {

pkg/api/api.proto

@@ -34,6 +34,7 @@ import (
 	nrilog "github.com/containerd/nri/pkg/log"
 	"github.com/containerd/nri/pkg/net"
 	"github.com/containerd/nri/pkg/net/multiplex"
+	"github.com/containerd/nri/pkg/utils"
 	"github.com/containerd/ttrpc"
 )
 
@@ -186,6 +187,9 @@ type Stub interface {
 	GetRole() string
 	// GetTags returns any tags associated with the plugin's role, if any.
 	GetTags() map[string]string
+
+	// PeerNRIVersion returns the NRI version used in our peer, if known.
+	PeerNRIVersion() string
 }
 
 const (
@@ -322,6 +326,7 @@ type stub struct {
 
 	registrationTimeout time.Duration
 	requestTimeout      time.Duration
+	peerNRIVersion      string
 }
 
 // Handlers for NRI plugin event and request.
@@ -356,6 +361,7 @@ func New(p interface{}, opts ...Option) (Stub, error) {
 
 		registrationTimeout: DefaultRegistrationTimeout,
 		requestTimeout:      DefaultRequestTimeout,
+		peerNRIVersion:      "unknown",
 	}
 
 	for _, o := range opts {
@@ -584,6 +590,10 @@ func (stub *stub) GetTags() map[string]string {
 	return maps.Clone(stub.tags)
 }
 
+func (stub *stub) PeerNRIVersion() string {
+	return stub.peerNRIVersion
+}
+
 // Connect the plugin to NRI.
 func (stub *stub) connect() error {
 	if stub.conn != nil {
@@ -692,6 +702,7 @@ func (stub *stub) register(ctx context.Context) error {
 	req := &api.RegisterPluginRequest{
 		PluginName: stub.name,
 		PluginIdx:  stub.idx,
+		NRIVersion: utils.GetVersionFromBuildInfo(utils.NRIModulePath),
 	}
 	if _, err := stub.runtime.RegisterPlugin(ctx, req); err != nil {
 		return fmt.Errorf("failed to register with NRI/Runtime: %w", err)
@@ -739,11 +750,12 @@ func (stub *stub) Configure(ctx context.Context, req *api.ConfigureRequest) (rpl
 		err    error
 	)
 
-	log.Infof(ctx, "Configuring plugin %s for runtime %s/%s...", stub.Name(),
-		req.RuntimeName, req.RuntimeVersion)
+	log.Infof(ctx, "Configuring plugin %s for runtime %s/%s (NRI version %s)...", stub.Name(),
+		req.RuntimeName, req.RuntimeVersion, req.NRIVersion)
 
 	stub.registrationTimeout = time.Duration(req.RegistrationTimeout * int64(time.Millisecond))
 	stub.requestTimeout = time.Duration(req.RequestTimeout * int64(time.Millisecond))
+	stub.peerNRIVersion = req.NRIVersion
 
 	defer func() {
 		stub.cfgErrC <- retErr

pkg/api/api_vtproto.pb.go

@@ -0,0 +1,37 @@
+/*
+   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 utils
+
+import (
+	"runtime/debug"
+)
+
+const (
+	NRIModulePath = "github.com/containerd/nri"
+)
+
+func GetVersionFromBuildInfo(modPath string) string {
+	if bi, ok := debug.ReadBuildInfo(); ok {
+		for _, mod := range bi.Deps {
+			if mod.Path == modPath {
+				return mod.Version
+			}
+		}
+	}
+
+	return "unknown"
+}