github/containerd
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Generalize the plugin package

Browse Source 
Remove containerd specific parts of the plugin package to prepare its
move out of the main repository. Separate the plugin registration
singleton into a separate package.

Separating out the plugin package and registration makes it easier to
implement external plugins without creating a dependency loop.

Signed-off-by: Derek McGowan <derek@mcg.dev>
This commit is contained in:
Derek McGowan
2023-10-12 15:36:02 -07:00
parent a80606bc2d
commit 7b2a918213
65 changed files with 363 additions and 299 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
services/server/config/config.go
View File

@@ -239,11 +239,10 @@ type ProxyPlugin struct {
}
// Decode unmarshals a plugin specific configuration by plugin id
func (c *Config) Decode(ctx context.Context, p *plugin.Registration) (interface{}, error) {
id := p.URI()
func (c *Config) Decode(ctx context.Context, id string, config interface{}) (interface{}, error) {
data, ok := c.Plugins[id]
if !ok {
return p.Config, nil
return config, nil
}
b, err := toml.Marshal(data)
@@ -251,7 +250,7 @@ func (c *Config) Decode(ctx context.Context, p *plugin.Registration) (interface{
return nil, err
}
if err := toml.NewDecoder(bytes.NewReader(b)).DisallowUnknownFields().Decode(p.Config); err != nil {
if err := toml.NewDecoder(bytes.NewReader(b)).DisallowUnknownFields().Decode(config); err != nil {
var serr *toml.StrictMissingError
if errors.As(err, &serr) {
for _, derr := range serr.Errors {
@@ -260,7 +259,7 @@ func (c *Config) Decode(ctx context.Context, p *plugin.Registration) (interface{
"key": strings.Join(derr.Key(), " "),
}).WithError(err).Warn("Ignoring unknown key in TOML for plugin")
}
err = toml.Unmarshal(b, p.Config)
err = toml.Unmarshal(b, config)
}
if err != nil {
return nil, err
@@ -268,7 +267,7 @@ func (c *Config) Decode(ctx context.Context, p *plugin.Registration) (interface{
}
return p.Config, nil
return config, nil
}
// LoadConfig loads the containerd server config from the provided path

9
services/server/config/config_test.go
View File

@@ -25,7 +25,6 @@ import (
"github.com/stretchr/testify/assert"
"github.com/containerd/containerd/plugin"
"github.com/containerd/log/logtest"
)
@@ -201,7 +200,7 @@ func TestDecodePlugin(t *testing.T) {
ctx := logtest.WithT(context.Background(), t)
data := `
version = 2
[plugins."io.containerd.runtime.v1.linux"]
[plugins."io.containerd.runtime.v2.task"]
shim_debug = true
`
@@ -216,7 +215,7 @@ version = 2
assert.NoError(t, err)
pluginConfig := map[string]interface{}{}
_, err = out.Decode(ctx, &plugin.Registration{Type: "io.containerd.runtime.v1", ID: "linux", Config: &pluginConfig})
_, err = out.Decode(ctx, "io.containerd.runtime.v2.task", &pluginConfig)
assert.NoError(t, err)
assert.Equal(t, true, pluginConfig["shim_debug"])
}
@@ -226,7 +225,7 @@ version = 2
func TestDecodePluginInV1Config(t *testing.T) {
ctx := logtest.WithT(context.Background(), t)
data := `
[plugins.linux]
[plugins.task]
shim_debug = true
`
@@ -244,7 +243,7 @@ func TestDecodePluginInV1Config(t *testing.T) {
assert.Equal(t, 3, out.Version)
pluginConfig := map[string]interface{}{}
_, err = out.Decode(ctx, &plugin.Registration{Type: "io.containerd.runtime.v1", ID: "linux", Config: &pluginConfig})
_, err = out.Decode(ctx, "io.containerd.runtime.v2.task", &pluginConfig)
assert.NoError(t, err)
assert.Equal(t, true, pluginConfig["shim_debug"])
}

27
services/server/server.go
View File

@@ -46,6 +46,7 @@ import (
"github.com/containerd/containerd/pkg/timeout"
"github.com/containerd/containerd/platforms"
"github.com/containerd/containerd/plugin"
"github.com/containerd/containerd/plugin/registry"
"github.com/containerd/containerd/plugins"
srvconfig "github.com/containerd/containerd/services/server/config"
ssproxy "github.com/containerd/containerd/snapshots/proxy"
@@ -245,13 +246,14 @@ func New(ctx context.Context, config *srvconfig.Config) (*Server, error) {
initContext := plugin.NewContext(
ctx,
p,
initialized,
config.Root,
config.State,
map[string]string{
plugins.PropertyRootDir: filepath.Join(config.Root, id),
plugins.PropertyStateDir: filepath.Join(config.State, id),
plugins.PropertyGRPCAddress: config.GRPC.Address,
plugins.PropertyTTRPCAddress: config.TTRPC.Address,
},
)
initContext.Address = config.GRPC.Address
initContext.TTRPCAddress = config.TTRPC.Address
initContext.RegisterReadiness = func() func() {
atomic.StoreInt32(&mustSucceed, 1)
return s.RegisterReadiness()
@@ -259,7 +261,7 @@ func New(ctx context.Context, config *srvconfig.Config) (*Server, error) {
// load the plugin specific configuration if it is provided
if p.Config != nil {
pc, err := config.Decode(ctx, p)
pc, err := config.Decode(ctx, id, p.Config)
if err != nil {
return nil, err
}
@@ -426,7 +428,7 @@ func (s *Server) Wait() {
// LoadPlugins loads all plugins into containerd and generates an ordered graph
// of all plugins.
func LoadPlugins(ctx context.Context, config *srvconfig.Config) ([]*plugin.Registration, error) {
func LoadPlugins(ctx context.Context, config *srvconfig.Config) ([]plugin.Registration, error) {
// load all plugins into containerd
path := config.PluginDir
if path == "" {
@@ -436,12 +438,13 @@ func LoadPlugins(ctx context.Context, config *srvconfig.Config) ([]*plugin.Regis
return nil, err
}
// load additional plugins that don't automatically register themselves
plugin.Register(&plugin.Registration{
registry.Register(&plugin.Registration{
Type: plugins.ContentPlugin,
ID: "content",
InitFn: func(ic *plugin.InitContext) (interface{}, error) {
ic.Meta.Exports["root"] = ic.Root
return local.NewStore(ic.Root)
root := ic.Properties[plugins.PropertyRootDir]
ic.Meta.Exports["root"] = root
return local.NewStore(root)
},
})
@@ -486,7 +489,7 @@ func LoadPlugins(ctx context.Context, config *srvconfig.Config) ([]*plugin.Regis
p = platforms.DefaultSpec()
}
plugin.Register(&plugin.Registration{
registry.Register(&plugin.Registration{
Type: t,
ID: name,
InitFn: func(ic *plugin.InitContext) (interface{}, error) {
@@ -504,7 +507,7 @@ func LoadPlugins(ctx context.Context, config *srvconfig.Config) ([]*plugin.Regis
filter := srvconfig.V2DisabledFilter
// return the ordered graph for plugins
return plugin.Graph(filter(config.DisabledPlugins)), nil
return registry.Graph(filter(config.DisabledPlugins)), nil
}
type proxyClients struct {

9
services/server/server_test.go
View File

@@ -21,6 +21,7 @@ import (
"testing"
"github.com/containerd/containerd/plugin"
"github.com/containerd/containerd/plugin/registry"
srvconfig "github.com/containerd/containerd/services/server/config"
"github.com/stretchr/testify/assert"
)
@@ -57,8 +58,8 @@ func TestCreateTopLevelDirectoriesWithEmptyRootPath(t *testing.T) {
}
func TestMigration(t *testing.T) {
plugin.Reset()
defer plugin.Reset()
registry.Reset()
defer registry.Reset()
version := srvconfig.CurrentConfigVersion - 1
@@ -67,7 +68,7 @@ func TestMigration(t *testing.T) {
NotMigrated string `toml:"notmigrated"`
}
plugin.Register(&plugin.Registration{
registry.Register(&plugin.Registration{
Type: "io.containerd.test",
ID: "t1",
Config: &testConfig{},
@@ -86,7 +87,7 @@ func TestMigration(t *testing.T) {
return nil, nil
},
})
plugin.Register(&plugin.Registration{
registry.Register(&plugin.Registration{
Type: "io.containerd.new",
Requires: []plugin.Type{
"io.containerd.test", // Ensure this test runs second