Separate the CRI image config from the main plugin config
This change simplifies the CRI plugin dependencies by not requiring the CRI image plugin to depend on any other CRI components. Since other CRI plugins depend on the image plugin, this allows prevents a dependency cycle for CRI configurations on a base plugin. Signed-off-by: Derek McGowan <derek@mcg.dev>
This commit is contained in:
Derek McGowan
238
plugins/cri/images/plugin.go
Normal file
238
plugins/cri/images/plugin.go
Normal file
@@ -0,0 +1,238 @@
|
||||
/*
|
||||
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 images
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
|
||||
containerd "github.com/containerd/containerd/v2/client"
|
||||
"github.com/containerd/containerd/v2/events"
|
||||
"github.com/containerd/containerd/v2/metadata"
|
||||
criconfig "github.com/containerd/containerd/v2/pkg/cri/config"
|
||||
"github.com/containerd/containerd/v2/pkg/cri/constants"
|
||||
"github.com/containerd/containerd/v2/pkg/cri/server/images"
|
||||
"github.com/containerd/containerd/v2/platforms"
|
||||
"github.com/containerd/containerd/v2/plugins"
|
||||
srvconfig "github.com/containerd/containerd/v2/services/server/config"
|
||||
"github.com/containerd/containerd/v2/snapshots"
|
||||
"github.com/containerd/log"
|
||||
"github.com/containerd/plugin"
|
||||
"github.com/containerd/plugin/registry"
|
||||
)
|
||||
|
||||
func init() {
|
||||
config := criconfig.DefaultImageConfig()
|
||||
|
||||
registry.Register(&plugin.Registration{
|
||||
Type: plugins.CRIImagePlugin,
|
||||
ID: "local",
|
||||
Config: &config,
|
||||
Requires: []plugin.Type{
|
||||
plugins.LeasePlugin,
|
||||
plugins.EventPlugin,
|
||||
plugins.MetadataPlugin,
|
||||
plugins.SandboxStorePlugin,
|
||||
plugins.InternalPlugin, // For config migration ordering
|
||||
plugins.ServicePlugin, // For client
|
||||
plugins.SnapshotPlugin, // For root directory properties
|
||||
},
|
||||
InitFn: func(ic *plugin.InitContext) (interface{}, error) {
|
||||
m, err := ic.GetSingle(plugins.MetadataPlugin)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
mdb := m.(*metadata.DB)
|
||||
|
||||
ep, err := ic.GetSingle(plugins.EventPlugin)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
options := &images.CRIImageServiceOptions{
|
||||
Content: mdb.ContentStore(),
|
||||
Images: metadata.NewImageStore(mdb),
|
||||
RuntimePlatforms: map[string]images.ImagePlatform{},
|
||||
Snapshotters: map[string]snapshots.Snapshotter{},
|
||||
ImageFSPaths: map[string]string{},
|
||||
Publisher: ep.(events.Publisher),
|
||||
}
|
||||
|
||||
options.Client, err = containerd.New(
|
||||
"",
|
||||
containerd.WithDefaultNamespace(constants.K8sContainerdNamespace),
|
||||
containerd.WithDefaultPlatform(platforms.Default()),
|
||||
containerd.WithInMemoryServices(ic),
|
||||
)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to init client for cri image service: %w", err)
|
||||
}
|
||||
|
||||
allSnapshotters := mdb.Snapshotters()
|
||||
defaultSnapshotter := config.Snapshotter
|
||||
if s, ok := allSnapshotters[defaultSnapshotter]; ok {
|
||||
options.Snapshotters[defaultSnapshotter] = s
|
||||
} else {
|
||||
return nil, fmt.Errorf("failed to find snapshotter %q", defaultSnapshotter)
|
||||
}
|
||||
var snapshotRoot string
|
||||
if plugin := ic.Plugins().Get(plugins.SnapshotPlugin, defaultSnapshotter); plugin != nil {
|
||||
snapshotRoot = plugin.Meta.Exports["root"]
|
||||
}
|
||||
if snapshotRoot == "" {
|
||||
// Try a root in the same parent as this plugin
|
||||
snapshotRoot = filepath.Join(filepath.Dir(ic.Properties[plugins.PropertyRootDir]), plugins.SnapshotPlugin.String()+"."+defaultSnapshotter)
|
||||
}
|
||||
options.ImageFSPaths[defaultSnapshotter] = snapshotRoot
|
||||
log.L.Infof("Get image filesystem path %q for snapshotter %q", snapshotRoot, defaultSnapshotter)
|
||||
|
||||
for runtimeName, rp := range config.RuntimePlatforms {
|
||||
snapshotter := rp.Snapshotter
|
||||
if snapshotter == "" {
|
||||
snapshotter = defaultSnapshotter
|
||||
} else if _, ok := options.ImageFSPaths[snapshotter]; !ok {
|
||||
if s, ok := options.Snapshotters[defaultSnapshotter]; ok {
|
||||
options.Snapshotters[defaultSnapshotter] = s
|
||||
} else {
|
||||
return nil, fmt.Errorf("failed to find snapshotter %q", defaultSnapshotter)
|
||||
}
|
||||
var snapshotRoot string
|
||||
if plugin := ic.Plugins().Get(plugins.SnapshotPlugin, snapshotter); plugin != nil {
|
||||
snapshotRoot = plugin.Meta.Exports["root"]
|
||||
}
|
||||
if snapshotRoot == "" {
|
||||
// Try a root in the same parent as this plugin
|
||||
snapshotRoot = filepath.Join(filepath.Dir(ic.Properties[plugins.PropertyRootDir]), plugins.SnapshotPlugin.String()+"."+snapshotter)
|
||||
}
|
||||
|
||||
options.ImageFSPaths[defaultSnapshotter] = snapshotRoot
|
||||
log.L.Infof("Get image filesystem path %q for snapshotter %q", options.ImageFSPaths[snapshotter], snapshotter)
|
||||
}
|
||||
platform := platforms.DefaultSpec()
|
||||
if rp.Platform != "" {
|
||||
p, err := platforms.Parse(rp.Platform)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to parse platform %q: %w", rp.Platform, err)
|
||||
}
|
||||
platform = p
|
||||
}
|
||||
options.RuntimePlatforms[runtimeName] = images.ImagePlatform{
|
||||
Snapshotter: snapshotter,
|
||||
Platform: platform,
|
||||
}
|
||||
}
|
||||
|
||||
service, err := images.NewService(config, options)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create image service: %w", err)
|
||||
}
|
||||
|
||||
return service, nil
|
||||
},
|
||||
ConfigMigration: configMigration,
|
||||
})
|
||||
}
|
||||
|
||||
func configMigration(ctx context.Context, version int, pluginConfigs map[string]interface{}) error {
|
||||
if version >= srvconfig.CurrentConfigVersion {
|
||||
return nil
|
||||
}
|
||||
original, ok := pluginConfigs[string(plugins.InternalPlugin)+".cri"]
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
src := original.(map[string]interface{})
|
||||
updated, ok := pluginConfigs[string(plugins.CRIImagePlugin)+".local"]
|
||||
var dst map[string]interface{}
|
||||
if ok {
|
||||
dst = updated.(map[string]interface{})
|
||||
} else {
|
||||
dst = map[string]interface{}{}
|
||||
}
|
||||
|
||||
migrateConfig(dst, src)
|
||||
pluginConfigs[string(plugins.CRIImagePlugin)+".local"] = dst
|
||||
return nil
|
||||
}
|
||||
func migrateConfig(dst, src map[string]interface{}) {
|
||||
containerdConf, ok := src["containerd"]
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
containerdConfMap := containerdConf.(map[string]interface{})
|
||||
runtimesConf, ok := containerdConfMap["runtimes"]
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
|
||||
var runtimePlatforms map[string]interface{}
|
||||
if v, ok := dst["runtime_platform"]; ok {
|
||||
runtimePlatforms = v.(map[string]interface{})
|
||||
} else {
|
||||
runtimePlatforms = map[string]interface{}{}
|
||||
}
|
||||
for runtime, v := range runtimesConf.(map[string]interface{}) {
|
||||
runtimeConf := v.(map[string]interface{})
|
||||
if snapshotter, ok := runtimeConf["snapshot"]; ok && snapshotter != "" {
|
||||
runtimePlatforms[runtime] = map[string]interface{}{
|
||||
"platform": platforms.DefaultStrict(),
|
||||
"snapshotter": snapshotter,
|
||||
}
|
||||
}
|
||||
}
|
||||
if len(runtimePlatforms) > 0 {
|
||||
dst["runtime_platform"] = runtimePlatforms
|
||||
}
|
||||
|
||||
var pinnedImages map[string]interface{}
|
||||
if v, ok := dst["pinned_images"]; ok {
|
||||
pinnedImages = v.(map[string]interface{})
|
||||
} else {
|
||||
pinnedImages = map[string]interface{}{}
|
||||
}
|
||||
|
||||
if simage, ok := src["sandbox_image"]; ok {
|
||||
pinnedImages["sandbox"] = simage
|
||||
}
|
||||
if len(pinnedImages) > 0 {
|
||||
dst["pinned_images"] = pinnedImages
|
||||
}
|
||||
|
||||
for _, key := range []string{
|
||||
"snapshotter",
|
||||
"disable_snapshot_annotations",
|
||||
"discard_unpacked_layers",
|
||||
} {
|
||||
if val, ok := containerdConfMap[key]; ok {
|
||||
dst[key] = val
|
||||
}
|
||||
}
|
||||
|
||||
for _, key := range []string{
|
||||
"registry",
|
||||
"image_decryption",
|
||||
"max_concurrent_downloads",
|
||||
"image_pull_progress_timeout",
|
||||
"image_pull_with_sync_fs",
|
||||
"stats_collect_period",
|
||||
} {
|
||||
if val, ok := src[key]; ok {
|
||||
dst[key] = val
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user